diff --git a/MANUAL.html b/MANUAL.html index 65a06a1a2..e7192362c 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Sep 02, 2020

+

Sep 13, 2020

Rclone syncs your files to cloud storage

rclone logo

@@ -118,6 +118,7 @@
  • StackPath
  • SugarSync
  • Tardigrade
    • +
  • Tencent Cloud Object Storage (COS)
  • Wasabi
  • WebDAV
  • Yandex Disk
    • @@ -335,7 +336,7 @@ rclone sync -i /local/path remote:path # syncs /local/path to the remote<
  • rclone config userinfo - Prints info about logged in user of remote.

    • rclone copy

    -

    Copy files from source to dest, skipping already copied

    +

    Copy files from source to dest, skipping already copied.

    Synopsis

    Copy the source to the destination. Doesn't transfer unchanged files, testing by size and modification time or MD5SUM. Doesn't delete files from the destination.

    Note that it is always the contents of the directory that is synced, not the directory so when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents.

    @@ -472,7 +473,7 @@ rclone --dry-run --min-size 100M delete remote:path

    If you supply the --size-only flag, it will only compare the sizes not the hashes as well. Use this for a quick check.

    If you supply the --download flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data.

    If you supply the --one-way flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected.

    -

    The --differ, --missing-on-dst, --missing-on-src, --src-only and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and destination but different.

    +

    The --differ, --missing-on-dst, --missing-on-src, --match and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and destination but different.

    The --combined flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files.

    rclone cleanup

    -

    Clean up the remote if possible

    +

    Clean up the remote if possible.

    Synopsis

    Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.

    rclone cleanup remote:path [flags]
    @@ -1024,7 +1026,7 @@ rclone backend help <backendname>
  • rclone config - Enter an interactive configuration session.

    • rclone copyto

    -

    Copy files from source to dest, skipping already copied

    +

    Copy files from source to dest, skipping already copied.

    Synopsis

    If source:path is a file or directory then it copies it to a file or directory named dest:path.

    This can be used to upload single files to other than their current name. If the source is a directory then it acts exactly like the copy command.

    @@ -1077,7 +1079,7 @@ if src is directory 
    rclone cryptcheck remote:path encryptedremote:path

    After it has run it will log the status of the encryptedremote:.

    If you supply the --one-way flag, it will only check that files in the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected.

    -

    The --differ, --missing-on-dst, --missing-on-src, --src-only and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and destination but different.

    +

    The --differ, --missing-on-dst, --missing-on-src, --match and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and destination but different.

    The --combined flag will write a file (or stdout) which contains all file paths with a symbol and then a space and then the path to tell you what happened to it. These are reminiscent of diff files.

    rclone lsf

    -

    List directories and objects in remote:path formatted for parsing

    +

    List directories and objects in remote:path formatted for parsing.

    Synopsis

    List the contents of the source path (directories and objects) to standard output in a form which is easy to parse by scripts. By default this will just be the names of the objects and directories, one per line. The directories will have a / suffix.

    Eg

    @@ -1418,6 +1420,7 @@ rclone mount remote:path/to/files C:\path\to\nonexistent\directory fusermount -u /path/to/local/mount # OS X umount /path/to/local/mount +

    Note: As of rclone 1.52.2, rclone mount now requires Go version 1.13 or newer on some platforms depending on the underlying FUSE library in use.

    Installing on Windows

    To run rclone mount on Windows, you will need to download and install WinFsp.

    WinFsp is an open source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with cgofuse. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.

    @@ -1519,6 +1522,7 @@ umount /path/to/local/mount

    This mode should support all normal file system operations and is otherwise identical to --vfs-cache-mode writes.

    When reading a file rclone will read --buffer-size plus --vfs-read-ahead bytes ahead. The --buffer-size is buffered in memory whereas the --vfs-read-ahead is buffered on disk.

    When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required.

    +

    IMPORTANT not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.

    VFS Performance

    These flags may be used to enable/disable features of the VFS for performance or other reasons.

    In particular S3 and Swift benefit hugely from the --no-modtime flag (or use --use-server-modtime for a slightly different effect) as each read of the modification time takes a transaction.

    @@ -1639,7 +1643,7 @@ if src is directory
  • rclone - Show help for rclone commands, flags and backends.

    • rclone obscure

    -

    Obscure password for use in the rclone config file

    +

    Obscure password for use in the rclone config file.

    Synopsis

    In the rclone config file, human readable passwords are obscured. Obscuring them is done by encrypting them and writing them out in base64. This is not a secure way of encrypting these passwords as rclone can decrypt them - it is to prevent "eyedropping" - namely someone seeing a password in the rclone config file by accident.

    Many equally important things (like access tokens) are not obscured in the config file. However it is very hard to shoulder surf a 64 character hex token.

    @@ -1833,6 +1837,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    This mode should support all normal file system operations and is otherwise identical to --vfs-cache-mode writes.

    When reading a file rclone will read --buffer-size plus --vfs-read-ahead bytes ahead. The --buffer-size is buffered in memory whereas the --vfs-read-ahead is buffered on disk.

    When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required.

    +

    IMPORTANT not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.

    VFS Performance

    These flags may be used to enable/disable features of the VFS for performance or other reasons.

    In particular S3 and Swift benefit hugely from the --no-modtime flag (or use --use-server-modtime for a slightly different effect) as each read of the modification time takes a transaction.

    @@ -1964,6 +1969,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    This mode should support all normal file system operations and is otherwise identical to --vfs-cache-mode writes.

    When reading a file rclone will read --buffer-size plus --vfs-read-ahead bytes ahead. The --buffer-size is buffered in memory whereas the --vfs-read-ahead is buffered on disk.

    When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required.

    +

    IMPORTANT not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.

    VFS Performance

    These flags may be used to enable/disable features of the VFS for performance or other reasons.

    In particular S3 and Swift benefit hugely from the --no-modtime flag (or use --use-server-modtime for a slightly different effect) as each read of the modification time takes a transaction.

    @@ -2223,6 +2229,7 @@ htpasswd -B htpasswd anotherUser

    This mode should support all normal file system operations and is otherwise identical to --vfs-cache-mode writes.

    When reading a file rclone will read --buffer-size plus --vfs-read-ahead bytes ahead. The --buffer-size is buffered in memory whereas the --vfs-read-ahead is buffered on disk.

    When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required.

    +

    IMPORTANT not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.

    VFS Performance

    These flags may be used to enable/disable features of the VFS for performance or other reasons.

    In particular S3 and Swift benefit hugely from the --no-modtime flag (or use --use-server-modtime for a slightly different effect) as each read of the modification time takes a transaction.

    @@ -2530,6 +2537,7 @@ htpasswd -B htpasswd anotherUser

    This mode should support all normal file system operations and is otherwise identical to --vfs-cache-mode writes.

    When reading a file rclone will read --buffer-size plus --vfs-read-ahead bytes ahead. The --buffer-size is buffered in memory whereas the --vfs-read-ahead is buffered on disk.

    When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required.

    +

    IMPORTANT not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.

    VFS Performance

    These flags may be used to enable/disable features of the VFS for performance or other reasons.

    In particular S3 and Swift benefit hugely from the --no-modtime flag (or use --use-server-modtime for a slightly different effect) as each read of the modification time takes a transaction.

    @@ -2792,6 +2800,7 @@ htpasswd -B htpasswd anotherUser

    This mode should support all normal file system operations and is otherwise identical to --vfs-cache-mode writes.

    When reading a file rclone will read --buffer-size plus --vfs-read-ahead bytes ahead. The --buffer-size is buffered in memory whereas the --vfs-read-ahead is buffered on disk.

    When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required.

    +

    IMPORTANT not all file systems support sparse files. In particular FAT/exFAT do not. Rclone will perform very badly if the cache directory is on a filesystem which doesn't support sparse files and it will log an ERROR message if one is detected.

    VFS Performance

    These flags may be used to enable/disable features of the VFS for performance or other reasons.

    In particular S3 and Swift benefit hugely from the --no-modtime flag (or use --use-server-modtime for a slightly different effect) as each read of the modification time takes a transaction.

    @@ -3200,6 +3209,7 @@ y/n/s/!/q> n

    During rmdirs it will not remove root directory, even if it's empty.

    --log-file=FILE

    Log all of rclone's output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination with the -v flag. See the Logging section for more info.

    +

    If FILE exists then rclone will append to it.

    Note that if you are using the logrotate program to manage rclone's logs, then you should use the copytruncate option as rclone doesn't have a signal to rotate logs.

    --log-format LIST

    Comma separated list of log format options. date, time, microseconds, longfile, shortfile, UTC. The default is "date,time".

    @@ -4340,8088 +4350,9164 @@ OR "error": true, "result": "<Raw command line output>" } - -**Authentication is required for this call.** - -### core/gc: Runs a garbage collection. {#core-gc} - -This tells the go runtime to do a garbage collection run. It isn't -necessary to call this normally, but it can be useful for debugging -memory problems. - -### core/group-list: Returns list of stats. {#core-group-list} - -This returns list of stats groups currently in memory. - -Returns the following values: -

    { "groups": an array of group names: [ "group1", "group2", ... ] }

    -
    
-### core/memstats: Returns the memory statistics {#core-memstats}
-
-This returns the memory statistics of the running program.  What the values mean
-are explained in the go docs: https://golang.org/pkg/runtime/#MemStats
-
-The most interesting values for most people are:
-
-* HeapAlloc: This is the amount of memory rclone is actually using
-* HeapSys: This is the amount of memory rclone has obtained from the OS
-* Sys: this is the total amount of memory requested from the OS
-  * It is virtual memory so may include unused memory
-
-### core/obscure: Obscures a string passed in. {#core-obscure}
-
-Pass a clear string and rclone will obscure it for the config file:
-- clear - string
-
-Returns
-- obscured - string
-
-### core/pid: Return PID of current process {#core-pid}
-
-This returns PID of current process.
-Useful for stopping rclone process.
-
-### core/quit: Terminates the app. {#core-quit}
-
-(optional) Pass an exit code to be used for terminating the app:
-- exitCode - int
-
-### core/stats: Returns stats about current transfers. {#core-stats}
-
-This returns all available stats:
-
-    rclone rc core/stats
-
-If group is not provided then summed up stats for all groups will be
-returned.
-
-Parameters
-
-- group - name of the stats group (string)
-
-Returns the following values:
    -

    { "speed": average speed in bytes/sec since start of the process, "bytes": total transferred bytes since the start of the process, "errors": number of errors, "fatalError": whether there has been at least one FatalError, "retryError": whether there has been at least one non-NoRetryError, "checks": number of checked files, "transfers": number of transferred files, "deletes" : number of deleted files, "renames" : number of renamed files, "transferTime" : total time spent on running jobs, "elapsedTime": time in seconds since the start of the process, "lastError": last occurred error, "transferring": an array of currently active file transfers: [ { "bytes": total transferred bytes for this file, "eta": estimated time in seconds until file transfer completion "name": name of the file, "percentage": progress of the file transfer in percent, "speed": average speed over the whole transfer in bytes/sec, "speedAvg": current speed in bytes/sec as an exponentially weighted moving average, "size": size of the file in bytes } ], "checking": an array of names of currently active file checks [] }

    -
    Values for "transferring", "checking" and "lastError" are only assigned if data is available.
-The value for "eta" is null if an eta cannot be determined.
-
-### core/stats-delete: Delete stats group. {#core-stats-delete}
-
-This deletes entire stats group
-
-Parameters
-
-- group - name of the stats group (string)
-
-### core/stats-reset: Reset stats. {#core-stats-reset}
-
-This clears counters, errors and finished transfers for all stats or specific 
-stats group if group is provided.
-
-Parameters
-
-- group - name of the stats group (string)
-
-### core/transferred: Returns stats about completed transfers. {#core-transferred}
-
-This returns stats about completed transfers:
-
-    rclone rc core/transferred
-
-If group is not provided then completed transfers for all groups will be
-returned.
-
-Note only the last 100 completed transfers are returned.
-
-Parameters
-
-- group - name of the stats group (string)
-
-Returns the following values:
    -

    { "transferred": an array of completed transfers (including failed ones): [ { "name": name of the file, "size": size of the file in bytes, "bytes": total transferred bytes for this file, "checked": if the transfer is only checked (skipped, deleted), "timestamp": integer representing millisecond unix epoch, "error": string description of the error (empty if successful), "jobid": id of the job that this transfer belongs to } ] }

    -
    
-### core/version: Shows the current version of rclone and the go runtime. {#core-version}
-
-This shows the current version of go and the go runtime
-
-- version - rclone version, eg "v1.53.0"
-- decomposed - version number as [major, minor, patch]
-- isGit - boolean - true if this was compiled from the git version
-- isBeta - boolean - true if this is a beta version
-- os - OS in use as according to Go
-- arch - cpu architecture in use according to Go
-- goVersion - version of Go runtime in use
-
-### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate}
-
-SetBlockProfileRate controls the fraction of goroutine blocking events
-that are reported in the blocking profile. The profiler aims to sample
-an average of one blocking event per rate nanoseconds spent blocked.
-
-To include every blocking event in the profile, pass rate = 1. To turn
-off profiling entirely, pass rate <= 0.
-
-After calling this you can use this to see the blocking profile:
-
-    go tool pprof http://localhost:5572/debug/pprof/block
-
-Parameters
-
-- rate - int
-
-### debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug-set-mutex-profile-fraction}
-
-SetMutexProfileFraction controls the fraction of mutex contention
-events that are reported in the mutex profile. On average 1/rate
-events are reported. The previous rate is returned.
-
-To turn off profiling entirely, pass rate 0. To just read the current
-rate, pass rate < 0. (For n>1 the details of sampling may change.)
-
-Once this is set you can look use this to profile the mutex contention:
-
-    go tool pprof http://localhost:5572/debug/pprof/mutex
-
-Parameters
-
-- rate - int
-
-Results
-
-- previousRate - int
-
-### job/list: Lists the IDs of the running jobs {#job-list}
-
-Parameters - None
-
-Results
-
-- jobids - array of integer job ids
-
-### job/status: Reads the status of the job ID {#job-status}
-
-Parameters
-
-- jobid - id of the job (integer)
-
-Results
-
-- finished - boolean
-- duration - time in seconds that the job ran for
-- endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00")
-- error - error from the job or empty string for no error
-- finished - boolean whether the job has finished or not
-- id - as passed in above
-- startTime - time the job started (eg "2018-10-26T18:50:20.528336039+01:00")
-- success - boolean - true for success false otherwise
-- output - output of the job as would have been returned if called synchronously
-- progress - output of the progress related to the underlying job
-
-### job/stop: Stop the running job {#job-stop}
-
-Parameters
-
-- jobid - id of the job (integer)
-
-### mount/listmounts: Show current mount points {#mount-listmounts}
-
-This shows currently mounted points, which can be used for performing an unmount
-
-This takes no parameters and returns
-
-- mountPoints: list of current mount points
-
-Eg
-
-    rclone rc mount/listmounts
-
-**Authentication is required for this call.**
-
-### mount/mount: Create a new mount point {#mount-mount}
-
-rclone allows Linux, FreeBSD, macOS and Windows to mount any of
-Rclone's cloud storage systems as a file system with FUSE.
-
-If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2
-
-This takes the following parameters
-
-- fs - a remote path to be mounted (required)
-- mountPoint: valid path on the local machine (required)
-- mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use
-- mountOpt: a JSON object with Mount options in.
-- vfsOpt: a JSON object with VFS options in.
-
-Eg
-
-    rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
-    rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
-    rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
-
-The vfsOpt are as described in options/get and can be seen in the the
-"vfs" section when running and the mountOpt can be seen in the "mount" section.
-
-    rclone rc options/get
-
-**Authentication is required for this call.**
-
-### mount/types: Show all possible mount types {#mount-types}
-
-This shows all possible mount types and returns them as a list.
-
-This takes no parameters and returns
-
-- mountTypes: list of mount types
-
-The mount types are strings like "mount", "mount2", "cmount" and can
-be passed to mount/mount as the mountType parameter.
-
-Eg
-
-    rclone rc mount/types
-
-**Authentication is required for this call.**
-
-### mount/unmount: Unmount selected active mount {#mount-unmount}
-
-rclone allows Linux, FreeBSD, macOS and Windows to
-mount any of Rclone's cloud storage systems as a file system with
-FUSE.
-
-This takes the following parameters
-
-- mountPoint: valid path on the local machine where the mount was created (required)
-
-Eg
-
-    rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
-
-**Authentication is required for this call.**
-
-### mount/unmountall: Show current mount points {#mount-unmountall}
-
-This shows currently mounted points, which can be used for performing an unmount
-
-This takes no parameters and returns error if unmount does not succeed.
-
-Eg
-
-    rclone rc mount/unmountall
-
-**Authentication is required for this call.**
-
-### operations/about: Return the space used on the remote {#operations-about}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-The result is as returned from rclone about --json
-
-See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:" for the source
-- srcRemote - a path within that remote eg "file.txt" for the source
-- dstFs - a remote name string eg "drive2:" for the destination
-- dstRemote - a path within that remote eg "file2.txt" for the destination
-
-**Authentication is required for this call.**
-
-### operations/copyurl: Copy the URL to the object {#operations-copyurl}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- url - string, URL to read from
- - autoFilename - boolean, set to true to retrieve destination file name from url
-See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/delete: Remove files in the path {#operations-delete}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/deletefile: Remove the single file pointed to {#operations-deletefile}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/fsinfo: Return information about the remote {#operations-fsinfo}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-This returns info about the remote passed in;
+
    Authentication is required for this call.
    
+
    core/gc: Runs a garbage collection.
    
+
    This tells the go runtime to do a garbage collection run. It isn't necessary to call this normally, but it can be useful for debugging memory problems.
    
+
    core/group-list: Returns list of stats.
    
+
    This returns list of stats groups currently in memory.
    
+
    Returns the following values:
    
+
    {
+    "groups":  an array of group names:
+        [
+            "group1",
+            "group2",
+            ...
+        ]
+}
    
+
    core/memstats: Returns the memory statistics
    
+
    This returns the memory statistics of the running program. What the values mean are explained in the go docs: https://golang.org/pkg/runtime/#MemStats
    
+
    The most interesting values for most people are:
    
+
+
    core/obscure: Obscures a string passed in.
    
+
    Pass a clear string and rclone will obscure it for the config file: - clear - string
    
+
    Returns - obscured - string
    
+
    core/pid: Return PID of current process
    
+
    This returns PID of current process. Useful for stopping rclone process.
    
+
    core/quit: Terminates the app.
    
+
    (optional) Pass an exit code to be used for terminating the app: - exitCode - int
    
+
    core/stats: Returns stats about current transfers.
    
+
    This returns all available stats:
    
+
    rclone rc core/stats
    
+
    If group is not provided then summed up stats for all groups will be returned.
    
+
    Parameters
    
+
+
    Returns the following values:
    
+
    {
+    "speed": average speed in bytes/sec since start of the process,
+    "bytes": total transferred bytes since the start of the process,
+    "errors": number of errors,
+    "fatalError": whether there has been at least one FatalError,
+    "retryError": whether there has been at least one non-NoRetryError,
+    "checks": number of checked files,
+    "transfers": number of transferred files,
+    "deletes" : number of deleted files,
+    "renames" : number of renamed files,
+    "transferTime" : total time spent on running jobs,
+    "elapsedTime": time in seconds since the start of the process,
+    "lastError": last occurred error,
+    "transferring": an array of currently active file transfers:
+        [
+            {
+                "bytes": total transferred bytes for this file,
+                "eta": estimated time in seconds until file transfer completion
+                "name": name of the file,
+                "percentage": progress of the file transfer in percent,
+                "speed": average speed over the whole transfer in bytes/sec,
+                "speedAvg": current speed in bytes/sec as an exponentially weighted moving average,
+                "size": size of the file in bytes
+            }
+        ],
+    "checking": an array of names of currently active file checks
+        []
+}
    
+
    Values for "transferring", "checking" and "lastError" are only assigned if data is available. The value for "eta" is null if an eta cannot be determined.
    
+
    core/stats-delete: Delete stats group.
    
+
    This deletes entire stats group
    
+
    Parameters
    
+
+
    core/stats-reset: Reset stats.
    
+
    This clears counters, errors and finished transfers for all stats or specific stats group if group is provided.
    
+
    Parameters
    
+
+
    core/transferred: Returns stats about completed transfers.
    
+
    This returns stats about completed transfers:
    
+
    rclone rc core/transferred
    
+
    If group is not provided then completed transfers for all groups will be returned.
    
+
    Note only the last 100 completed transfers are returned.
    
+
    Parameters
    
+
+
    Returns the following values:
    
+
    {
+    "transferred":  an array of completed transfers (including failed ones):
+        [
+            {
+                "name": name of the file,
+                "size": size of the file in bytes,
+                "bytes": total transferred bytes for this file,
+                "checked": if the transfer is only checked (skipped, deleted),
+                "timestamp": integer representing millisecond unix epoch,
+                "error": string description of the error (empty if successful),
+                "jobid": id of the job that this transfer belongs to
+            }
+        ]
+}
    
+
    core/version: Shows the current version of rclone and the go runtime.
    
+
    This shows the current version of go and the go runtime
    
+
+
    debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling.
    
+
    SetBlockProfileRate controls the fraction of goroutine blocking events that are reported in the blocking profile. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked.
    
+
    To include every blocking event in the profile, pass rate = 1. To turn off profiling entirely, pass rate <= 0.
    
+
    After calling this you can use this to see the blocking profile:
    
+
    go tool pprof http://localhost:5572/debug/pprof/block
    
+
    Parameters
    
+
+
    debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling.
    
+
    SetMutexProfileFraction controls the fraction of mutex contention events that are reported in the mutex profile. On average 1/rate events are reported. The previous rate is returned.
    
+
    To turn off profiling entirely, pass rate 0. To just read the current rate, pass rate < 0. (For n>1 the details of sampling may change.)
    
+
    Once this is set you can look use this to profile the mutex contention:
    
+
    go tool pprof http://localhost:5572/debug/pprof/mutex
    
+
    Parameters
    
+
+
    Results
    
+
+
    job/list: Lists the IDs of the running jobs
    
+
    Parameters - None
    
+
    Results
    
+
+
    job/status: Reads the status of the job ID
    
+
    Parameters
    
+
+
    Results
    
+
+
    job/stop: Stop the running job
    
+
    Parameters
    
+
+
    mount/listmounts: Show current mount points
    
+
    This shows currently mounted points, which can be used for performing an unmount
    
+
    This takes no parameters and returns
    
+
+
    Eg
    
+
    rclone rc mount/listmounts
    
+
    Authentication is required for this call.
    
+
    mount/mount: Create a new mount point
    
+
    rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.
    
+
    If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2
    
+
    This takes the following parameters
    
+
+
    Eg
    
+
    rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
+rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
+rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
    
+
    The vfsOpt are as described in options/get and can be seen in the the "vfs" section when running and the mountOpt can be seen in the "mount" section.
    
+
    rclone rc options/get
    
+
    Authentication is required for this call.
    
+
    mount/types: Show all possible mount types
    
+
    This shows all possible mount types and returns them as a list.
    
+
    This takes no parameters and returns
    
+
+
    The mount types are strings like "mount", "mount2", "cmount" and can be passed to mount/mount as the mountType parameter.
    
+
    Eg
    
+
    rclone rc mount/types
    
+
    Authentication is required for this call.
    
+
    mount/unmount: Unmount selected active mount
    
+
    rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.
    
+
    This takes the following parameters
    
+
+
    Eg
    
+
    rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
    
+
    Authentication is required for this call.
    
+
    mount/unmountall: Show current mount points
    
+
    This shows currently mounted points, which can be used for performing an unmount
    
+
    This takes no parameters and returns error if unmount does not succeed.
    
+
    Eg
    
+
    rclone rc mount/unmountall
    
+
    Authentication is required for this call.
    
+
    operations/about: Return the space used on the remote
    
+
    This takes the following parameters
    
+
+
    The result is as returned from rclone about --json
    
+
    See the about command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/cleanup: Remove trashed files in the remote or path
    
+
    This takes the following parameters
    
+
+
    See the cleanup command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/copyfile: Copy a file from source remote to destination remote
    
+
    This takes the following parameters
    
+
+
    Authentication is required for this call.
    
+
    operations/copyurl: Copy the URL to the object
    
+
    This takes the following parameters
    
+
+
    Authentication is required for this call.
    
+
    operations/delete: Remove files in the path
    
+
    This takes the following parameters
    
+
+
    See the delete command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/deletefile: Remove the single file pointed to
    
+
    This takes the following parameters
    
+
+
    See the deletefile command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/fsinfo: Return information about the remote
    
+
    This takes the following parameters
    
+
+
    This returns info about the remote passed in;
    
+
    {
+    // optional features and whether they are available or not
+    "Features": {
+        "About": true,
+        "BucketBased": false,
+        "CanHaveEmptyDirectories": true,
+        "CaseInsensitive": false,
+        "ChangeNotify": false,
+        "CleanUp": false,
+        "Copy": false,
+        "DirCacheFlush": false,
+        "DirMove": true,
+        "DuplicateFiles": false,
+        "GetTier": false,
+        "ListR": false,
+        "MergeDirs": false,
+        "Move": true,
+        "OpenWriterAt": true,
+        "PublicLink": false,
+        "Purge": true,
+        "PutStream": true,
+        "PutUnchecked": false,
+        "ReadMimeType": false,
+        "ServerSideAcrossConfigs": false,
+        "SetTier": false,
+        "SetWrapper": false,
+        "UnWrap": false,
+        "WrapFs": false,
+        "WriteMimeType": false
+    },
+    // Names of hashes available
+    "Hashes": [
+        "MD5",
+        "SHA-1",
+        "DropboxHash",
+        "QuickXorHash"
+    ],
+    "Name": "local",    // Name as created
+    "Precision": 1,     // Precision of timestamps in ns
+    "Root": "/",        // Path as created
+    "String": "Local file system at /" // how the remote will appear in logs
+}
    
+
    This command does not have a command line equivalent so use this instead:
    
+
    rclone rc --loopback operations/fsinfo fs=remote:
    
+
    operations/list: List the given remote and path in JSON format
    
+
    This takes the following parameters
    
+
+
    The result is
    
+
+
    See the lsjson command for more information on the above and examples.
    
+
    Authentication is required for this call.
    
+
    operations/mkdir: Make a destination directory or container
    
+
    This takes the following parameters
    
+
+
    See the mkdir command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/movefile: Move a file from source remote to destination remote
    
+
    This takes the following parameters
    
+
+
    Authentication is required for this call.
    
+
+
    This takes the following parameters
    
+
+
    Returns
    
+
+
    See the link command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/purge: Remove a directory or container and all of its contents
    
+
    This takes the following parameters
    
+
+
    See the purge command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/rmdir: Remove an empty directory or container
    
+
    This takes the following parameters
    
+
+
    See the rmdir command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/rmdirs: Remove all the empty directories in the path
    
+
    This takes the following parameters
    
+
+
    See the rmdirs command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/size: Count the number of bytes and files in remote
    
+
    This takes the following parameters
    
+
+
    Returns
    
+
+
    See the size command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/uploadfile: Upload file using multiform/form-data
    
+
    This takes the following parameters
    
+
+
    Authentication is required for this call.
    
+
    options/blocks: List all the option blocks
    
+
    Returns - options - a list of the options block names
    
+
    options/get: Get all the options
    
+
    Returns an object where keys are option block names and values are an object with the current option values in.
    
+
    This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions.
    
+
    options/set: Set an option
    
+
    Parameters
    
+
+
    Repeated as often as required.
    
+
    Only supply the options you wish to change. If an option is unknown it will be silently ignored. Not all options will have an effect when changed like this.
    
+
    For example:
    
+
    This sets DEBUG level logs (-vv)
    
+
    rclone rc options/set --json '{"main": {"LogLevel": 8}}'
    
+
    And this sets INFO level logs (-v)
    
+
    rclone rc options/set --json '{"main": {"LogLevel": 7}}'
    
+
    And this sets NOTICE level logs (normal without -v)
    
+
    rclone rc options/set --json '{"main": {"LogLevel": 6}}'
    
+
    pluginsctl/addPlugin: Add a plugin using url
    
+
    used for adding a plugin to the webgui
    
+
    This takes the following parameters
    
+
+
    Eg
    
+
    rclone rc pluginsctl/addPlugin
    
+
    Authentication is required for this call.
    
+
    pluginsctl/getPluginsForType: Get plugins with type criteria
    
+
    This shows all possible plugins by a mime type
    
+
    This takes the following parameters
    
+
+
    and returns
    
+
+
    Eg
    
+
    rclone rc pluginsctl/getPluginsForType type=video/mp4
    
+
    Authentication is required for this call.
    
+
    pluginsctl/listPlugins: Get the list of currently loaded plugins
    
+
    This allows you to get the currently enabled plugins and their details.
    
+
    This takes no parameters and returns
    
+
+
    Eg
    
+
    rclone rc pluginsctl/listPlugins
    
+
    Authentication is required for this call.
    
+
    pluginsctl/listTestPlugins: Show currently loaded test plugins
    
+
    allows listing of test plugins with the rclone.test set to true in package.json of the plugin
    
+
    This takes no parameters and returns
    
+
+
    Eg
    
+
    rclone rc pluginsctl/listTestPlugins
    
+
    Authentication is required for this call.
    
+
    pluginsctl/removePlugin: Remove a loaded plugin
    
+
    This allows you to remove a plugin using it's name
    
+
    This takes parameters
    
+
+
    Eg
    
+
    rclone rc pluginsctl/removePlugin name=rclone/video-plugin
    
+
    Authentication is required for this call.
    
+
    pluginsctl/removeTestPlugin: Remove a test plugin
    
+
    This allows you to remove a plugin using it's name
    
+
    This takes the following parameters
    
+
+
    Eg
    
+
    rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
    
+
    Authentication is required for this call.
    
+
    rc/error: This returns an error
    
+
    This returns an error with the input as part of its error string. Useful for testing error handling.
    
+
    rc/list: List all the registered remote control commands
    
+
    This lists all the registered remote control commands as a JSON map in the commands response.
    
+
    rc/noop: Echo the input to the output parameters
    
+
    This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly.
    
+
    rc/noopauth: Echo the input to the output parameters requiring auth
    
+
    This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly.
    
+
    Authentication is required for this call.
    
+
    sync/copy: copy a directory from source remote to destination remote
    
+
    This takes the following parameters
    
+
+
    See the copy command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    sync/move: move a directory from source remote to destination remote
    
+
    This takes the following parameters
    
+
+
    See the move command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    sync/sync: sync a directory from source remote to destination remote
    
+
    This takes the following parameters
    
+
+
    See the sync command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    vfs/forget: Forget files or directories in the directory cache.
    
+
    This forgets the paths in the directory cache causing them to be re-read from the remote when needed.
    
+
    If no paths are passed in then it will forget all the paths in the directory cache.
    
+
    rclone rc vfs/forget
    
+
    Otherwise pass files or dirs in as file=path or dir=path. Any parameter key starting with file will forget that file and any starting with dir will forget that dir, eg
    
+
    rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
    
+
    This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.
    
+
    vfs/list: List active VFSes.
    
+
    This lists the active VFSes.
    
+
    It returns a list under the key "vfses" where the values are the VFS names that could be passed to the other VFS commands in the "fs" parameter.
    
+
    vfs/poll-interval: Get the status or update the value of the poll-interval option.
    
+
    Without any parameter given this returns the current status of the poll-interval setting.
    
+
    When the interval=duration parameter is set, the poll-interval value is updated and the polling function is notified. Setting interval=0 disables poll-interval.
    
+
    rclone rc vfs/poll-interval interval=5m
    
+
    The timeout=duration parameter can be used to specify a time to wait for the current poll function to apply the new value. If timeout is less or equal 0, which is the default, wait indefinitely.
    
+
    The new poll-interval value will only be active when the timeout is not reached.
    
+
    If poll-interval is updated or disabled temporarily, some changes might not get picked up by the polling function, depending on the used remote.
    
+
    This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.
    
+
    vfs/refresh: Refresh the directory cache.
    
+
    This reads the directories for the specified paths and freshens the directory cache.
    
+
    If no paths are passed in then it will refresh the root directory.
    
+
    rclone rc vfs/refresh
    
+
    Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, eg
    
+
    rclone rc vfs/refresh dir=home/junk dir2=data/misc
    
+
    If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use --fast-list if enabled.
    
+
    This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.
    
+
    Accessing the remote control via HTTP
    
+
    Rclone implements a simple HTTP based protocol.
    
+
    Each endpoint takes an JSON object and returns a JSON object or an error. The JSON objects are essentially a map of string names to values.
    
+
    All calls must made using POST.
    
+
    The input objects can be supplied using URL parameters, POST parameters or by supplying "Content-Type: application/json" and a JSON blob in the body. There are examples of these below using curl.
    
+
    The response will be a JSON blob in the body of the response. This is formatted to be reasonably human readable.
    
+
    Error returns
    
+
    If an error occurs then there will be an HTTP error status (eg 500) and the body of the response will contain a JSON encoded error object, eg
    
+
    {
+    "error": "Expecting string value for key \"remote\" (was float64)",
+    "input": {
+        "fs": "/tmp",
+        "remote": 3
+    },
+    "status": 400
+    "path": "operations/rmdir",
+}
    
+
    The keys in the error response are - error - error string - input - the input parameters to the call - status - the HTTP status code - path - the path of the call
    
+
    CORS
    
+
    The sever implements basic CORS support and allows all origins for that. The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back.
    
+
    Using POST with URL parameters only
    
+
    curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'
    
+
    Response
    
+
    {
+    "potato": "1",
+    "sausage": "2"
+}
    
+
    Here is what an error response looks like:
    
+
    curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'
    
+
    {
+    "error": "arbitrary error on input map[potato:1 sausage:2]",
+    "input": {
+        "potato": "1",
+        "sausage": "2"
+    }
+}
    
+
    Note that curl doesn't return errors to the shell unless you use the -f option
    
+
    $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'
+curl: (22) The requested URL returned error: 400 Bad Request
+$ echo $?
+22
    
+
    Using POST with a form
    
+
    curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop
    
+
    Response
    
+
    {
+    "potato": "1",
+    "sausage": "2"
+}
    
+
    Note that you can combine these with URL parameters too with the POST parameters taking precedence.
    
+
    curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"
    
+
    Response
    
+
    {
+    "potato": "1",
+    "rutabaga": "3",
+    "sausage": "4"
+}
 
    
-
    { // optional features and whether they are available or not "Features": { "About": true, "BucketBased": false, "CanHaveEmptyDirectories": true, "CaseInsensitive": false, "ChangeNotify": false, "CleanUp": false, "Copy": false, "DirCacheFlush": false, "DirMove": true, "DuplicateFiles": false, "GetTier": false, "ListR": false, "MergeDirs": false, "Move": true, "OpenWriterAt": true, "PublicLink": false, "Purge": true, "PutStream": true, "PutUnchecked": false, "ReadMimeType": false, "ServerSideAcrossConfigs": false, "SetTier": false, "SetWrapper": false, "UnWrap": false, "WrapFs": false, "WriteMimeType": false }, // Names of hashes available "Hashes": [ "MD5", "SHA-1", "DropboxHash", "QuickXorHash" ], "Name": "local", // Name as created "Precision": 1, // Precision of timestamps in ns "Root": "/", // Path as created "String": "Local file system at /" // how the remote will appear in logs }
    
-
    
-This command does not have a command line equivalent so use this instead:
-
-    rclone rc --loopback operations/fsinfo fs=remote:
-
-### operations/list: List the given remote and path in JSON format {#operations-list}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- opt - a dictionary of options to control the listing (optional)
-    - recurse - If set recurse directories
-    - noModTime - If set return modification time
-    - showEncrypted -  If set show decrypted names
-    - showOrigIDs - If set show the IDs for each item if known
-    - showHash - If set return a dictionary of hashes
-
-The result is
-
-- list
-    - This is an array of objects as described in the lsjson command
-
-See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples.
-
-**Authentication is required for this call.**
-
-### operations/mkdir: Make a destination directory or container {#operations-mkdir}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/movefile: Move a file from source remote to destination remote {#operations-movefile}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:" for the source
-- srcRemote - a path within that remote eg "file.txt" for the source
-- dstFs - a remote name string eg "drive2:" for the destination
-- dstRemote - a path within that remote eg "file2.txt" for the destination
-
-**Authentication is required for this call.**
-
-### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- unlink - boolean - if set removes the link rather than adding it (optional)
-- expire - string - the expiry time of the link eg "1d" (optional)
-
-Returns
-
-- url - URL of the resource
-
-See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/purge: Remove a directory or container and all of its contents {#operations-purge}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/rmdir: Remove an empty directory or container {#operations-rmdir}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- leaveRoot - boolean, set to true not to delete the root
-
-See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/size: Count the number of bytes and files in remote {#operations-size}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:path/to/dir"
-
-Returns
-
-- count - number of files
-- bytes - number of bytes in those files
-
-See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- each part in body represents a file to be uploaded
-See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### options/blocks: List all the option blocks {#options-blocks}
-
-Returns
-- options - a list of the options block names
-
-### options/get: Get all the options {#options-get}
-
-Returns an object where keys are option block names and values are an
-object with the current option values in.
-
-This shows the internal names of the option within rclone which should
-map to the external options very easily with a few exceptions.
-
-### options/set: Set an option {#options-set}
-
-Parameters
-
-- option block name containing an object with
-  - key: value
-
-Repeated as often as required.
-
-Only supply the options you wish to change.  If an option is unknown
-it will be silently ignored.  Not all options will have an effect when
-changed like this.
-
-For example:
-
-This sets DEBUG level logs (-vv)
-
-    rclone rc options/set --json '{"main": {"LogLevel": 8}}'
-
-And this sets INFO level logs (-v)
-
-    rclone rc options/set --json '{"main": {"LogLevel": 7}}'
-
-And this sets NOTICE level logs (normal without -v)
-
-    rclone rc options/set --json '{"main": {"LogLevel": 6}}'
-
-### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl-addPlugin}
-
-used for adding a plugin to the webgui
-
-This takes the following parameters
-
-- url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react)
-
-Eg
-
-   rclone rc pluginsctl/addPlugin
-
-**Authentication is required for this call.**
-
-### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType}
-
-This shows all possible plugins by a mime type
-
-This takes the following parameters
-
-- type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3)
-- pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) 
-
-and returns
-
-- loadedPlugins: list of current production plugins
-- testPlugins: list of temporarily loaded development plugins, usually running on a different server.
-
-Eg
-
-   rclone rc pluginsctl/getPluginsForType type=video/mp4
-
-**Authentication is required for this call.**
-
-### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins}
-
-This allows you to get the currently enabled plugins and their details.
-
-This takes no parameters and returns
-
-- loadedPlugins: list of current production plugins
-- testPlugins: list of temporarily loaded development plugins, usually running on a different server.
-
-Eg
-
-   rclone rc pluginsctl/listPlugins
-
-**Authentication is required for this call.**
-
-### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins}
-
-allows listing of test plugins with the rclone.test set to true in package.json of the plugin
-
-This takes no parameters and returns
-
-- loadedTestPlugins: list of currently available test plugins
-
-Eg
-
-    rclone rc pluginsctl/listTestPlugins
-
-**Authentication is required for this call.**
-
-### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin}
-
-This allows you to remove a plugin using it's name
-
-This takes parameters
-
-- name: name of the plugin in the format <author>/<plugin_name>
-
-Eg
-
-   rclone rc pluginsctl/removePlugin name=rclone/video-plugin
-
-**Authentication is required for this call.**
-
-### pluginsctl/removeTestPlugin: Remove  a test plugin {#pluginsctl-removeTestPlugin}
-
-This allows you to remove a plugin using it's name
-
-This takes the following parameters
-
-- name: name of the plugin in the format <author>/<plugin_name>
-
-Eg
-
-    rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
-
-**Authentication is required for this call.**
-
-### rc/error: This returns an error {#rc-error}
-
-This returns an error with the input as part of its error string.
-Useful for testing error handling.
-
-### rc/list: List all the registered remote control commands {#rc-list}
-
-This lists all the registered remote control commands as a JSON map in
-the commands response.
-
-### rc/noop: Echo the input to the output parameters {#rc-noop}
-
-This echoes the input parameters to the output parameters for testing
-purposes.  It can be used to check that rclone is still alive and to
-check that parameter passing is working properly.
-
-### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth}
-
-This echoes the input parameters to the output parameters for testing
-purposes.  It can be used to check that rclone is still alive and to
-check that parameter passing is working properly.
-
-**Authentication is required for this call.**
-
-### sync/copy: copy a directory from source remote to destination remote {#sync-copy}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:src" for the source
-- dstFs - a remote name string eg "drive:dst" for the destination
-
-
-See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### sync/move: move a directory from source remote to destination remote {#sync-move}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:src" for the source
-- dstFs - a remote name string eg "drive:dst" for the destination
-- deleteEmptySrcDirs - delete empty src directories if set
-
-
-See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### sync/sync: sync a directory from source remote to destination remote {#sync-sync}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:src" for the source
-- dstFs - a remote name string eg "drive:dst" for the destination
-
-
-See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget}
-
-This forgets the paths in the directory cache causing them to be
-re-read from the remote when needed.
-
-If no paths are passed in then it will forget all the paths in the
-directory cache.
-
-    rclone rc vfs/forget
-
-Otherwise pass files or dirs in as file=path or dir=path.  Any
-parameter key starting with file will forget that file and any
-starting with dir will forget that dir, eg
-
-    rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
- 
-This command takes an "fs" parameter. If this parameter is not
-supplied and if there is only one VFS in use then that VFS will be
-used. If there is more than one VFS in use then the "fs" parameter
-must be supplied.
-
-### vfs/list: List active VFSes. {#vfs-list}
-
-This lists the active VFSes.
-
-It returns a list under the key "vfses" where the values are the VFS
-names that could be passed to the other VFS commands in the "fs"
-parameter.
-
-### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval}
-
-Without any parameter given this returns the current status of the
-poll-interval setting.
-
-When the interval=duration parameter is set, the poll-interval value
-is updated and the polling function is notified.
-Setting interval=0 disables poll-interval.
-
-    rclone rc vfs/poll-interval interval=5m
-
-The timeout=duration parameter can be used to specify a time to wait
-for the current poll function to apply the new value.
-If timeout is less or equal 0, which is the default, wait indefinitely.
-
-The new poll-interval value will only be active when the timeout is
-not reached.
-
-If poll-interval is updated or disabled temporarily, some changes
-might not get picked up by the polling function, depending on the
-used remote.
- 
-This command takes an "fs" parameter. If this parameter is not
-supplied and if there is only one VFS in use then that VFS will be
-used. If there is more than one VFS in use then the "fs" parameter
-must be supplied.
-
-### vfs/refresh: Refresh the directory cache. {#vfs-refresh}
-
-This reads the directories for the specified paths and freshens the
-directory cache.
-
-If no paths are passed in then it will refresh the root directory.
-
-    rclone rc vfs/refresh
-
-Otherwise pass directories in as dir=path. Any parameter key
-starting with dir will refresh that directory, eg
-
-    rclone rc vfs/refresh dir=home/junk dir2=data/misc
-
-If the parameter recursive=true is given the whole directory tree
-will get refreshed. This refresh will use --fast-list if enabled.
- 
-This command takes an "fs" parameter. If this parameter is not
-supplied and if there is only one VFS in use then that VFS will be
-used. If there is more than one VFS in use then the "fs" parameter
-must be supplied.
-
-
-
-## Accessing the remote control via HTTP
-
-Rclone implements a simple HTTP based protocol.
-
-Each endpoint takes an JSON object and returns a JSON object or an
-error.  The JSON objects are essentially a map of string names to
-values.
-
-All calls must made using POST.
-
-The input objects can be supplied using URL parameters, POST
-parameters or by supplying "Content-Type: application/json" and a JSON
-blob in the body.  There are examples of these below using `curl`.
-
-The response will be a JSON blob in the body of the response.  This is
-formatted to be reasonably human readable.
-
-### Error returns
-
-If an error occurs then there will be an HTTP error status (eg 500)
-and the body of the response will contain a JSON encoded error object,
-eg
-
    
-
    { "error": "Expecting string value for key "remote" (was float64)", "input": { "fs": "/tmp", "remote": 3 }, "status": 400 "path": "operations/rmdir", }
    
-
    
-The keys in the error response are
-- error - error string
-- input - the input parameters to the call
-- status - the HTTP status code
-- path - the path of the call
-
-### CORS
-
-The sever implements basic CORS support and allows all origins for that.
-The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back.
-
-### Using POST with URL parameters only
-
    
-
    curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'
    
-
    
-Response
-
    
-
    { "potato": "1", "sausage": "2" }
    
-
    
-Here is what an error response looks like:
-
    
-
    curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'
    
-
    
-
    { "error": "arbitrary error on input map[potato:1 sausage:2]", "input": { "potato": "1", "sausage": "2" } }
    
-
    
-Note that curl doesn't return errors to the shell unless you use the `-f` option
-
    
-
    $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' curl: (22) The requested URL returned error: 400 Bad Request $ echo $? 22
    
-
    
-### Using POST with a form
-
    
-
    curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop
    
-
    
-Response
-
    
-
    { "potato": "1", "sausage": "2" }
    
-
    
-Note that you can combine these with URL parameters too with the POST
-parameters taking precedence.
-
    
-
    curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"
    
-
    
-Response
-
    
-
    { "potato": "1", "rutabaga": "3", "sausage": "4" }
    
-
    
-### Using POST with a JSON blob
-
    
-
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop
    
-
    
-response
-
    
-
    { "password": "xyz", "username": "xyz" }
    
-
    
-This can be combined with URL parameters too if required.  The JSON
-blob takes precedence.
-
    
-
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4'
    
-
    
-
    { "potato": 2, "rutabaga": "3", "sausage": 1 }
    
-
    
-## Debugging rclone with pprof ##
-
-If you use the `--rc` flag this will also enable the use of the go
-profiling tools on the same port.
-
-To use these, first [install go](https://golang.org/doc/install).
-
-### Debugging memory use
-
-To profile rclone's memory use you can run:
-
-    go tool pprof -web http://localhost:5572/debug/pprof/heap
-
-This should open a page in your browser showing what is using what
-memory.
-
-You can also use the `-text` flag to produce a textual summary
-
    
-
    $ go tool pprof -text http://localhost:5572/debug/pprof/heap Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% 100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% net/http.(conn).readRequest 0 0% 100% 513kB 33.38% net/http.(conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main
    
-
    
-### Debugging go routine leaks
-
-Memory leaks are most often caused by go routine leaks keeping memory
-alive which should have been garbage collected.
-
-See all active go routines using
-
-    curl http://localhost:5572/debug/pprof/goroutine?debug=1
-
-Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.
-
-### Other profiles to look at
-
-You can see a summary of profiles available at http://localhost:5572/debug/pprof/
-
-Here is how to use some of them:
-
-- Memory: `go tool pprof http://localhost:5572/debug/pprof/heap`
-- Go routines: `curl http://localhost:5572/debug/pprof/goroutine?debug=1`
-- 30-second CPU profile: `go tool pprof http://localhost:5572/debug/pprof/profile`
-- 5-second execution trace: `wget http://localhost:5572/debug/pprof/trace?seconds=5`
-- Goroutine blocking profile
-    - Enable first with: `rclone rc debug/set-block-profile-rate rate=1` ([docs](#debug/set-block-profile-rate))
-    - `go tool pprof http://localhost:5572/debug/pprof/block`
-- Contended mutexes:
-    - Enable first with: `rclone rc debug/set-mutex-profile-fraction rate=1` ([docs](#debug/set-mutex-profile-fraction))
-    - `go tool pprof http://localhost:5572/debug/pprof/mutex`
-
-See the [net/http/pprof docs](https://golang.org/pkg/net/http/pprof/)
-for more info on how to use the profiling and for a general overview
-see [the Go team's blog post on profiling go programs](https://blog.golang.org/profiling-go-programs).
-
-The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234).
-
-# Overview of cloud storage systems #
-
-Each cloud storage system is slightly different.  Rclone attempts to
-provide a unified interface to them, but some underlying differences
-show through.
-
-## Features ##
-
-Here is an overview of the major features of each cloud storage system.
-
-| Name                         | Hash        | ModTime | Case Insensitive | Duplicate Files | MIME Type |
-| ---------------------------- |:-----------:|:-------:|:----------------:|:---------------:|:---------:|
-| 1Fichier                     | Whirlpool   | No      | No               | Yes             | R         |
-| Amazon Drive                 | MD5         | No      | Yes              | No              | R         |
-| Amazon S3                    | MD5         | Yes     | No               | No              | R/W       |
-| Backblaze B2                 | SHA1        | Yes     | No               | No              | R/W       |
-| Box                          | SHA1        | Yes     | Yes              | No              | -         |
-| Citrix ShareFile             | MD5         | Yes     | Yes              | No              | -         |
-| Dropbox                      | DBHASH †    | Yes     | Yes              | No              | -         |
-| FTP                          | -           | No      | No               | No              | -         |
-| Google Cloud Storage         | MD5         | Yes     | No               | No              | R/W       |
-| Google Drive                 | MD5         | Yes     | No               | Yes             | R/W       |
-| Google Photos                | -           | No      | No               | Yes             | R         |
-| HTTP                         | -           | No      | No               | No              | R         |
-| Hubic                        | MD5         | Yes     | No               | No              | R/W       |
-| Jottacloud                   | MD5         | Yes     | Yes              | No              | R/W       |
-| Koofr                        | MD5         | No      | Yes              | No              | -         |
-| Mail.ru Cloud                | Mailru ‡‡‡  | Yes     | Yes              | No              | -         |
-| Mega                         | -           | No      | No               | Yes             | -         |
-| Memory                       | MD5         | Yes     | No               | No              | -         |
-| Microsoft Azure Blob Storage | MD5         | Yes     | No               | No              | R/W       |
-| Microsoft OneDrive           | SHA1 ‡‡     | Yes     | Yes              | No              | R         |
-| OpenDrive                    | MD5         | Yes     | Yes              | Partial \*      | -         |
-| OpenStack Swift              | MD5         | Yes     | No               | No              | R/W       |
-| pCloud                       | MD5, SHA1   | Yes     | No               | No              | W         |
-| premiumize.me                | -           | No      | Yes              | No              | R         |
-| put.io                       | CRC-32      | Yes     | No               | Yes             | R         |
-| QingStor                     | MD5         | No      | No               | No              | R/W       |
-| Seafile                      | -           | No      | No               | No              | -         |
-| SFTP                         | MD5, SHA1 ‡ | Yes     | Depends          | No              | -         |
-| SugarSync                    | -           | No      | No               | No              | -         |
-| Tardigrade                   | -           | Yes     | No               | No              | -         |
-| WebDAV                       | MD5, SHA1 ††| Yes ††† | Depends          | No              | -         |
-| Yandex Disk                  | MD5         | Yes     | No               | No              | R/W       |
-| The local filesystem         | All         | Yes     | Depends          | No              | -         |
-
-### Hash ###
-
-The cloud storage system supports various hash types of the objects.
-The hashes are used when transferring data as an integrity check and
-can be specifically used with the `--checksum` flag in syncs and in
-the `check` command.
-
-To use the verify checksums when transferring between cloud storage
-systems they must support a common hash type.
-
-† Note that Dropbox supports [its own custom
-hash](https://www.dropbox.com/developers/reference/content-hash).
-This is an SHA256 sum of all the 4MB block SHA256s.
-
-‡ SFTP supports checksums if the same login has shell access and `md5sum`
-or `sha1sum` as well as `echo` are in the remote's PATH.
-
-†† WebDAV supports hashes when used with Owncloud and Nextcloud only.
-
-††† WebDAV supports modtimes when used with Owncloud and Nextcloud only.
-
-‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive
-for business and SharePoint server support Microsoft's own
-[QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash).
-
-‡‡‡ Mail.ru uses its own modified SHA1 hash
-
-### ModTime ###
-
-The cloud storage system supports setting modification times on
-objects.  If it does then this enables a using the modification times
-as part of the sync.  If not then only the size will be checked by
-default, though the MD5SUM can be checked with the `--checksum` flag.
-
-All cloud storage systems support some kind of date on the object and
-these will be set when transferring from the cloud storage system.
-
-### Case Insensitive ###
-
-If a cloud storage systems is case sensitive then it is possible to
-have two files which differ only in case, eg `file.txt` and
-`FILE.txt`.  If a cloud storage system is case insensitive then that
-isn't possible.
-
-This can cause problems when syncing between a case insensitive
-system and a case sensitive system.  The symptom of this is that no
-matter how many times you run the sync it never completes fully.
-
-The local filesystem and SFTP may or may not be case sensitive
-depending on OS.
-
-  * Windows - usually case insensitive, though case is preserved
-  * OSX - usually case insensitive, though it is possible to format case sensitive
-  * Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys)
-
-Most of the time this doesn't cause any problems as people tend to
-avoid files whose name differs only by case even on case sensitive
-systems.
-
-### Duplicate files ###
-
-If a cloud storage system allows duplicate files then it can have two
-objects with the same name.
-
-This confuses rclone greatly when syncing - use the `rclone dedupe`
-command to rename or remove duplicates.
-
-\* Opendrive does not support creation of duplicate files using
-their web client interface or other stock clients, but the underlying
-storage platform has been determined to allow duplicate files, and it
-is possible to create them with `rclone`.  It may be that this is a
-mistake or an unsupported feature.
-
-### Restricted filenames ###
-
-Some cloud storage systems might have restrictions on the characters
-that are usable in file or directory names.
-When `rclone` detects such a name during a file upload, it will
-transparently replace the restricted characters with similar looking
-Unicode characters.
-
-This process is designed to avoid ambiguous file names as much as
-possible and allow to move files between many cloud storage systems
-transparently.
-
-The name shown by `rclone` to the user or during log output will only
-contain a minimal set of [replaced characters](#restricted-characters)
-to ensure correct formatting and not necessarily the actual name used
-on the cloud storage.
-
-This transformation is reversed when downloading a file or parsing
-`rclone` arguments.
-For example, when uploading a file named `my file?.txt` to Onedrive
-will be displayed as `my file?.txt` on the console, but stored as
-`my file？.txt` (the `?` gets replaced by the similar looking `？`
-character) to Onedrive.
-The reverse transformation allows to read a file`unusual/name.txt`
-from Google Drive, by passing the name `unusual／name.txt` (the `/` needs
-to be replaced by the similar looking `／` character) on the command line.
-
-#### Default restricted characters {#restricted-characters}
-
-The table below shows the characters that are replaced by default.
-
-When a replacement character is found in a filename, this character
-will be escaped with the `‛` character to avoid ambiguous file names.
-(e.g. a file named `␀.txt` would shown as `‛␀.txt`)
-
-Each cloud storage backend can use a different set of characters,
-which will be specified in the documentation for each backend.
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| SOH       | 0x01  | ␁           |
-| STX       | 0x02  | ␂           |
-| ETX       | 0x03  | ␃           |
-| EOT       | 0x04  | ␄           |
-| ENQ       | 0x05  | ␅           |
-| ACK       | 0x06  | ␆           |
-| BEL       | 0x07  | ␇           |
-| BS        | 0x08  | ␈           |
-| HT        | 0x09  | ␉           |
-| LF        | 0x0A  | ␊           |
-| VT        | 0x0B  | ␋           |
-| FF        | 0x0C  | ␌           |
-| CR        | 0x0D  | ␍           |
-| SO        | 0x0E  | ␎           |
-| SI        | 0x0F  | ␏           |
-| DLE       | 0x10  | ␐           |
-| DC1       | 0x11  | ␑           |
-| DC2       | 0x12  | ␒           |
-| DC3       | 0x13  | ␓           |
-| DC4       | 0x14  | ␔           |
-| NAK       | 0x15  | ␕           |
-| SYN       | 0x16  | ␖           |
-| ETB       | 0x17  | ␗           |
-| CAN       | 0x18  | ␘           |
-| EM        | 0x19  | ␙           |
-| SUB       | 0x1A  | ␚           |
-| ESC       | 0x1B  | ␛           |
-| FS        | 0x1C  | ␜           |
-| GS        | 0x1D  | ␝           |
-| RS        | 0x1E  | ␞           |
-| US        | 0x1F  | ␟           |
-| /         | 0x2F  | ／           |
-| DEL       | 0x7F  | ␡           |
-
-The default encoding will also encode these file names as they are
-problematic with many cloud storage systems.
-
-| File name | Replacement |
-| --------- |:-----------:|
-| .         | ．          |
-| ..        | ．．         |
-
-#### Invalid UTF-8 bytes {#invalid-utf8}
-
-Some backends only support a sequence of well formed UTF-8 bytes
-as file or directory names.
-
-In this case all invalid UTF-8 bytes will be replaced with a quoted
-representation of the byte value to allow uploading a file to such a
-backend. For example, the invalid byte `0xFE` will be encoded as `‛FE`.
-
-A common source of invalid UTF-8 bytes are local filesystems, that store
-names in a different encoding than UTF-8 or UTF-16, like latin1. See the
-[local filenames](https://rclone.org/local/#filenames) section for details.
-
-#### Encoding option {#encoding}
-
-Most backends have an encoding options, specified as a flag
-`--backend-encoding` where `backend` is the name of the backend, or as
-a config parameter `encoding` (you'll need to select the Advanced
-config in `rclone config` to see it).
-
-This will have default value which encodes and decodes characters in
-such a way as to preserve the maximum number of characters (see
-above).
-
-However this can be incorrect in some scenarios, for example if you
-have a Windows file system with characters such as `＊` and `？` that
-you want to remain as those characters on the remote rather than being
-translated to `*` and `?`.
-
-The `--backend-encoding` flags allow you to change that. You can
-disable the encoding completely with `--backend-encoding None` or set
-`encoding = None` in the config file.
-
-Encoding takes a comma separated list of encodings. You can see the
-list of all available characters by passing an invalid value to this
-flag, eg `--local-encoding "help"` and `rclone help flags encoding`
-will show you the defaults for the backends.
-
-| Encoding  | Characters |
-| --------- | ---------- |
-| Asterisk | `*` |
-| BackQuote | `` ` `` |
-| BackSlash | `\` |
-| Colon | `:` |
-| CrLf | CR 0x0D, LF 0x0A |
-| Ctl | All control characters 0x00-0x1F |
-| Del | DEL 0x7F |
-| Dollar | `$` |
-| Dot | `.` |
-| DoubleQuote | `"` |
-| Hash | `#` |
-| InvalidUtf8 | An invalid UTF-8 character (eg latin1) |
-| LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string |
-| LeftPeriod | `.` on the left of a string |
-| LeftSpace | SPACE on the left of a string |
-| LeftTilde | `~` on the left of a string |
-| LtGt | `<`, `>` |
-| None | No characters are encoded |
-| Percent | `%` |
-| Pipe | \| |
-| Question | `?` |
-| RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string |
-| RightPeriod | `.` on the right of a string |
-| RightSpace | SPACE on the right of a string |
-| SingleQuote | `'` |
-| Slash | `/` |
-
-To take a specific example, the FTP backend's default encoding is
-
-    --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot"
-
-However, let's say the FTP server is running on Windows and can't have
-any of the invalid Windows characters in file names. You are backing
-up Linux servers to this FTP server which do have those characters in
-file names. So you would add the Windows set which are
-
-    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
-
-to the existing ones, giving:
-
-    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace
-
-This can be specified using the `--ftp-encoding` flag or using an `encoding` parameter in the config file.
-
-Or let's say you have a Windows server but you want to preserve `＊`
-and `？`, you would then have this as the encoding (the Windows
-encoding minus `Asterisk` and `Question`).
-
-    Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
-
-This can be specified using the `--local-encoding` flag or using an
-`encoding` parameter in the config file.
-
-### MIME Type ###
-
-MIME types (also known as media types) classify types of documents
-using a simple text classification, eg `text/html` or
-`application/pdf`.
-
-Some cloud storage systems support reading (`R`) the MIME type of
-objects and some support writing (`W`) the MIME type of objects.
-
-The MIME type can be important if you are serving files directly to
-HTTP from the storage system.
-
-If you are copying from a remote which supports reading (`R`) to a
-remote which supports writing (`W`) then rclone will preserve the MIME
-types.  Otherwise they will be guessed from the extension, or the
-remote itself may assign the MIME type.
-
-## Optional Features ##
-
-All the remotes support a basic set of features, but there are some
-optional features supported by some remotes used to make some
-operations more efficient.
-
-| Name                         | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir |
-| ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| :------: |
-| 1Fichier                     | No    | No   | No   | No      | No      | No    | No           | No           |   No  |  Yes |
-| Amazon Drive                 | Yes   | No   | Yes  | Yes     | No [#575](https://github.com/rclone/rclone/issues/575) | No  | No  | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | Yes |
-| Amazon S3                    | No    | Yes  | No   | No      | Yes     | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Backblaze B2                 | No    | Yes  | No   | No      | Yes     | Yes   | Yes          | Yes          | No  | No |
-| Box                          | Yes   | Yes  | Yes  | Yes     | Yes ‡‡  | No    | Yes          | Yes          | No  | Yes |
-| Citrix ShareFile             | Yes   | Yes  | Yes  | Yes     | No      | No    | Yes          | No          | No  | Yes |
-| Dropbox                      | Yes   | Yes  | Yes  | Yes     | No [#575](https://github.com/rclone/rclone/issues/575) | No  | Yes | Yes | Yes | Yes |
-| FTP                          | No    | No   | Yes  | Yes     | No      | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | Yes |
-| Google Cloud Storage         | Yes   | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Google Drive                 | Yes   | Yes  | Yes  | Yes     | Yes     | Yes   | Yes          | Yes         | Yes | Yes |
-| Google Photos                | No    | No   | No   | No      | No      | No    | No           | No          | No | No |
-| HTTP                         | No    | No   | No   | No      | No      | No    | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | Yes |
-| Hubic                        | Yes † | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No |
-| Jottacloud                   | Yes   | Yes  | Yes  | Yes     | Yes     | Yes   | No           | Yes                                                   | Yes | Yes |
-| Mail.ru Cloud                | Yes   | Yes  | Yes  | Yes     | Yes     | No    | No           | Yes                                                   | Yes | Yes |
-| Mega                         | Yes   | No   | Yes  | Yes     | Yes     | No    | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes |
-| Memory                       | No    | Yes  | No   | No      | No      | Yes   | Yes          | No          | No | No |
-| Microsoft Azure Blob Storage | Yes   | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Microsoft OneDrive           | Yes   | Yes  | Yes  | Yes     | Yes     | No    | No           | Yes | Yes | Yes |
-| OpenDrive                    | Yes   | Yes  | Yes  | Yes     | No      | No    | No           | No                                                    | No  | Yes |
-| OpenStack Swift              | Yes † | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No |
-| pCloud                       | Yes   | Yes  | Yes  | Yes     | Yes     | No    | No           | Yes | Yes | Yes |
-| premiumize.me                | Yes   | No   | Yes  | Yes     | No      | No    | No           | Yes         | Yes | Yes |
-| put.io                       | Yes   | No   | Yes  | Yes     | Yes     | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes |
-| QingStor                     | No    | Yes  | No   | No      | Yes     | Yes   | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Seafile                      | Yes   | Yes  | Yes  | Yes     | Yes     | Yes   | Yes          | Yes         | Yes | Yes |
-| SFTP                         | No    | No   | Yes  | Yes     | No      | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes  | Yes |
-| SugarSync                    | Yes   | Yes  | Yes  | Yes     | No      | No    | Yes          | Yes         | No  | Yes |
-| Tardigrade                   | Yes † | No   | No   | No      | No      | Yes   | Yes          | No          | No  | No  |
-| WebDAV                       | Yes   | Yes  | Yes  | Yes     | No      | No    | Yes ‡        | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes  | Yes |
-| Yandex Disk                  | Yes   | Yes  | Yes  | Yes     | Yes     | No    | Yes          | Yes         | Yes | Yes |
-| The local filesystem         | Yes   | No   | Yes  | Yes     | No      | No    | Yes          | No          | Yes | Yes |
-
-### Purge ###
-
-This deletes a directory quicker than just deleting all the files in
-the directory.
-
-† Note Swift, Hubic, and Tardigrade implement this in order to delete
-directory markers but they don't actually have a quicker way of deleting
-files other than deleting them individually.
-
-‡ StreamUpload is not supported with Nextcloud
-
-### Copy ###
-
-Used when copying an object to and from the same remote.  This known
-as a server side copy so you can copy a file without downloading it
-and uploading it again.  It is used if you use `rclone copy` or
-`rclone move` if the remote doesn't support `Move` directly.
-
-If the server doesn't support `Copy` directly then for copy operations
-the file is downloaded then re-uploaded.
-
-### Move ###
-
-Used when moving/renaming an object on the same remote.  This is known
-as a server side move of a file.  This is used in `rclone move` if the
-server doesn't support `DirMove`.
-
-If the server isn't capable of `Move` then rclone simulates it with
-`Copy` then delete.  If the server doesn't support `Copy` then rclone
-will download the file and re-upload it.
-
-### DirMove ###
-
-This is used to implement `rclone move` to move a directory if
-possible.  If it isn't then it will use `Move` on each file (which
-falls back to `Copy` then download and upload - see `Move` section).
-
-### CleanUp ###
-
-This is used for emptying the trash for a remote by `rclone cleanup`.
-
-If the server can't do `CleanUp` then `rclone cleanup` will return an
-error.
-
-‡‡ Note that while Box implements this it has to delete every file
-idividually so it will be slower than emptying the trash via the WebUI
-
-### ListR ###
-
-The remote supports a recursive list to list all the contents beneath
-a directory quickly.  This enables the `--fast-list` flag to work.
-See the [rclone docs](https://rclone.org/docs/#fast-list) for more details.
-
-### StreamUpload ###
-
-Some remotes allow files to be uploaded without knowing the file size
-in advance. This allows certain operations to work without spooling the
-file to local disk first, e.g. `rclone rcat`.
-
-### LinkSharing ###
-
-Sets the necessary permissions on a file or folder and prints a link
-that allows others to access them, even if they don't have an account
-on the particular cloud provider.
-
-### About ###
-
-This is used to fetch quota information from the remote, like bytes
-used/free/quota and bytes used in the trash.
-
-This is also used to return the space used, available for `rclone mount`.
-
-If the server can't do `About` then `rclone about` will return an
-error.
-
-### EmptyDir ###
-
-The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations)
- for details. Most Object/Bucket based remotes do not support this.
-
-# Global Flags
-
-This describes the global flags available to every rclone command
-split into two groups, non backend and backend flags.
-
-## Non Backend Flags
-
-These flags are available for every command.
-
    
-
      --ask-password                         Allow prompt for password for encrypted configuration. (default true)
-  --auto-confirm                         If enabled, do not request console confirmation.
-  --backup-dir string                    Make backups into hierarchy based in DIR.
-  --bind string                          Local address to bind to for outgoing connections, IPv4, IPv6 or name.
-  --buffer-size SizeSuffix               In memory buffer size when reading files for each --transfer. (default 16M)
-  --bwlimit BwTimetable                  Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
-  --bwlimit-file BwTimetable             Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable.
-  --ca-cert string                       CA certificate used to verify servers
-  --cache-dir string                     Directory rclone will use for caching. (default "$HOME/.cache/rclone")
-  --check-first                          Do all the checks before starting transfers.
-  --checkers int                         Number of checkers to run in parallel. (default 8)
    
-
    -c, --checksum Skip based on checksum (if available) & size, not mod-time & size --client-cert string Client SSL certificate (PEM) for mutual TLS auth --client-key string Client SSL private key (PEM) for mutual TLS auth --compare-dest string Include additional server-side path during comparison. --config string Config file. (default "$HOME/.config/rclone/rclone.conf") --contimeout duration Connect timeout (default 1m0s) --copy-dest string Implies --compare-dest but also copies files from path into destination. --cpuprofile string Write cpu profile to file --cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring --delete-during When synchronizing, delete files during transfer --delete-excluded Delete files on dest excluded from sync --disable string Disable a comma separated list of features. Use help to see a list. -n, --dry-run Do a trial run with no permanent changes --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles --dump-bodies Dump HTTP headers and bodies - may contain sensitive info --dump-headers Dump HTTP headers - may contain sensitive info --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read exclude patterns from file (use - to read from stdin) --exclude-if-present string Exclude directories if filename is present --expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s) --fast-list Use recursive list if available. Uses more memory but fewer transactions. --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) -f, --filter stringArray Add a file-filtering rule --filter-from stringArray Read filtering patterns from a file (use - to read from stdin) --header stringArray Set HTTP header for all transactions --header-download stringArray Set HTTP header for download transactions --header-upload stringArray Set HTTP header for upload transactions --ignore-case Ignore case in filters (case insensitive) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums. --ignore-errors delete even if there are I/O errors --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use mod-time or checksum. -I, --ignore-times Don't skip files that match size and time - transfer all files --immutable Do not modify files. Fail if existing files have been modified. --include stringArray Include files matching pattern --include-from stringArray Read include patterns from file (use - to read from stdin) -i, --interactive Enable interactive mode --log-file string Log everything to this file --log-format string Comma separated list of log format options (default "date,time") --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") --low-level-retries int Number of low level retries to do. (default 10) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) --max-delete int When synchronizing, limit the number of deletes (default -1) --max-depth int If set limits the recursion depth to this. (default -1) --max-duration duration Maximum duration rclone will transfer data for. --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) --max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) --max-transfer SizeSuffix Maximum size of data to transfer. (default off) --memprofile string Write memory profile to file --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) --modify-window duration Max time diff to be considered the same (default 1ns) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) --no-check-certificate Do not verify the server SSL certificate. Insecure. --no-check-dest Don't check the destination, copy regardless. --no-gzip-encoding Don't set Accept-Encoding: gzip. --no-traverse Don't traverse destination file system on copy. --no-unicode-normalization Don't normalize unicode characters in filenames. --no-update-modtime Don't update destination mod-time if files identical. --order-by string Instructions on how to order the transfers, eg 'size,descending' --password-command SpaceSepList Command for supplying password for encrypted configuration. -P, --progress Show progress during transfer. -q, --quiet Print as little stuff as possible --rc Enable the remote control server. --rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572") --rc-allow-origin string Set the allowed origin for CORS. --rc-baseurl string Prefix for URLs - leave blank for root. --rc-cert string SSL PEM key (concatenation of certificate and CA certificate) --rc-client-ca string Client certificate authority to verify clients with --rc-enable-metrics Enable prometheus metrics on /metrics --rc-files string Path to local files to serve on the HTTP server. --rc-htpasswd string htpasswd file - if not provided no authentication is done --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) --rc-key string SSL PEM Private key --rc-max-header-bytes int Maximum size of request header (default 4096) --rc-no-auth Don't require auth for certain methods. --rc-pass string Password for authentication. --rc-realm string realm for authentication (default "rclone") --rc-serve Enable the serving of remote objects. --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) --rc-template string User Specified Template. --rc-user string User name for authentication. --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") --rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force update to latest version of web gui --rc-web-gui-no-open-browser Don't open the browser automatically --rc-web-gui-update Check and update to latest version of web gui --refresh-times Refresh the modtime of remote files. --retries int Retry operations this many times if they fail (default 3) --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) --size-only Skip based on size only, not mod-time or checksum --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") --stats-one-line Make the stats fit on one line. --stats-one-line-date Enables --stats-one-line and add current date/time prefix. --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) --suffix string Suffix to add to changed files. --suffix-keep-extension Preserve the extension when using --suffix. --syslog Use Syslog for logging --syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON") --timeout duration IO idle timeout (default 5m0s) --tpslimit float Limit HTTP transactions per second to this. --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) --track-renames When synchronizing, track file renames and do a server side move if possible --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") --transfers int Number of file transfers to run in parallel. (default 4) -u, --update Skip files that are newer on the destination. --use-cookies Enable session cookiejar. --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.0") -v, --verbose count Print lots more stuff (repeat for more)
    
-
    
-## Backend Flags
-
-These flags are available for every command. They control the backends
-and may be set in the config file.
-
    
-
      --acd-auth-url string                                      Auth server URL.
-  --acd-client-id string                                     OAuth Client Id
-  --acd-client-secret string                                 OAuth Client Secret
-  --acd-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
-  --acd-templink-threshold SizeSuffix                        Files >= this size will be downloaded via their tempLink. (default 9G)
-  --acd-token string                                         OAuth Access Token as a JSON blob.
-  --acd-token-url string                                     Token server url.
-  --acd-upload-wait-per-gb Duration                          Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
-  --alias-remote string                                      Remote or path to alias.
-  --azureblob-access-tier string                             Access tier of blob: hot, cool or archive.
-  --azureblob-account string                                 Storage Account Name (leave blank to use SAS URL or Emulator)
-  --azureblob-chunk-size SizeSuffix                          Upload chunk size (<= 100MB). (default 4M)
-  --azureblob-disable-checksum                               Don't store MD5 checksum with object metadata.
-  --azureblob-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
-  --azureblob-endpoint string                                Endpoint for the service
-  --azureblob-key string                                     Storage Account Key (leave blank to use SAS URL or Emulator)
-  --azureblob-list-chunk int                                 Size of blob list. (default 5000)
-  --azureblob-memory-pool-flush-time Duration                How often internal memory buffer pools will be flushed. (default 1m0s)
-  --azureblob-memory-pool-use-mmap                           Whether to use mmap buffers in internal memory pool.
-  --azureblob-sas-url string                                 SAS URL for container level access only
-  --azureblob-upload-cutoff SizeSuffix                       Cutoff for switching to chunked upload (<= 256MB). (default 256M)
-  --azureblob-use-emulator                                   Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)
-  --b2-account string                                        Account ID or Application Key ID
-  --b2-chunk-size SizeSuffix                                 Upload chunk size. Must fit in memory. (default 96M)
-  --b2-copy-cutoff SizeSuffix                                Cutoff for switching to multipart copy (default 4G)
-  --b2-disable-checksum                                      Disable checksums for large (> upload cutoff) files
-  --b2-download-auth-duration Duration                       Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w)
-  --b2-download-url string                                   Custom endpoint for downloads.
-  --b2-encoding MultiEncoder                                 This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
-  --b2-endpoint string                                       Endpoint for the service.
-  --b2-hard-delete                                           Permanently delete files on remote removal, otherwise hide files.
-  --b2-key string                                            Application Key
-  --b2-memory-pool-flush-time Duration                       How often internal memory buffer pools will be flushed. (default 1m0s)
-  --b2-memory-pool-use-mmap                                  Whether to use mmap buffers in internal memory pool.
-  --b2-test-mode string                                      A flag string for X-Bz-Test-Mode header for debugging.
-  --b2-upload-cutoff SizeSuffix                              Cutoff for switching to chunked upload. (default 200M)
-  --b2-versions                                              Include old versions in directory listings.
-  --box-access-token string                                  Box App Primary Access Token
-  --box-auth-url string                                      Auth server URL.
-  --box-box-config-file string                               Box App config.json location
-  --box-box-sub-type string                                   (default "user")
-  --box-client-id string                                     OAuth Client Id
-  --box-client-secret string                                 OAuth Client Secret
-  --box-commit-retries int                                   Max number of times to try committing a multipart file. (default 100)
-  --box-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
-  --box-root-folder-id string                                Fill in for rclone to use a non root folder as its starting point.
-  --box-token string                                         OAuth Access Token as a JSON blob.
-  --box-token-url string                                     Token server url.
-  --box-upload-cutoff SizeSuffix                             Cutoff for switching to multipart upload (>= 50MB). (default 50M)
-  --cache-chunk-clean-interval Duration                      How often should the cache perform cleanups of the chunk storage. (default 1m0s)
-  --cache-chunk-no-memory                                    Disable the in-memory cache for storing chunks during streaming.
-  --cache-chunk-path string                                  Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend")
-  --cache-chunk-size SizeSuffix                              The size of a chunk (partial file data). (default 5M)
-  --cache-chunk-total-size SizeSuffix                        The total size that the chunks can take up on the local disk. (default 10G)
-  --cache-db-path string                                     Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend")
-  --cache-db-purge                                           Clear all the cached data for this remote on start.
-  --cache-db-wait-time Duration                              How long to wait for the DB to be available - 0 is unlimited (default 1s)
-  --cache-info-age Duration                                  How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
-  --cache-plex-insecure string                               Skip all certificate verification when connecting to the Plex server
-  --cache-plex-password string                               The password of the Plex user (obscured)
-  --cache-plex-url string                                    The URL of the Plex server
-  --cache-plex-username string                               The username of the Plex user
-  --cache-read-retries int                                   How many times to retry a read from a cache storage. (default 10)
-  --cache-remote string                                      Remote to cache.
-  --cache-rps int                                            Limits the number of requests per second to the source FS (-1 to disable) (default -1)
-  --cache-tmp-upload-path string                             Directory to keep temporary files until they are uploaded.
-  --cache-tmp-wait-time Duration                             How long should files be stored in local cache before being uploaded (default 15s)
-  --cache-workers int                                        How many workers should run in parallel to download chunks. (default 4)
-  --cache-writes                                             Cache file data on writes through the FS
-  --chunker-chunk-size SizeSuffix                            Files larger than chunk size will be split in chunks. (default 2G)
-  --chunker-fail-hard                                        Choose how chunker should handle files with missing or invalid chunks.
-  --chunker-hash-type string                                 Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5")
-  --chunker-meta-format string                               Format of the metadata object or "none". By default "simplejson". (default "simplejson")
-  --chunker-name-format string                               String format of chunk file names. (default "*.rclone_chunk.###")
-  --chunker-remote string                                    Remote to chunk/unchunk.
-  --chunker-start-from int                                   Minimum valid chunk number. Usually 0 or 1. (default 1)
    
--L, --copy-links Follow symlinks and copy the pointed to item. --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) --crypt-filename-encryption string How to encrypt the filenames. (default "standard") --crypt-password string Password or pass phrase for encryption. (obscured) --crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) --crypt-remote string Remote to encrypt/decrypt. --crypt-server-side-across-configs Allow server side operations (eg copy) to work across different crypt configs. --crypt-show-mapping For all files listed show how the names encrypt. --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. --drive-auth-owner-only Only consider files owned by the authenticated user. --drive-auth-url string Auth server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) --drive-client-id string OAuth Client Id --drive-client-secret string OAuth Client Secret --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") --drive-formats string Deprecated: see export_formats --drive-impersonate string Impersonate this user when using a service account. --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. --drive-keep-revision-forever Keep new head revision of each file forever. --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) --drive-root-folder-id string ID of the root folder --drive-scope string Scope that rclone should use when requesting access from drive. --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. --drive-service-account-credentials string Service Account Credentials JSON blob --drive-service-account-file string Service Account Credentials JSON file path --drive-shared-with-me Only show files that are shared with me. --drive-size-as-quota Show sizes as storage quota usage, not actual size. --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. --drive-skip-gdocs Skip google documents in all listings. --drive-skip-shortcuts If set skip shortcut files --drive-starred-only Only show files that are starred. --drive-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Team Drive --drive-token string OAuth Access Token as a JSON blob. --drive-token-url string Token server url. --drive-trashed-only Only show files that are in the trash. --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) --drive-use-created-date Use file created date instead of modified date., --drive-use-shared-date Use date file was shared instead of modified date. --drive-use-trash Send files to the trash instead of deleting permanently. (default true) --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) --dropbox-auth-url string Auth server URL. --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) --dropbox-client-id string OAuth Client Id --dropbox-client-secret string OAuth Client Secret --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-impersonate string Impersonate this user when using a business account. --dropbox-token string OAuth Access Token as a JSON blob. --dropbox-token-url string Token server url. --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) --fichier-shared-folder string If you want to download a shared folder, add this parameter --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited --ftp-disable-epsv Disable using EPSV even if server advertises support --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) --ftp-explicit-tls Use FTP over TLS (Explicit) --ftp-host string FTP host to connect to --ftp-no-check-certificate Do not verify the TLS certificate of the server --ftp-pass string FTP password (obscured) --ftp-port string FTP port, leave blank to use default (21) --ftp-tls Use FTPS over TLS (Implicit) --ftp-user string FTP username, leave blank for current username, $USER --gcs-anonymous Access public buckets and objects without credentials --gcs-auth-url string Auth server URL. --gcs-bucket-acl string Access Control List for new buckets. --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. --gcs-client-id string OAuth Client Id --gcs-client-secret string OAuth Client Secret --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) --gcs-location string Location for the newly created buckets. --gcs-object-acl string Access Control List for new objects. --gcs-project-number string Project number. --gcs-service-account-file string Service Account Credentials JSON file path --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. --gcs-token string OAuth Access Token as a JSON blob. --gcs-token-url string Token server url. --gphotos-auth-url string Auth server URL. --gphotos-client-id string OAuth Client Id --gphotos-client-secret string OAuth Client Secret --gphotos-read-only Set to make the Google Photos backend read only. --gphotos-read-size Set to read the size of media items. --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) --gphotos-token string OAuth Access Token as a JSON blob. --gphotos-token-url string Token server url. --http-headers CommaSepList Set HTTP headers for all transactions --http-no-head Don't use HEAD requests to find file sizes in dir listing --http-no-slash Set this if the site doesn't end directories with / --http-url string URL of http host to connect to --hubic-auth-url string Auth server URL. --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --hubic-client-id string OAuth Client Id --hubic-client-secret string OAuth Client Secret --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) --hubic-no-chunk Don't chunk files during streaming upload. --hubic-token string OAuth Access Token as a JSON blob. --hubic-token-url string Token server url. --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) --jottacloud-trashed-only Only show files that are in the trash. --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) --koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net") --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) --koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) --koofr-user string Your Koofr user name -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --local-case-insensitive Force the filesystem to report itself as case insensitive --local-case-sensitive Force the filesystem to report itself as case sensitive. --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) --local-no-check-updated Don't check to see if the files change during upload --local-no-set-modtime Disable setting modtime --local-no-sparse Disable sparse files for multi-thread downloads --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) --local-nounc string Disable UNC (long path names) conversion on Windows --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) --mailru-pass string Password (obscured) --mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true) --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default ".mkv,.avi,.mp4,.mp3,.zip,.gz,.rar,.pdf") --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) --mailru-user string User name (usually email) --mega-debug Output more debug from Mega. --mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) --mega-hard-delete Delete files permanently rather than putting them into the trash. --mega-pass string Password. (obscured) --mega-user string User name -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). --onedrive-auth-url string Auth server URL. --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) --onedrive-client-id string OAuth Client Id --onedrive-client-secret string OAuth Client Secret --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. --onedrive-no-versions Remove all versions on modifying operations --onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs. --onedrive-token string OAuth Access Token as a JSON blob. --onedrive-token-url string Token server url. --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) --opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) --opendrive-password string Password. (obscured) --opendrive-username string Username --pcloud-auth-url string Auth server URL. --pcloud-client-id string OAuth Client Id --pcloud-client-secret string OAuth Client Secret --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --pcloud-hostname string Hostname to connect to. (default "api.pcloud.com") --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") --pcloud-token string OAuth Access Token as a JSON blob. --pcloud-token-url string Token server url. --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --qingstor-access-key-id string QingStor Access Key ID --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) --qingstor-connection-retries int Number of connection retries. (default 3) --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. --qingstor-secret-access-key string QingStor Secret Access Key (password) --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) --qingstor-zone string Zone to connect to. --s3-access-key-id string AWS Access Key ID. --s3-acl string Canned ACL used when creating buckets and storing or copying objects. --s3-bucket-acl string Canned ACL used when creating buckets. --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) --s3-disable-checksum Don't store MD5 checksum with object metadata --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) --s3-endpoint string Endpoint for S3 API. --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) --s3-location-constraint string Location constraint - must be set to match the Region. --s3-max-upload-parts int Maximum number of parts in a multipart upload. (default 10000) --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. --s3-no-check-bucket If set don't attempt to check the bucket exists or create it --s3-profile string Profile to use in the shared credentials file --s3-provider string Choose your S3 provider. --s3-region string Region to connect to. --s3-secret-access-key string AWS Secret Access Key (password) --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. --s3-session-token string An AWS session token --s3-shared-credentials-file string Path to the shared credentials file --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. --s3-storage-class string The storage class to use when storing new objects in S3. --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. --s3-v2-auth If true use v2 authentication. --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) --seafile-create-library Should rclone create a library if it doesn't exist --seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) --seafile-library string Name of the library. Leave blank to access all non-encrypted libraries. --seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) --seafile-pass string Password (obscured) --seafile-url string URL of seafile host to connect to --seafile-user string User name (usually email address) --sftp-ask-password Allow asking for SFTP password when needed. --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. --sftp-host string SSH host to connect to --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. --sftp-key-use-agent When set forces the usage of the ssh-agent. --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) --sftp-path-override string Override path used by SSH connection. --sftp-port string SSH port, leave blank to use default (22) --sftp-server-command string Specifies the path or command to run a sftp server on the remote host. --sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. --sftp-skip-links Set to skip any symlinks and any other non regular files. --sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp") --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. --sftp-user string SSH username, leave blank for current username, ncw --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) --sharefile-endpoint string Endpoint for API calls. --sharefile-root-folder-id string ID of the root folder --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) --skip-links Don't warn about skipped symlinks. --sugarsync-access-key-id string Sugarsync Access Key ID. --sugarsync-app-id string Sugarsync App ID. --sugarsync-authorization string Sugarsync authorization --sugarsync-authorization-expiry string Sugarsync authorization expiry --sugarsync-deleted-id string Sugarsync deleted folder id --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) --sugarsync-hard-delete Permanently delete files if true --sugarsync-private-access-key string Sugarsync Private Access Key --sugarsync-refresh-token string Sugarsync refresh token --sugarsync-root-id string Sugarsync root id --sugarsync-user string Sugarsync user --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) --swift-auth string Authentication URL for server (OS_AUTH_URL). --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. --swift-key string API key or password (OS_PASSWORD). --swift-no-chunk Don't chunk files during streaming upload. --swift-region string Region name - optional (OS_REGION_NAME) --swift-storage-policy string The storage policy to use when creating a new container --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) --swift-user string User name to log in (OS_USERNAME). --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). --tardigrade-access-grant string Access Grant. --tardigrade-api-key string API Key. --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. --tardigrade-provider string Choose an authentication method. (default "existing") --tardigrade-satellite-address @
-
    
-: Satellite Address. Custom satellite address should match the format: @
-
    
-
    :. (default "us-central-1.tardigrade.io") --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") --union-upstreams string List of space separated upstreams. --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) --webdav-bearer-token-command string Command to run to get a bearer token --webdav-pass string Password. (obscured) --webdav-url string URL of http host to connect to --webdav-user string User name --webdav-vendor string Name of the Webdav site/service/software you are using --yandex-auth-url string Auth server URL. --yandex-client-id string OAuth Client Id --yandex-client-secret string OAuth Client Secret --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-token string OAuth Access Token as a JSON blob. --yandex-token-url string Token server url.
    
-
    
- 1Fichier
------------------------------------------
-
-This is a backend for the [1fichier](https://1fichier.com) cloud
-storage service. Note that a Premium subscription is required to use
-the API.
-
-Paths are specified as `remote:path`
-
-Paths may be as deep as required, eg `remote:directory/subdirectory`.
-
-The initial setup for 1Fichier involves getting the API key from the website which you
-need to do in your browser.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / 1Fichier  "fichier" [snip] Storage> fichier ** See help for fichier backend at: https://rclone.org/fichier/ **
    
-
    Your API Key, get it from https://1fichier.com/console/params.pl Enter a string value. Press Enter for the default (""). api_key> example_key
    
-
    Edit advanced config? (y/n) y) Yes n) No y/n> Remote config -------------------- [remote] type = fichier api_key = example_key -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your 1Fichier account
-
-    rclone lsd remote:
-
-List all the files in your 1Fichier account
-
-    rclone ls remote:
-
-To copy a local directory to a 1Fichier directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Modified time and hashes ###
-
-1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
-
-### Duplicated files ###
-
-1Fichier can have two files with exactly the same name and path (unlike a
-normal file system).
-
-Duplicated files cause problems with the syncing and you will see
-messages in the log about duplicates.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \         | 0x5C  | ＼           |
-| <         | 0x3C  | ＜           |
-| >         | 0x3E  | ＞           |
-| "         | 0x22  | ＂           |
-| $         | 0x24  | ＄           |
-| `         | 0x60  | ｀           |
-| '         | 0x27  | ＇           |
-
-File names can also not start or end with the following characters.
-These only get replaced if they are the first or last character in the
-name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to fichier (1Fichier).
-
-#### --fichier-api-key
+
    Using POST with a JSON blob
    
+
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop
    
+
    response
    
+
    {
+    "password": "xyz",
+    "username": "xyz"
+}
    
+
    This can be combined with URL parameters too if required. The JSON blob takes precedence.
    
+
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4'
    
+
    {
+    "potato": 2,
+    "rutabaga": "3",
+    "sausage": 1
+}
    
+
    Debugging rclone with pprof
    
+
    If you use the --rc flag this will also enable the use of the go profiling tools on the same port.
    
+
    To use these, first install go.
    
+
    Debugging memory use
    
+
    To profile rclone's memory use you can run:
    
+
    go tool pprof -web http://localhost:5572/debug/pprof/heap
    
+
    This should open a page in your browser showing what is using what memory.
    
+
    You can also use the -text flag to produce a textual summary
    
+
    $ go tool pprof -text http://localhost:5572/debug/pprof/heap
+Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
+      flat  flat%   sum%        cum   cum%
+ 1024.03kB 66.62% 66.62%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode
+     513kB 33.38%   100%      513kB 33.38%  net/http.newBufioWriterSize
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/all.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve/restic.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0
+         0     0%   100%  1024.03kB 66.62%  main.init
+         0     0%   100%      513kB 33.38%  net/http.(*conn).readRequest
+         0     0%   100%      513kB 33.38%  net/http.(*conn).serve
+         0     0%   100%  1024.03kB 66.62%  runtime.main
    
+
    Debugging go routine leaks
    
+
    Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected.
    
+
    See all active go routines using
    
+
    curl http://localhost:5572/debug/pprof/goroutine?debug=1
    
+
    Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.
    
+
    Other profiles to look at
    
+
    You can see a summary of profiles available at http://localhost:5572/debug/pprof/
    
+
    Here is how to use some of them:
    
+
      
+
    • Memory: go tool pprof http://localhost:5572/debug/pprof/heap
      • 
+
    • Go routines: curl http://localhost:5572/debug/pprof/goroutine?debug=1
      • 
+
    • 30-second CPU profile: go tool pprof http://localhost:5572/debug/pprof/profile
      • 
+
    • 5-second execution trace: wget http://localhost:5572/debug/pprof/trace?seconds=5
      • 
+
    • Goroutine blocking profile
+
        
+
      • Enable first with: rclone rc debug/set-block-profile-rate rate=1 (docs)
        • 
+
      • go tool pprof http://localhost:5572/debug/pprof/block
        • 
+
      • 
+
    • Contended mutexes:
+
        
+
      • Enable first with: rclone rc debug/set-mutex-profile-fraction rate=1 (docs)
        • 
+
      • go tool pprof http://localhost:5572/debug/pprof/mutex
        • 
+
      • 
+
    
+
    See the net/http/pprof docs for more info on how to use the profiling and for a general overview see the Go team's blog post on profiling go programs.
    
+
    The profiling hook is zero overhead unless it is used.
    
+
    Overview of cloud storage systems
    
+
    Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through.
    
+
    Features
    
+
    Here is an overview of the major features of each cloud storage system.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    NameHashModTimeCase InsensitiveDuplicate FilesMIME Type
    1FichierWhirlpoolNoNoYesR
    Amazon DriveMD5NoYesNoR
    Amazon S3MD5YesNoNoR/W
    Backblaze B2SHA1YesNoNoR/W
    BoxSHA1YesYesNo-
    Citrix ShareFileMD5YesYesNo-
    DropboxDBHASH †YesYesNo-
    FTP-NoNoNo-
    Google Cloud StorageMD5YesNoNoR/W
    Google DriveMD5YesNoYesR/W
    Google Photos-NoNoYesR
    HTTP-NoNoNoR
    HubicMD5YesNoNoR/W
    JottacloudMD5YesYesNoR/W
    KoofrMD5NoYesNo-
    Mail.ru CloudMailru ‡‡‡YesYesNo-
    Mega-NoNoYes-
    MemoryMD5YesNoNo-
    Microsoft Azure Blob StorageMD5YesNoNoR/W
    Microsoft OneDriveSHA1 ‡‡YesYesNoR
    OpenDriveMD5YesYesPartial *-
    OpenStack SwiftMD5YesNoNoR/W
    pCloudMD5, SHA1YesNoNoW
    premiumize.me-NoYesNoR
    put.ioCRC-32YesNoYesR
    QingStorMD5NoNoNoR/W
    Seafile-NoNoNo-
    SFTPMD5, SHA1 ‡YesDependsNo-
    SugarSync-NoNoNo-
    Tardigrade-YesNoNo-
    WebDAVMD5, SHA1 ††Yes †††DependsNo-
    Yandex DiskMD5YesNoNoR/W
    The local filesystemAllYesDependsNo-
    
+
    Hash
    
+
    The cloud storage system supports various hash types of the objects. The hashes are used when transferring data as an integrity check and can be specifically used with the --checksum flag in syncs and in the check command.
    
+
    To use the verify checksums when transferring between cloud storage systems they must support a common hash type.
    
+
    † Note that Dropbox supports its own custom hash. This is an SHA256 sum of all the 4MB block SHA256s.
    
+
    ‡ SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote's PATH.
    
+
    †† WebDAV supports hashes when used with Owncloud and Nextcloud only.
    
+
    ††† WebDAV supports modtimes when used with Owncloud and Nextcloud only.
    
+
    ‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for business and SharePoint server support Microsoft's own QuickXorHash.
    
+
    ‡‡‡ Mail.ru uses its own modified SHA1 hash
    
+
    ModTime
    
+
    The cloud storage system supports setting modification times on objects. If it does then this enables a using the modification times as part of the sync. If not then only the size will be checked by default, though the MD5SUM can be checked with the --checksum flag.
    
+
    All cloud storage systems support some kind of date on the object and these will be set when transferring from the cloud storage system.
    
+
    Case Insensitive
    
+
    If a cloud storage systems is case sensitive then it is possible to have two files which differ only in case, eg file.txt and FILE.txt. If a cloud storage system is case insensitive then that isn't possible.
    
+
    This can cause problems when syncing between a case insensitive system and a case sensitive system. The symptom of this is that no matter how many times you run the sync it never completes fully.
    
+
    The local filesystem and SFTP may or may not be case sensitive depending on OS.
    
+
      
+
    • Windows - usually case insensitive, though case is preserved
      • 
+
    • OSX - usually case insensitive, though it is possible to format case sensitive
      • 
+
    • Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys)
      • 
+
    
+
    Most of the time this doesn't cause any problems as people tend to avoid files whose name differs only by case even on case sensitive systems.
    
+
    Duplicate files
    
+
    If a cloud storage system allows duplicate files then it can have two objects with the same name.
    
+
    This confuses rclone greatly when syncing - use the rclone dedupe command to rename or remove duplicates.
    
+
    * Opendrive does not support creation of duplicate files using their web client interface or other stock clients, but the underlying storage platform has been determined to allow duplicate files, and it is possible to create them with rclone. It may be that this is a mistake or an unsupported feature.
    
+
    Restricted filenames
    
+
    Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. When rclone detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters.
    
+
    This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently.
    
+
    The name shown by rclone to the user or during log output will only contain a minimal set of replaced characters to ensure correct formatting and not necessarily the actual name used on the cloud storage.
    
+
    This transformation is reversed when downloading a file or parsing rclone arguments. For example, when uploading a file named my file?.txt to Onedrive will be displayed as my file?.txt on the console, but stored as my file？.txt (the ? gets replaced by the similar looking ？ character) to Onedrive. The reverse transformation allows to read a fileunusual/name.txt from Google Drive, by passing the name unusual／name.txt (the / needs to be replaced by the similar looking ／ character) on the command line.
    
+
    Default restricted characters
    
+
    The table below shows the characters that are replaced by default.
    
+
    When a replacement character is found in a filename, this character will be escaped with the ‛ character to avoid ambiguous file names. (e.g. a file named ␀.txt would shown as ‛␀.txt)
    
+
    Each cloud storage backend can use a different set of characters, which will be specified in the documentation for each backend.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    SOH0x01␁
    STX0x02␂
    ETX0x03␃
    EOT0x04␄
    ENQ0x05␅
    ACK0x06␆
    BEL0x07␇
    BS0x08␈
    HT0x09␉
    LF0x0A␊
    VT0x0B␋
    FF0x0C␌
    CR0x0D␍
    SO0x0E␎
    SI0x0F␏
    DLE0x10␐
    DC10x11␑
    DC20x12␒
    DC30x13␓
    DC40x14␔
    NAK0x15␕
    SYN0x16␖
    ETB0x17␗
    CAN0x18␘
    EM0x19␙
    SUB0x1A␚
    ESC0x1B␛
    FS0x1C␜
    GS0x1D␝
    RS0x1E␞
    US0x1F␟
    /0x2F／
    DEL0x7F␡
    
+
    The default encoding will also encode these file names as they are problematic with many cloud storage systems.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    File nameReplacement
    .．
    ..．．
    
+
    Invalid UTF-8 bytes
    
+
    Some backends only support a sequence of well formed UTF-8 bytes as file or directory names.
    
+
    In this case all invalid UTF-8 bytes will be replaced with a quoted representation of the byte value to allow uploading a file to such a backend. For example, the invalid byte 0xFE will be encoded as ‛FE.
    
+
    A common source of invalid UTF-8 bytes are local filesystems, that store names in a different encoding than UTF-8 or UTF-16, like latin1. See the local filenames section for details.
    
+
    Encoding option
    
+
    Most backends have an encoding options, specified as a flag --backend-encoding where backend is the name of the backend, or as a config parameter encoding (you'll need to select the Advanced config in rclone config to see it).
    
+
    This will have default value which encodes and decodes characters in such a way as to preserve the maximum number of characters (see above).
    
+
    However this can be incorrect in some scenarios, for example if you have a Windows file system with characters such as ＊ and ？ that you want to remain as those characters on the remote rather than being translated to * and ?.
    
+
    The --backend-encoding flags allow you to change that. You can disable the encoding completely with --backend-encoding None or set encoding = None in the config file.
    
+
    Encoding takes a comma separated list of encodings. You can see the list of all available characters by passing an invalid value to this flag, eg --local-encoding "help" and rclone help flags encoding will show you the defaults for the backends.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    EncodingCharacters
    Asterisk*
    BackQuote`
    BackSlash\
    Colon:
    CrLfCR 0x0D, LF 0x0A
    CtlAll control characters 0x00-0x1F
    DelDEL 0x7F
    Dollar$
    Dot.
    DoubleQuote"
    Hash#
    InvalidUtf8An invalid UTF-8 character (eg latin1)
    LeftCrLfHtVtCR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string
    LeftPeriod. on the left of a string
    LeftSpaceSPACE on the left of a string
    LeftTilde~ on the left of a string
    LtGt<, >
    NoneNo characters are encoded
    Percent%
    Pipe|
    Question?
    RightCrLfHtVtCR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string
    RightPeriod. on the right of a string
    RightSpaceSPACE on the right of a string
    SingleQuote'
    Slash/
    
+
    To take a specific example, the FTP backend's default encoding is
    
+
    --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot"
    
+
    However, let's say the FTP server is running on Windows and can't have any of the invalid Windows characters in file names. You are backing up Linux servers to this FTP server which do have those characters in file names. So you would add the Windows set which are
    
+
    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
    
+
    to the existing ones, giving:
    
+
    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace
    
+
    This can be specified using the --ftp-encoding flag or using an encoding parameter in the config file.
    
+
    Or let's say you have a Windows server but you want to preserve ＊ and ？, you would then have this as the encoding (the Windows encoding minus Asterisk and Question).
    
+
    Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
    
+
    This can be specified using the --local-encoding flag or using an encoding parameter in the config file.
    
+
    MIME Type
    
+
    MIME types (also known as media types) classify types of documents using a simple text classification, eg text/html or application/pdf.
    
+
    Some cloud storage systems support reading (R) the MIME type of objects and some support writing (W) the MIME type of objects.
    
+
    The MIME type can be important if you are serving files directly to HTTP from the storage system.
    
+
    If you are copying from a remote which supports reading (R) to a remote which supports writing (W) then rclone will preserve the MIME types. Otherwise they will be guessed from the extension, or the remote itself may assign the MIME type.
    
+
    Optional Features
    
+
    All the remotes support a basic set of features, but there are some optional features supported by some remotes used to make some operations more efficient.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    NamePurgeCopyMoveDirMoveCleanUpListRStreamUploadLinkSharingAboutEmptyDir
    1FichierNoNoNoNoNoNoNoNoNoYes
    Amazon DriveYesNoYesYesNo #575NoNoNo #2178NoYes
    Amazon S3NoYesNoNoYesYesYesNo #2178NoNo
    Backblaze B2NoYesNoNoYesYesYesYesNoNo
    BoxYesYesYesYesYes ‡‡NoYesYesNoYes
    Citrix ShareFileYesYesYesYesNoNoYesNoNoYes
    DropboxYesYesYesYesNo #575NoYesYesYesYes
    FTPNoNoYesYesNoNoYesNo #2178NoYes
    Google Cloud StorageYesYesNoNoNoYesYesNo #2178NoNo
    Google DriveYesYesYesYesYesYesYesYesYesYes
    Google PhotosNoNoNoNoNoNoNoNoNoNo
    HTTPNoNoNoNoNoNoNoNo #2178NoYes
    HubicYes †YesNoNoNoYesYesNo #2178YesNo
    JottacloudYesYesYesYesYesYesNoYesYesYes
    Mail.ru CloudYesYesYesYesYesNoNoYesYesYes
    MegaYesNoYesYesYesNoNoNo #2178YesYes
    MemoryNoYesNoNoNoYesYesNoNoNo
    Microsoft Azure Blob StorageYesYesNoNoNoYesYesNo #2178NoNo
    Microsoft OneDriveYesYesYesYesYesNoNoYesYesYes
    OpenDriveYesYesYesYesNoNoNoNoNoYes
    OpenStack SwiftYes †YesNoNoNoYesYesNo #2178YesNo
    pCloudYesYesYesYesYesNoNoYesYesYes
    premiumize.meYesNoYesYesNoNoNoYesYesYes
    put.ioYesNoYesYesYesNoYesNo #2178YesYes
    QingStorNoYesNoNoYesYesNoNo #2178NoNo
    SeafileYesYesYesYesYesYesYesYesYesYes
    SFTPNoNoYesYesNoNoYesNo #2178YesYes
    SugarSyncYesYesYesYesNoNoYesYesNoYes
    TardigradeYes †NoNoNoNoYesYesNoNoNo
    WebDAVYesYesYesYesNoNoYes ‡No #2178YesYes
    Yandex DiskYesYesYesYesYesNoYesYesYesYes
    The local filesystemYesNoYesYesNoNoYesNoYesYes
    
+
    Purge
    
+
    This deletes a directory quicker than just deleting all the files in the directory.
    
+
    † Note Swift, Hubic, and Tardigrade implement this in order to delete directory markers but they don't actually have a quicker way of deleting files other than deleting them individually.
    
+
    ‡ StreamUpload is not supported with Nextcloud
    
+
    Copy
    
+
    Used when copying an object to and from the same remote. This known as a server side copy so you can copy a file without downloading it and uploading it again. It is used if you use rclone copy or rclone move if the remote doesn't support Move directly.
    
+
    If the server doesn't support Copy directly then for copy operations the file is downloaded then re-uploaded.
    
+
    Move
    
+
    Used when moving/renaming an object on the same remote. This is known as a server side move of a file. This is used in rclone move if the server doesn't support DirMove.
    
+
    If the server isn't capable of Move then rclone simulates it with Copy then delete. If the server doesn't support Copy then rclone will download the file and re-upload it.
    
+
    DirMove
    
+
    This is used to implement rclone move to move a directory if possible. If it isn't then it will use Move on each file (which falls back to Copy then download and upload - see Move section).
    
+
    CleanUp
    
+
    This is used for emptying the trash for a remote by rclone cleanup.
    
+
    If the server can't do CleanUp then rclone cleanup will return an error.
    
+
    ‡‡ Note that while Box implements this it has to delete every file idividually so it will be slower than emptying the trash via the WebUI
    
+
    ListR
    
+
    The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the --fast-list flag to work. See the rclone docs for more details.
    
+
    StreamUpload
    
+
    Some remotes allow files to be uploaded without knowing the file size in advance. This allows certain operations to work without spooling the file to local disk first, e.g. rclone rcat.
    
+
    LinkSharing
    
+
    Sets the necessary permissions on a file or folder and prints a link that allows others to access them, even if they don't have an account on the particular cloud provider.
    
+
    About
    
+
    This is used to fetch quota information from the remote, like bytes used/free/quota and bytes used in the trash.
    
+
    This is also used to return the space used, available for rclone mount.
    
+
    If the server can't do About then rclone about will return an error.
    
+
    EmptyDir
    
+
    The remote supports empty directories. See Limitations for details. Most Object/Bucket based remotes do not support this.
    
+
    Global Flags
    
+
    This describes the global flags available to every rclone command split into two groups, non backend and backend flags.
    
+
    Non Backend Flags
    
+
    These flags are available for every command.
    
+
          --ask-password                         Allow prompt for password for encrypted configuration. (default true)
+      --auto-confirm                         If enabled, do not request console confirmation.
+      --backup-dir string                    Make backups into hierarchy based in DIR.
+      --bind string                          Local address to bind to for outgoing connections, IPv4, IPv6 or name.
+      --buffer-size SizeSuffix               In memory buffer size when reading files for each --transfer. (default 16M)
+      --bwlimit BwTimetable                  Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
+      --bwlimit-file BwTimetable             Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable.
+      --ca-cert string                       CA certificate used to verify servers
+      --cache-dir string                     Directory rclone will use for caching. (default "$HOME/.cache/rclone")
+      --check-first                          Do all the checks before starting transfers.
+      --checkers int                         Number of checkers to run in parallel. (default 8)
+  -c, --checksum                             Skip based on checksum (if available) & size, not mod-time & size
+      --client-cert string                   Client SSL certificate (PEM) for mutual TLS auth
+      --client-key string                    Client SSL private key (PEM) for mutual TLS auth
+      --compare-dest string                  Include additional server-side path during comparison.
+      --config string                        Config file. (default "$HOME/.config/rclone/rclone.conf")
+      --contimeout duration                  Connect timeout (default 1m0s)
+      --copy-dest string                     Implies --compare-dest but also copies files from path into destination.
+      --cpuprofile string                    Write cpu profile to file
+      --cutoff-mode string                   Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD")
+      --delete-after                         When synchronizing, delete files on destination after transferring (default)
+      --delete-before                        When synchronizing, delete files on destination before transferring
+      --delete-during                        When synchronizing, delete files during transfer
+      --delete-excluded                      Delete files on dest excluded from sync
+      --disable string                       Disable a comma separated list of features.  Use help to see a list.
+  -n, --dry-run                              Do a trial run with no permanent changes
+      --dump DumpFlags                       List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles
+      --dump-bodies                          Dump HTTP headers and bodies - may contain sensitive info
+      --dump-headers                         Dump HTTP headers - may contain sensitive info
+      --error-on-no-transfer                 Sets exit code 9 if no files are transferred, useful in scripts
+      --exclude stringArray                  Exclude files matching pattern
+      --exclude-from stringArray             Read exclude patterns from file (use - to read from stdin)
+      --exclude-if-present string            Exclude directories if filename is present
+      --expect-continue-timeout duration     Timeout when using expect / 100-continue in HTTP (default 1s)
+      --fast-list                            Use recursive list if available. Uses more memory but fewer transactions.
+      --files-from stringArray               Read list of source-file names from file (use - to read from stdin)
+      --files-from-raw stringArray           Read list of source-file names from file without any processing of lines (use - to read from stdin)
+  -f, --filter stringArray                   Add a file-filtering rule
+      --filter-from stringArray              Read filtering patterns from a file (use - to read from stdin)
+      --header stringArray                   Set HTTP header for all transactions
+      --header-download stringArray          Set HTTP header for download transactions
+      --header-upload stringArray            Set HTTP header for upload transactions
+      --ignore-case                          Ignore case in filters (case insensitive)
+      --ignore-case-sync                     Ignore case when synchronizing
+      --ignore-checksum                      Skip post copy check of checksums.
+      --ignore-errors                        delete even if there are I/O errors
+      --ignore-existing                      Skip all files that exist on destination
+      --ignore-size                          Ignore size when skipping use mod-time or checksum.
+  -I, --ignore-times                         Don't skip files that match size and time - transfer all files
+      --immutable                            Do not modify files. Fail if existing files have been modified.
+      --include stringArray                  Include files matching pattern
+      --include-from stringArray             Read include patterns from file (use - to read from stdin)
+  -i, --interactive                          Enable interactive mode
+      --log-file string                      Log everything to this file
+      --log-format string                    Comma separated list of log format options (default "date,time")
+      --log-level string                     Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE")
+      --low-level-retries int                Number of low level retries to do. (default 10)
+      --max-age Duration                     Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
+      --max-backlog int                      Maximum number of objects in sync or check backlog. (default 10000)
+      --max-delete int                       When synchronizing, limit the number of deletes (default -1)
+      --max-depth int                        If set limits the recursion depth to this. (default -1)
+      --max-duration duration                Maximum duration rclone will transfer data for.
+      --max-size SizeSuffix                  Only transfer files smaller than this in k or suffix b|k|M|G (default off)
+      --max-stats-groups int                 Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000)
+      --max-transfer SizeSuffix              Maximum size of data to transfer. (default off)
+      --memprofile string                    Write memory profile to file
+      --min-age Duration                     Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
+      --min-size SizeSuffix                  Only transfer files bigger than this in k or suffix b|k|M|G (default off)
+      --modify-window duration               Max time diff to be considered the same (default 1ns)
+      --multi-thread-cutoff SizeSuffix       Use multi-thread downloads for files above this size. (default 250M)
+      --multi-thread-streams int             Max number of streams to use for multi-thread downloads. (default 4)
+      --no-check-certificate                 Do not verify the server SSL certificate. Insecure.
+      --no-check-dest                        Don't check the destination, copy regardless.
+      --no-gzip-encoding                     Don't set Accept-Encoding: gzip.
+      --no-traverse                          Don't traverse destination file system on copy.
+      --no-unicode-normalization             Don't normalize unicode characters in filenames.
+      --no-update-modtime                    Don't update destination mod-time if files identical.
+      --order-by string                      Instructions on how to order the transfers, eg 'size,descending'
+      --password-command SpaceSepList        Command for supplying password for encrypted configuration.
+  -P, --progress                             Show progress during transfer.
+  -q, --quiet                                Print as little stuff as possible
+      --rc                                   Enable the remote control server.
+      --rc-addr string                       IPaddress:Port or :Port to bind server to. (default "localhost:5572")
+      --rc-allow-origin string               Set the allowed origin for CORS.
+      --rc-baseurl string                    Prefix for URLs - leave blank for root.
+      --rc-cert string                       SSL PEM key (concatenation of certificate and CA certificate)
+      --rc-client-ca string                  Client certificate authority to verify clients with
+      --rc-enable-metrics                    Enable prometheus metrics on /metrics
+      --rc-files string                      Path to local files to serve on the HTTP server.
+      --rc-htpasswd string                   htpasswd file - if not provided no authentication is done
+      --rc-job-expire-duration duration      expire finished async jobs older than this value (default 1m0s)
+      --rc-job-expire-interval duration      interval to check for expired async jobs (default 10s)
+      --rc-key string                        SSL PEM Private key
+      --rc-max-header-bytes int              Maximum size of request header (default 4096)
+      --rc-no-auth                           Don't require auth for certain methods.
+      --rc-pass string                       Password for authentication.
+      --rc-realm string                      realm for authentication (default "rclone")
+      --rc-serve                             Enable the serving of remote objects.
+      --rc-server-read-timeout duration      Timeout for server reading data (default 1h0m0s)
+      --rc-server-write-timeout duration     Timeout for server writing data (default 1h0m0s)
+      --rc-template string                   User Specified Template.
+      --rc-user string                       User name for authentication.
+      --rc-web-fetch-url string              URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
+      --rc-web-gui                           Launch WebGUI on localhost
+      --rc-web-gui-force-update              Force update to latest version of web gui
+      --rc-web-gui-no-open-browser           Don't open the browser automatically
+      --rc-web-gui-update                    Check and update to latest version of web gui
+      --refresh-times                        Refresh the modtime of remote files.
+      --retries int                          Retry operations this many times if they fail (default 3)
+      --retries-sleep duration               Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable)
+      --size-only                            Skip based on size only, not mod-time or checksum
+      --stats duration                       Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s)
+      --stats-file-name-length int           Max file name length in stats. 0 for no limit (default 45)
+      --stats-log-level string               Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO")
+      --stats-one-line                       Make the stats fit on one line.
+      --stats-one-line-date                  Enables --stats-one-line and add current date/time prefix.
+      --stats-one-line-date-format string    Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format
+      --stats-unit string                    Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes")
+      --streaming-upload-cutoff SizeSuffix   Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k)
+      --suffix string                        Suffix to add to changed files.
+      --suffix-keep-extension                Preserve the extension when using --suffix.
+      --syslog                               Use Syslog for logging
+      --syslog-facility string               Facility for syslog, eg KERN,USER,... (default "DAEMON")
+      --timeout duration                     IO idle timeout (default 5m0s)
+      --tpslimit float                       Limit HTTP transactions per second to this.
+      --tpslimit-burst int                   Max burst of transactions for --tpslimit. (default 1)
+      --track-renames                        When synchronizing, track file renames and do a server side move if possible
+      --track-renames-strategy string        Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
+      --transfers int                        Number of file transfers to run in parallel. (default 4)
+  -u, --update                               Skip files that are newer on the destination.
+      --use-cookies                          Enable session cookiejar.
+      --use-json-log                         Use json log format.
+      --use-mmap                             Use mmap allocator (see docs).
+      --use-server-modtime                   Use server modified time instead of object metadata
+      --user-agent string                    Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.1")
+  -v, --verbose count                        Print lots more stuff (repeat for more)
    
+
    Backend Flags
    
+
    These flags are available for every command. They control the backends and may be set in the config file.
    
+
          --acd-auth-url string                                      Auth server URL.
+      --acd-client-id string                                     OAuth Client Id
+      --acd-client-secret string                                 OAuth Client Secret
+      --acd-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
+      --acd-templink-threshold SizeSuffix                        Files >= this size will be downloaded via their tempLink. (default 9G)
+      --acd-token string                                         OAuth Access Token as a JSON blob.
+      --acd-token-url string                                     Token server url.
+      --acd-upload-wait-per-gb Duration                          Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
+      --alias-remote string                                      Remote or path to alias.
+      --azureblob-access-tier string                             Access tier of blob: hot, cool or archive.
+      --azureblob-account string                                 Storage Account Name (leave blank to use SAS URL or Emulator)
+      --azureblob-chunk-size SizeSuffix                          Upload chunk size (<= 100MB). (default 4M)
+      --azureblob-disable-checksum                               Don't store MD5 checksum with object metadata.
+      --azureblob-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
+      --azureblob-endpoint string                                Endpoint for the service
+      --azureblob-key string                                     Storage Account Key (leave blank to use SAS URL or Emulator)
+      --azureblob-list-chunk int                                 Size of blob list. (default 5000)
+      --azureblob-memory-pool-flush-time Duration                How often internal memory buffer pools will be flushed. (default 1m0s)
+      --azureblob-memory-pool-use-mmap                           Whether to use mmap buffers in internal memory pool.
+      --azureblob-sas-url string                                 SAS URL for container level access only
+      --azureblob-upload-cutoff SizeSuffix                       Cutoff for switching to chunked upload (<= 256MB). (default 256M)
+      --azureblob-use-emulator                                   Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)
+      --b2-account string                                        Account ID or Application Key ID
+      --b2-chunk-size SizeSuffix                                 Upload chunk size. Must fit in memory. (default 96M)
+      --b2-copy-cutoff SizeSuffix                                Cutoff for switching to multipart copy (default 4G)
+      --b2-disable-checksum                                      Disable checksums for large (> upload cutoff) files
+      --b2-download-auth-duration Duration                       Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w)
+      --b2-download-url string                                   Custom endpoint for downloads.
+      --b2-encoding MultiEncoder                                 This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --b2-endpoint string                                       Endpoint for the service.
+      --b2-hard-delete                                           Permanently delete files on remote removal, otherwise hide files.
+      --b2-key string                                            Application Key
+      --b2-memory-pool-flush-time Duration                       How often internal memory buffer pools will be flushed. (default 1m0s)
+      --b2-memory-pool-use-mmap                                  Whether to use mmap buffers in internal memory pool.
+      --b2-test-mode string                                      A flag string for X-Bz-Test-Mode header for debugging.
+      --b2-upload-cutoff SizeSuffix                              Cutoff for switching to chunked upload. (default 200M)
+      --b2-versions                                              Include old versions in directory listings.
+      --box-access-token string                                  Box App Primary Access Token
+      --box-auth-url string                                      Auth server URL.
+      --box-box-config-file string                               Box App config.json location
+      --box-box-sub-type string                                   (default "user")
+      --box-client-id string                                     OAuth Client Id
+      --box-client-secret string                                 OAuth Client Secret
+      --box-commit-retries int                                   Max number of times to try committing a multipart file. (default 100)
+      --box-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
+      --box-root-folder-id string                                Fill in for rclone to use a non root folder as its starting point.
+      --box-token string                                         OAuth Access Token as a JSON blob.
+      --box-token-url string                                     Token server url.
+      --box-upload-cutoff SizeSuffix                             Cutoff for switching to multipart upload (>= 50MB). (default 50M)
+      --cache-chunk-clean-interval Duration                      How often should the cache perform cleanups of the chunk storage. (default 1m0s)
+      --cache-chunk-no-memory                                    Disable the in-memory cache for storing chunks during streaming.
+      --cache-chunk-path string                                  Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend")
+      --cache-chunk-size SizeSuffix                              The size of a chunk (partial file data). (default 5M)
+      --cache-chunk-total-size SizeSuffix                        The total size that the chunks can take up on the local disk. (default 10G)
+      --cache-db-path string                                     Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend")
+      --cache-db-purge                                           Clear all the cached data for this remote on start.
+      --cache-db-wait-time Duration                              How long to wait for the DB to be available - 0 is unlimited (default 1s)
+      --cache-info-age Duration                                  How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
+      --cache-plex-insecure string                               Skip all certificate verification when connecting to the Plex server
+      --cache-plex-password string                               The password of the Plex user (obscured)
+      --cache-plex-url string                                    The URL of the Plex server
+      --cache-plex-username string                               The username of the Plex user
+      --cache-read-retries int                                   How many times to retry a read from a cache storage. (default 10)
+      --cache-remote string                                      Remote to cache.
+      --cache-rps int                                            Limits the number of requests per second to the source FS (-1 to disable) (default -1)
+      --cache-tmp-upload-path string                             Directory to keep temporary files until they are uploaded.
+      --cache-tmp-wait-time Duration                             How long should files be stored in local cache before being uploaded (default 15s)
+      --cache-workers int                                        How many workers should run in parallel to download chunks. (default 4)
+      --cache-writes                                             Cache file data on writes through the FS
+      --chunker-chunk-size SizeSuffix                            Files larger than chunk size will be split in chunks. (default 2G)
+      --chunker-fail-hard                                        Choose how chunker should handle files with missing or invalid chunks.
+      --chunker-hash-type string                                 Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5")
+      --chunker-meta-format string                               Format of the metadata object or "none". By default "simplejson". (default "simplejson")
+      --chunker-name-format string                               String format of chunk file names. (default "*.rclone_chunk.###")
+      --chunker-remote string                                    Remote to chunk/unchunk.
+      --chunker-start-from int                                   Minimum valid chunk number. Usually 0 or 1. (default 1)
+  -L, --copy-links                                               Follow symlinks and copy the pointed to item.
+      --crypt-directory-name-encryption                          Option to either encrypt directory names or leave them intact. (default true)
+      --crypt-filename-encryption string                         How to encrypt the filenames. (default "standard")
+      --crypt-password string                                    Password or pass phrase for encryption. (obscured)
+      --crypt-password2 string                                   Password or pass phrase for salt. Optional but recommended. (obscured)
+      --crypt-remote string                                      Remote to encrypt/decrypt.
+      --crypt-server-side-across-configs                         Allow server side operations (eg copy) to work across different crypt configs.
+      --crypt-show-mapping                                       For all files listed show how the names encrypt.
+      --drive-acknowledge-abuse                                  Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
+      --drive-allow-import-name-change                           Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.
+      --drive-auth-owner-only                                    Only consider files owned by the authenticated user.
+      --drive-auth-url string                                    Auth server URL.
+      --drive-chunk-size SizeSuffix                              Upload chunk size. Must a power of 2 >= 256k. (default 8M)
+      --drive-client-id string                                   Google Application Client Id
+      --drive-client-secret string                               OAuth Client Secret
+      --drive-disable-http2                                      Disable drive using http2 (default true)
+      --drive-encoding MultiEncoder                              This sets the encoding for the backend. (default InvalidUtf8)
+      --drive-export-formats string                              Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg")
+      --drive-formats string                                     Deprecated: see export_formats
+      --drive-impersonate string                                 Impersonate this user when using a service account.
+      --drive-import-formats string                              Comma separated list of preferred formats for uploading Google docs.
+      --drive-keep-revision-forever                              Keep new head revision of each file forever.
+      --drive-list-chunk int                                     Size of listing chunk 100-1000. 0 to disable. (default 1000)
+      --drive-pacer-burst int                                    Number of API calls to allow without sleeping. (default 100)
+      --drive-pacer-min-sleep Duration                           Minimum time to sleep between API calls. (default 100ms)
+      --drive-root-folder-id string                              ID of the root folder
+      --drive-scope string                                       Scope that rclone should use when requesting access from drive.
+      --drive-server-side-across-configs                         Allow server side operations (eg copy) to work across different drive configs.
+      --drive-service-account-credentials string                 Service Account Credentials JSON blob
+      --drive-service-account-file string                        Service Account Credentials JSON file path
+      --drive-shared-with-me                                     Only show files that are shared with me.
+      --drive-size-as-quota                                      Show sizes as storage quota usage, not actual size.
+      --drive-skip-checksum-gphotos                              Skip MD5 checksum on Google photos and videos only.
+      --drive-skip-gdocs                                         Skip google documents in all listings.
+      --drive-skip-shortcuts                                     If set skip shortcut files
+      --drive-starred-only                                       Only show files that are starred.
+      --drive-stop-on-upload-limit                               Make upload limit errors be fatal
+      --drive-team-drive string                                  ID of the Team Drive
+      --drive-token string                                       OAuth Access Token as a JSON blob.
+      --drive-token-url string                                   Token server url.
+      --drive-trashed-only                                       Only show files that are in the trash.
+      --drive-upload-cutoff SizeSuffix                           Cutoff for switching to chunked upload (default 8M)
+      --drive-use-created-date                                   Use file created date instead of modified date.,
+      --drive-use-shared-date                                    Use date file was shared instead of modified date.
+      --drive-use-trash                                          Send files to the trash instead of deleting permanently. (default true)
+      --drive-v2-download-min-size SizeSuffix                    If Object's are greater, use drive v2 API to download. (default off)
+      --dropbox-auth-url string                                  Auth server URL.
+      --dropbox-chunk-size SizeSuffix                            Upload chunk size. (< 150M). (default 48M)
+      --dropbox-client-id string                                 OAuth Client Id
+      --dropbox-client-secret string                             OAuth Client Secret
+      --dropbox-encoding MultiEncoder                            This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
+      --dropbox-impersonate string                               Impersonate this user when using a business account.
+      --dropbox-token string                                     OAuth Access Token as a JSON blob.
+      --dropbox-token-url string                                 Token server url.
+      --fichier-api-key string                                   Your API Key, get it from https://1fichier.com/console/params.pl
+      --fichier-encoding MultiEncoder                            This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
+      --fichier-shared-folder string                             If you want to download a shared folder, add this parameter
+      --ftp-concurrency int                                      Maximum number of FTP simultaneous connections, 0 for unlimited
+      --ftp-disable-epsv                                         Disable using EPSV even if server advertises support
+      --ftp-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
+      --ftp-explicit-tls                                         Use FTP over TLS (Explicit)
+      --ftp-host string                                          FTP host to connect to
+      --ftp-no-check-certificate                                 Do not verify the TLS certificate of the server
+      --ftp-pass string                                          FTP password (obscured)
+      --ftp-port string                                          FTP port, leave blank to use default (21)
+      --ftp-tls                                                  Use FTPS over TLS (Implicit)
+      --ftp-user string                                          FTP username, leave blank for current username, $USER
+      --gcs-anonymous                                            Access public buckets and objects without credentials
+      --gcs-auth-url string                                      Auth server URL.
+      --gcs-bucket-acl string                                    Access Control List for new buckets.
+      --gcs-bucket-policy-only                                   Access checks should use bucket-level IAM policies.
+      --gcs-client-id string                                     OAuth Client Id
+      --gcs-client-secret string                                 OAuth Client Secret
+      --gcs-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot)
+      --gcs-location string                                      Location for the newly created buckets.
+      --gcs-object-acl string                                    Access Control List for new objects.
+      --gcs-project-number string                                Project number.
+      --gcs-service-account-file string                          Service Account Credentials JSON file path
+      --gcs-storage-class string                                 The storage class to use when storing objects in Google Cloud Storage.
+      --gcs-token string                                         OAuth Access Token as a JSON blob.
+      --gcs-token-url string                                     Token server url.
+      --gphotos-auth-url string                                  Auth server URL.
+      --gphotos-client-id string                                 OAuth Client Id
+      --gphotos-client-secret string                             OAuth Client Secret
+      --gphotos-read-only                                        Set to make the Google Photos backend read only.
+      --gphotos-read-size                                        Set to read the size of media items.
+      --gphotos-start-year int                                   Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
+      --gphotos-token string                                     OAuth Access Token as a JSON blob.
+      --gphotos-token-url string                                 Token server url.
+      --http-headers CommaSepList                                Set HTTP headers for all transactions
+      --http-no-head                                             Don't use HEAD requests to find file sizes in dir listing
+      --http-no-slash                                            Set this if the site doesn't end directories with /
+      --http-url string                                          URL of http host to connect to
+      --hubic-auth-url string                                    Auth server URL.
+      --hubic-chunk-size SizeSuffix                              Above this size files will be chunked into a _segments container. (default 5G)
+      --hubic-client-id string                                   OAuth Client Id
+      --hubic-client-secret string                               OAuth Client Secret
+      --hubic-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,InvalidUtf8)
+      --hubic-no-chunk                                           Don't chunk files during streaming upload.
+      --hubic-token string                                       OAuth Access Token as a JSON blob.
+      --hubic-token-url string                                   Token server url.
+      --jottacloud-encoding MultiEncoder                         This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+      --jottacloud-hard-delete                                   Delete files permanently rather than putting them into the trash.
+      --jottacloud-md5-memory-limit SizeSuffix                   Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M)
+      --jottacloud-trashed-only                                  Only show files that are in the trash.
+      --jottacloud-upload-resume-limit SizeSuffix                Files bigger than this can be resumed if the upload fail's. (default 10M)
+      --koofr-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --koofr-endpoint string                                    The Koofr API endpoint to use (default "https://app.koofr.net")
+      --koofr-mountid string                                     Mount ID of the mount to use. If omitted, the primary mount is used.
+      --koofr-password string                                    Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
+      --koofr-setmtime                                           Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
+      --koofr-user string                                        Your Koofr user name
+  -l, --links                                                    Translate symlinks to/from regular files with a '.rclonelink' extension
+      --local-case-insensitive                                   Force the filesystem to report itself as case insensitive
+      --local-case-sensitive                                     Force the filesystem to report itself as case sensitive.
+      --local-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,Dot)
+      --local-no-check-updated                                   Don't check to see if the files change during upload
+      --local-no-set-modtime                                     Disable setting modtime
+      --local-no-sparse                                          Disable sparse files for multi-thread downloads
+      --local-no-unicode-normalization                           Don't apply unicode normalization to paths and filenames (Deprecated)
+      --local-nounc string                                       Disable UNC (long path names) conversion on Windows
+      --mailru-check-hash                                        What should copy do if file checksum is mismatched or invalid (default true)
+      --mailru-encoding MultiEncoder                             This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --mailru-pass string                                       Password (obscured)
+      --mailru-speedup-enable                                    Skip full upload if there is another file with same data hash. (default true)
+      --mailru-speedup-file-patterns string                      Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
+      --mailru-speedup-max-disk SizeSuffix                       This option allows you to disable speedup (put by hash) for large files (default 3G)
+      --mailru-speedup-max-memory SizeSuffix                     Files larger than the size given below will always be hashed on disk. (default 32M)
+      --mailru-user string                                       User name (usually email)
+      --mega-debug                                               Output more debug from Mega.
+      --mega-encoding MultiEncoder                               This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
+      --mega-hard-delete                                         Delete files permanently rather than putting them into the trash.
+      --mega-pass string                                         Password. (obscured)
+      --mega-user string                                         User name
+  -x, --one-file-system                                          Don't cross filesystem boundaries (unix/macOS only).
+      --onedrive-auth-url string                                 Auth server URL.
+      --onedrive-chunk-size SizeSuffix                           Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
+      --onedrive-client-id string                                OAuth Client Id
+      --onedrive-client-secret string                            OAuth Client Secret
+      --onedrive-drive-id string                                 The ID of the drive to use
+      --onedrive-drive-type string                               The type of the drive ( personal | business | documentLibrary )
+      --onedrive-encoding MultiEncoder                           This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+      --onedrive-expose-onenote-files                            Set to make OneNote files show up in directory listings.
+      --onedrive-no-versions                                     Remove all versions on modifying operations
+      --onedrive-server-side-across-configs                      Allow server side operations (eg copy) to work across different onedrive configs.
+      --onedrive-token string                                    OAuth Access Token as a JSON blob.
+      --onedrive-token-url string                                Token server url.
+      --opendrive-chunk-size SizeSuffix                          Files will be uploaded in chunks this size. (default 10M)
+      --opendrive-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
+      --opendrive-password string                                Password. (obscured)
+      --opendrive-username string                                Username
+      --pcloud-auth-url string                                   Auth server URL.
+      --pcloud-client-id string                                  OAuth Client Id
+      --pcloud-client-secret string                              OAuth Client Secret
+      --pcloud-encoding MultiEncoder                             This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --pcloud-hostname string                                   Hostname to connect to. (default "api.pcloud.com")
+      --pcloud-root-folder-id string                             Fill in for rclone to use a non root folder as its starting point. (default "d0")
+      --pcloud-token string                                      OAuth Access Token as a JSON blob.
+      --pcloud-token-url string                                  Token server url.
+      --premiumizeme-encoding MultiEncoder                       This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --putio-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --qingstor-access-key-id string                            QingStor Access Key ID
+      --qingstor-chunk-size SizeSuffix                           Chunk size to use for uploading. (default 4M)
+      --qingstor-connection-retries int                          Number of connection retries. (default 3)
+      --qingstor-encoding MultiEncoder                           This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8)
+      --qingstor-endpoint string                                 Enter an endpoint URL to connection QingStor API.
+      --qingstor-env-auth                                        Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.
+      --qingstor-secret-access-key string                        QingStor Secret Access Key (password)
+      --qingstor-upload-concurrency int                          Concurrency for multipart uploads. (default 1)
+      --qingstor-upload-cutoff SizeSuffix                        Cutoff for switching to chunked upload (default 200M)
+      --qingstor-zone string                                     Zone to connect to.
+      --s3-access-key-id string                                  AWS Access Key ID.
+      --s3-acl string                                            Canned ACL used when creating buckets and storing or copying objects.
+      --s3-bucket-acl string                                     Canned ACL used when creating buckets.
+      --s3-chunk-size SizeSuffix                                 Chunk size to use for uploading. (default 5M)
+      --s3-copy-cutoff SizeSuffix                                Cutoff for switching to multipart copy (default 4.656G)
+      --s3-disable-checksum                                      Don't store MD5 checksum with object metadata
+      --s3-encoding MultiEncoder                                 This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
+      --s3-endpoint string                                       Endpoint for S3 API.
+      --s3-env-auth                                              Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+      --s3-force-path-style                                      If true use path style access if false use virtual hosted style. (default true)
+      --s3-leave-parts-on-error                                  If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
+      --s3-list-chunk int                                        Size of listing chunk (response list for each ListObject S3 request). (default 1000)
+      --s3-location-constraint string                            Location constraint - must be set to match the Region.
+      --s3-max-upload-parts int                                  Maximum number of parts in a multipart upload. (default 10000)
+      --s3-memory-pool-flush-time Duration                       How often internal memory buffer pools will be flushed. (default 1m0s)
+      --s3-memory-pool-use-mmap                                  Whether to use mmap buffers in internal memory pool.
+      --s3-no-check-bucket                                       If set don't attempt to check the bucket exists or create it
+      --s3-profile string                                        Profile to use in the shared credentials file
+      --s3-provider string                                       Choose your S3 provider.
+      --s3-region string                                         Region to connect to.
+      --s3-secret-access-key string                              AWS Secret Access Key (password)
+      --s3-server-side-encryption string                         The server-side encryption algorithm used when storing this object in S3.
+      --s3-session-token string                                  An AWS session token
+      --s3-shared-credentials-file string                        Path to the shared credentials file
+      --s3-sse-customer-algorithm string                         If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
+      --s3-sse-customer-key string                               If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
+      --s3-sse-customer-key-md5 string                           If using SSE-C you must provide the secret encryption key MD5 checksum.
+      --s3-sse-kms-key-id string                                 If using KMS ID you must provide the ARN of Key.
+      --s3-storage-class string                                  The storage class to use when storing new objects in S3.
+      --s3-upload-concurrency int                                Concurrency for multipart uploads. (default 4)
+      --s3-upload-cutoff SizeSuffix                              Cutoff for switching to chunked upload (default 200M)
+      --s3-use-accelerate-endpoint                               If true use the AWS S3 accelerated endpoint.
+      --s3-v2-auth                                               If true use v2 authentication.
+      --seafile-2fa                                              Two-factor authentication ('true' if the account has 2FA enabled)
+      --seafile-create-library                                   Should rclone create a library if it doesn't exist
+      --seafile-encoding MultiEncoder                            This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
+      --seafile-library string                                   Name of the library. Leave blank to access all non-encrypted libraries.
+      --seafile-library-key string                               Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
+      --seafile-pass string                                      Password (obscured)
+      --seafile-url string                                       URL of seafile host to connect to
+      --seafile-user string                                      User name (usually email address)
+      --sftp-ask-password                                        Allow asking for SFTP password when needed.
+      --sftp-disable-hashcheck                                   Disable the execution of SSH commands to determine if remote file hashing is available.
+      --sftp-host string                                         SSH host to connect to
+      --sftp-key-file string                                     Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
+      --sftp-key-file-pass string                                The passphrase to decrypt the PEM-encoded private key file. (obscured)
+      --sftp-key-pem string                                      Raw PEM-encoded private key, If specified, will override key_file parameter.
+      --sftp-key-use-agent                                       When set forces the usage of the ssh-agent.
+      --sftp-md5sum-command string                               The command used to read md5 hashes. Leave blank for autodetect.
+      --sftp-pass string                                         SSH password, leave blank to use ssh-agent. (obscured)
+      --sftp-path-override string                                Override path used by SSH connection.
+      --sftp-port string                                         SSH port, leave blank to use default (22)
+      --sftp-server-command string                               Specifies the path or command to run a sftp server on the remote host.
+      --sftp-set-modtime                                         Set the modified time on the remote if set. (default true)
+      --sftp-sha1sum-command string                              The command used to read sha1 hashes. Leave blank for autodetect.
+      --sftp-skip-links                                          Set to skip any symlinks and any other non regular files.
+      --sftp-subsystem string                                    Specifies the SSH2 subsystem on the remote host. (default "sftp")
+      --sftp-use-insecure-cipher                                 Enable the use of insecure ciphers and key exchange methods.
+      --sftp-user string                                         SSH username, leave blank for current username, ncw
+      --sharefile-chunk-size SizeSuffix                          Upload chunk size. Must a power of 2 >= 256k. (default 64M)
+      --sharefile-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
+      --sharefile-endpoint string                                Endpoint for API calls.
+      --sharefile-root-folder-id string                          ID of the root folder
+      --sharefile-upload-cutoff SizeSuffix                       Cutoff for switching to multipart upload. (default 128M)
+      --skip-links                                               Don't warn about skipped symlinks.
+      --sugarsync-access-key-id string                           Sugarsync Access Key ID.
+      --sugarsync-app-id string                                  Sugarsync App ID.
+      --sugarsync-authorization string                           Sugarsync authorization
+      --sugarsync-authorization-expiry string                    Sugarsync authorization expiry
+      --sugarsync-deleted-id string                              Sugarsync deleted folder id
+      --sugarsync-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot)
+      --sugarsync-hard-delete                                    Permanently delete files if true
+      --sugarsync-private-access-key string                      Sugarsync Private Access Key
+      --sugarsync-refresh-token string                           Sugarsync refresh token
+      --sugarsync-root-id string                                 Sugarsync root id
+      --sugarsync-user string                                    Sugarsync user
+      --swift-application-credential-id string                   Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
+      --swift-application-credential-name string                 Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)
+      --swift-application-credential-secret string               Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
+      --swift-auth string                                        Authentication URL for server (OS_AUTH_URL).
+      --swift-auth-token string                                  Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
+      --swift-auth-version int                                   AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
+      --swift-chunk-size SizeSuffix                              Above this size files will be chunked into a _segments container. (default 5G)
+      --swift-domain string                                      User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
+      --swift-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,InvalidUtf8)
+      --swift-endpoint-type string                               Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public")
+      --swift-env-auth                                           Get swift credentials from environment variables in standard OpenStack form.
+      --swift-key string                                         API key or password (OS_PASSWORD).
+      --swift-no-chunk                                           Don't chunk files during streaming upload.
+      --swift-region string                                      Region name - optional (OS_REGION_NAME)
+      --swift-storage-policy string                              The storage policy to use when creating a new container
+      --swift-storage-url string                                 Storage URL - optional (OS_STORAGE_URL)
+      --swift-tenant string                                      Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
+      --swift-tenant-domain string                               Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
+      --swift-tenant-id string                                   Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
+      --swift-user string                                        User name to log in (OS_USERNAME).
+      --swift-user-id string                                     User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).
+      --tardigrade-access-grant string                           Access Grant.
+      --tardigrade-api-key string                                API Key.
+      --tardigrade-passphrase string                             Encryption Passphrase. To access existing objects enter passphrase used for uploading.
+      --tardigrade-provider string                               Choose an authentication method. (default "existing")
+      --tardigrade-satellite-address <nodeid>@<address>:<port>   Satellite Address. Custom satellite address should match the format: <nodeid>@<address>:<port>. (default "us-central-1.tardigrade.io")
+      --union-action-policy string                               Policy to choose upstream on ACTION category. (default "epall")
+      --union-cache-time int                                     Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120)
+      --union-create-policy string                               Policy to choose upstream on CREATE category. (default "epmfs")
+      --union-search-policy string                               Policy to choose upstream on SEARCH category. (default "ff")
+      --union-upstreams string                                   List of space separated upstreams.
+      --webdav-bearer-token string                               Bearer token instead of user/pass (eg a Macaroon)
+      --webdav-bearer-token-command string                       Command to run to get a bearer token
+      --webdav-pass string                                       Password. (obscured)
+      --webdav-url string                                        URL of http host to connect to
+      --webdav-user string                                       User name
+      --webdav-vendor string                                     Name of the Webdav site/service/software you are using
+      --yandex-auth-url string                                   Auth server URL.
+      --yandex-client-id string                                  OAuth Client Id
+      --yandex-client-secret string                              OAuth Client Secret
+      --yandex-encoding MultiEncoder                             This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot)
+      --yandex-token string                                      OAuth Access Token as a JSON blob.
+      --yandex-token-url string                                  Token server url.
    
+
    1Fichier
    
+
    This is a backend for the 1fichier cloud storage service. Note that a Premium subscription is required to use the API.
    
+
    Paths are specified as remote:path
    
+
    Paths may be as deep as required, eg remote:directory/subdirectory.
    
+
    The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+XX / 1Fichier
+   \ "fichier"
+[snip]
+Storage> fichier
+** See help for fichier backend at: https://rclone.org/fichier/ **
 
 Your API Key, get it from https://1fichier.com/console/params.pl
+Enter a string value. Press Enter for the default ("").
+api_key> example_key
 
-- Config:      api_key
-- Env Var:     RCLONE_FICHIER_API_KEY
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to fichier (1Fichier).
-
-#### --fichier-shared-folder
-
-If you want to download a shared folder, add this parameter
-
-- Config:      shared_folder
-- Env Var:     RCLONE_FICHIER_SHARED_FOLDER
-- Type:        string
-- Default:     ""
-
-#### --fichier-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_FICHIER_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
-
-
-
- Alias
------------------------------------------
-
-The `alias` remote provides a new name for another remote.
-
-Paths may be as deep as required or a local path, 
-eg `remote:directory/subdirectory` or `/directory/subdirectory`.
-
-During the initial setup with `rclone config` you will specify the target
-remote. The target remote can either be a local path or another remote.
-
-Subfolders can be used in target remote. Assume an alias remote named `backup`
-with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop`
-is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`.
-
-There will be no special handling of paths containing `..` segments.
-Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking
-`rclone mkdir mydrive:private/backup/../desktop`.
-The empty path is not allowed as a remote. To alias the current directory
-use `.` instead.
-
-Here is an example of how to make an alias called `remote` for local folder.
-First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Alias for an existing remote  "alias" [snip] Storage> alias Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". remote> /mnt/storage/backup Remote config -------------------- [remote] remote = /mnt/storage/backup -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes:
    
-
    Name Type ==== ==== remote alias
    
-
      
-
    1. Edit existing remote
      2. 
-
    2. New remote
      3. 
-
    3. Delete remote
      4. 
-
    4. Rename remote
      5. 
-
    5. Copy remote
      6. 
-
    6. Set configuration password
      7. 
-
    7. Quit config e/n/d/r/c/s/q> q
      8. 
-
    
-
    
-Once configured you can then use `rclone` like this,
-
-List directories in top level in `/mnt/storage/backup`
-
-    rclone lsd remote:
-
-List all the files in `/mnt/storage/backup`
-
-    rclone ls remote:
-
-Copy another local directory to the alias directory called source
-
-    rclone copy /home/source remote:source
-
-
-### Standard Options
-
-Here are the standard options specific to alias (Alias for an existing remote).
-
-#### --alias-remote
-
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> 
+Remote config
+--------------------
+[remote]
+type = fichier
+api_key = example_key
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your 1Fichier account
    
+
    rclone lsd remote:
    
+
    List all the files in your 1Fichier account
    
+
    rclone ls remote:
    
+
    To copy a local directory to a 1Fichier directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Modified time and hashes
    
+
    1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
    
+
    Duplicated files
    
+
    1Fichier can have two files with exactly the same name and path (unlike a normal file system).
    
+
    Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    \0x5C＼
    <0x3C＜
    >0x3E＞
    "0x22＂
    $0x24＄
    `0x60｀
    '0x27＇
    
+
    File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Standard Options
    
+
    Here are the standard options specific to fichier (1Fichier).
    
+
    --fichier-api-key
    
+
    Your API Key, get it from https://1fichier.com/console/params.pl
    
+
      
+
    • Config: api_key
      • 
+
    • Env Var: RCLONE_FICHIER_API_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to fichier (1Fichier).
    
+
    --fichier-shared-folder
    
+
    If you want to download a shared folder, add this parameter
    
+
      
+
    • Config: shared_folder
      • 
+
    • Env Var: RCLONE_FICHIER_SHARED_FOLDER
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --fichier-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_FICHIER_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
      • 
+
    
+
    Alias
    
+
    The alias remote provides a new name for another remote.
    
+
    Paths may be as deep as required or a local path, eg remote:directory/subdirectory or /directory/subdirectory.
    
+
    During the initial setup with rclone config you will specify the target remote. The target remote can either be a local path or another remote.
    
+
    Subfolders can be used in target remote. Assume an alias remote named backup with the target mydrive:private/backup. Invoking rclone mkdir backup:desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/desktop.
    
+
    There will be no special handling of paths containing .. segments. Invoking rclone mkdir backup:../desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/../desktop. The empty path is not allowed as a remote. To alias the current directory use . instead.
    
+
    Here is an example of how to make an alias called remote for local folder. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Alias for an existing remote
+   \ "alias"
+[snip]
+Storage> alias
 Remote or path to alias.
 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
-
-- Config:      remote
-- Env Var:     RCLONE_ALIAS_REMOTE
-- Type:        string
-- Default:     ""
-
-
-
- Amazon Drive
------------------------------------------
-
-Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage
-service run by Amazon for consumers.
-
-## Status
-
-**Important:** rclone supports Amazon Drive only if you have your own
-set of API keys. Unfortunately the [Amazon Drive developer
-program](https://developer.amazon.com/amazon-drive) is now closed to
-new entries so if you don't already have your own set of keys you will
-not be able to use rclone with Amazon Drive.
-
-For the history on why rclone no longer has a set of Amazon Drive API
-keys see [the forum](https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314).
-
-If you happen to know anyone who works at Amazon then please ask them
-to re-instate rclone into the Amazon Drive developer program - thanks!
-
-## Setup
-
-The initial setup for Amazon Drive involves getting a token from
-Amazon which you need to do in your browser.  `rclone config` walks
-you through it.
-
-The configuration process for Amazon Drive may involve using an [oauth
-proxy](https://github.com/ncw/oauthproxy). This is used to keep the
-Amazon credentials out of the source code.  The proxy runs in Google's
-very secure App Engine environment and doesn't store any credentials
-which pass through it.
-
-Since rclone doesn't currently have its own Amazon Drive credentials
-so you will either need to have your own `client_id` and
-`client_secret` with Amazon Drive, or use a third party oauth proxy
-in which case you will need to enter `client_id`, `client_secret`,
-`auth_url` and `token_url`.
-
-Note also if you are not using Amazon's `auth_url` and `token_url`,
-(ie you filled in something for those) then if setting up on a remote
-machine you can only use the [copying the config method of
-configuration](https://rclone.org/remote_setup/#configuring-by-copying-the-config-file)
-- `rclone authorize` will not work.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon Drive  "amazon cloud drive" [snip] Storage> amazon cloud drive Amazon Application Client Id - required. client_id> your client ID goes here Amazon Application Client Secret - required. client_secret> your client secret goes here Auth server URL - leave blank to use Amazon's. auth_url> Optional auth URL Token server url - leave blank to use Amazon's. token_url> Optional token URL Remote config Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] client_id = your client ID goes here client_secret = your client secret goes here auth_url = Optional auth URL token_url = Optional token URL token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
-machine with no Internet browser available.
-
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Amazon. This only runs from the moment it
-opens your browser to the moment you get back the verification
-code.  This is on `http://127.0.0.1:53682/` and this it may require
-you to unblock it temporarily if you are running a host firewall.
-
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your Amazon Drive
-
-    rclone lsd remote:
-
-List all the files in your Amazon Drive
-
-    rclone ls remote:
-
-To copy a local directory to an Amazon Drive directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Modified time and MD5SUMs ###
-
-Amazon Drive doesn't allow modification times to be changed via
-the API so these won't be accurate or used for syncing.
-
-It does store MD5SUMs so for a more accurate sync, you can use the
-`--checksum` flag.
-
-#### Restricted filename characters
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| /         | 0x2F  | ／          |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-### Deleting files ###
-
-Any files you delete with rclone will end up in the trash.  Amazon
-don't provide an API to permanently delete files, nor to empty the
-trash, so you will have to do that with one of Amazon's apps or via
-the Amazon Drive website. As of November 17, 2016, files are 
-automatically deleted by Amazon from the trash after 30 days.
-
-### Using with non `.com` Amazon accounts ###
-
-Let's say you usually use `amazon.co.uk`. When you authenticate with
-rclone it will take you to an `amazon.com` page to log in.  Your
-`amazon.co.uk` email and password should work here just fine.
-
-
-### Standard Options
-
-Here are the standard options specific to amazon cloud drive (Amazon Drive).
-
-#### --acd-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_ACD_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --acd-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_ACD_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to amazon cloud drive (Amazon Drive).
-
-#### --acd-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_ACD_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --acd-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_ACD_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --acd-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_ACD_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --acd-checkpoint
-
-Checkpoint for internal polling (debug).
-
-- Config:      checkpoint
-- Env Var:     RCLONE_ACD_CHECKPOINT
-- Type:        string
-- Default:     ""
-
-#### --acd-upload-wait-per-gb
-
-Additional time per GB to wait after a failed complete upload to see if it appears.
-
-Sometimes Amazon Drive gives an error when a file has been fully
-uploaded but the file appears anyway after a little while.  This
-happens sometimes for files over 1GB in size and nearly every time for
-files bigger than 10GB. This parameter controls the time rclone waits
-for the file to appear.
-
-The default value for this parameter is 3 minutes per GB, so by
-default it will wait 3 minutes for every GB uploaded to see if the
-file appears.
-
-You can disable this feature by setting it to 0. This may cause
-conflict errors as rclone retries the failed upload but the file will
-most likely appear correctly eventually.
-
-These values were determined empirically by observing lots of uploads
-of big files for a range of file sizes.
-
-Upload with the "-v" flag to see more info about what rclone is doing
-in this situation.
-
-- Config:      upload_wait_per_gb
-- Env Var:     RCLONE_ACD_UPLOAD_WAIT_PER_GB
-- Type:        Duration
-- Default:     3m0s
-
-#### --acd-templink-threshold
-
-Files >= this size will be downloaded via their tempLink.
-
-Files this size or more will be downloaded via their "tempLink". This
-is to work around a problem with Amazon Drive which blocks downloads
-of files bigger than about 10GB.  The default for this is 9GB which
-shouldn't need to be changed.
-
-To download files above this threshold, rclone requests a "tempLink"
-which downloads the file through a temporary URL directly from the
-underlying S3 storage.
-
-- Config:      templink_threshold
-- Env Var:     RCLONE_ACD_TEMPLINK_THRESHOLD
-- Type:        SizeSuffix
-- Default:     9G
-
-#### --acd-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_ACD_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,InvalidUtf8,Dot
-
-
-
-### Limitations ###
-
-Note that Amazon Drive is case insensitive so you can't have a
-file called "Hello.doc" and one called "hello.doc".
-
-Amazon Drive has rate limiting so you may notice errors in the
-sync (429 errors).  rclone will automatically retry the sync up to 3
-times by default (see `--retries` flag) which should hopefully work
-around this problem.
-
-Amazon Drive has an internal limit of file sizes that can be uploaded
-to the service. This limit is not officially published, but all files
-larger than this will fail.
-
-At the time of writing (Jan 2016) is in the area of 50GB per file.
-This means that larger files are likely to fail.
-
-Unfortunately there is no way for rclone to see that this failure is
-because of file size, so it will retry the operation, as any other
-failure. To avoid this problem, use `--max-size 50000M` option to limit
-the maximum size of uploaded files. Note that `--max-size` does not split
-files into segments, it only ignores files over this size.
-
- Amazon S3 Storage Providers
---------------------------------------------------------
-
-The S3 backend can be used with a number of different providers:
-
-
-- AWS S3
-- Alibaba Cloud (Aliyun) Object Storage System (OSS)
-- Ceph
-- DigitalOcean Spaces
-- Dreamhost
-- IBM COS S3
-- Minio
-- Scaleway
-- StackPath
-- Wasabi
-
-
-Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
-command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
-
-Once you have made a remote (see the provider specific section above)
-you can use it like this:
-
-See all buckets
-
-    rclone lsd remote:
-
-Make a new bucket
-
-    rclone mkdir remote:bucket
-
-List the contents of a bucket
-
-    rclone ls remote:bucket
-
-Sync `/home/local/directory` to the remote bucket, deleting any excess
-files in the bucket.
-
-    rclone sync -i /home/local/directory remote:bucket
-
-## AWS S3 {#amazon-s3}
-
-Here is an example of making an s3 configuration.  First run
-
-    rclone config
-
-This will guide you through an interactive setup process.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio)  "s3" [snip] Storage> s3 Choose your S3 provider. Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3  "AWS" 2 / Ceph Object Storage  "Ceph" 3 / Digital Ocean Spaces  "DigitalOcean" 4 / Dreamhost DreamObjects  "Dreamhost" 5 / IBM COS S3  "IBMCOS" 6 / Minio Object Storage  "Minio" 7 / Wasabi Object Storage  "Wasabi" 8 / Any other S3 compatible provider  "Other" provider> 1 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step  "false" 2 / Get AWS credentials from the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> XXX AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> YYY Region to connect to. Choose a number from below, or type in your own value / The default endpoint - a good choice if you are unsure. 1 | US Region, Northern Virginia or Pacific Northwest. | Leave location constraint empty.  "us-east-1" / US East (Ohio) Region 2 | Needs location constraint us-east-2.  "us-east-2" / US West (Oregon) Region 3 | Needs location constraint us-west-2.  "us-west-2" / US West (Northern California) Region 4 | Needs location constraint us-west-1.  "us-west-1" / Canada (Central) Region 5 | Needs location constraint ca-central-1.  "ca-central-1" / EU (Ireland) Region 6 | Needs location constraint EU or eu-west-1.  "eu-west-1" / EU (London) Region 7 | Needs location constraint eu-west-2.  "eu-west-2" / EU (Frankfurt) Region 8 | Needs location constraint eu-central-1.  "eu-central-1" / Asia Pacific (Singapore) Region 9 | Needs location constraint ap-southeast-1.  "ap-southeast-1" / Asia Pacific (Sydney) Region 10 | Needs location constraint ap-southeast-2.  "ap-southeast-2" / Asia Pacific (Tokyo) Region 11 | Needs location constraint ap-northeast-1.  "ap-northeast-1" / Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2.  "ap-northeast-2" / Asia Pacific (Mumbai) 13 | Needs location constraint ap-south-1.  "ap-south-1" / Asia Patific (Hong Kong) Region 14 | Needs location constraint ap-east-1.  "ap-east-1" / South America (Sao Paulo) Region 15 | Needs location constraint sa-east-1.  "sa-east-1" region> 1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. endpoint> Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value 1 / Empty for US Region, Northern Virginia or Pacific Northwest.  "" 2 / US East (Ohio) Region.  "us-east-2" 3 / US West (Oregon) Region.  "us-west-2" 4 / US West (Northern California) Region.  "us-west-1" 5 / Canada (Central) Region.  "ca-central-1" 6 / EU (Ireland) Region.  "eu-west-1" 7 / EU (London) Region.  "eu-west-2" 8 / EU Region.  "EU" 9 / Asia Pacific (Singapore) Region.  "ap-southeast-1" 10 / Asia Pacific (Sydney) Region.  "ap-southeast-2" 11 / Asia Pacific (Tokyo) Region.  "ap-northeast-1" 12 / Asia Pacific (Seoul)  "ap-northeast-2" 13 / Asia Pacific (Mumbai)  "ap-south-1" 14 / Asia Pacific (Hong Kong)  "ap-east-1" 15 / South America (Sao Paulo) Region.  "sa-east-1" location_constraint> 1 Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default).  "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.  "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 3 | Granting this on a bucket is generally not recommended.  "public-read-write" 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.  "authenticated-read" / Object owner gets FULL_CONTROL. Bucket owner gets READ access. 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.  "bucket-owner-read" / Both the object owner and the bucket owner get FULL_CONTROL over the object. 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.  "bucket-owner-full-control" acl> 1 The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value 1 / None  "" 2 / AES256  "AES256" server_side_encryption> 1 The storage class to use when storing objects in S3. Choose a number from below, or type in your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 / Reduced redundancy storage class  "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access storage class  "STANDARD_IA" 5 / One Zone Infrequent Access storage class  "ONEZONE_IA" 6 / Glacier storage class  "GLACIER" 7 / Glacier Deep Archive storage class  "DEEP_ARCHIVE" 8 / Intelligent-Tiering storage class  "INTELLIGENT_TIERING" storage_class> 1 Remote config -------------------- [remote] type = s3 provider = AWS env_auth = false access_key_id = XXX secret_access_key = YYY region = us-east-1 endpoint = location_constraint = acl = private server_side_encryption = storage_class = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d>
    
-
    
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-### --update and --use-server-modtime ###
-
-As noted below, the modified time is stored on metadata on the object. It is
-used by default for all operations that require checking the time a file was
-last updated. It allows rclone to treat the remote more like a true filesystem,
-but it is inefficient because it requires an extra API call to retrieve the
-metadata.
-
-For many operations, the time the object was last uploaded to the remote is
-sufficient to determine if it is "dirty". By using `--update` along with
-`--use-server-modtime`, you can avoid the extra API call and simply upload
-files whose local modtime is newer than the time it was last uploaded.
-
-### Modified time ###
-
-The modified time is stored as metadata on the object as
-`X-Amz-Meta-Mtime` as floating point since the epoch accurate to 1 ns.
-
-If the modification time needs to be updated rclone will attempt to perform a server
-side copy to update the modification if the object can be copied in a single part.
-In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive
-storage the object will be uploaded rather than copied.
-
-### Cleanup ###
-
-If you run `rclone cleanup s3:bucket` then it will remove all pending
-multipart uploads older than 24 hours. You can use the `-i` flag to
-see exactly what it will do. If you want more control over the expiry
-date then run `rclone backend cleanup s3:bucket -o max-age=1h` to
-expire all uploads older than one hour. You can use `rclone backend
-list-multipart-uploads s3:bucket` to see the pending multipart
-uploads.
-
-#### Restricted filename characters
-
-S3 allows any valid UTF-8 string as a key.
-
-Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), as
-they can't be used in XML.
-
-The following characters are replaced since these are problematic when
-dealing with the REST API:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| /         | 0x2F  | ／           |
-
-The encoding will also encode these file names as they don't seem to
-work with the SDK properly:
-
-| File name | Replacement |
-| --------- |:-----------:|
-| .         | ．          |
-| ..        | ．．         |
-
-### Multipart uploads ###
-
-rclone supports multipart uploads with S3 which means that it can
-upload files bigger than 5GB.
-
-Note that files uploaded *both* with multipart upload *and* through
-crypt remotes do not have MD5 sums.
-
-rclone switches from single part uploads to multipart uploads at the
-point specified by `--s3-upload-cutoff`.  This can be a maximum of 5GB
-and a minimum of 0 (ie always upload multipart files).
-
-The chunk sizes used in the multipart upload are specified by
-`--s3-chunk-size` and the number of chunks uploaded concurrently is
-specified by `--s3-upload-concurrency`.
-
-Multipart uploads will use `--transfers` * `--s3-upload-concurrency` *
-`--s3-chunk-size` extra memory.  Single part uploads to not use extra
-memory.
-
-Single part transfers can be faster than multipart transfers or slower
-depending on your latency from S3 - the more latency, the more likely
-single part transfers will be faster.
-
-Increasing `--s3-upload-concurrency` will increase throughput (8 would
-be a sensible value) and increasing `--s3-chunk-size` also increases
-throughput (16M would be sensible).  Increasing either of these will
-use more memory.  The default values are high enough to gain most of
-the possible performance without using too much memory.
-
-
-### Buckets and Regions ###
-
-With Amazon S3 you can list buckets (`rclone lsd`) using any region,
-but you can only access the content of a bucket from the region it was
-created in.  If you attempt to access a bucket from the wrong region,
-you will get an error, `incorrect region, the bucket is not in 'XXX'
-region`.
-
-### Authentication ###
-
-There are a number of ways to supply `rclone` with a set of AWS
-credentials, with and without using the environment.
-
-The different authentication methods are tried in this order:
-
- - Directly in the rclone configuration file (`env_auth = false` in the config file):
-   - `access_key_id` and `secret_access_key` are required.
-   - `session_token` can be optionally set when using AWS STS.
- - Runtime configuration (`env_auth = true` in the config file):
-   - Export the following environment variables before running `rclone`:
-     - Access Key ID: `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY`
-     - Secret Access Key: `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY`
-     - Session Token: `AWS_SESSION_TOKEN` (optional)
-   - Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html):
-     - Profile files are standard files used by AWS CLI tools
-     - By default it will use the profile in your home directory (eg `~/.aws/credentials` on unix based systems) file and the "default" profile, to change set these environment variables:
-         - `AWS_SHARED_CREDENTIALS_FILE` to control which file.
-         - `AWS_PROFILE` to control which profile to use.
-   - Or, run `rclone` in an ECS task with an IAM role (AWS only).
-   - Or, run `rclone` on an EC2 instance with an IAM role (AWS only).
-   - Or, run `rclone` in an EKS pod with an IAM role that is associated with a service account (AWS only).
-
-If none of these option actually end up providing `rclone` with AWS
-credentials then S3 interaction will be non-authenticated (see below).
-
-### S3 Permissions ###
-
-When using the `sync` subcommand of `rclone` the following minimum
-permissions are required to be available on the bucket being written to:
-
-* `ListBucket`
-* `DeleteObject`
-* `GetObject`
-* `PutObject`
-* `PutObjectACL`
-
-When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required.
-
-Example policy:
-
    
-
    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" }, "Action": [ "s3:ListBucket", "s3:DeleteObject", "s3:GetObject", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": [ "arn:aws:s3:::BUCKET_NAME/*", "arn:aws:s3:::BUCKET_NAME" ] }, { "Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": "arn:aws:s3:::*" }
    
-] }
    
-
    
-Notes on above:
-
-1. This is a policy that can be used when creating bucket. It assumes
-   that `USER_NAME` has been created.
-2. The Resource entry must include both resource ARNs, as one implies
-   the bucket and the other implies the bucket's objects.
-
-For reference, [here's an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b)
-that will generate one or more buckets that will work with `rclone sync`.
-
-### Key Management System (KMS) ###
-
-If you are using server side encryption with KMS then you will find
-you can't transfer small objects.  As a work-around you can use the
-`--ignore-checksum` flag.
-
-A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824).
-
-### Glacier and Glacier Deep Archive ###
-
-You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html).
-The bucket can still be synced or copied into normally, but if rclone
-tries to access data from the glacier storage class you will see an error like below.
-
-    2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file
-
-In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html)
-the object(s) in question before using rclone.
-
-Note that rclone only speaks the S3 API it does not speak the Glacier
-Vault API, so rclone cannot directly access Glacier Vaults.
-
-
-### Standard Options
-
-Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).
-
-#### --s3-provider
-
+remote> /mnt/storage/backup
+Remote config
+--------------------
+[remote]
+remote = /mnt/storage/backup
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+Current remotes:
+
+Name                 Type
+====                 ====
+remote               alias
+
+e) Edit existing remote
+n) New remote
+d) Delete remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+e/n/d/r/c/s/q> q
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level in /mnt/storage/backup
    
+
    rclone lsd remote:
    
+
    List all the files in /mnt/storage/backup
    
+
    rclone ls remote:
    
+
    Copy another local directory to the alias directory called source
    
+
    rclone copy /home/source remote:source
    
+
    Standard Options
    
+
    Here are the standard options specific to alias (Alias for an existing remote).
    
+
    --alias-remote
    
+
    Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_ALIAS_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Amazon Drive
    
+
    Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers.
    
+
    Status
    
+
    Important: rclone supports Amazon Drive only if you have your own set of API keys. Unfortunately the Amazon Drive developer program is now closed to new entries so if you don't already have your own set of keys you will not be able to use rclone with Amazon Drive.
    
+
    For the history on why rclone no longer has a set of Amazon Drive API keys see the forum.
    
+
    If you happen to know anyone who works at Amazon then please ask them to re-instate rclone into the Amazon Drive developer program - thanks!
    
+
    Setup
    
+
    The initial setup for Amazon Drive involves getting a token from Amazon which you need to do in your browser. rclone config walks you through it.
    
+
    The configuration process for Amazon Drive may involve using an oauth proxy. This is used to keep the Amazon credentials out of the source code. The proxy runs in Google's very secure App Engine environment and doesn't store any credentials which pass through it.
    
+
    Since rclone doesn't currently have its own Amazon Drive credentials so you will either need to have your own client_id and client_secret with Amazon Drive, or use a third party oauth proxy in which case you will need to enter client_id, client_secret, auth_url and token_url.
    
+
    Note also if you are not using Amazon's auth_url and token_url, (ie you filled in something for those) then if setting up on a remote machine you can only use the copying the config method of configuration - rclone authorize will not work.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon Drive
+   \ "amazon cloud drive"
+[snip]
+Storage> amazon cloud drive
+Amazon Application Client Id - required.
+client_id> your client ID goes here
+Amazon Application Client Secret - required.
+client_secret> your client secret goes here
+Auth server URL - leave blank to use Amazon's.
+auth_url> Optional auth URL
+Token server url - leave blank to use Amazon's.
+token_url> Optional token URL
+Remote config
+Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config.
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+client_id = your client ID goes here
+client_secret = your client secret goes here
+auth_url = Optional auth URL
+token_url = Optional token URL
+token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    See the remote setup docs for how to set it up on a machine with no Internet browser available.
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Amazon. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your Amazon Drive
    
+
    rclone lsd remote:
    
+
    List all the files in your Amazon Drive
    
+
    rclone ls remote:
    
+
    To copy a local directory to an Amazon Drive directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Modified time and MD5SUMs
    
+
    Amazon Drive doesn't allow modification times to be changed via the API so these won't be accurate or used for syncing.
    
+
    It does store MD5SUMs so for a more accurate sync, you can use the --checksum flag.
    
+
    Restricted filename characters
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Deleting files
    
+
    Any files you delete with rclone will end up in the trash. Amazon don't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Amazon's apps or via the Amazon Drive website. As of November 17, 2016, files are automatically deleted by Amazon from the trash after 30 days.
    
+
    Using with non .com Amazon accounts
    
+
    Let's say you usually use amazon.co.uk. When you authenticate with rclone it will take you to an amazon.com page to log in. Your amazon.co.uk email and password should work here just fine.
    
+
    Standard Options
    
+
    Here are the standard options specific to amazon cloud drive (Amazon Drive).
    
+
    --acd-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_ACD_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_ACD_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to amazon cloud drive (Amazon Drive).
    
+
    --acd-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_ACD_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_ACD_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_ACD_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-checkpoint
    
+
    Checkpoint for internal polling (debug).
    
+
      
+
    • Config: checkpoint
      • 
+
    • Env Var: RCLONE_ACD_CHECKPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-upload-wait-per-gb
    
+
    Additional time per GB to wait after a failed complete upload to see if it appears.
    
+
    Sometimes Amazon Drive gives an error when a file has been fully uploaded but the file appears anyway after a little while. This happens sometimes for files over 1GB in size and nearly every time for files bigger than 10GB. This parameter controls the time rclone waits for the file to appear.
    
+
    The default value for this parameter is 3 minutes per GB, so by default it will wait 3 minutes for every GB uploaded to see if the file appears.
    
+
    You can disable this feature by setting it to 0. This may cause conflict errors as rclone retries the failed upload but the file will most likely appear correctly eventually.
    
+
    These values were determined empirically by observing lots of uploads of big files for a range of file sizes.
    
+
    Upload with the "-v" flag to see more info about what rclone is doing in this situation.
    
+
      
+
    • Config: upload_wait_per_gb
      • 
+
    • Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB
      • 
+
    • Type: Duration
      • 
+
    • Default: 3m0s
      • 
+
    
+
+
    Files >= this size will be downloaded via their tempLink.
    
+
    Files this size or more will be downloaded via their "tempLink". This is to work around a problem with Amazon Drive which blocks downloads of files bigger than about 10GB. The default for this is 9GB which shouldn't need to be changed.
    
+
    To download files above this threshold, rclone requests a "tempLink" which downloads the file through a temporary URL directly from the underlying S3 storage.
    
+
      
+
    • Config: templink_threshold
      • 
+
    • Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 9G
      • 
+
    
+
    --acd-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_ACD_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    Note that Amazon Drive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    Amazon Drive has rate limiting so you may notice errors in the sync (429 errors). rclone will automatically retry the sync up to 3 times by default (see --retries flag) which should hopefully work around this problem.
    
+
    Amazon Drive has an internal limit of file sizes that can be uploaded to the service. This limit is not officially published, but all files larger than this will fail.
    
+
    At the time of writing (Jan 2016) is in the area of 50GB per file. This means that larger files are likely to fail.
    
+
    Unfortunately there is no way for rclone to see that this failure is because of file size, so it will retry the operation, as any other failure. To avoid this problem, use --max-size 50000M option to limit the maximum size of uploaded files. Note that --max-size does not split files into segments, it only ignores files over this size.
    
+
    Amazon S3 Storage Providers
    
+
    The S3 backend can be used with a number of different providers:
    
+
      
+
    • AWS S3
      • 
+
    • Alibaba Cloud (Aliyun) Object Storage System (OSS)
      • 
+
    • Ceph
      • 
+
    • DigitalOcean Spaces
      • 
+
    • Dreamhost
      • 
+
    • IBM COS S3
      • 
+
    • Minio
      • 
+
    • Scaleway
      • 
+
    • StackPath
      • 
+
    • Tencent Cloud Object Storage (COS)
      • 
+
    • Wasabi
      • 
+
    
+
    Paths are specified as remote:bucket (or remote: for the lsd command.) You may put subdirectories in too, eg remote:bucket/path/to/dir.
    
+
    Once you have made a remote (see the provider specific section above) you can use it like this:
    
+
    See all buckets
    
+
    rclone lsd remote:
    
+
    Make a new bucket
    
+
    rclone mkdir remote:bucket
    
+
    List the contents of a bucket
    
+
    rclone ls remote:bucket
    
+
    Sync /home/local/directory to the remote bucket, deleting any excess files in the bucket.
    
+
    rclone sync -i /home/local/directory remote:bucket
    
+
    AWS S3
    
+
    Here is an example of making an s3 configuration. First run
    
+
    rclone config
    
+
    This will guide you through an interactive setup process.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio)
+   \ "s3"
+[snip]
+Storage> s3
 Choose your S3 provider.
-
-- Config:      provider
-- Env Var:     RCLONE_S3_PROVIDER
-- Type:        string
-- Default:     ""
-- Examples:
-    - "AWS"
-        - Amazon Web Services (AWS) S3
-    - "Alibaba"
-        - Alibaba Cloud Object Storage System (OSS) formerly Aliyun
-    - "Ceph"
-        - Ceph Object Storage
-    - "DigitalOcean"
-        - Digital Ocean Spaces
-    - "Dreamhost"
-        - Dreamhost DreamObjects
-    - "IBMCOS"
-        - IBM COS S3
-    - "Minio"
-        - Minio Object Storage
-    - "Netease"
-        - Netease Object Storage (NOS)
-    - "Scaleway"
-        - Scaleway Object Storage
-    - "StackPath"
-        - StackPath Object Storage
-    - "Wasabi"
-        - Wasabi Object Storage
-    - "Other"
-        - Any other S3 compatible provider
-
-#### --s3-env-auth
-
-Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
-Only applies if access_key_id and secret_access_key is blank.
-
-- Config:      env_auth
-- Env Var:     RCLONE_S3_ENV_AUTH
-- Type:        bool
-- Default:     false
-- Examples:
-    - "false"
-        - Enter AWS credentials in the next step
-    - "true"
-        - Get AWS credentials from the environment (env vars or IAM)
-
-#### --s3-access-key-id
-
-AWS Access Key ID.
-Leave blank for anonymous access or runtime credentials.
-
-- Config:      access_key_id
-- Env Var:     RCLONE_S3_ACCESS_KEY_ID
-- Type:        string
-- Default:     ""
-
-#### --s3-secret-access-key
-
-AWS Secret Access Key (password)
-Leave blank for anonymous access or runtime credentials.
-
-- Config:      secret_access_key
-- Env Var:     RCLONE_S3_SECRET_ACCESS_KEY
-- Type:        string
-- Default:     ""
-
-#### --s3-region
-
+Choose a number from below, or type in your own value
+ 1 / Amazon Web Services (AWS) S3
+   \ "AWS"
+ 2 / Ceph Object Storage
+   \ "Ceph"
+ 3 / Digital Ocean Spaces
+   \ "DigitalOcean"
+ 4 / Dreamhost DreamObjects
+   \ "Dreamhost"
+ 5 / IBM COS S3
+   \ "IBMCOS"
+ 6 / Minio Object Storage
+   \ "Minio"
+ 7 / Wasabi Object Storage
+   \ "Wasabi"
+ 8 / Any other S3 compatible provider
+   \ "Other"
+provider> 1
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID - leave blank for anonymous access or runtime credentials.
+access_key_id> XXX
+AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
+secret_access_key> YYY
 Region to connect to.
-
-- Config:      region
-- Env Var:     RCLONE_S3_REGION
-- Type:        string
-- Default:     ""
-- Examples:
-    - "us-east-1"
-        - The default endpoint - a good choice if you are unsure.
-        - US Region, Northern Virginia or Pacific Northwest.
-        - Leave location constraint empty.
-    - "us-east-2"
-        - US East (Ohio) Region
-        - Needs location constraint us-east-2.
-    - "us-west-2"
-        - US West (Oregon) Region
-        - Needs location constraint us-west-2.
-    - "us-west-1"
-        - US West (Northern California) Region
-        - Needs location constraint us-west-1.
-    - "ca-central-1"
-        - Canada (Central) Region
-        - Needs location constraint ca-central-1.
-    - "eu-west-1"
-        - EU (Ireland) Region
-        - Needs location constraint EU or eu-west-1.
-    - "eu-west-2"
-        - EU (London) Region
-        - Needs location constraint eu-west-2.
-    - "eu-north-1"
-        - EU (Stockholm) Region
-        - Needs location constraint eu-north-1.
-    - "eu-central-1"
-        - EU (Frankfurt) Region
-        - Needs location constraint eu-central-1.
-    - "ap-southeast-1"
-        - Asia Pacific (Singapore) Region
-        - Needs location constraint ap-southeast-1.
-    - "ap-southeast-2"
-        - Asia Pacific (Sydney) Region
-        - Needs location constraint ap-southeast-2.
-    - "ap-northeast-1"
-        - Asia Pacific (Tokyo) Region
-        - Needs location constraint ap-northeast-1.
-    - "ap-northeast-2"
-        - Asia Pacific (Seoul)
-        - Needs location constraint ap-northeast-2.
-    - "ap-south-1"
-        - Asia Pacific (Mumbai)
-        - Needs location constraint ap-south-1.
-    - "ap-east-1"
-        - Asia Patific (Hong Kong) Region
-        - Needs location constraint ap-east-1.
-    - "sa-east-1"
-        - South America (Sao Paulo) Region
-        - Needs location constraint sa-east-1.
-
-#### --s3-region
-
-Region to connect to.
-
-- Config:      region
-- Env Var:     RCLONE_S3_REGION
-- Type:        string
-- Default:     ""
-- Examples:
-    - "nl-ams"
-        - Amsterdam, The Netherlands
-    - "fr-par"
-        - Paris, France
-
-#### --s3-region
-
-Region to connect to.
-Leave blank if you are using an S3 clone and you don't have a region.
-
-- Config:      region
-- Env Var:     RCLONE_S3_REGION
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Use this if unsure. Will use v4 signatures and an empty region.
-    - "other-v2-signature"
-        - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.
-
-#### --s3-endpoint
-
+Choose a number from below, or type in your own value
+   / The default endpoint - a good choice if you are unsure.
+ 1 | US Region, Northern Virginia or Pacific Northwest.
+   | Leave location constraint empty.
+   \ "us-east-1"
+   / US East (Ohio) Region
+ 2 | Needs location constraint us-east-2.
+   \ "us-east-2"
+   / US West (Oregon) Region
+ 3 | Needs location constraint us-west-2.
+   \ "us-west-2"
+   / US West (Northern California) Region
+ 4 | Needs location constraint us-west-1.
+   \ "us-west-1"
+   / Canada (Central) Region
+ 5 | Needs location constraint ca-central-1.
+   \ "ca-central-1"
+   / EU (Ireland) Region
+ 6 | Needs location constraint EU or eu-west-1.
+   \ "eu-west-1"
+   / EU (London) Region
+ 7 | Needs location constraint eu-west-2.
+   \ "eu-west-2"
+   / EU (Frankfurt) Region
+ 8 | Needs location constraint eu-central-1.
+   \ "eu-central-1"
+   / Asia Pacific (Singapore) Region
+ 9 | Needs location constraint ap-southeast-1.
+   \ "ap-southeast-1"
+   / Asia Pacific (Sydney) Region
+10 | Needs location constraint ap-southeast-2.
+   \ "ap-southeast-2"
+   / Asia Pacific (Tokyo) Region
+11 | Needs location constraint ap-northeast-1.
+   \ "ap-northeast-1"
+   / Asia Pacific (Seoul)
+12 | Needs location constraint ap-northeast-2.
+   \ "ap-northeast-2"
+   / Asia Pacific (Mumbai)
+13 | Needs location constraint ap-south-1.
+   \ "ap-south-1"
+   / Asia Patific (Hong Kong) Region
+14 | Needs location constraint ap-east-1.
+   \ "ap-east-1"
+   / South America (Sao Paulo) Region
+15 | Needs location constraint sa-east-1.
+   \ "sa-east-1"
+region> 1
 Endpoint for S3 API.
 Leave blank if using AWS to use the default endpoint for the region.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-
-#### --s3-endpoint
-
-Endpoint for IBM COS S3 API.
-Specify if using an IBM COS On Premise.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "s3.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Endpoint
-    - "s3.dal.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Dallas Endpoint
-    - "s3.wdc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Washington DC Endpoint
-    - "s3.sjc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region San Jose Endpoint
-    - "s3.private.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Private Endpoint
-    - "s3.private.dal.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Dallas Private Endpoint
-    - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Washington DC Private Endpoint
-    - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region San Jose Private Endpoint
-    - "s3.us-east.cloud-object-storage.appdomain.cloud"
-        - US Region East Endpoint
-    - "s3.private.us-east.cloud-object-storage.appdomain.cloud"
-        - US Region East Private Endpoint
-    - "s3.us-south.cloud-object-storage.appdomain.cloud"
-        - US Region South Endpoint
-    - "s3.private.us-south.cloud-object-storage.appdomain.cloud"
-        - US Region South Private Endpoint
-    - "s3.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Endpoint
-    - "s3.fra.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Frankfurt Endpoint
-    - "s3.mil.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Milan Endpoint
-    - "s3.ams.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Amsterdam Endpoint
-    - "s3.private.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Private Endpoint
-    - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Frankfurt Private Endpoint
-    - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Milan Private Endpoint
-    - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Amsterdam Private Endpoint
-    - "s3.eu-gb.cloud-object-storage.appdomain.cloud"
-        - Great Britain Endpoint
-    - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud"
-        - Great Britain Private Endpoint
-    - "s3.eu-de.cloud-object-storage.appdomain.cloud"
-        - EU Region DE Endpoint
-    - "s3.private.eu-de.cloud-object-storage.appdomain.cloud"
-        - EU Region DE Private Endpoint
-    - "s3.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Endpoint
-    - "s3.tok.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Tokyo Endpoint
-    - "s3.hkg.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional HongKong Endpoint
-    - "s3.seo.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Seoul Endpoint
-    - "s3.private.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Private Endpoint
-    - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Tokyo Private Endpoint
-    - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional HongKong Private Endpoint
-    - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Seoul Private Endpoint
-    - "s3.jp-tok.cloud-object-storage.appdomain.cloud"
-        - APAC Region Japan Endpoint
-    - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud"
-        - APAC Region Japan Private Endpoint
-    - "s3.au-syd.cloud-object-storage.appdomain.cloud"
-        - APAC Region Australia Endpoint
-    - "s3.private.au-syd.cloud-object-storage.appdomain.cloud"
-        - APAC Region Australia Private Endpoint
-    - "s3.ams03.cloud-object-storage.appdomain.cloud"
-        - Amsterdam Single Site Endpoint
-    - "s3.private.ams03.cloud-object-storage.appdomain.cloud"
-        - Amsterdam Single Site Private Endpoint
-    - "s3.che01.cloud-object-storage.appdomain.cloud"
-        - Chennai Single Site Endpoint
-    - "s3.private.che01.cloud-object-storage.appdomain.cloud"
-        - Chennai Single Site Private Endpoint
-    - "s3.mel01.cloud-object-storage.appdomain.cloud"
-        - Melbourne Single Site Endpoint
-    - "s3.private.mel01.cloud-object-storage.appdomain.cloud"
-        - Melbourne Single Site Private Endpoint
-    - "s3.osl01.cloud-object-storage.appdomain.cloud"
-        - Oslo Single Site Endpoint
-    - "s3.private.osl01.cloud-object-storage.appdomain.cloud"
-        - Oslo Single Site Private Endpoint
-    - "s3.tor01.cloud-object-storage.appdomain.cloud"
-        - Toronto Single Site Endpoint
-    - "s3.private.tor01.cloud-object-storage.appdomain.cloud"
-        - Toronto Single Site Private Endpoint
-    - "s3.seo01.cloud-object-storage.appdomain.cloud"
-        - Seoul Single Site Endpoint
-    - "s3.private.seo01.cloud-object-storage.appdomain.cloud"
-        - Seoul Single Site Private Endpoint
-    - "s3.mon01.cloud-object-storage.appdomain.cloud"
-        - Montreal Single Site Endpoint
-    - "s3.private.mon01.cloud-object-storage.appdomain.cloud"
-        - Montreal Single Site Private Endpoint
-    - "s3.mex01.cloud-object-storage.appdomain.cloud"
-        - Mexico Single Site Endpoint
-    - "s3.private.mex01.cloud-object-storage.appdomain.cloud"
-        - Mexico Single Site Private Endpoint
-    - "s3.sjc04.cloud-object-storage.appdomain.cloud"
-        - San Jose Single Site Endpoint
-    - "s3.private.sjc04.cloud-object-storage.appdomain.cloud"
-        - San Jose Single Site Private Endpoint
-    - "s3.mil01.cloud-object-storage.appdomain.cloud"
-        - Milan Single Site Endpoint
-    - "s3.private.mil01.cloud-object-storage.appdomain.cloud"
-        - Milan Single Site Private Endpoint
-    - "s3.hkg02.cloud-object-storage.appdomain.cloud"
-        - Hong Kong Single Site Endpoint
-    - "s3.private.hkg02.cloud-object-storage.appdomain.cloud"
-        - Hong Kong Single Site Private Endpoint
-    - "s3.par01.cloud-object-storage.appdomain.cloud"
-        - Paris Single Site Endpoint
-    - "s3.private.par01.cloud-object-storage.appdomain.cloud"
-        - Paris Single Site Private Endpoint
-    - "s3.sng01.cloud-object-storage.appdomain.cloud"
-        - Singapore Single Site Endpoint
-    - "s3.private.sng01.cloud-object-storage.appdomain.cloud"
-        - Singapore Single Site Private Endpoint
-
-#### --s3-endpoint
-
-Endpoint for OSS API.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "oss-cn-hangzhou.aliyuncs.com"
-        - East China 1 (Hangzhou)
-    - "oss-cn-shanghai.aliyuncs.com"
-        - East China 2 (Shanghai)
-    - "oss-cn-qingdao.aliyuncs.com"
-        - North China 1 (Qingdao)
-    - "oss-cn-beijing.aliyuncs.com"
-        - North China 2 (Beijing)
-    - "oss-cn-zhangjiakou.aliyuncs.com"
-        - North China 3 (Zhangjiakou)
-    - "oss-cn-huhehaote.aliyuncs.com"
-        - North China 5 (Huhehaote)
-    - "oss-cn-shenzhen.aliyuncs.com"
-        - South China 1 (Shenzhen)
-    - "oss-cn-hongkong.aliyuncs.com"
-        - Hong Kong (Hong Kong)
-    - "oss-us-west-1.aliyuncs.com"
-        - US West 1 (Silicon Valley)
-    - "oss-us-east-1.aliyuncs.com"
-        - US East 1 (Virginia)
-    - "oss-ap-southeast-1.aliyuncs.com"
-        - Southeast Asia Southeast 1 (Singapore)
-    - "oss-ap-southeast-2.aliyuncs.com"
-        - Asia Pacific Southeast 2 (Sydney)
-    - "oss-ap-southeast-3.aliyuncs.com"
-        - Southeast Asia Southeast 3 (Kuala Lumpur)
-    - "oss-ap-southeast-5.aliyuncs.com"
-        - Asia Pacific Southeast 5 (Jakarta)
-    - "oss-ap-northeast-1.aliyuncs.com"
-        - Asia Pacific Northeast 1 (Japan)
-    - "oss-ap-south-1.aliyuncs.com"
-        - Asia Pacific South 1 (Mumbai)
-    - "oss-eu-central-1.aliyuncs.com"
-        - Central Europe 1 (Frankfurt)
-    - "oss-eu-west-1.aliyuncs.com"
-        - West Europe (London)
-    - "oss-me-east-1.aliyuncs.com"
-        - Middle East 1 (Dubai)
-
-#### --s3-endpoint
-
-Endpoint for Scaleway Object Storage.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "s3.nl-ams.scw.cloud"
-        - Amsterdam Endpoint
-    - "s3.fr-par.scw.cloud"
-        - Paris Endpoint
-
-#### --s3-endpoint
-
-Endpoint for StackPath Object Storage.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "s3.us-east-2.stackpathstorage.com"
-        - US East Endpoint
-    - "s3.us-west-1.stackpathstorage.com"
-        - US West Endpoint
-    - "s3.eu-central-1.stackpathstorage.com"
-        - EU Endpoint
-
-#### --s3-endpoint
-
-Endpoint for S3 API.
-Required when using an S3 clone.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "objects-us-east-1.dream.io"
-        - Dream Objects endpoint
-    - "nyc3.digitaloceanspaces.com"
-        - Digital Ocean Spaces New York 3
-    - "ams3.digitaloceanspaces.com"
-        - Digital Ocean Spaces Amsterdam 3
-    - "sgp1.digitaloceanspaces.com"
-        - Digital Ocean Spaces Singapore 1
-    - "s3.wasabisys.com"
-        - Wasabi US East endpoint
-    - "s3.us-west-1.wasabisys.com"
-        - Wasabi US West endpoint
-    - "s3.eu-central-1.wasabisys.com"
-        - Wasabi EU Central endpoint
-
-#### --s3-location-constraint
-
-Location constraint - must be set to match the Region.
-Used when creating buckets only.
-
-- Config:      location_constraint
-- Env Var:     RCLONE_S3_LOCATION_CONSTRAINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Empty for US Region, Northern Virginia or Pacific Northwest.
-    - "us-east-2"
-        - US East (Ohio) Region.
-    - "us-west-2"
-        - US West (Oregon) Region.
-    - "us-west-1"
-        - US West (Northern California) Region.
-    - "ca-central-1"
-        - Canada (Central) Region.
-    - "eu-west-1"
-        - EU (Ireland) Region.
-    - "eu-west-2"
-        - EU (London) Region.
-    - "eu-north-1"
-        - EU (Stockholm) Region.
-    - "EU"
-        - EU Region.
-    - "ap-southeast-1"
-        - Asia Pacific (Singapore) Region.
-    - "ap-southeast-2"
-        - Asia Pacific (Sydney) Region.
-    - "ap-northeast-1"
-        - Asia Pacific (Tokyo) Region.
-    - "ap-northeast-2"
-        - Asia Pacific (Seoul)
-    - "ap-south-1"
-        - Asia Pacific (Mumbai)
-    - "ap-east-1"
-        - Asia Pacific (Hong Kong)
-    - "sa-east-1"
-        - South America (Sao Paulo) Region.
-
-#### --s3-location-constraint
-
-Location constraint - must match endpoint when using IBM Cloud Public.
-For on-prem COS, do not make a selection from this list, hit enter
-
-- Config:      location_constraint
-- Env Var:     RCLONE_S3_LOCATION_CONSTRAINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "us-standard"
-        - US Cross Region Standard
-    - "us-vault"
-        - US Cross Region Vault
-    - "us-cold"
-        - US Cross Region Cold
-    - "us-flex"
-        - US Cross Region Flex
-    - "us-east-standard"
-        - US East Region Standard
-    - "us-east-vault"
-        - US East Region Vault
-    - "us-east-cold"
-        - US East Region Cold
-    - "us-east-flex"
-        - US East Region Flex
-    - "us-south-standard"
-        - US South Region Standard
-    - "us-south-vault"
-        - US South Region Vault
-    - "us-south-cold"
-        - US South Region Cold
-    - "us-south-flex"
-        - US South Region Flex
-    - "eu-standard"
-        - EU Cross Region Standard
-    - "eu-vault"
-        - EU Cross Region Vault
-    - "eu-cold"
-        - EU Cross Region Cold
-    - "eu-flex"
-        - EU Cross Region Flex
-    - "eu-gb-standard"
-        - Great Britain Standard
-    - "eu-gb-vault"
-        - Great Britain Vault
-    - "eu-gb-cold"
-        - Great Britain Cold
-    - "eu-gb-flex"
-        - Great Britain Flex
-    - "ap-standard"
-        - APAC Standard
-    - "ap-vault"
-        - APAC Vault
-    - "ap-cold"
-        - APAC Cold
-    - "ap-flex"
-        - APAC Flex
-    - "mel01-standard"
-        - Melbourne Standard
-    - "mel01-vault"
-        - Melbourne Vault
-    - "mel01-cold"
-        - Melbourne Cold
-    - "mel01-flex"
-        - Melbourne Flex
-    - "tor01-standard"
-        - Toronto Standard
-    - "tor01-vault"
-        - Toronto Vault
-    - "tor01-cold"
-        - Toronto Cold
-    - "tor01-flex"
-        - Toronto Flex
-
-#### --s3-location-constraint
-
-Location constraint - must be set to match the Region.
-Leave blank if not sure. Used when creating buckets only.
-
-- Config:      location_constraint
-- Env Var:     RCLONE_S3_LOCATION_CONSTRAINT
-- Type:        string
-- Default:     ""
-
-#### --s3-acl
-
-Canned ACL used when creating buckets and storing or copying objects.
-
-This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.
-
+endpoint> 
+Location constraint - must be set to match the Region. Used when creating buckets only.
+Choose a number from below, or type in your own value
+ 1 / Empty for US Region, Northern Virginia or Pacific Northwest.
+   \ ""
+ 2 / US East (Ohio) Region.
+   \ "us-east-2"
+ 3 / US West (Oregon) Region.
+   \ "us-west-2"
+ 4 / US West (Northern California) Region.
+   \ "us-west-1"
+ 5 / Canada (Central) Region.
+   \ "ca-central-1"
+ 6 / EU (Ireland) Region.
+   \ "eu-west-1"
+ 7 / EU (London) Region.
+   \ "eu-west-2"
+ 8 / EU Region.
+   \ "EU"
+ 9 / Asia Pacific (Singapore) Region.
+   \ "ap-southeast-1"
+10 / Asia Pacific (Sydney) Region.
+   \ "ap-southeast-2"
+11 / Asia Pacific (Tokyo) Region.
+   \ "ap-northeast-1"
+12 / Asia Pacific (Seoul)
+   \ "ap-northeast-2"
+13 / Asia Pacific (Mumbai)
+   \ "ap-south-1"
+14 / Asia Pacific (Hong Kong)
+   \ "ap-east-1"
+15 / South America (Sao Paulo) Region.
+   \ "sa-east-1"
+location_constraint> 1
+Canned ACL used when creating buckets and/or storing objects in S3.
 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Choose a number from below, or type in your own value
+ 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
+   \ "private"
+ 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
+   \ "public-read"
+   / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
+ 3 | Granting this on a bucket is generally not recommended.
+   \ "public-read-write"
+ 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
+   \ "authenticated-read"
+   / Object owner gets FULL_CONTROL. Bucket owner gets READ access.
+ 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
+   \ "bucket-owner-read"
+   / Both the object owner and the bucket owner get FULL_CONTROL over the object.
+ 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
+   \ "bucket-owner-full-control"
+acl> 1
+The server-side encryption algorithm used when storing this object in S3.
+Choose a number from below, or type in your own value
+ 1 / None
+   \ ""
+ 2 / AES256
+   \ "AES256"
+server_side_encryption> 1
+The storage class to use when storing objects in S3.
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+ 2 / Standard storage class
+   \ "STANDARD"
+ 3 / Reduced redundancy storage class
+   \ "REDUCED_REDUNDANCY"
+ 4 / Standard Infrequent Access storage class
+   \ "STANDARD_IA"
+ 5 / One Zone Infrequent Access storage class
+   \ "ONEZONE_IA"
+ 6 / Glacier storage class
+   \ "GLACIER"
+ 7 / Glacier Deep Archive storage class
+   \ "DEEP_ARCHIVE"
+ 8 / Intelligent-Tiering storage class
+   \ "INTELLIGENT_TIERING"
+storage_class> 1
+Remote config
+--------------------
+[remote]
+type = s3
+provider = AWS
+env_auth = false
+access_key_id = XXX
+secret_access_key = YYY
+region = us-east-1
+endpoint = 
+location_constraint = 
+acl = private
+server_side_encryption = 
+storage_class = 
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> 
    
+
    --fast-list
    
+
    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.
    
+
    --update and --use-server-modtime
    
+
    As noted below, the modified time is stored on metadata on the object. It is used by default for all operations that require checking the time a file was last updated. It allows rclone to treat the remote more like a true filesystem, but it is inefficient because it requires an extra API call to retrieve the metadata.
    
+
    For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is "dirty". By using --update along with --use-server-modtime, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded.
    
+
    Modified time
    
+
    The modified time is stored as metadata on the object as X-Amz-Meta-Mtime as floating point since the epoch accurate to 1 ns.
    
+
    If the modification time needs to be updated rclone will attempt to perform a server side copy to update the modification if the object can be copied in a single part. In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive storage the object will be uploaded rather than copied.
    
+
    Cleanup
    
+
    If you run rclone cleanup s3:bucket then it will remove all pending multipart uploads older than 24 hours. You can use the -i flag to see exactly what it will do. If you want more control over the expiry date then run rclone backend cleanup s3:bucket -o max-age=1h to expire all uploads older than one hour. You can use rclone backend list-multipart-uploads s3:bucket to see the pending multipart uploads.
    
+
    Restricted filename characters
    
+
    S3 allows any valid UTF-8 string as a key.
    
+
    Invalid UTF-8 bytes will be replaced, as they can't be used in XML.
    
+
    The following characters are replaced since these are problematic when dealing with the REST API:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    
+
    The encoding will also encode these file names as they don't seem to work with the SDK properly:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    File nameReplacement
    .．
    ..．．
    
+
    Multipart uploads
    
+
    rclone supports multipart uploads with S3 which means that it can upload files bigger than 5GB.
    
+
    Note that files uploaded both with multipart upload and through crypt remotes do not have MD5 sums.
    
+
    rclone switches from single part uploads to multipart uploads at the point specified by --s3-upload-cutoff. This can be a maximum of 5GB and a minimum of 0 (ie always upload multipart files).
    
+
    The chunk sizes used in the multipart upload are specified by --s3-chunk-size and the number of chunks uploaded concurrently is specified by --s3-upload-concurrency.
    
+
    Multipart uploads will use --transfers * --s3-upload-concurrency * --s3-chunk-size extra memory. Single part uploads to not use extra memory.
    
+
    Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 - the more latency, the more likely single part transfers will be faster.
    
+
    Increasing --s3-upload-concurrency will increase throughput (8 would be a sensible value) and increasing --s3-chunk-size also increases throughput (16M would be sensible). Increasing either of these will use more memory. The default values are high enough to gain most of the possible performance without using too much memory.
    
+
    Buckets and Regions
    
+
    With Amazon S3 you can list buckets (rclone lsd) using any region, but you can only access the content of a bucket from the region it was created in. If you attempt to access a bucket from the wrong region, you will get an error, incorrect region, the bucket is not in 'XXX' region.
    
+
    Authentication
    
+
    There are a number of ways to supply rclone with a set of AWS credentials, with and without using the environment.
    
+
    The different authentication methods are tried in this order:
    
+
      
+
    • Directly in the rclone configuration file (env_auth = false in the config file):
+
        
+
      • access_key_id and secret_access_key are required.
        • 
+
      • session_token can be optionally set when using AWS STS.
        • 
+
      • 
+
    • Runtime configuration (env_auth = true in the config file):
+
        
+
      • Export the following environment variables before running rclone:
+
          
+
        • Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY
          • 
+
        • Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY
          • 
+
        • Session Token: AWS_SESSION_TOKEN (optional)
          • 
+
        • 
+
      • Or, use a named profile:
+
          
+
        • Profile files are standard files used by AWS CLI tools
          • 
+
        • By default it will use the profile in your home directory (eg ~/.aws/credentials on unix based systems) file and the "default" profile, to change set these environment variables:
+
            
+
          • AWS_SHARED_CREDENTIALS_FILE to control which file.
            • 
+
          • AWS_PROFILE to control which profile to use.
            • 
+
          • 
+
        • 
+
      • Or, run rclone in an ECS task with an IAM role (AWS only).
        • 
+
      • Or, run rclone on an EC2 instance with an IAM role (AWS only).
        • 
+
      • Or, run rclone in an EKS pod with an IAM role that is associated with a service account (AWS only).
        • 
+
      • 
+
    
+
    If none of these option actually end up providing rclone with AWS credentials then S3 interaction will be non-authenticated (see below).
    
+
    S3 Permissions
    
+
    When using the sync subcommand of rclone the following minimum permissions are required to be available on the bucket being written to:
    
+
      
+
    • ListBucket
      • 
+
    • DeleteObject
      • 
+
    • GetObject
      • 
+
    • PutObject
      • 
+
    • PutObjectACL
      • 
+
    
+
    When using the lsd subcommand, the ListAllMyBuckets permission is required.
    
+
    Example policy:
    
+
    {
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Principal": {
+                "AWS": "arn:aws:iam::USER_SID:user/USER_NAME"
+            },
+            "Action": [
+                "s3:ListBucket",
+                "s3:DeleteObject",
+                "s3:GetObject",
+                "s3:PutObject",
+                "s3:PutObjectAcl"
+            ],
+            "Resource": [
+              "arn:aws:s3:::BUCKET_NAME/*",
+              "arn:aws:s3:::BUCKET_NAME"
+            ]
+        },
+        {
+            "Effect": "Allow",
+            "Action": "s3:ListAllMyBuckets",
+            "Resource": "arn:aws:s3:::*"
+        }   
+    ]
+}
    
+
    Notes on above:
    
+
      
+
    1. This is a policy that can be used when creating bucket. It assumes that USER_NAME has been created.
      2. 
+
    2. The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket's objects.
      3. 
+
    
+
    For reference, here's an Ansible script that will generate one or more buckets that will work with rclone sync.
    
+
    Key Management System (KMS)
    
+
    If you are using server side encryption with KMS then you will find you can't transfer small objects. As a work-around you can use the --ignore-checksum flag.
    
+
    A proper fix is being worked on in issue #1824.
    
+
    Glacier and Glacier Deep Archive
    
+
    You can upload objects using the glacier storage class or transition them to glacier using a lifecycle policy. The bucket can still be synced or copied into normally, but if rclone tries to access data from the glacier storage class you will see an error like below.
    
+
    2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file
    
+
    In this case you need to restore the object(s) in question before using rclone.
    
+
    Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults.
    
+
    Standard Options
    
+
    Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)).
    
+
    --s3-provider
    
+
    Choose your S3 provider.
    
+
      
+
    • Config: provider
      • 
+
    • Env Var: RCLONE_S3_PROVIDER
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "AWS"
+
          
+
        • Amazon Web Services (AWS) S3
          • 
+
        • 
+
      • "Alibaba"
+
          
+
        • Alibaba Cloud Object Storage System (OSS) formerly Aliyun
          • 
+
        • 
+
      • "Ceph"
+
          
+
        • Ceph Object Storage
          • 
+
        • 
+
      • "DigitalOcean"
+
          
+
        • Digital Ocean Spaces
          • 
+
        • 
+
      • "Dreamhost"
+
          
+
        • Dreamhost DreamObjects
          • 
+
        • 
+
      • "IBMCOS"
+
          
+
        • IBM COS S3
          • 
+
        • 
+
      • "Minio"
+
          
+
        • Minio Object Storage
          • 
+
        • 
+
      • "Netease"
+
          
+
        • Netease Object Storage (NOS)
          • 
+
        • 
+
      • "Scaleway"
+
          
+
        • Scaleway Object Storage
          • 
+
        • 
+
      • "StackPath"
+
          
+
        • StackPath Object Storage
          • 
+
        • 
+
      • "TencentCOS"
+
          
+
        • Tencent Cloud Object Storage (COS)
          • 
+
        • 
+
      • "Wasabi"
+
          
+
        • Wasabi Object Storage
          • 
+
        • 
+
      • "Other"
+
          
+
        • Any other S3 compatible provider
          • 
+
        • 
+
      • 
+
    
+
    --s3-env-auth
    
+
    Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
    
+
      
+
    • Config: env_auth
      • 
+
    • Env Var: RCLONE_S3_ENV_AUTH
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    • Examples:
+
        
+
      • "false"
+
          
+
        • Enter AWS credentials in the next step
          • 
+
        • 
+
      • "true"
+
          
+
        • Get AWS credentials from the environment (env vars or IAM)
          • 
+
        • 
+
      • 
+
    
+
    --s3-access-key-id
    
+
    AWS Access Key ID. Leave blank for anonymous access or runtime credentials.
    
+
      
+
    • Config: access_key_id
      • 
+
    • Env Var: RCLONE_S3_ACCESS_KEY_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-secret-access-key
    
+
    AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials.
    
+
      
+
    • Config: secret_access_key
      • 
+
    • Env Var: RCLONE_S3_SECRET_ACCESS_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-region
    
+
    Region to connect to.
    
+
      
+
    • Config: region
      • 
+
    • Env Var: RCLONE_S3_REGION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "us-east-1"
+
          
+
        • The default endpoint - a good choice if you are unsure.
          • 
+
        • US Region, Northern Virginia or Pacific Northwest.
          • 
+
        • Leave location constraint empty.
          • 
+
        • 
+
      • "us-east-2"
+
          
+
        • US East (Ohio) Region
          • 
+
        • Needs location constraint us-east-2.
          • 
+
        • 
+
      • "us-west-2"
+
          
+
        • US West (Oregon) Region
          • 
+
        • Needs location constraint us-west-2.
          • 
+
        • 
+
      • "us-west-1"
+
          
+
        • US West (Northern California) Region
          • 
+
        • Needs location constraint us-west-1.
          • 
+
        • 
+
      • "ca-central-1"
+
          
+
        • Canada (Central) Region
          • 
+
        • Needs location constraint ca-central-1.
          • 
+
        • 
+
      • "eu-west-1"
+
          
+
        • EU (Ireland) Region
          • 
+
        • Needs location constraint EU or eu-west-1.
          • 
+
        • 
+
      • "eu-west-2"
+
          
+
        • EU (London) Region
          • 
+
        • Needs location constraint eu-west-2.
          • 
+
        • 
+
      • "eu-north-1"
+
          
+
        • EU (Stockholm) Region
          • 
+
        • Needs location constraint eu-north-1.
          • 
+
        • 
+
      • "eu-central-1"
+
          
+
        • EU (Frankfurt) Region
          • 
+
        • Needs location constraint eu-central-1.
          • 
+
        • 
+
      • "ap-southeast-1"
+
          
+
        • Asia Pacific (Singapore) Region
          • 
+
        • Needs location constraint ap-southeast-1.
          • 
+
        • 
+
      • "ap-southeast-2"
+
          
+
        • Asia Pacific (Sydney) Region
          • 
+
        • Needs location constraint ap-southeast-2.
          • 
+
        • 
+
      • "ap-northeast-1"
+
          
+
        • Asia Pacific (Tokyo) Region
          • 
+
        • Needs location constraint ap-northeast-1.
          • 
+
        • 
+
      • "ap-northeast-2"
+
          
+
        • Asia Pacific (Seoul)
          • 
+
        • Needs location constraint ap-northeast-2.
          • 
+
        • 
+
      • "ap-south-1"
+
          
+
        • Asia Pacific (Mumbai)
          • 
+
        • Needs location constraint ap-south-1.
          • 
+
        • 
+
      • "ap-east-1"
+
          
+
        • Asia Patific (Hong Kong) Region
          • 
+
        • Needs location constraint ap-east-1.
          • 
+
        • 
+
      • "sa-east-1"
+
          
+
        • South America (Sao Paulo) Region
          • 
+
        • Needs location constraint sa-east-1.
          • 
+
        • 
+
      • 
+
    
+
    --s3-region
    
+
    Region to connect to.
    
+
      
+
    • Config: region
      • 
+
    • Env Var: RCLONE_S3_REGION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "nl-ams"
+
          
+
        • Amsterdam, The Netherlands
          • 
+
        • 
+
      • "fr-par"
+
          
+
        • Paris, France
          • 
+
        • 
+
      • 
+
    
+
    --s3-region
    
+
    Region to connect to. Leave blank if you are using an S3 clone and you don't have a region.
    
+
      
+
    • Config: region
      • 
+
    • Env Var: RCLONE_S3_REGION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Use this if unsure. Will use v4 signatures and an empty region.
          • 
+
        • 
+
      • "other-v2-signature"
+
          
+
        • Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "s3.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Endpoint
          • 
+
        • 
+
      • "s3.dal.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Dallas Endpoint
          • 
+
        • 
+
      • "s3.wdc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Washington DC Endpoint
          • 
+
        • 
+
      • "s3.sjc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region San Jose Endpoint
          • 
+
        • 
+
      • "s3.private.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Private Endpoint
          • 
+
        • 
+
      • "s3.private.dal.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Dallas Private Endpoint
          • 
+
        • 
+
      • "s3.private.wdc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Washington DC Private Endpoint
          • 
+
        • 
+
      • "s3.private.sjc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region San Jose Private Endpoint
          • 
+
        • 
+
      • "s3.us-east.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region East Endpoint
          • 
+
        • 
+
      • "s3.private.us-east.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region East Private Endpoint
          • 
+
        • 
+
      • "s3.us-south.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region South Endpoint
          • 
+
        • 
+
      • "s3.private.us-south.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region South Private Endpoint
          • 
+
        • 
+
      • "s3.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Endpoint
          • 
+
        • 
+
      • "s3.fra.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Frankfurt Endpoint
          • 
+
        • 
+
      • "s3.mil.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Milan Endpoint
          • 
+
        • 
+
      • "s3.ams.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Amsterdam Endpoint
          • 
+
        • 
+
      • "s3.private.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Private Endpoint
          • 
+
        • 
+
      • "s3.private.fra.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Frankfurt Private Endpoint
          • 
+
        • 
+
      • "s3.private.mil.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Milan Private Endpoint
          • 
+
        • 
+
      • "s3.private.ams.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Amsterdam Private Endpoint
          • 
+
        • 
+
      • "s3.eu-gb.cloud-object-storage.appdomain.cloud"
+
          
+
        • Great Britain Endpoint
          • 
+
        • 
+
      • "s3.private.eu-gb.cloud-object-storage.appdomain.cloud"
+
          
+
        • Great Britain Private Endpoint
          • 
+
        • 
+
      • "s3.eu-de.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Region DE Endpoint
          • 
+
        • 
+
      • "s3.private.eu-de.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Region DE Private Endpoint
          • 
+
        • 
+
      • "s3.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Endpoint
          • 
+
        • 
+
      • "s3.tok.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Tokyo Endpoint
          • 
+
        • 
+
      • "s3.hkg.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional HongKong Endpoint
          • 
+
        • 
+
      • "s3.seo.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Seoul Endpoint
          • 
+
        • 
+
      • "s3.private.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Private Endpoint
          • 
+
        • 
+
      • "s3.private.tok.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Tokyo Private Endpoint
          • 
+
        • 
+
      • "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional HongKong Private Endpoint
          • 
+
        • 
+
      • "s3.private.seo.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Seoul Private Endpoint
          • 
+
        • 
+
      • "s3.jp-tok.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Japan Endpoint
          • 
+
        • 
+
      • "s3.private.jp-tok.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Japan Private Endpoint
          • 
+
        • 
+
      • "s3.au-syd.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Australia Endpoint
          • 
+
        • 
+
      • "s3.private.au-syd.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Australia Private Endpoint
          • 
+
        • 
+
      • "s3.ams03.cloud-object-storage.appdomain.cloud"
+
          
+
        • Amsterdam Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.ams03.cloud-object-storage.appdomain.cloud"
+
          
+
        • Amsterdam Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.che01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Chennai Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.che01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Chennai Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mel01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Melbourne Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mel01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Melbourne Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.osl01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Oslo Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.osl01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Oslo Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.tor01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Toronto Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.tor01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Toronto Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.seo01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Seoul Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.seo01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Seoul Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mon01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Montreal Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mon01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Montreal Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mex01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Mexico Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mex01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Mexico Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.sjc04.cloud-object-storage.appdomain.cloud"
+
          
+
        • San Jose Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.sjc04.cloud-object-storage.appdomain.cloud"
+
          
+
        • San Jose Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mil01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Milan Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mil01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Milan Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.hkg02.cloud-object-storage.appdomain.cloud"
+
          
+
        • Hong Kong Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.hkg02.cloud-object-storage.appdomain.cloud"
+
          
+
        • Hong Kong Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.par01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Paris Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.par01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Paris Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.sng01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Singapore Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.sng01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Singapore Single Site Private Endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for OSS API.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "oss-cn-hangzhou.aliyuncs.com"
+
          
+
        • East China 1 (Hangzhou)
          • 
+
        • 
+
      • "oss-cn-shanghai.aliyuncs.com"
+
          
+
        • East China 2 (Shanghai)
          • 
+
        • 
+
      • "oss-cn-qingdao.aliyuncs.com"
+
          
+
        • North China 1 (Qingdao)
          • 
+
        • 
+
      • "oss-cn-beijing.aliyuncs.com"
+
          
+
        • North China 2 (Beijing)
          • 
+
        • 
+
      • "oss-cn-zhangjiakou.aliyuncs.com"
+
          
+
        • North China 3 (Zhangjiakou)
          • 
+
        • 
+
      • "oss-cn-huhehaote.aliyuncs.com"
+
          
+
        • North China 5 (Huhehaote)
          • 
+
        • 
+
      • "oss-cn-shenzhen.aliyuncs.com"
+
          
+
        • South China 1 (Shenzhen)
          • 
+
        • 
+
      • "oss-cn-hongkong.aliyuncs.com"
+
          
+
        • Hong Kong (Hong Kong)
          • 
+
        • 
+
      • "oss-us-west-1.aliyuncs.com"
+
          
+
        • US West 1 (Silicon Valley)
          • 
+
        • 
+
      • "oss-us-east-1.aliyuncs.com"
+
          
+
        • US East 1 (Virginia)
          • 
+
        • 
+
      • "oss-ap-southeast-1.aliyuncs.com"
+
          
+
        • Southeast Asia Southeast 1 (Singapore)
          • 
+
        • 
+
      • "oss-ap-southeast-2.aliyuncs.com"
+
          
+
        • Asia Pacific Southeast 2 (Sydney)
          • 
+
        • 
+
      • "oss-ap-southeast-3.aliyuncs.com"
+
          
+
        • Southeast Asia Southeast 3 (Kuala Lumpur)
          • 
+
        • 
+
      • "oss-ap-southeast-5.aliyuncs.com"
+
          
+
        • Asia Pacific Southeast 5 (Jakarta)
          • 
+
        • 
+
      • "oss-ap-northeast-1.aliyuncs.com"
+
          
+
        • Asia Pacific Northeast 1 (Japan)
          • 
+
        • 
+
      • "oss-ap-south-1.aliyuncs.com"
+
          
+
        • Asia Pacific South 1 (Mumbai)
          • 
+
        • 
+
      • "oss-eu-central-1.aliyuncs.com"
+
          
+
        • Central Europe 1 (Frankfurt)
          • 
+
        • 
+
      • "oss-eu-west-1.aliyuncs.com"
+
          
+
        • West Europe (London)
          • 
+
        • 
+
      • "oss-me-east-1.aliyuncs.com"
+
          
+
        • Middle East 1 (Dubai)
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for Scaleway Object Storage.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "s3.nl-ams.scw.cloud"
+
          
+
        • Amsterdam Endpoint
          • 
+
        • 
+
      • "s3.fr-par.scw.cloud"
+
          
+
        • Paris Endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for StackPath Object Storage.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "s3.us-east-2.stackpathstorage.com"
+
          
+
        • US East Endpoint
          • 
+
        • 
+
      • "s3.us-west-1.stackpathstorage.com"
+
          
+
        • US West Endpoint
          • 
+
        • 
+
      • "s3.eu-central-1.stackpathstorage.com"
+
          
+
        • EU Endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for Tencent COS API.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "cos.ap-beijing.myqcloud.com"
+
          
+
        • Beijing Region.
          • 
+
        • 
+
      • "cos.ap-nanjing.myqcloud.com"
+
          
+
        • Nanjing Region.
          • 
+
        • 
+
      • "cos.ap-shanghai.myqcloud.com"
+
          
+
        • Shanghai Region.
          • 
+
        • 
+
      • "cos.ap-guangzhou.myqcloud.com"
+
          
+
        • Guangzhou Region.
          • 
+
        • 
+
      • "cos.ap-nanjing.myqcloud.com"
+
          
+
        • Nanjing Region.
          • 
+
        • 
+
      • "cos.ap-chengdu.myqcloud.com"
+
          
+
        • Chengdu Region.
          • 
+
        • 
+
      • "cos.ap-chongqing.myqcloud.com"
+
          
+
        • Chongqing Region.
          • 
+
        • 
+
      • "cos.ap-hongkong.myqcloud.com"
+
          
+
        • Hong Kong (China) Region.
          • 
+
        • 
+
      • "cos.ap-singapore.myqcloud.com"
+
          
+
        • Singapore Region.
          • 
+
        • 
+
      • "cos.ap-mumbai.myqcloud.com"
+
          
+
        • Mumbai Region.
          • 
+
        • 
+
      • "cos.ap-seoul.myqcloud.com"
+
          
+
        • Seoul Region.
          • 
+
        • 
+
      • "cos.ap-bangkok.myqcloud.com"
+
          
+
        • Bangkok Region.
          • 
+
        • 
+
      • "cos.ap-tokyo.myqcloud.com"
+
          
+
        • Tokyo Region.
          • 
+
        • 
+
      • "cos.na-siliconvalley.myqcloud.com"
+
          
+
        • Silicon Valley Region.
          • 
+
        • 
+
      • "cos.na-ashburn.myqcloud.com"
+
          
+
        • Virginia Region.
          • 
+
        • 
+
      • "cos.na-toronto.myqcloud.com"
+
          
+
        • Toronto Region.
          • 
+
        • 
+
      • "cos.eu-frankfurt.myqcloud.com"
+
          
+
        • Frankfurt Region.
          • 
+
        • 
+
      • "cos.eu-moscow.myqcloud.com"
+
          
+
        • Moscow Region.
          • 
+
        • 
+
      • "cos.accelerate.myqcloud.com"
+
          
+
        • Use Tencent COS Accelerate Endpoint.
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for S3 API. Required when using an S3 clone.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "objects-us-east-1.dream.io"
+
          
+
        • Dream Objects endpoint
          • 
+
        • 
+
      • "nyc3.digitaloceanspaces.com"
+
          
+
        • Digital Ocean Spaces New York 3
          • 
+
        • 
+
      • "ams3.digitaloceanspaces.com"
+
          
+
        • Digital Ocean Spaces Amsterdam 3
          • 
+
        • 
+
      • "sgp1.digitaloceanspaces.com"
+
          
+
        • Digital Ocean Spaces Singapore 1
          • 
+
        • 
+
      • "s3.wasabisys.com"
+
          
+
        • Wasabi US East endpoint
          • 
+
        • 
+
      • "s3.us-west-1.wasabisys.com"
+
          
+
        • Wasabi US West endpoint
          • 
+
        • 
+
      • "s3.eu-central-1.wasabisys.com"
+
          
+
        • Wasabi EU Central endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-location-constraint
    
+
    Location constraint - must be set to match the Region. Used when creating buckets only.
    
+
      
+
    • Config: location_constraint
      • 
+
    • Env Var: RCLONE_S3_LOCATION_CONSTRAINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Empty for US Region, Northern Virginia or Pacific Northwest.
          • 
+
        • 
+
      • "us-east-2"
+
          
+
        • US East (Ohio) Region.
          • 
+
        • 
+
      • "us-west-2"
+
          
+
        • US West (Oregon) Region.
          • 
+
        • 
+
      • "us-west-1"
+
          
+
        • US West (Northern California) Region.
          • 
+
        • 
+
      • "ca-central-1"
+
          
+
        • Canada (Central) Region.
          • 
+
        • 
+
      • "eu-west-1"
+
          
+
        • EU (Ireland) Region.
          • 
+
        • 
+
      • "eu-west-2"
+
          
+
        • EU (London) Region.
          • 
+
        • 
+
      • "eu-north-1"
+
          
+
        • EU (Stockholm) Region.
          • 
+
        • 
+
      • "EU"
+
          
+
        • EU Region.
          • 
+
        • 
+
      • "ap-southeast-1"
+
          
+
        • Asia Pacific (Singapore) Region.
          • 
+
        • 
+
      • "ap-southeast-2"
+
          
+
        • Asia Pacific (Sydney) Region.
          • 
+
        • 
+
      • "ap-northeast-1"
+
          
+
        • Asia Pacific (Tokyo) Region.
          • 
+
        • 
+
      • "ap-northeast-2"
+
          
+
        • Asia Pacific (Seoul)
          • 
+
        • 
+
      • "ap-south-1"
+
          
+
        • Asia Pacific (Mumbai)
          • 
+
        • 
+
      • "ap-east-1"
+
          
+
        • Asia Pacific (Hong Kong)
          • 
+
        • 
+
      • "sa-east-1"
+
          
+
        • South America (Sao Paulo) Region.
          • 
+
        • 
+
      • 
+
    
+
    --s3-location-constraint
    
+
    Location constraint - must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter
    
+
      
+
    • Config: location_constraint
      • 
+
    • Env Var: RCLONE_S3_LOCATION_CONSTRAINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "us-standard"
+
          
+
        • US Cross Region Standard
          • 
+
        • 
+
      • "us-vault"
+
          
+
        • US Cross Region Vault
          • 
+
        • 
+
      • "us-cold"
+
          
+
        • US Cross Region Cold
          • 
+
        • 
+
      • "us-flex"
+
          
+
        • US Cross Region Flex
          • 
+
        • 
+
      • "us-east-standard"
+
          
+
        • US East Region Standard
          • 
+
        • 
+
      • "us-east-vault"
+
          
+
        • US East Region Vault
          • 
+
        • 
+
      • "us-east-cold"
+
          
+
        • US East Region Cold
          • 
+
        • 
+
      • "us-east-flex"
+
          
+
        • US East Region Flex
          • 
+
        • 
+
      • "us-south-standard"
+
          
+
        • US South Region Standard
          • 
+
        • 
+
      • "us-south-vault"
+
          
+
        • US South Region Vault
          • 
+
        • 
+
      • "us-south-cold"
+
          
+
        • US South Region Cold
          • 
+
        • 
+
      • "us-south-flex"
+
          
+
        • US South Region Flex
          • 
+
        • 
+
      • "eu-standard"
+
          
+
        • EU Cross Region Standard
          • 
+
        • 
+
      • "eu-vault"
+
          
+
        • EU Cross Region Vault
          • 
+
        • 
+
      • "eu-cold"
+
          
+
        • EU Cross Region Cold
          • 
+
        • 
+
      • "eu-flex"
+
          
+
        • EU Cross Region Flex
          • 
+
        • 
+
      • "eu-gb-standard"
+
          
+
        • Great Britain Standard
          • 
+
        • 
+
      • "eu-gb-vault"
+
          
+
        • Great Britain Vault
          • 
+
        • 
+
      • "eu-gb-cold"
+
          
+
        • Great Britain Cold
          • 
+
        • 
+
      • "eu-gb-flex"
+
          
+
        • Great Britain Flex
          • 
+
        • 
+
      • "ap-standard"
+
          
+
        • APAC Standard
          • 
+
        • 
+
      • "ap-vault"
+
          
+
        • APAC Vault
          • 
+
        • 
+
      • "ap-cold"
+
          
+
        • APAC Cold
          • 
+
        • 
+
      • "ap-flex"
+
          
+
        • APAC Flex
          • 
+
        • 
+
      • "mel01-standard"
+
          
+
        • Melbourne Standard
          • 
+
        • 
+
      • "mel01-vault"
+
          
+
        • Melbourne Vault
          • 
+
        • 
+
      • "mel01-cold"
+
          
+
        • Melbourne Cold
          • 
+
        • 
+
      • "mel01-flex"
+
          
+
        • Melbourne Flex
          • 
+
        • 
+
      • "tor01-standard"
+
          
+
        • Toronto Standard
          • 
+
        • 
+
      • "tor01-vault"
+
          
+
        • Toronto Vault
          • 
+
        • 
+
      • "tor01-cold"
+
          
+
        • Toronto Cold
          • 
+
        • 
+
      • "tor01-flex"
+
          
+
        • Toronto Flex
          • 
+
        • 
+
      • 
+
    
+
    --s3-location-constraint
    
+
    Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only.
    
+
      
+
    • Config: location_constraint
      • 
+
    • Env Var: RCLONE_S3_LOCATION_CONSTRAINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-acl
    
+
    Canned ACL used when creating buckets and storing or copying objects.
    
+
    This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.
    
+
    For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
    
+
    Note that this ACL is applied when server side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one.
    
+
      
+
    • Config: acl
      • 
+
    • Env Var: RCLONE_S3_ACL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "default"
+
          
+
        • Owner gets Full_CONTROL. No one else has access rights (default).
          • 
+
        • 
+
      • "private"
+
          
+
        • Owner gets FULL_CONTROL. No one else has access rights (default).
          • 
+
        • 
+
      • "public-read"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ access.
          • 
+
        • 
+
      • "public-read-write"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
          • 
+
        • Granting this on a bucket is generally not recommended.
          • 
+
        • 
+
      • "authenticated-read"
+
          
+
        • Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
          • 
+
        • 
+
      • "bucket-owner-read"
+
          
+
        • Object owner gets FULL_CONTROL. Bucket owner gets READ access.
          • 
+
        • If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
          • 
+
        • 
+
      • "bucket-owner-full-control"
+
          
+
        • Both the object owner and the bucket owner get FULL_CONTROL over the object.
          • 
+
        • If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
          • 
+
        • 
+
      • "private"
+
          
+
        • Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
          • 
+
        • 
+
      • "public-read"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
          • 
+
        • 
+
      • "public-read-write"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
          • 
+
        • 
+
      • "authenticated-read"
+
          
+
        • Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
          • 
+
        • 
+
      • 
+
    
+
    --s3-server-side-encryption
    
+
    The server-side encryption algorithm used when storing this object in S3.
    
+
      
+
    • Config: server_side_encryption
      • 
+
    • Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • "AES256"
+
          
+
        • AES256
          • 
+
        • 
+
      • "aws:kms"
+
          
+
        • aws:kms
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-kms-key-id
    
+
    If using KMS ID you must provide the ARN of Key.
    
+
      
+
    • Config: sse_kms_key_id
      • 
+
    • Env Var: RCLONE_S3_SSE_KMS_KEY_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • "arn:aws:kms:us-east-1:*"
+
          
+
        • arn:aws:kms:*
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in S3.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • Standard storage class
          • 
+
        • 
+
      • "REDUCED_REDUNDANCY"
+
          
+
        • Reduced redundancy storage class
          • 
+
        • 
+
      • "STANDARD_IA"
+
          
+
        • Standard Infrequent Access storage class
          • 
+
        • 
+
      • "ONEZONE_IA"
+
          
+
        • One Zone Infrequent Access storage class
          • 
+
        • 
+
      • "GLACIER"
+
          
+
        • Glacier storage class
          • 
+
        • 
+
      • "DEEP_ARCHIVE"
+
          
+
        • Glacier Deep Archive storage class
          • 
+
        • 
+
      • "INTELLIGENT_TIERING"
+
          
+
        • Intelligent-Tiering storage class
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in OSS.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • Standard storage class
          • 
+
        • 
+
      • "GLACIER"
+
          
+
        • Archive storage mode.
          • 
+
        • 
+
      • "STANDARD_IA"
+
          
+
        • Infrequent access storage mode.
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in Tencent COS.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • Standard storage class
          • 
+
        • 
+
      • "ARCHIVE"
+
          
+
        • Archive storage mode.
          • 
+
        • 
+
      • "STANDARD_IA"
+
          
+
        • Infrequent access storage mode.
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in S3.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • The Standard class for any upload; suitable for on-demand content like streaming or CDN.
          • 
+
        • 
+
      • "GLACIER"
+
          
+
        • Archived storage; prices are lower, but it needs to be restored first to be accessed.
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)).
    
+
    --s3-bucket-acl
    
+
    Canned ACL used when creating buckets.
    
+
    For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
    
+
    Note that this ACL is applied when only when creating buckets. If it isn't set then "acl" is used instead.
    
+
      
+
    • Config: bucket_acl
      • 
+
    • Env Var: RCLONE_S3_BUCKET_ACL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "private"
+
          
+
        • Owner gets FULL_CONTROL. No one else has access rights (default).
          • 
+
        • 
+
      • "public-read"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ access.
          • 
+
        • 
+
      • "public-read-write"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
          • 
+
        • Granting this on a bucket is generally not recommended.
          • 
+
        • 
+
      • "authenticated-read"
+
          
+
        • Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-customer-algorithm
    
+
    If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
    
+
      
+
    • Config: sse_customer_algorithm
      • 
+
    • Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • "AES256"
+
          
+
        • AES256
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-customer-key
    
+
    If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
    
+
      
+
    • Config: sse_customer_key
      • 
+
    • Env Var: RCLONE_S3_SSE_CUSTOMER_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-customer-key-md5
    
+
    If using SSE-C you must provide the secret encryption key MD5 checksum.
    
+
      
+
    • Config: sse_customer_key_md5
      • 
+
    • Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • 
+
    
+
    --s3-upload-cutoff
    
+
    Cutoff for switching to chunked upload
    
+
    Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_S3_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 200M
      • 
+
    
+
    --s3-chunk-size
    
+
    Chunk size to use for uploading.
    
+
    When uploading files larger than upload_cutoff or files with unknown size (eg from "rclone rcat" or uploaded with "rclone mount" or google photos or google docs) they will be uploaded as multipart uploads using this chunk size.
    
+
    Note that "--s3-upload-concurrency" chunks of this size are buffered in memory per transfer.
    
+
    If you are transferring large files over high speed links and you have enough memory, then increasing this will speed up the transfers.
    
+
    Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit.
    
+
    Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5MB and there can be at most 10,000 chunks, this means that by default the maximum size of file you can stream upload is 48GB. If you wish to stream upload larger files then you will need to increase chunk_size.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_S3_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 5M
      • 
+
    
+
    --s3-max-upload-parts
    
+
    Maximum number of parts in a multipart upload.
    
+
    This option defines the maximum number of multipart chunks to use when doing a multipart upload.
    
+
    This can be useful if a service does not support the AWS S3 specification of 10,000 chunks.
    
+
    Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit.
    
+
      
+
    • Config: max_upload_parts
      • 
+
    • Env Var: RCLONE_S3_MAX_UPLOAD_PARTS
      • 
+
    • Type: int
      • 
+
    • Default: 10000
      • 
+
    
+
    --s3-copy-cutoff
    
+
    Cutoff for switching to multipart copy
    
+
    Any files larger than this that need to be server side copied will be copied in chunks of this size.
    
+
    The minimum is 0 and the maximum is 5GB.
    
+
      
+
    • Config: copy_cutoff
      • 
+
    • Env Var: RCLONE_S3_COPY_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 4.656G
      • 
+
    
+
    --s3-disable-checksum
    
+
    Don't store MD5 checksum with object metadata
    
+
    Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.
    
+
      
+
    • Config: disable_checksum
      • 
+
    • Env Var: RCLONE_S3_DISABLE_CHECKSUM
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-shared-credentials-file
    
+
    Path to the shared credentials file
    
+
    If env_auth = true then rclone can use a shared credentials file.
    
+
    If this variable is empty rclone will look for the "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it will default to the current user's home directory.
    
+
    Linux/OSX: "$HOME/.aws/credentials"
+Windows:   "%USERPROFILE%\.aws\credentials"
    
+
      
+
    • Config: shared_credentials_file
      • 
+
    • Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-profile
    
+
    Profile to use in the shared credentials file
    
+
    If env_auth = true then rclone can use a shared credentials file. This variable controls which profile is used in that file.
    
+
    If empty it will default to the environment variable "AWS_PROFILE" or "default" if that environment variable is also not set.
    
+
      
+
    • Config: profile
      • 
+
    • Env Var: RCLONE_S3_PROFILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-session-token
    
+
    An AWS session token
    
+
      
+
    • Config: session_token
      • 
+
    • Env Var: RCLONE_S3_SESSION_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-upload-concurrency
    
+
    Concurrency for multipart uploads.
    
+
    This is the number of chunks of the same file that are uploaded concurrently.
    
+
    If you are uploading small numbers of large file over high speed link and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.
    
+
      
+
    • Config: upload_concurrency
      • 
+
    • Env Var: RCLONE_S3_UPLOAD_CONCURRENCY
      • 
+
    • Type: int
      • 
+
    • Default: 4
      • 
+
    
+
    --s3-force-path-style
    
+
    If true use path style access if false use virtual hosted style.
    
+
    If this is true (the default) then rclone will use path style access, if false then rclone will use virtual path style. See the AWS S3 docs for more info.
    
+
    Some providers (eg AWS, Aliyun OSS, Netease COS or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting.
    
+
      
+
    • Config: force_path_style
      • 
+
    • Env Var: RCLONE_S3_FORCE_PATH_STYLE
      • 
+
    • Type: bool
      • 
+
    • Default: true
      • 
+
    
+
    --s3-v2-auth
    
+
    If true use v2 authentication.
    
+
    If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.
    
+
    Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.
    
+
      
+
    • Config: v2_auth
      • 
+
    • Env Var: RCLONE_S3_V2_AUTH
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-use-accelerate-endpoint
    
+
    If true use the AWS S3 accelerated endpoint.
    
+
    See: AWS S3 Transfer acceleration
    
+
      
+
    • Config: use_accelerate_endpoint
      • 
+
    • Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-leave-parts-on-error
    
+
    If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
    
+
    It should be set to true for resuming uploads across different sessions.
    
+
    WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.
    
+
      
+
    • Config: leave_parts_on_error
      • 
+
    • Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-list-chunk
    
+
    Size of listing chunk (response list for each ListObject S3 request).
    
+
    This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. Most services truncate the response list to 1000 objects even if requested more than that. In AWS S3 this is a global maximum and cannot be changed, see AWS S3. In Ceph, this can be increased with the "rgw list buckets max chunk" option.
    
+
      
+
    • Config: list_chunk
      • 
+
    • Env Var: RCLONE_S3_LIST_CHUNK
      • 
+
    • Type: int
      • 
+
    • Default: 1000
      • 
+
    
+
    --s3-no-check-bucket
    
+
    If set don't attempt to check the bucket exists or create it
    
+
    This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already.
    
+
      
+
    • Config: no_check_bucket
      • 
+
    • Env Var: RCLONE_S3_NO_CHECK_BUCKET
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_S3_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,InvalidUtf8,Dot
      • 
+
    
+
    --s3-memory-pool-flush-time
    
+
    How often internal memory buffer pools will be flushed. Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. This option controls how often unused buffers will be removed from the pool.
    
+
      
+
    • Config: memory_pool_flush_time
      • 
+
    • Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 1m0s
      • 
+
    
+
    --s3-memory-pool-use-mmap
    
+
    Whether to use mmap buffers in internal memory pool.
    
+
      
+
    • Config: memory_pool_use_mmap
      • 
+
    • Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Backend commands
    
+
    Here are the commands specific to the s3 backend.
    
+
    Run them with
    
+
    rclone backend COMMAND remote:
    
+
    The help below will explain what arguments each command takes.
    
+
    See the "rclone backend" command for more info on how to pass options and arguments.
    
+
    These can be run on a running backend using the rc command backend/command.
    
+
    restore
    
+
    Restore objects from GLACIER to normal storage
    
+
    rclone backend restore remote: [options] [<arguments>+]
    
+
    This command can be used to restore one or more objects from GLACIER to normal storage.
    
+
    Usage Examples:
    
+
    rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]
+rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]
+rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]
    
+
    This flag also obeys the filters. Test first with -i/--interactive or --dry-run flags
    
+
    rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard
    
+
    All the objects shown will be marked for restore, then
    
+
    rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard
    
+
    It returns a list of status dictionaries with Remote and Status keys. The Status will be OK if it was successfull or an error message if not.
    
+
    [
+    {
+        "Status": "OK",
+        "Path": "test.txt"
+    },
+    {
+        "Status": "OK",
+        "Path": "test/file4.txt"
+    }
+]
    
+
    Options:
    
+
      
+
    • "description": The optional description for the job.
      • 
+
    • "lifetime": Lifetime of the active copy in days
      • 
+
    • "priority": Priority of restore: Standard|Expedited|Bulk
      • 
+
    
+
    list-multipart-uploads
    
+
    List the unfinished multipart uploads
    
+
    rclone backend list-multipart-uploads remote: [options] [<arguments>+]
    
+
    This command lists the unfinished multipart uploads in JSON format.
    
+
    rclone backend list-multipart s3:bucket/path/to/object
    
+
    It returns a dictionary of buckets with values as lists of unfinished multipart uploads.
    
+
    You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path.
    
+
    {
+  "rclone": [
+    {
+      "Initiated": "2020-06-26T14:20:36Z",
+      "Initiator": {
+        "DisplayName": "XXX",
+        "ID": "arn:aws:iam::XXX:user/XXX"
+      },
+      "Key": "KEY",
+      "Owner": {
+        "DisplayName": null,
+        "ID": "XXX"
+      },
+      "StorageClass": "STANDARD",
+      "UploadId": "XXX"
+    }
+  ],
+  "rclone-1000files": [],
+  "rclone-dst": []
+}
    
+
    cleanup
    
+
    Remove unfinished multipart uploads.
    
+
    rclone backend cleanup remote: [options] [<arguments>+]
    
+
    This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours.
    
+
    Note that you can use -i/--dry-run with this command to see what it would do.
    
+
    rclone backend cleanup s3:bucket/path/to/object
+rclone backend cleanup -o max-age=7w s3:bucket/path/to/object
    
+
    Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
    
+
    Options:
    
+
      
+
    • "max-age": Max age of upload to delete
      • 
+
    
+
    Anonymous access to public buckets
    
+
    If you want to use rclone to access a public bucket, configure with a blank access_key_id and secret_access_key. Your config should end up looking like this:
    
+
    [anons3]
+type = s3
+provider = AWS
+env_auth = false
+access_key_id = 
+secret_access_key = 
+region = us-east-1
+endpoint = 
+location_constraint = 
+acl = private
+server_side_encryption = 
+storage_class = 
    
+
    Then use it as normal with the name of the public bucket, eg
    
+
    rclone lsd anons3:1000genomes
    
+
    You will be able to list and copy data but not upload it.
    
+
    Ceph
    
+
    Ceph is an open source unified, distributed storage system designed for excellent performance, reliability and scalability. It has an S3 compatible object storage interface.
    
+
    To use rclone with Ceph, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config:
    
+
    [ceph]
+type = s3
+provider = Ceph
+env_auth = false
+access_key_id = XXX
+secret_access_key = YYY
+region =
+endpoint = https://ceph.endpoint.example.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
    
+
    If you are using an older version of CEPH, eg 10.2.x Jewel, then you may need to supply the parameter --s3-upload-cutoff 0 or put this in the config file as upload_cutoff 0 to work around a bug which causes uploading of small files to fail.
    
+
    Note also that Ceph sometimes puts / in the passwords it gives users. If you read the secret access key using the command line tools you will get a JSON blob with the / escaped as \/. Make sure you only write / in the secret access key.
    
+
    Eg the dump from Ceph looks something like this (irrelevant keys removed).
    
+
    {
+    "user_id": "xxx",
+    "display_name": "xxxx",
+    "keys": [
+        {
+            "user": "xxx",
+            "access_key": "xxxxxx",
+            "secret_key": "xxxxxx\/xxxx"
+        }
+    ],
+}
    
+
    Because this is a json dump, it is encoding the / as \/, so if you use the secret key as xxxxxx/xxxx it will work fine.
    
+
    Dreamhost
    
+
    Dreamhost DreamObjects is an object storage system based on CEPH.
    
+
    To use rclone with Dreamhost, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config:
    
+
    [dreamobjects]
+type = s3
+provider = DreamHost
+env_auth = false
+access_key_id = your_access_key
+secret_access_key = your_secret_key
+region =
+endpoint = objects-us-west-1.dream.io
+location_constraint =
+acl = private
+server_side_encryption =
+storage_class =
    
+
    DigitalOcean Spaces
    
+
    Spaces is an S3-interoperable object storage service from cloud provider DigitalOcean.
    
+
    To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "Applications & API" page of the DigitalOcean control panel. They will be needed when prompted by rclone config for your access_key_id and secret_access_key.
    
+
    When prompted for a region or location_constraint, press enter to use the default value. The region must be included in the endpoint setting (e.g. nyc3.digitaloceanspaces.com). The default values can be used for other settings.
    
+
    Going through the whole process of creating a new remote by running rclone config, each prompt should be answered as shown below:
    
+
    Storage> s3
+env_auth> 1
+access_key_id> YOUR_ACCESS_KEY
+secret_access_key> YOUR_SECRET_KEY
+region>
+endpoint> nyc3.digitaloceanspaces.com
+location_constraint>
+acl>
+storage_class>
    
+
    The resulting configuration file should look like:
    
+
    [spaces]
+type = s3
+provider = DigitalOcean
+env_auth = false
+access_key_id = YOUR_ACCESS_KEY
+secret_access_key = YOUR_SECRET_KEY
+region =
+endpoint = nyc3.digitaloceanspaces.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
    
+
    Once configured, you can create a new Space and begin copying files. For example:
    
+
    rclone mkdir spaces:my-new-space
+rclone copy /path/to/files spaces:my-new-space
    
+
    IBM COS (S3)
    
+
    Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage)
    
+
    To configure access to IBM COS S3, follow the steps below:
    
+
      
+
    1. Run rclone config and select n for a new remote.
      2. 
+
    
+
        2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults
+    No remotes found - make a new one
+    n) New remote
+    s) Set configuration password
+    q) Quit config
+    n/s/q> n
    
+
      
+
    1. Enter the name for the configuration
      2. 
+
    
+
        name> <YOUR NAME>
    
+
      
+
    1. Select "s3" storage.
      2. 
+
    
+
    Choose a number from below, or type in your own value
+    1 / Alias for an existing remote
+    \ "alias"
+    2 / Amazon Drive
+    \ "amazon cloud drive"
+    3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS)
+    \ "s3"
+    4 / Backblaze B2
+    \ "b2"
+[snip]
+    23 / http Connection
+    \ "http"
+Storage> 3
    
+
      
+
    1. Select IBM COS as the S3 Storage Provider.
      2. 
+
    
+
    Choose the S3 provider.
+Choose a number from below, or type in your own value
+     1 / Choose this option to configure Storage to AWS S3
+       \ "AWS"
+     2 / Choose this option to configure Storage to Ceph Systems
+     \ "Ceph"
+     3 /  Choose this option to configure Storage to Dreamhost
+     \ "Dreamhost"
+   4 / Choose this option to the configure Storage to IBM COS S3
+     \ "IBMCOS"
+     5 / Choose this option to the configure Storage to Minio
+     \ "Minio"
+     Provider>4
    
+
      
+
    1. Enter the Access Key and Secret.
      2. 
+
    
+
        AWS Access Key ID - leave blank for anonymous access or runtime credentials.
+    access_key_id> <>
+    AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
+    secret_access_key> <>
    
+
      
+
    1. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address.
      2. 
+
    
+
        Endpoint for IBM COS S3 API.
+    Specify if using an IBM COS On Premise.
+    Choose a number from below, or type in your own value
+     1 / US Cross Region Endpoint
+       \ "s3-api.us-geo.objectstorage.softlayer.net"
+     2 / US Cross Region Dallas Endpoint
+       \ "s3-api.dal.us-geo.objectstorage.softlayer.net"
+     3 / US Cross Region Washington DC Endpoint
+       \ "s3-api.wdc-us-geo.objectstorage.softlayer.net"
+     4 / US Cross Region San Jose Endpoint
+       \ "s3-api.sjc-us-geo.objectstorage.softlayer.net"
+     5 / US Cross Region Private Endpoint
+       \ "s3-api.us-geo.objectstorage.service.networklayer.com"
+     6 / US Cross Region Dallas Private Endpoint
+       \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com"
+     7 / US Cross Region Washington DC Private Endpoint
+       \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com"
+     8 / US Cross Region San Jose Private Endpoint
+       \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com"
+     9 / US Region East Endpoint
+       \ "s3.us-east.objectstorage.softlayer.net"
+    10 / US Region East Private Endpoint
+       \ "s3.us-east.objectstorage.service.networklayer.com"
+    11 / US Region South Endpoint
+[snip]
+    34 / Toronto Single Site Private Endpoint
+       \ "s3.tor01.objectstorage.service.networklayer.com"
+    endpoint>1
    
+
      
+
    1. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter
      2. 
+
    
+
         1 / US Cross Region Standard
+       \ "us-standard"
+     2 / US Cross Region Vault
+       \ "us-vault"
+     3 / US Cross Region Cold
+       \ "us-cold"
+     4 / US Cross Region Flex
+       \ "us-flex"
+     5 / US East Region Standard
+       \ "us-east-standard"
+     6 / US East Region Vault
+       \ "us-east-vault"
+     7 / US East Region Cold
+       \ "us-east-cold"
+     8 / US East Region Flex
+       \ "us-east-flex"
+     9 / US South Region Standard
+       \ "us-south-standard"
+    10 / US South Region Vault
+       \ "us-south-vault"
+[snip]
+    32 / Toronto Flex
+       \ "tor01-flex"
+location_constraint>1
    
+
      
+
    1. Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.
      2. 
+
    
+
    Canned ACL used when creating buckets and/or storing objects in S3.
+For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Choose a number from below, or type in your own value
+      1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
+      \ "private"
+      2  / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
+      \ "public-read"
+      3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
+      \ "public-read-write"
+      4  / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
+      \ "authenticated-read"
+acl> 1
    
+
      
+
    1. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this
      2. 
+
    
+
        [xxx]
+    type = s3
+    Provider = IBMCOS
+    access_key_id = xxx
+    secret_access_key = yyy
+    endpoint = s3-api.us-geo.objectstorage.softlayer.net
+    location_constraint = us-standard
+    acl = private
    
+
      
+
    1. Execute rclone commands
      2. 
+
    
+
        1)  Create a bucket.
+        rclone mkdir IBM-COS-XREGION:newbucket
+    2)  List available buckets.
+        rclone lsd IBM-COS-XREGION:
+        -1 2017-11-08 21:16:22        -1 test
+        -1 2018-02-14 20:16:39        -1 newbucket
+    3)  List contents of a bucket.
+        rclone ls IBM-COS-XREGION:newbucket
+        18685952 test.exe
+    4)  Copy a file from local to remote.
+        rclone copy /Users/file.txt IBM-COS-XREGION:newbucket
+    5)  Copy a file from remote to local.
+        rclone copy IBM-COS-XREGION:newbucket/file.txt .
+    6)  Delete a file on remote.
+        rclone delete IBM-COS-XREGION:newbucket/file.txt
    
+
    Minio
    
+
    Minio is an object storage server built for cloud application developers and devops.
    
+
    It is very easy to install and provides an S3 compatible server which can be used by rclone.
    
+
    To use it, install Minio following the instructions here.
    
+
    When it configures itself Minio will print something like this
    
+
    Endpoint:  http://192.168.1.106:9000  http://172.23.0.1:9000
+AccessKey: USWUXHGYZQYFYFFIT3RE
+SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+Region:    us-east-1
+SQS ARNs:  arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis
+
+Browser Access:
+   http://192.168.1.106:9000  http://172.23.0.1:9000
+
+Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
+   $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+
+Object API (Amazon S3 compatible):
+   Go:         https://docs.minio.io/docs/golang-client-quickstart-guide
+   Java:       https://docs.minio.io/docs/java-client-quickstart-guide
+   Python:     https://docs.minio.io/docs/python-client-quickstart-guide
+   JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
+   .NET:       https://docs.minio.io/docs/dotnet-client-quickstart-guide
+
+Drive Capacity: 26 GiB Free, 165 GiB Total
    
+
    These details need to go into rclone config like this. Note that it is important to put the region in as stated above.
    
+
    env_auth> 1
+access_key_id> USWUXHGYZQYFYFFIT3RE
+secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+region> us-east-1
+endpoint> http://192.168.1.106:9000
+location_constraint>
+server_side_encryption>
    
+
    Which makes the config file look like this
    
+
    [minio]
+type = s3
+provider = Minio
+env_auth = false
+access_key_id = USWUXHGYZQYFYFFIT3RE
+secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+region = us-east-1
+endpoint = http://192.168.1.106:9000
+location_constraint =
+server_side_encryption =
    
+
    So once set up, for example to copy files into a bucket
    
+
    rclone copy /path/to/files minio:bucket
    
+
    Scaleway
    
+
    Scaleway The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool.
    
+
    Scaleway provides an S3 interface which can be configured for use with rclone like this:
    
+
    [scaleway]
+type = s3
+provider = Scaleway
+env_auth = false
+endpoint = s3.nl-ams.scw.cloud
+access_key_id = SCWXXXXXXXXXXXXXX
+secret_access_key = 1111111-2222-3333-44444-55555555555555
+region = nl-ams
+location_constraint =
+acl = private
+server_side_encryption =
+storage_class =
    
+
    Wasabi
    
+
    Wasabi is a cloud-based object storage service for a broad range of applications and use cases. Wasabi is designed for individuals and organizations that require a high-performance, reliable, and secure data storage infrastructure at minimal cost.
    
+
    Wasabi provides an S3 interface which can be configured for use with rclone like this.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+n/s> n
+name> wasabi
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon S3 (also Dreamhost, Ceph, Minio)
+   \ "s3"
+[snip]
+Storage> s3
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID - leave blank for anonymous access or runtime credentials.
+access_key_id> YOURACCESSKEY
+AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
+secret_access_key> YOURSECRETACCESSKEY
+Region to connect to.
+Choose a number from below, or type in your own value
+   / The default endpoint - a good choice if you are unsure.
+ 1 | US Region, Northern Virginia or Pacific Northwest.
+   | Leave location constraint empty.
+   \ "us-east-1"
+[snip]
+region> us-east-1
+Endpoint for S3 API.
+Leave blank if using AWS to use the default endpoint for the region.
+Specify if using an S3 clone such as Ceph.
+endpoint> s3.wasabisys.com
+Location constraint - must be set to match the Region. Used when creating buckets only.
+Choose a number from below, or type in your own value
+ 1 / Empty for US Region, Northern Virginia or Pacific Northwest.
+   \ ""
+[snip]
+location_constraint>
+Canned ACL used when creating buckets and/or storing objects in S3.
+For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Choose a number from below, or type in your own value
+ 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
+   \ "private"
+[snip]
+acl>
+The server-side encryption algorithm used when storing this object in S3.
+Choose a number from below, or type in your own value
+ 1 / None
+   \ ""
+ 2 / AES256
+   \ "AES256"
+server_side_encryption>
+The storage class to use when storing objects in S3.
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+ 2 / Standard storage class
+   \ "STANDARD"
+ 3 / Reduced redundancy storage class
+   \ "REDUCED_REDUNDANCY"
+ 4 / Standard Infrequent Access storage class
+   \ "STANDARD_IA"
+storage_class>
+Remote config
+--------------------
+[wasabi]
+env_auth = false
+access_key_id = YOURACCESSKEY
+secret_access_key = YOURSECRETACCESSKEY
+region = us-east-1
+endpoint = s3.wasabisys.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    This will leave the config file looking like this.
    
+
    [wasabi]
+type = s3
+provider = Wasabi
+env_auth = false
+access_key_id = YOURACCESSKEY
+secret_access_key = YOURSECRETACCESSKEY
+region =
+endpoint = s3.wasabisys.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
    
+
    Alibaba OSS
    
+
    Here is an example of making an Alibaba Cloud (Aliyun) OSS configuration. First run:
    
+
    rclone config
    
+
    This will guide you through an interactive setup process.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> oss
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+ 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)
+   \ "s3"
+[snip]
+Storage> s3
+Choose your S3 provider.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Amazon Web Services (AWS) S3
+   \ "AWS"
+ 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun
+   \ "Alibaba"
+ 3 / Ceph Object Storage
+   \ "Ceph"
+[snip]
+provider> Alibaba
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Enter a boolean value (true or false). Press Enter for the default ("false").
+Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default ("").
+access_key_id> accesskeyid
+AWS Secret Access Key (password)
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default ("").
+secret_access_key> secretaccesskey
+Endpoint for OSS API.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / East China 1 (Hangzhou)
+   \ "oss-cn-hangzhou.aliyuncs.com"
+ 2 / East China 2 (Shanghai)
+   \ "oss-cn-shanghai.aliyuncs.com"
+ 3 / North China 1 (Qingdao)
+   \ "oss-cn-qingdao.aliyuncs.com"
+[snip]
+endpoint> 1
+Canned ACL used when creating buckets and storing or copying objects.
 
 Note that this ACL is applied when server side copying objects as S3
 doesn't copy the ACL from the source but rather writes a fresh one.
-
-- Config:      acl
-- Env Var:     RCLONE_S3_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "private"
-        - Owner gets FULL_CONTROL. No one else has access rights (default).
-    - "public-read"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ access.
-    - "public-read-write"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
-        - Granting this on a bucket is generally not recommended.
-    - "authenticated-read"
-        - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
-    - "bucket-owner-read"
-        - Object owner gets FULL_CONTROL. Bucket owner gets READ access.
-        - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
-    - "bucket-owner-full-control"
-        - Both the object owner and the bucket owner get FULL_CONTROL over the object.
-        - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
-    - "private"
-        - Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
-    - "public-read"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
-    - "public-read-write"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
-    - "authenticated-read"
-        - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
-
-#### --s3-server-side-encryption
-
-The server-side encryption algorithm used when storing this object in S3.
-
-- Config:      server_side_encryption
-- Env Var:     RCLONE_S3_SERVER_SIDE_ENCRYPTION
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-    - "AES256"
-        - AES256
-    - "aws:kms"
-        - aws:kms
-
-#### --s3-sse-kms-key-id
-
-If using KMS ID you must provide the ARN of Key.
-
-- Config:      sse_kms_key_id
-- Env Var:     RCLONE_S3_SSE_KMS_KEY_ID
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-    - "arn:aws:kms:us-east-1:*"
-        - arn:aws:kms:*
-
-#### --s3-storage-class
-
-The storage class to use when storing new objects in S3.
-
-- Config:      storage_class
-- Env Var:     RCLONE_S3_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "STANDARD"
-        - Standard storage class
-    - "REDUCED_REDUNDANCY"
-        - Reduced redundancy storage class
-    - "STANDARD_IA"
-        - Standard Infrequent Access storage class
-    - "ONEZONE_IA"
-        - One Zone Infrequent Access storage class
-    - "GLACIER"
-        - Glacier storage class
-    - "DEEP_ARCHIVE"
-        - Glacier Deep Archive storage class
-    - "INTELLIGENT_TIERING"
-        - Intelligent-Tiering storage class
-
-#### --s3-storage-class
-
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
+   \ "private"
+ 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.
+   \ "public-read"
+   / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
+[snip]
+acl> 1
 The storage class to use when storing new objects in OSS.
-
-- Config:      storage_class
-- Env Var:     RCLONE_S3_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "STANDARD"
-        - Standard storage class
-    - "GLACIER"
-        - Archive storage mode.
-    - "STANDARD_IA"
-        - Infrequent access storage mode.
-
-#### --s3-storage-class
-
-The storage class to use when storing new objects in S3.
-
-- Config:      storage_class
-- Env Var:     RCLONE_S3_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "STANDARD"
-        - The Standard class for any upload; suitable for on-demand content like streaming or CDN.
-    - "GLACIER"
-        - Archived storage; prices are lower, but it needs to be restored first to be accessed.
-
-### Advanced Options
-
-Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).
-
-#### --s3-bucket-acl
-
-Canned ACL used when creating buckets.
-
-For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
-
-Note that this ACL is applied when only when creating buckets.  If it
-isn't set then "acl" is used instead.
-
-- Config:      bucket_acl
-- Env Var:     RCLONE_S3_BUCKET_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "private"
-        - Owner gets FULL_CONTROL. No one else has access rights (default).
-    - "public-read"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ access.
-    - "public-read-write"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
-        - Granting this on a bucket is generally not recommended.
-    - "authenticated-read"
-        - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
-
-#### --s3-sse-customer-algorithm
-
-If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
-
-- Config:      sse_customer_algorithm
-- Env Var:     RCLONE_S3_SSE_CUSTOMER_ALGORITHM
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-    - "AES256"
-        - AES256
-
-#### --s3-sse-customer-key
-
-If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
-
-- Config:      sse_customer_key
-- Env Var:     RCLONE_S3_SSE_CUSTOMER_KEY
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-
-#### --s3-sse-customer-key-md5
-
-If using SSE-C you must provide the secret encryption key MD5 checksum.
-
-- Config:      sse_customer_key_md5
-- Env Var:     RCLONE_S3_SSE_CUSTOMER_KEY_MD5
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-
-#### --s3-upload-cutoff
-
-Cutoff for switching to chunked upload
-
-Any files larger than this will be uploaded in chunks of chunk_size.
-The minimum is 0 and the maximum is 5GB.
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_S3_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     200M
-
-#### --s3-chunk-size
-
-Chunk size to use for uploading.
-
-When uploading files larger than upload_cutoff or files with unknown
-size (eg from "rclone rcat" or uploaded with "rclone mount" or google
-photos or google docs) they will be uploaded as multipart uploads
-using this chunk size.
-
-Note that "--s3-upload-concurrency" chunks of this size are buffered
-in memory per transfer.
-
-If you are transferring large files over high speed links and you have
-enough memory, then increasing this will speed up the transfers.
-
-Rclone will automatically increase the chunk size when uploading a
-large file of known size to stay below the 10,000 chunks limit.
-
-Files of unknown size are uploaded with the configured
-chunk_size. Since the default chunk size is 5MB and there can be at
-most 10,000 chunks, this means that by default the maximum size of
-file you can stream upload is 48GB.  If you wish to stream upload
-larger files then you will need to increase chunk_size.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_S3_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     5M
-
-#### --s3-max-upload-parts
-
-Maximum number of parts in a multipart upload.
-
-This option defines the maximum number of multipart chunks to use
-when doing a multipart upload.
-
-This can be useful if a service does not support the AWS S3
-specification of 10,000 chunks.
-
-Rclone will automatically increase the chunk size when uploading a
-large file of a known size to stay below this number of chunks limit.
-
-
-- Config:      max_upload_parts
-- Env Var:     RCLONE_S3_MAX_UPLOAD_PARTS
-- Type:        int
-- Default:     10000
-
-#### --s3-copy-cutoff
-
-Cutoff for switching to multipart copy
-
-Any files larger than this that need to be server side copied will be
-copied in chunks of this size.
-
-The minimum is 0 and the maximum is 5GB.
-
-- Config:      copy_cutoff
-- Env Var:     RCLONE_S3_COPY_CUTOFF
-- Type:        SizeSuffix
-- Default:     4.656G
-
-#### --s3-disable-checksum
-
-Don't store MD5 checksum with object metadata
-
-Normally rclone will calculate the MD5 checksum of the input before
-uploading it so it can add it to metadata on the object. This is great
-for data integrity checking but can cause long delays for large files
-to start uploading.
-
-- Config:      disable_checksum
-- Env Var:     RCLONE_S3_DISABLE_CHECKSUM
-- Type:        bool
-- Default:     false
-
-#### --s3-shared-credentials-file
-
-Path to the shared credentials file
-
-If env_auth = true then rclone can use a shared credentials file.
-
-If this variable is empty rclone will look for the
-"AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty
-it will default to the current user's home directory.
-
-    Linux/OSX: "$HOME/.aws/credentials"
-    Windows:   "%USERPROFILE%\.aws\credentials"
-
-
-- Config:      shared_credentials_file
-- Env Var:     RCLONE_S3_SHARED_CREDENTIALS_FILE
-- Type:        string
-- Default:     ""
-
-#### --s3-profile
-
-Profile to use in the shared credentials file
-
-If env_auth = true then rclone can use a shared credentials file. This
-variable controls which profile is used in that file.
-
-If empty it will default to the environment variable "AWS_PROFILE" or
-"default" if that environment variable is also not set.
-
-
-- Config:      profile
-- Env Var:     RCLONE_S3_PROFILE
-- Type:        string
-- Default:     ""
-
-#### --s3-session-token
-
-An AWS session token
-
-- Config:      session_token
-- Env Var:     RCLONE_S3_SESSION_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --s3-upload-concurrency
-
-Concurrency for multipart uploads.
-
-This is the number of chunks of the same file that are uploaded
-concurrently.
-
-If you are uploading small numbers of large file over high speed link
-and these uploads do not fully utilize your bandwidth, then increasing
-this may help to speed up the transfers.
-
-- Config:      upload_concurrency
-- Env Var:     RCLONE_S3_UPLOAD_CONCURRENCY
-- Type:        int
-- Default:     4
-
-#### --s3-force-path-style
-
-If true use path style access if false use virtual hosted style.
-
-If this is true (the default) then rclone will use path style access,
-if false then rclone will use virtual path style. See [the AWS S3
-docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)
-for more info.
-
-Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to
-false - rclone will do this automatically based on the provider
-setting.
-
-- Config:      force_path_style
-- Env Var:     RCLONE_S3_FORCE_PATH_STYLE
-- Type:        bool
-- Default:     true
-
-#### --s3-v2-auth
-
-If true use v2 authentication.
-
-If this is false (the default) then rclone will use v4 authentication.
-If it is set then rclone will use v2 authentication.
-
-Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.
-
-- Config:      v2_auth
-- Env Var:     RCLONE_S3_V2_AUTH
-- Type:        bool
-- Default:     false
-
-#### --s3-use-accelerate-endpoint
-
-If true use the AWS S3 accelerated endpoint.
-
-See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html)
-
-- Config:      use_accelerate_endpoint
-- Env Var:     RCLONE_S3_USE_ACCELERATE_ENDPOINT
-- Type:        bool
-- Default:     false
-
-#### --s3-leave-parts-on-error
-
-If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
-
-It should be set to true for resuming uploads across different sessions.
-
-WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.
-
-
-- Config:      leave_parts_on_error
-- Env Var:     RCLONE_S3_LEAVE_PARTS_ON_ERROR
-- Type:        bool
-- Default:     false
-
-#### --s3-list-chunk
-
-Size of listing chunk (response list for each ListObject S3 request).
-
-This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification.
-Most services truncate the response list to 1000 objects even if requested more than that.
-In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html).
-In Ceph, this can be increased with the "rgw list buckets max chunk" option.
-
-
-- Config:      list_chunk
-- Env Var:     RCLONE_S3_LIST_CHUNK
-- Type:        int
-- Default:     1000
-
-#### --s3-no-check-bucket
-
-If set don't attempt to check the bucket exists or create it
-
-This can be useful when trying to minimise the number of transactions
-rclone does if you know the bucket exists already.
-
-
-- Config:      no_check_bucket
-- Env Var:     RCLONE_S3_NO_CHECK_BUCKET
-- Type:        bool
-- Default:     false
-
-#### --s3-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_S3_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,InvalidUtf8,Dot
-
-#### --s3-memory-pool-flush-time
-
-How often internal memory buffer pools will be flushed.
-Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations.
-This option controls how often unused buffers will be removed from the pool.
-
-- Config:      memory_pool_flush_time
-- Env Var:     RCLONE_S3_MEMORY_POOL_FLUSH_TIME
-- Type:        Duration
-- Default:     1m0s
-
-#### --s3-memory-pool-use-mmap
-
-Whether to use mmap buffers in internal memory pool.
-
-- Config:      memory_pool_use_mmap
-- Env Var:     RCLONE_S3_MEMORY_POOL_USE_MMAP
-- Type:        bool
-- Default:     false
-
-### Backend commands
-
-Here are the commands specific to the s3 backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### restore
-
-Restore objects from GLACIER to normal storage
-
-    rclone backend restore remote: [options] [<arguments>+]
-
-This command can be used to restore one or more objects from GLACIER
-to normal storage.
-
-Usage Examples:
-
-    rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]
-    rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]
-    rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]
-
-This flag also obeys the filters. Test first with -i/--interactive or --dry-run flags
-
-    rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard
-
-All the objects shown will be marked for restore, then
-
-    rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard
-
-It returns a list of status dictionaries with Remote and Status
-keys. The Status will be OK if it was successfull or an error message
-if not.
-
-    [
-        {
-            "Status": "OK",
-            "Path": "test.txt"
-        },
-        {
-            "Status": "OK",
-            "Path": "test/file4.txt"
-        }
-    ]
-
-
-
-Options:
-
-- "description": The optional description for the job.
-- "lifetime": Lifetime of the active copy in days
-- "priority": Priority of restore: Standard|Expedited|Bulk
-
-#### list-multipart-uploads
-
-List the unfinished multipart uploads
-
-    rclone backend list-multipart-uploads remote: [options] [<arguments>+]
-
-This command lists the unfinished multipart uploads in JSON format.
-
-    rclone backend list-multipart s3:bucket/path/to/object
-
-It returns a dictionary of buckets with values as lists of unfinished
-multipart uploads.
-
-You can call it with no bucket in which case it lists all bucket, with
-a bucket or with a bucket and path.
-
-    {
-      "rclone": [
-        {
-          "Initiated": "2020-06-26T14:20:36Z",
-          "Initiator": {
-            "DisplayName": "XXX",
-            "ID": "arn:aws:iam::XXX:user/XXX"
-          },
-          "Key": "KEY",
-          "Owner": {
-            "DisplayName": null,
-            "ID": "XXX"
-          },
-          "StorageClass": "STANDARD",
-          "UploadId": "XXX"
-        }
-      ],
-      "rclone-1000files": [],
-      "rclone-dst": []
-    }
-
-
-
-#### cleanup
-
-Remove unfinished multipart uploads.
-
-    rclone backend cleanup remote: [options] [<arguments>+]
-
-This command removes unfinished multipart uploads of age greater than
-max-age which defaults to 24 hours.
-
-Note that you can use -i/--dry-run with this command to see what it
-would do.
-
-    rclone backend cleanup s3:bucket/path/to/object
-    rclone backend cleanup -o max-age=7w s3:bucket/path/to/object
-
-Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
-
-
-Options:
-
-- "max-age": Max age of upload to delete
-
-
-
-### Anonymous access to public buckets ###
-
-If you want to use rclone to access a public bucket, configure with a
-blank `access_key_id` and `secret_access_key`.  Your config should end
-up looking like this:
-
    
-
    [anons3] type = s3 provider = AWS env_auth = false access_key_id = secret_access_key = region = us-east-1 endpoint = location_constraint = acl = private server_side_encryption = storage_class =
    
-
    
-Then use it as normal with the name of the public bucket, eg
-
-    rclone lsd anons3:1000genomes
-
-You will be able to list and copy data but not upload it.
-
-### Ceph ###
-
-[Ceph](https://ceph.com/) is an open source unified, distributed
-storage system designed for excellent performance, reliability and
-scalability.  It has an S3 compatible object storage interface.
-
-To use rclone with Ceph, configure as above but leave the region blank
-and set the endpoint.  You should end up with something like this in
-your config:
-
-
    
-
    [ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX secret_access_key = YYY region = endpoint = https://ceph.endpoint.example.com location_constraint = acl = server_side_encryption = storage_class =
    
-
    
-If you are using an older version of CEPH, eg 10.2.x Jewel, then you
-may need to supply the parameter `--s3-upload-cutoff 0` or put this in
-the config file as `upload_cutoff 0` to work around a bug which causes
-uploading of small files to fail.
-
-Note also that Ceph sometimes puts `/` in the passwords it gives
-users.  If you read the secret access key using the command line tools
-you will get a JSON blob with the `/` escaped as `\/`.  Make sure you
-only write `/` in the secret access key.
-
-Eg the dump from Ceph looks something like this (irrelevant keys
-removed).
-
    
-
    { "user_id": "xxx", "display_name": "xxxx", "keys": [ { "user": "xxx", "access_key": "xxxxxx", "secret_key": "xxxxxx/xxxx" } ], }
    
-
    
-Because this is a json dump, it is encoding the `/` as `\/`, so if you
-use the secret key as `xxxxxx/xxxx`  it will work fine.
-
-### Dreamhost ###
-
-Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is
-an object storage system based on CEPH.
-
-To use rclone with Dreamhost, configure as above but leave the region blank
-and set the endpoint.  You should end up with something like this in
-your config:
-
    
-
    [dreamobjects] type = s3 provider = DreamHost env_auth = false access_key_id = your_access_key secret_access_key = your_secret_key region = endpoint = objects-us-west-1.dream.io location_constraint = acl = private server_side_encryption = storage_class =
    
-
    
-### DigitalOcean Spaces ###
-
-[Spaces](https://www.digitalocean.com/products/object-storage/) is an [S3-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean.
-
-To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when prompted by `rclone config` for your `access_key_id` and `secret_access_key`.
-
-When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The default values can be used for other settings.
-
-Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below:
-
    
-
    Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY secret_access_key> YOUR_SECRET_KEY region> endpoint> nyc3.digitaloceanspaces.com location_constraint> acl> storage_class>
    
-
    
-The resulting configuration file should look like:
-
    
-
    [spaces] type = s3 provider = DigitalOcean env_auth = false access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY region = endpoint = nyc3.digitaloceanspaces.com location_constraint = acl = server_side_encryption = storage_class =
    
-
    
-Once configured, you can create a new Space and begin copying files. For example:
-
    
-
    rclone mkdir spaces:my-new-space rclone copy /path/to/files spaces:my-new-space
    
-
    
-### IBM COS (S3) ###
-
-Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage)
-
-To configure access to IBM COS S3, follow the steps below:
-
-1. Run rclone config and select n for a new remote.
    
-
    2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+ 2 / Standard storage class
+   \ "STANDARD"
+ 3 / Archive storage mode.
+   \ "GLACIER"
+ 4 / Infrequent access storage mode.
+   \ "STANDARD_IA"
+storage_class> 1
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+--------------------
+[oss]
+type = s3
+provider = Alibaba
+env_auth = false
+access_key_id = accesskeyid
+secret_access_key = secretaccesskey
+endpoint = oss-cn-hangzhou.aliyuncs.com
+acl = private
+storage_class = Standard
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Tencent COS
    
+
    Tencent Cloud Object Storage (COS) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost.
    
+
    To configure access to Tencent COS, follow the steps below:
    
+
      
+
    1. Run rclone config and select n for a new remote.
      2. 
+
    
+
    rclone config
 No remotes found - make a new one
 n) New remote
 s) Set configuration password
 q) Quit config
 n/s/q> n
    
-
    
-2. Enter the name for the configuration
    
-
    name> <YOUR NAME>
    
-
    
-3. Select "s3" storage.
    
-
    Choose a number from below, or type in your own value 1 / Alias for an existing remote  "alias" 2 / Amazon Drive  "amazon cloud drive" 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS)  "s3" 4 / Backblaze B2  "b2" [snip] 23 / http Connection  "http" Storage> 3
    
-
    
-4. Select IBM COS as the S3 Storage Provider.
    
-
    Choose the S3 provider. Choose a number from below, or type in your own value 1 / Choose this option to configure Storage to AWS S3  "AWS" 2 / Choose this option to configure Storage to Ceph Systems  "Ceph" 3 / Choose this option to configure Storage to Dreamhost  "Dreamhost" 4 / Choose this option to the configure Storage to IBM COS S3  "IBMCOS" 5 / Choose this option to the configure Storage to Minio  "Minio" Provider>4
    
-
    
-5. Enter the Access Key and Secret.
    
-
    AWS Access Key ID - leave blank for anonymous access or runtime credentials.
-access_key_id> <>
-AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
-secret_access_key> <>
    
-
    
-6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address.
    
-
    Endpoint for IBM COS S3 API.
-Specify if using an IBM COS On Premise.
+
      
+
    1. Give the name of the configuration. For example, name it 'cos'.
      2. 
+
    
+
    name> cos
    
+
      
+
    1. Select s3 storage.
      2. 
+
    
+
    Choose a number from below, or type in your own value
+1 / 1Fichier
+   \ "fichier"
+ 2 / Alias for an existing remote
+   \ "alias"
+ 3 / Amazon Drive
+   \ "amazon cloud drive"
+ 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)
+   \ "s3"
+[snip]
+Storage> s3
    
+
      
+
    1. Select TencentCOS provider.
      2. 
+
    
+
    Choose a number from below, or type in your own value
+1 / Amazon Web Services (AWS) S3
+   \ "AWS"
+[snip]
+11 / Tencent Cloud Object Storage (COS)
+   \ "TencentCOS"
+[snip]
+provider> TencentCOS
    
+
      
+
    1. Enter your SecretId and SecretKey of Tencent Cloud.
      2. 
+
    
+
    Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Enter a boolean value (true or false). Press Enter for the default ("false").
 Choose a number from below, or type in your own value
- 1 / US Cross Region Endpoint
-   \ "s3-api.us-geo.objectstorage.softlayer.net"
- 2 / US Cross Region Dallas Endpoint
-   \ "s3-api.dal.us-geo.objectstorage.softlayer.net"
- 3 / US Cross Region Washington DC Endpoint
-   \ "s3-api.wdc-us-geo.objectstorage.softlayer.net"
- 4 / US Cross Region San Jose Endpoint
-   \ "s3-api.sjc-us-geo.objectstorage.softlayer.net"
- 5 / US Cross Region Private Endpoint
-   \ "s3-api.us-geo.objectstorage.service.networklayer.com"
- 6 / US Cross Region Dallas Private Endpoint
-   \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com"
- 7 / US Cross Region Washington DC Private Endpoint
-   \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com"
- 8 / US Cross Region San Jose Private Endpoint
-   \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com"
- 9 / US Region East Endpoint
-   \ "s3.us-east.objectstorage.softlayer.net"
-10 / US Region East Private Endpoint
-   \ "s3.us-east.objectstorage.service.networklayer.com"
-11 / US Region South Endpoint
    
-
    [snip] 34 / Toronto Single Site Private Endpoint  "s3.tor01.objectstorage.service.networklayer.com" endpoint>1
    
-
    
-
-7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter
    
-
     1 / US Cross Region Standard
-   \ "us-standard"
- 2 / US Cross Region Vault
-   \ "us-vault"
- 3 / US Cross Region Cold
-   \ "us-cold"
- 4 / US Cross Region Flex
-   \ "us-flex"
- 5 / US East Region Standard
-   \ "us-east-standard"
- 6 / US East Region Vault
-   \ "us-east-vault"
- 7 / US East Region Cold
-   \ "us-east-cold"
- 8 / US East Region Flex
-   \ "us-east-flex"
- 9 / US South Region Standard
-   \ "us-south-standard"
-10 / US South Region Vault
-   \ "us-south-vault"
    
-
    [snip] 32 / Toronto Flex  "tor01-flex" location_constraint>1
    
-
    
-9. Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.
    
-
    Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS  "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS  "public-read" 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS  "public-read-write" 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS  "authenticated-read" acl> 1
    
-
    
-
-12. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this
    
-
    [xxx]
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default ("").
+access_key_id> AKIDxxxxxxxxxx
+AWS Secret Access Key (password)
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default ("").
+secret_access_key> xxxxxxxxxxx
    
+
      
+
    1. Select endpoint for Tencent COS. This is the standard endpoint for different region.
      2. 
+
    
+
     1 / Beijing Region.
+   \ "cos.ap-beijing.myqcloud.com"
+ 2 / Nanjing Region.
+   \ "cos.ap-nanjing.myqcloud.com"
+ 3 / Shanghai Region.
+   \ "cos.ap-shanghai.myqcloud.com"
+ 4 / Guangzhou Region.
+   \ "cos.ap-guangzhou.myqcloud.com"
+[snip]
+endpoint> 4
    
+
      
+
    1. Choose acl and storage class.
      2. 
+
    
+
    Note that this ACL is applied when server side copying objects as S3
+doesn't copy the ACL from the source but rather writes a fresh one.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Owner gets Full_CONTROL. No one else has access rights (default).
+   \ "default"
+[snip]
+acl> 1
+The storage class to use when storing new objects in Tencent COS.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+[snip]
+storage_class> 1
+Edit advanced config? (y/n)
+y) Yes
+n) No (default)
+y/n> n
+Remote config
+--------------------
+[cos]
 type = s3
-Provider = IBMCOS
+provider = TencentCOS
+env_auth = false
 access_key_id = xxx
-secret_access_key = yyy
-endpoint = s3-api.us-geo.objectstorage.softlayer.net
-location_constraint = us-standard
-acl = private
    
-
    
-13. Execute rclone commands
    
-
    1)  Create a bucket.
-    rclone mkdir IBM-COS-XREGION:newbucket
-2)  List available buckets.
-    rclone lsd IBM-COS-XREGION:
-    -1 2017-11-08 21:16:22        -1 test
-    -1 2018-02-14 20:16:39        -1 newbucket
-3)  List contents of a bucket.
-    rclone ls IBM-COS-XREGION:newbucket
-    18685952 test.exe
-4)  Copy a file from local to remote.
-    rclone copy /Users/file.txt IBM-COS-XREGION:newbucket
-5)  Copy a file from remote to local.
-    rclone copy IBM-COS-XREGION:newbucket/file.txt .
-6)  Delete a file on remote.
-    rclone delete IBM-COS-XREGION:newbucket/file.txt
    
-
    
-### Minio ###
-
-[Minio](https://minio.io/) is an object storage server built for cloud application developers and devops.
-
-It is very easy to install and provides an S3 compatible server which can be used by rclone.
-
-To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio-quickstart-guide).
-
-When it configures itself Minio will print something like this
-
    
-
    Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 Region: us-east-1 SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis
    
-
    Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000
    
-
    Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
    
-
    Object API (Amazon S3 compatible): Go: https://docs.minio.io/docs/golang-client-quickstart-guide Java: https://docs.minio.io/docs/java-client-quickstart-guide Python: https://docs.minio.io/docs/python-client-quickstart-guide JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide
    
-
    Drive Capacity: 26 GiB Free, 165 GiB Total
    
-
    
-These details need to go into `rclone config` like this.  Note that it
-is important to put the region in as stated above.
-
    
-
    env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us-east-1 endpoint> http://192.168.1.106:9000 location_constraint> server_side_encryption>
    
-
    
-Which makes the config file look like this
-
    
-
    [minio] type = s3 provider = Minio env_auth = false access_key_id = USWUXHGYZQYFYFFIT3RE secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us-east-1 endpoint = http://192.168.1.106:9000 location_constraint = server_side_encryption =
    
-
    
-So once set up, for example to copy files into a bucket
-
    
-
    rclone copy /path/to/files minio:bucket
    
-
    
-### Scaleway {#scaleway}
-
-[Scaleway](https://www.scaleway.com/object-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos.
-Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool.
-
-Scaleway provides an S3 interface which can be configured for use with rclone like this:
-
    
-
    [scaleway] type = s3 provider = Scaleway env_auth = false endpoint = s3.nl-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key = 1111111-2222-3333-44444-55555555555555 region = nl-ams location_constraint = acl = private server_side_encryption = storage_class =
    
-
    
-### Wasabi ###
-
-[Wasabi](https://wasabi.com) is a cloud-based object storage service for a
-broad range of applications and use cases. Wasabi is designed for
-individuals and organizations that require a high-performance,
-reliable, and secure data storage infrastructure at minimal cost.
-
-Wasabi provides an S3 interface which can be configured for use with
-rclone like this.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password n/s> n name> wasabi Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon S3 (also Dreamhost, Ceph, Minio)  "s3" [snip] Storage> s3 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step  "false" 2 / Get AWS credentials from the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> YOURACCESSKEY AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> YOURSECRETACCESSKEY Region to connect to. Choose a number from below, or type in your own value / The default endpoint - a good choice if you are unsure. 1 | US Region, Northern Virginia or Pacific Northwest. | Leave location constraint empty.  "us-east-1" [snip] region> us-east-1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. Specify if using an S3 clone such as Ceph. endpoint> s3.wasabisys.com Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value 1 / Empty for US Region, Northern Virginia or Pacific Northwest.  "" [snip] location_constraint> Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default).  "private" [snip] acl> The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value 1 / None  "" 2 / AES256  "AES256" server_side_encryption> The storage class to use when storing objects in S3. Choose a number from below, or type in your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 / Reduced redundancy storage class  "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access storage class  "STANDARD_IA" storage_class> Remote config -------------------- [wasabi] env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = us-east-1 endpoint = s3.wasabisys.com location_constraint = acl = server_side_encryption = storage_class = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-This will leave the config file looking like this.
-
    
-
    [wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint = s3.wasabisys.com location_constraint = acl = server_side_encryption = storage_class =
    
-
    
-### Alibaba OSS {#alibaba-oss}
-
-Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/)
-configuration.  First run:
-
-    rclone config
-
-This will guide you through an interactive setup process.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> oss Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)  "s3" [snip] Storage> s3 Choose your S3 provider. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3  "AWS" 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun  "Alibaba" 3 / Ceph Object Storage  "Ceph" [snip] provider> Alibaba Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Enter a boolean value (true or false). Press Enter for the default ("false"). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step  "false" 2 / Get AWS credentials from the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (""). access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (""). secret_access_key> secretaccesskey Endpoint for OSS API. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / East China 1 (Hangzhou)  "oss-cn-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai)  "oss-cn-shanghai.aliyuncs.com" 3 / North China 1 (Qingdao)  "oss-cn-qingdao.aliyuncs.com" [snip] endpoint> 1 Canned ACL used when creating buckets and storing or copying objects.
    
-
    Note that this ACL is applied when server side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default).  "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.  "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. [snip] acl> 1 The storage class to use when storing new objects in OSS. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 / Archive storage mode.  "GLACIER" 4 / Infrequent access storage mode.  "STANDARD_IA" storage_class> 1 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [oss] type = s3 provider = Alibaba env_auth = false access_key_id = accesskeyid secret_access_key = secretaccesskey endpoint = oss-cn-hangzhou.aliyuncs.com acl = private storage_class = Standard -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-### Netease NOS  ###
-
-For Netease NOS configure as per the configurator `rclone config`
-setting the provider `Netease`.  This will automatically set
-`force_path_style = false` which is necessary for it to run properly.
-
- Backblaze B2
-----------------------------------------
-
-B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/).
-
-Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
-command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
-
-Here is an example of making a b2 configuration.  First run
-
-    rclone config
-
-This will guide you through an interactive setup process.  To authenticate
-you will either need your Account ID (a short hex number) and Master
-Application Key (a long hex number) OR an Application Key, which is the
-recommended method. See below for further details on generating and using
-an Application Key.
-
    
-
    No remotes found - make a new one n) New remote q) Quit config n/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Backblaze B2  "b2" [snip] Storage> b2 Account ID or Application Key ID account> 123456789abc Application Key key> 0123456789abcdef0123456789abcdef0123456789 Endpoint for the service - leave blank normally. endpoint> Remote config -------------------- [remote] account = 123456789abc key = 0123456789abcdef0123456789abcdef0123456789 endpoint = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-This remote is called `remote` and can now be used like this
-
-See all buckets
-
-    rclone lsd remote:
-
-Create a new bucket
-
-    rclone mkdir remote:bucket
-
-List the contents of a bucket
-
-    rclone ls remote:bucket
-
-Sync `/home/local/directory` to the remote bucket, deleting any
-excess files in the bucket.
-
-    rclone sync -i /home/local/directory remote:bucket
-
-### Application Keys ###
-
-B2 supports multiple [Application Keys for different access permission
-to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html).
-
-You can use these with rclone too; you will need to use rclone version 1.43
-or later.
-
-Follow Backblaze's docs to create an Application Key with the required
-permission and add the `applicationKeyId` as the `account` and the
-`Application Key` itself as the `key`.
-
-Note that you must put the _applicationKeyId_ as the `account` – you
-can't use the master Account ID.  If you try then B2 will return 401
-errors.
-
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-### Modified time ###
-
-The modified time is stored as metadata on the object as
-`X-Bz-Info-src_last_modified_millis` as milliseconds since 1970-01-01
-in the Backblaze standard.  Other tools should be able to use this as
-a modified time.
-
-Modified times are used in syncing and are fully supported. Note that
-if a modification time needs to be updated on an object then it will
-create a new version of the object.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \         | 0x5C  | ＼           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-Note that in 2020-05 Backblaze started allowing \ characters in file
-names. Rclone hasn't changed its encoding as this could cause syncs to
-re-transfer files. If you want rclone not to replace \ then see the
-`--b2-encoding` flag below and remove the `BackSlash` from the
-string. This can be set in the config.
-
-### SHA1 checksums ###
-
-The SHA1 checksums of the files are checked on upload and download and
-will be used in the syncing process.
-
-Large files (bigger than the limit in `--b2-upload-cutoff`) which are
-uploaded in chunks will store their SHA1 on the object as
-`X-Bz-Info-large_file_sha1` as recommended by Backblaze.
-
-For a large file to be uploaded with an SHA1 checksum, the source
-needs to support SHA1 checksums. The local disk supports SHA1
-checksums so large file transfers from local disk will have an SHA1.
-See [the overview](https://rclone.org/overview/#features) for exactly which remotes
-support SHA1.
-
-Sources which don't support SHA1, in particular `crypt` will upload
-large files without SHA1 checksums.  This may be fixed in the future
-(see [#1767](https://github.com/rclone/rclone/issues/1767)).
-
-Files sizes below `--b2-upload-cutoff` will always have an SHA1
-regardless of the source.
-
-### Transfers ###
-
-Backblaze recommends that you do lots of transfers simultaneously for
-maximum speed.  In tests from my SSD equipped laptop the optimum
-setting is about `--transfers 32` though higher numbers may be used
-for a slight speed improvement. The optimum number for you may vary
-depending on your hardware, how big the files are, how much you want
-to load your computer, etc.  The default of `--transfers 4` is
-definitely too low for Backblaze B2 though.
-
-Note that uploading big files (bigger than 200 MB by default) will use
-a 96 MB RAM buffer by default.  There can be at most `--transfers` of
-these in use at any moment, so this sets the upper limit on the memory
-used.
-
-### Versions ###
-
-When rclone uploads a new version of a file it creates a [new version
-of it](https://www.backblaze.com/b2/docs/file_versions.html).
-Likewise when you delete a file, the old version will be marked hidden
-and still be available.  Conversely, you may opt in to a "hard delete"
-of files with the `--b2-hard-delete` flag which would permanently remove
-the file instead of hiding it.
-
-Old versions of files, where available, are visible using the 
-`--b2-versions` flag.
-
-**NB** Note that `--b2-versions` does not work with crypt at the
-moment [#1627](https://github.com/rclone/rclone/issues/1627). Using
-[--backup-dir](https://rclone.org/docs/#backup-dir-dir) with rclone is the recommended
-way of working around this.
-
-If you wish to remove all the old versions then you can use the
-`rclone cleanup remote:bucket` command which will delete all the old
-versions of files, leaving the current ones intact.  You can also
-supply a path and only old versions under that path will be deleted,
-eg `rclone cleanup remote:bucket/path/to/stuff`.
-
-Note that `cleanup` will remove partially uploaded files from the bucket
-if they are more than a day old.
-
-When you `purge` a bucket, the current and the old versions will be
-deleted then the bucket will be deleted.
-
-However `delete` will cause the current versions of the files to
-become hidden old versions.
-
-Here is a session showing the listing and retrieval of an old
-version followed by a `cleanup` of the old versions.
-
-Show current version and all the versions with `--b2-versions` flag.
-
    
-
    $ rclone -q ls b2:cleanup-test 9 one.txt
    
-
    $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt
    
-
    
-Retrieve an old version
-
    
-
    $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp
    
-
    $ ls -l /tmp/one-v2016-07-04-141003-000.txt -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt
    
-
    
-Clean up all the old versions and show that they've gone.
-
    
-
    $ rclone -q cleanup b2:cleanup-test
    
-
    $ rclone -q ls b2:cleanup-test 9 one.txt
    
-
    $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt
    
-
    
-### Data usage ###
-
-It is useful to know how many requests are sent to the server in different scenarios.
-
-All copy commands send the following 4 requests:
-
    
-
    /b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket /b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names
    
-
    
-The `b2_list_file_names` request will be sent once for every 1k files
-in the remote path, providing the checksum and modification time of
-the listed files. As of version 1.33 issue
-[#818](https://github.com/rclone/rclone/issues/818) causes extra requests
-to be sent when using B2 with Crypt. When a copy operation does not
-require any files to be uploaded, no more requests will be sent.
-
-Uploading files that do not require chunking, will send 2 requests per
-file upload:
-
    
-
    /b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/
    
-
    
-Uploading files requiring chunking, will send 2 requests (one each to
-start and finish the upload) and another 2 requests for each chunk:
-
    
-
    /b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url /b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file
    
-
    
-#### Versions ####
-
-Versions can be viewed with the `--b2-versions` flag. When it is set
-rclone will show and act on older versions of files.  For example
-
-Listing without `--b2-versions`
-
    
-
    $ rclone -q ls b2:cleanup-test 9 one.txt
    
-
    
-And with
-
    
-
    $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt
    
-
    
-Showing that the current version is unchanged but older versions can
-be seen.  These have the UTC date that they were uploaded to the
-server to the nearest millisecond appended to them.
-
-Note that when using `--b2-versions` no file write operations are
-permitted, so you can't upload files or delete them.
-
-### B2 and rclone link ###
-
-Rclone supports generating file share links for private B2 buckets.
-They can either be for a file for example:
-
    
-
    ./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx
    
-
    
-or if run on a directory you will get:
-
    
-
    ./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx
    
-
    
-you can then use the authorization token (the part of the url from the
- `?Authorization=` on) on any file path under that directory. For example:
-
    
-
    https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx
    
-
    
-
-### Standard Options
-
-Here are the standard options specific to b2 (Backblaze B2).
-
-#### --b2-account
-
+secret_access_key = xxx
+endpoint = cos.ap-guangzhou.myqcloud.com
+acl = default
+--------------------
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+Current remotes:
+
+Name                 Type
+====                 ====
+cos                  s3
    
+
    Netease NOS
    
+
    For Netease NOS configure as per the configurator rclone config setting the provider Netease. This will automatically set force_path_style = false which is necessary for it to run properly.
    
+
    Backblaze B2
    
+
    B2 is Backblaze's cloud storage system.
    
+
    Paths are specified as remote:bucket (or remote: for the lsd command.) You may put subdirectories in too, eg remote:bucket/path/to/dir.
    
+
    Here is an example of making a b2 configuration. First run
    
+
    rclone config
    
+
    This will guide you through an interactive setup process. To authenticate you will either need your Account ID (a short hex number) and Master Application Key (a long hex number) OR an Application Key, which is the recommended method. See below for further details on generating and using an Application Key.
    
+
    No remotes found - make a new one
+n) New remote
+q) Quit config
+n/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Backblaze B2
+   \ "b2"
+[snip]
+Storage> b2
 Account ID or Application Key ID
-
-- Config:      account
-- Env Var:     RCLONE_B2_ACCOUNT
-- Type:        string
-- Default:     ""
-
-#### --b2-key
-
+account> 123456789abc
 Application Key
+key> 0123456789abcdef0123456789abcdef0123456789
+Endpoint for the service - leave blank normally.
+endpoint>
+Remote config
+--------------------
+[remote]
+account = 123456789abc
+key = 0123456789abcdef0123456789abcdef0123456789
+endpoint =
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    This remote is called remote and can now be used like this
    
+
    See all buckets
    
+
    rclone lsd remote:
    
+
    Create a new bucket
    
+
    rclone mkdir remote:bucket
    
+
    List the contents of a bucket
    
+
    rclone ls remote:bucket
    
+
    Sync /home/local/directory to the remote bucket, deleting any excess files in the bucket.
    
+
    rclone sync -i /home/local/directory remote:bucket
    
+
    Application Keys
    
+
    B2 supports multiple Application Keys for different access permission to B2 Buckets.
    
+
    You can use these with rclone too; you will need to use rclone version 1.43 or later.
    
+
    Follow Backblaze's docs to create an Application Key with the required permission and add the applicationKeyId as the account and the Application Key itself as the key.
    
+
    Note that you must put the applicationKeyId as the account – you can't use the master Account ID. If you try then B2 will return 401 errors.
    
+
    --fast-list
    
+
    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.
    
+
    Modified time
    
+
    The modified time is stored as metadata on the object as X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time.
    
+
    Modified times are used in syncing and are fully supported. Note that if a modification time needs to be updated on an object then it will create a new version of the object.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    \0x5C＼
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Note that in 2020-05 Backblaze started allowing  characters in file names. Rclone hasn't changed its encoding as this could cause syncs to re-transfer files. If you want rclone not to replace  then see the --b2-encoding flag below and remove the BackSlash from the string. This can be set in the config.
    
+
    SHA1 checksums
    
+
    The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.
    
+
    Large files (bigger than the limit in --b2-upload-cutoff) which are uploaded in chunks will store their SHA1 on the object as X-Bz-Info-large_file_sha1 as recommended by Backblaze.
    
+
    For a large file to be uploaded with an SHA1 checksum, the source needs to support SHA1 checksums. The local disk supports SHA1 checksums so large file transfers from local disk will have an SHA1. See the overview for exactly which remotes support SHA1.
    
+
    Sources which don't support SHA1, in particular crypt will upload large files without SHA1 checksums. This may be fixed in the future (see #1767).
    
+
    Files sizes below --b2-upload-cutoff will always have an SHA1 regardless of the source.
    
+
    Transfers
    
+
    Backblaze recommends that you do lots of transfers simultaneously for maximum speed. In tests from my SSD equipped laptop the optimum setting is about --transfers 32 though higher numbers may be used for a slight speed improvement. The optimum number for you may vary depending on your hardware, how big the files are, how much you want to load your computer, etc. The default of --transfers 4 is definitely too low for Backblaze B2 though.
    
+
    Note that uploading big files (bigger than 200 MB by default) will use a 96 MB RAM buffer by default. There can be at most --transfers of these in use at any moment, so this sets the upper limit on the memory used.
    
+
    Versions
    
+
    When rclone uploads a new version of a file it creates a new version of it. Likewise when you delete a file, the old version will be marked hidden and still be available. Conversely, you may opt in to a "hard delete" of files with the --b2-hard-delete flag which would permanently remove the file instead of hiding it.
    
+
    Old versions of files, where available, are visible using the --b2-versions flag.
    
+
    NB Note that --b2-versions does not work with crypt at the moment #1627. Using --backup-dir with rclone is the recommended way of working around this.
    
+
    If you wish to remove all the old versions then you can use the rclone cleanup remote:bucket command which will delete all the old versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, eg rclone cleanup remote:bucket/path/to/stuff.
    
+
    Note that cleanup will remove partially uploaded files from the bucket if they are more than a day old.
    
+
    When you purge a bucket, the current and the old versions will be deleted then the bucket will be deleted.
    
+
    However delete will cause the current versions of the files to become hidden old versions.
    
+
    Here is a session showing the listing and retrieval of an old version followed by a cleanup of the old versions.
    
+
    Show current version and all the versions with --b2-versions flag.
    
+
    $ rclone -q ls b2:cleanup-test
+        9 one.txt
 
-- Config:      key
-- Env Var:     RCLONE_B2_KEY
-- Type:        string
-- Default:     ""
+$ rclone -q --b2-versions ls b2:cleanup-test
+        9 one.txt
+        8 one-v2016-07-04-141032-000.txt
+       16 one-v2016-07-04-141003-000.txt
+       15 one-v2016-07-02-155621-000.txt
    
+
    Retrieve an old version
    
+
    $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp
 
-#### --b2-hard-delete
+$ ls -l /tmp/one-v2016-07-04-141003-000.txt
+-rw-rw-r-- 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt
    
+
    Clean up all the old versions and show that they've gone.
    
+
    $ rclone -q cleanup b2:cleanup-test
 
-Permanently delete files on remote removal, otherwise hide files.
+$ rclone -q ls b2:cleanup-test
+        9 one.txt
 
-- Config:      hard_delete
-- Env Var:     RCLONE_B2_HARD_DELETE
-- Type:        bool
-- Default:     false
-
-### Advanced Options
-
-Here are the advanced options specific to b2 (Backblaze B2).
-
-#### --b2-endpoint
-
-Endpoint for the service.
-Leave blank normally.
-
-- Config:      endpoint
-- Env Var:     RCLONE_B2_ENDPOINT
-- Type:        string
-- Default:     ""
-
-#### --b2-test-mode
-
-A flag string for X-Bz-Test-Mode header for debugging.
-
-This is for debugging purposes only. Setting it to one of the strings
-below will cause b2 to return specific errors:
-
-  * "fail_some_uploads"
-  * "expire_some_account_authorization_tokens"
-  * "force_cap_exceeded"
-
-These will be set in the "X-Bz-Test-Mode" header which is documented
-in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html).
-
-- Config:      test_mode
-- Env Var:     RCLONE_B2_TEST_MODE
-- Type:        string
-- Default:     ""
-
-#### --b2-versions
-
-Include old versions in directory listings.
-Note that when using this no file write operations are permitted,
-so you can't upload files or delete them.
-
-- Config:      versions
-- Env Var:     RCLONE_B2_VERSIONS
-- Type:        bool
-- Default:     false
-
-#### --b2-upload-cutoff
-
-Cutoff for switching to chunked upload.
-
-Files above this size will be uploaded in chunks of "--b2-chunk-size".
-
-This value should be set no larger than 4.657GiB (== 5GB).
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_B2_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     200M
-
-#### --b2-copy-cutoff
-
-Cutoff for switching to multipart copy
-
-Any files larger than this that need to be server side copied will be
-copied in chunks of this size.
-
-The minimum is 0 and the maximum is 4.6GB.
-
-- Config:      copy_cutoff
-- Env Var:     RCLONE_B2_COPY_CUTOFF
-- Type:        SizeSuffix
-- Default:     4G
-
-#### --b2-chunk-size
-
-Upload chunk size. Must fit in memory.
-
-When uploading large files, chunk the file into this size.  Note that
-these chunks are buffered in memory and there might a maximum of
-"--transfers" chunks in progress at once.  5,000,000 Bytes is the
-minimum size.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_B2_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     96M
-
-#### --b2-disable-checksum
-
-Disable checksums for large (> upload cutoff) files
-
-Normally rclone will calculate the SHA1 checksum of the input before
-uploading it so it can add it to metadata on the object. This is great
-for data integrity checking but can cause long delays for large files
-to start uploading.
-
-- Config:      disable_checksum
-- Env Var:     RCLONE_B2_DISABLE_CHECKSUM
-- Type:        bool
-- Default:     false
-
-#### --b2-download-url
-
-Custom endpoint for downloads.
-
-This is usually set to a Cloudflare CDN URL as Backblaze offers
-free egress for data downloaded through the Cloudflare network.
-This is probably only useful for a public bucket.
-Leave blank if you want to use the endpoint provided by Backblaze.
-
-- Config:      download_url
-- Env Var:     RCLONE_B2_DOWNLOAD_URL
-- Type:        string
-- Default:     ""
-
-#### --b2-download-auth-duration
-
-Time before the authorization token will expire in s or suffix ms|s|m|h|d.
-
-The duration before the download authorization token will expire.
-The minimum value is 1 second. The maximum value is one week.
-
-- Config:      download_auth_duration
-- Env Var:     RCLONE_B2_DOWNLOAD_AUTH_DURATION
-- Type:        Duration
-- Default:     1w
-
-#### --b2-memory-pool-flush-time
-
-How often internal memory buffer pools will be flushed.
-Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations.
-This option controls how often unused buffers will be removed from the pool.
-
-- Config:      memory_pool_flush_time
-- Env Var:     RCLONE_B2_MEMORY_POOL_FLUSH_TIME
-- Type:        Duration
-- Default:     1m0s
-
-#### --b2-memory-pool-use-mmap
-
-Whether to use mmap buffers in internal memory pool.
-
-- Config:      memory_pool_use_mmap
-- Env Var:     RCLONE_B2_MEMORY_POOL_USE_MMAP
-- Type:        bool
-- Default:     false
-
-#### --b2-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_B2_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
-
-
-
- Box
------------------------------------------
-
-Paths are specified as `remote:path`
-
-Paths may be as deep as required, eg `remote:directory/subdirectory`.
-
-The initial setup for Box involves getting a token from Box which you
-can do either in your browser, or with a config.json downloaded from Box
-to use JWT authentication.  `rclone config` walks you through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
+$ rclone -q --b2-versions ls b2:cleanup-test
+        9 one.txt
    
+
    Data usage
    
+
    It is useful to know how many requests are sent to the server in different scenarios.
    
+
    All copy commands send the following 4 requests:
    
+
    /b2api/v1/b2_authorize_account
+/b2api/v1/b2_create_bucket
+/b2api/v1/b2_list_buckets
+/b2api/v1/b2_list_file_names
    
+
    The b2_list_file_names request will be sent once for every 1k files in the remote path, providing the checksum and modification time of the listed files. As of version 1.33 issue #818 causes extra requests to be sent when using B2 with Crypt. When a copy operation does not require any files to be uploaded, no more requests will be sent.
    
+
    Uploading files that do not require chunking, will send 2 requests per file upload:
    
+
    /b2api/v1/b2_get_upload_url
+/b2api/v1/b2_upload_file/
    
+
    Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk:
    
+
    /b2api/v1/b2_start_large_file
+/b2api/v1/b2_get_upload_part_url
+/b2api/v1/b2_upload_part/
+/b2api/v1/b2_finish_large_file
    
+
    Versions
    
+
    Versions can be viewed with the --b2-versions flag. When it is set rclone will show and act on older versions of files. For example
    
+
    Listing without --b2-versions
    
+
    $ rclone -q ls b2:cleanup-test
+        9 one.txt
    
+
    And with
    
+
    $ rclone -q --b2-versions ls b2:cleanup-test
+        9 one.txt
+        8 one-v2016-07-04-141032-000.txt
+       16 one-v2016-07-04-141003-000.txt
+       15 one-v2016-07-02-155621-000.txt
    
+
    Showing that the current version is unchanged but older versions can be seen. These have the UTC date that they were uploaded to the server to the nearest millisecond appended to them.
    
+
    Note that when using --b2-versions no file write operations are permitted, so you can't upload files or delete them.
    
+
+
    Rclone supports generating file share links for private B2 buckets. They can either be for a file for example:
    
+
    ./rclone link B2:bucket/path/to/file.txt
+https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx
 
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Box  "box" [snip] Storage> box Box App Client Id - leave blank normally. client_id> Box App Client Secret - leave blank normally. client_secret> Box App config.json location Leave blank normally. Enter a string value. Press Enter for the default (""). box_config_file> Box App Primary Access Token Leave blank normally. Enter a string value. Press Enter for the default (""). access_token>
    
-
    Enter a string value. Press Enter for the default ("user"). Choose a number from below, or type in your own value 1 / Rclone should act on behalf of a user  "user" 2 / Rclone should act on behalf of a service account  "enterprise" box_sub_type> Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] client_id = client_secret = token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
-machine with no Internet 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 on `http://127.0.0.1:53682/` and this it may require you to unblock
-it temporarily if you are running a host firewall.
-
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your Box
-
-    rclone lsd remote:
-
-List all the files in your Box
-
-    rclone ls remote:
-
-To copy a local directory to an Box directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Using rclone with an Enterprise account with SSO ###
-
-If you have an "Enterprise" account type with Box with single sign on
-(SSO), you need to create a password to use Box with rclone. This can
-be done at your Enterprise Box account by going to Settings, "Account"
-Tab, and then set the password in the "Authentication" field.
-
-Once you have done this, you can setup your Enterprise Box account
-using the same procedure detailed above in the, using the password you
-have just set.
-
-### Invalid refresh token ###
-
-According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens):
-
-> Each refresh_token is valid for one use in 60 days.
-
-This means that if you
-
-  * Don't use the box remote for 60 days
-  * Copy the config file with a box refresh token in and use it in two places
-  * Get an error on a token refresh
-
-then rclone will return an error which includes the text `Invalid
-refresh token`.
-
-To fix this you will need to use oauth2 again to update the refresh
-token.  You can use the methods in [the remote setup
-docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the
-config file method, you should not use that remote on the computer you
-did the authentication on.
-
-Here is how to do it.
+
    or if run on a directory you will get:
    
+
    ./rclone link B2:bucket/path
+https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx
    
+
    you can then use the authorization token (the part of the url from the ?Authorization= on) on any file path under that directory. For example:
    
+
    https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx
+https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx
+https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx
 
    
-
    $ rclone config Current remotes:
    
-
    Name Type ==== ==== remote box
    
-
      
-
    1. Edit existing remote
      2. 
-
    2. New remote
      3. 
-
    3. Delete remote
      4. 
-
    4. Rename remote
      5. 
-
    5. Copy remote
      6. 
-
    6. Set configuration password
      7. 
-
    7. Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in an existing value 1 > remote remote> remote -------------------- [remote] type = box token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} -------------------- Edit remote Value "client_id" = "" Edit? (y/n)>
      8. 
-
    8. Yes
      9. 
-
    9. No y/n> n Value "client_secret" = "" Edit? (y/n)>
      10. 
-
    10. Yes
      11. 
-
    11. No y/n> n Remote config Already have a token - refresh?
      12. 
-
    12. Yes
      13. 
-
    13. No y/n> y Use auto config?
      14. 
-
    
+
    Standard Options
    
+
    Here are the standard options specific to b2 (Backblaze B2).
    
+
    --b2-account
    
+
    Account ID or Application Key ID
    
 
      
-
    • Say Y if not sure
      • 
-
    • Say N if you are working on a remote or headless machine
      • 
+
    • Config: account
      • 
+
    • Env Var: RCLONE_B2_ACCOUNT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
 
    
-
      
-
    1. Yes
      2. 
-
    2. No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = box token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} --------------------
      3. 
-
    3. Yes this is OK
      4. 
-
    4. Edit this remote
      5. 
-
    5. Delete this remote y/e/d> y
      6. 
-
    
-
    
-### Modified time and hashes ###
-
-Box allows modification times to be set on objects accurate to 1
-second.  These will be used to detect whether objects need syncing or
-not.
-
-Box supports SHA1 type hashes, so you can use the `--checksum`
-flag.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \         | 0x5C  | ＼           |
-
-File names can also not end with the following characters.
-These only get replaced if they are the last character in the name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-### Transfers ###
-
-For files above 50MB rclone will use a chunked transfer.  Rclone will
-upload up to `--transfers` chunks at the same time (shared among all
-the multipart uploads).  Chunks are buffered in memory and are
-normally 8MB so increasing `--transfers` will increase memory use.
-
-### Deleting files ###
-
-Depending on the enterprise settings for your user, the item will
-either be actually deleted from Box or moved to the trash.
-
-Emptying the trash is supported via the rclone however cleanup command
-however this deletes every trashed file and folder individually so it
-may take a very long time. 
-Emptying the trash via the  WebUI does not have this limitation 
-so it is advised to empty the trash via the WebUI.
-
-### Root folder ID ###
-
-You can set the `root_folder_id` for rclone.  This is the directory
-(identified by its `Folder ID`) that rclone considers to be the root
-of your Box drive.
-
-Normally you will leave this blank and rclone will determine the
-correct root to use itself.
-
-However you can set this to restrict rclone to a specific folder
-hierarchy.
-
-In order to do this you will have to find the `Folder ID` of the
-directory you wish rclone to display.  This will be the last segment
-of the URL when you open the relevant folder in the Box web
-interface.
-
-So if the folder you want rclone to use has a URL which looks like
-`https://app.box.com/folder/11xxxxxxxxx8`
-in the browser, then you use `11xxxxxxxxx8` as
-the `root_folder_id` in the config.
-
-
-### Standard Options
-
-Here are the standard options specific to box (Box).
-
-#### --box-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_BOX_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --box-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_BOX_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-#### --box-box-config-file
-
+
    --b2-key
    
+
    Application Key
    
+
      
+
    • Config: key
      • 
+
    • Env Var: RCLONE_B2_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-hard-delete
    
+
    Permanently delete files on remote removal, otherwise hide files.
    
+
      
+
    • Config: hard_delete
      • 
+
    • Env Var: RCLONE_B2_HARD_DELETE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to b2 (Backblaze B2).
    
+
    --b2-endpoint
    
+
    Endpoint for the service. Leave blank normally.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_B2_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-test-mode
    
+
    A flag string for X-Bz-Test-Mode header for debugging.
    
+
    This is for debugging purposes only. Setting it to one of the strings below will cause b2 to return specific errors:
    
+
      
+
    • "fail_some_uploads"
      • 
+
    • "expire_some_account_authorization_tokens"
      • 
+
    • "force_cap_exceeded"
      • 
+
    
+
    These will be set in the "X-Bz-Test-Mode" header which is documented in the b2 integrations checklist.
    
+
      
+
    • Config: test_mode
      • 
+
    • Env Var: RCLONE_B2_TEST_MODE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-versions
    
+
    Include old versions in directory listings. Note that when using this no file write operations are permitted, so you can't upload files or delete them.
    
+
      
+
    • Config: versions
      • 
+
    • Env Var: RCLONE_B2_VERSIONS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --b2-upload-cutoff
    
+
    Cutoff for switching to chunked upload.
    
+
    Files above this size will be uploaded in chunks of "--b2-chunk-size".
    
+
    This value should be set no larger than 4.657GiB (== 5GB).
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_B2_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 200M
      • 
+
    
+
    --b2-copy-cutoff
    
+
    Cutoff for switching to multipart copy
    
+
    Any files larger than this that need to be server side copied will be copied in chunks of this size.
    
+
    The minimum is 0 and the maximum is 4.6GB.
    
+
      
+
    • Config: copy_cutoff
      • 
+
    • Env Var: RCLONE_B2_COPY_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 4G
      • 
+
    
+
    --b2-chunk-size
    
+
    Upload chunk size. Must fit in memory.
    
+
    When uploading large files, chunk the file into this size. Note that these chunks are buffered in memory and there might a maximum of "--transfers" chunks in progress at once. 5,000,000 Bytes is the minimum size.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_B2_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 96M
      • 
+
    
+
    --b2-disable-checksum
    
+
    Disable checksums for large (> upload cutoff) files
    
+
    Normally rclone will calculate the SHA1 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.
    
+
      
+
    • Config: disable_checksum
      • 
+
    • Env Var: RCLONE_B2_DISABLE_CHECKSUM
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --b2-download-url
    
+
    Custom endpoint for downloads.
    
+
    This is usually set to a Cloudflare CDN URL as Backblaze offers free egress for data downloaded through the Cloudflare network. This is probably only useful for a public bucket. Leave blank if you want to use the endpoint provided by Backblaze.
    
+
      
+
    • Config: download_url
      • 
+
    • Env Var: RCLONE_B2_DOWNLOAD_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-download-auth-duration
    
+
    Time before the authorization token will expire in s or suffix ms|s|m|h|d.
    
+
    The duration before the download authorization token will expire. The minimum value is 1 second. The maximum value is one week.
    
+
      
+
    • Config: download_auth_duration
      • 
+
    • Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION
      • 
+
    • Type: Duration
      • 
+
    • Default: 1w
      • 
+
    
+
    --b2-memory-pool-flush-time
    
+
    How often internal memory buffer pools will be flushed. Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. This option controls how often unused buffers will be removed from the pool.
    
+
      
+
    • Config: memory_pool_flush_time
      • 
+
    • Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 1m0s
      • 
+
    
+
    --b2-memory-pool-use-mmap
    
+
    Whether to use mmap buffers in internal memory pool.
    
+
      
+
    • Config: memory_pool_use_mmap
      • 
+
    • Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --b2-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_B2_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
      • 
+
    
+
    Box
    
+
    Paths are specified as remote:path
    
+
    Paths may be as deep as required, eg remote:directory/subdirectory.
    
+
    The initial setup for Box involves getting a token from Box which you can do either in your browser, or with a config.json downloaded from Box to use JWT authentication. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Box
+   \ "box"
+[snip]
+Storage> box
+Box App Client Id - leave blank normally.
+client_id> 
+Box App Client Secret - leave blank normally.
+client_secret>
 Box App config.json location
 Leave blank normally.
-
-Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
-
-
-- Config:      box_config_file
-- Env Var:     RCLONE_BOX_BOX_CONFIG_FILE
-- Type:        string
-- Default:     ""
-
-#### --box-access-token
-
+Enter a string value. Press Enter for the default ("").
+box_config_file>
 Box App Primary Access Token
 Leave blank normally.
-
-- Config:      access_token
-- Env Var:     RCLONE_BOX_ACCESS_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --box-box-sub-type
-
-
-
-- Config:      box_sub_type
-- Env Var:     RCLONE_BOX_BOX_SUB_TYPE
-- Type:        string
-- Default:     "user"
-- Examples:
-    - "user"
-        - Rclone should act on behalf of a user
-    - "enterprise"
-        - Rclone should act on behalf of a service account
-
-### Advanced Options
-
-Here are the advanced options specific to box (Box).
-
-#### --box-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_BOX_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --box-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_BOX_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --box-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_BOX_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --box-root-folder-id
-
-Fill in for rclone to use a non root folder as its starting point.
-
-- Config:      root_folder_id
-- Env Var:     RCLONE_BOX_ROOT_FOLDER_ID
-- Type:        string
-- Default:     "0"
-
-#### --box-upload-cutoff
-
-Cutoff for switching to multipart upload (>= 50MB).
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_BOX_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     50M
-
-#### --box-commit-retries
-
-Max number of times to try committing a multipart file.
-
-- Config:      commit_retries
-- Env Var:     RCLONE_BOX_COMMIT_RETRIES
-- Type:        int
-- Default:     100
-
-#### --box-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_BOX_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
-
-
-
-### Limitations ###
-
-Note that Box is case insensitive so you can't have a file called
-"Hello.doc" and one called "hello.doc".
-
-Box file names can't have the `\` character in.  rclone maps this to
-and from an identical looking unicode equivalent `＼`.
-
-Box only supports filenames up to 255 characters in length.
-
- Cache (BETA)
------------------------------------------
-
-The `cache` remote wraps another existing remote and stores file structure
-and its data for long running tasks like `rclone mount`.
-
-## Status
-
-The cache backend code is working but it currently doesn't
-have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren't getting fixed.
-
-The cache backend is due to be phased out in favour of the VFS caching
-layer eventually which is more tightly integrated into rclone.
-
-Until this happens we recommend only using the cache backend if you
-find you can't work without it. There are many docs online describing
-the use of the cache backend to minimize API hits and by-and-large
-these are out of date and the cache backend isn't needed in those
-scenarios any more.
-
-## Setup
-
-To get started you just need to have an existing remote which can be configured
-with `cache`.
-
-Here is an example of how to make a remote called `test-cache`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> test-cache Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Cache a remote  "cache" [snip] Storage> cache Remote to cache. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). remote> local:/test Optional: The URL of the Plex server plex_url> http://127.0.0.1:32400 Optional: The username of the Plex user plex_username> dummyusername Optional: The password of the Plex user y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: The size of a chunk. Lower value good for slow connections but can affect seamless reading. Default: 5M Choose a number from below, or type in your own value 1 / 1MB  "1m" 2 / 5 MB  "5M" 3 / 10 MB  "10M" chunk_size> 2 How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. Accepted units are: "s", "m", "h". Default: 5m Choose a number from below, or type in your own value 1 / 1 hour  "1h" 2 / 24 hours  "24h" 3 / 24 hours  "48h" info_age> 2 The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. Default: 10G Choose a number from below, or type in your own value 1 / 500 MB  "500M" 2 / 1 GB  "1G" 3 / 10 GB  "10G" chunk_total_size> 3 Remote config -------------------- [test-cache] remote = local:/test plex_url = http://127.0.0.1:32400 plex_username = dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age = 48h chunk_total_size = 10G
    
-
    
-You can then use it like this,
-
-List directories in top level of your drive
-
-    rclone lsd test-cache:
-
-List all the files in your drive
-
-    rclone ls test-cache:
-
-To start a cached mount
-
-    rclone mount --allow-other test-cache: /var/tmp/test-cache
-
-### Write Features ###
-
-### Offline uploading ###
-
-In an effort to make writing through cache more reliable, the backend 
-now supports this feature which can be activated by specifying a
-`cache-tmp-upload-path`.
-
-A files goes through these states when using this feature:
-
-1. An upload is started (usually by copying a file on the cache remote)
-2. When the copy to the temporary location is complete the file is part 
-of the cached remote and looks and behaves like any other file (reading included)
-3. After `cache-tmp-wait-time` passes and the file is next in line, `rclone move` 
-is used to move the file to the cloud provider
-4. Reading the file still works during the upload but most modifications on it will be prohibited
-5. Once the move is complete the file is unlocked for modifications as it
-becomes as any other regular file
-6. If the file is being read through `cache` when it's actually
-deleted from the temporary path then `cache` will simply swap the source
-to the cloud provider without interrupting the reading (small blip can happen though)
-
-Files are uploaded in sequence and only one file is uploaded at a time.
-Uploads will be stored in a queue and be processed based on the order they were added.
-The queue and the temporary storage is persistent across restarts but
-can be cleared on startup with the `--cache-db-purge` flag.
-
-### Write Support ###
-
-Writes are supported through `cache`.
-One caveat is that a mounted cache remote does not add any retry or fallback
-mechanism to the upload operation. This will depend on the implementation
-of the wrapped remote. Consider using `Offline uploading` for reliable writes.
-
-One special case is covered with `cache-writes` which will cache the file
-data at the same time as the upload when it is enabled making it available
-from the cache store immediately once the upload is finished.
-
-### Read Features ###
-
-#### Multiple connections ####
-
-To counter the high latency between a local PC where rclone is running
-and cloud providers, the cache remote can split multiple requests to the
-cloud provider for smaller file chunks and combines them together locally
-where they can be available almost immediately before the reader usually
-needs them.
-
-This is similar to buffering when media files are played online. Rclone
-will stay around the current marker but always try its best to stay ahead
-and prepare the data before.
-
-#### Plex Integration ####
-
-There is a direct integration with Plex which allows cache to detect during reading
-if the file is in playback or not. This helps cache to adapt how it queries
-the cloud provider depending on what is needed for.
-
-Scans will have a minimum amount of workers (1) while in a confirmed playback cache
-will deploy the configured number of workers.
-
-This integration opens the doorway to additional performance improvements
-which will be explored in the near future.
-
-**Note:** If Plex options are not configured, `cache` will function with its
-configured options without adapting any of its settings.
-
-How to enable? Run `rclone config` and add all the Plex options (endpoint, username
-and password) in your remote and it will be automatically enabled.
-
-Affected settings:
-- `cache-workers`: _Configured value_ during confirmed playback or _1_ all the other times
-
-##### Certificate Validation #####
-
-When the Plex server is configured to only accept secure connections, it is
-possible to use `.plex.direct` URLs to ensure certificate validation succeeds.
-These URLs are used by Plex internally to connect to the Plex server securely.
-
-The format for these URLs is the following:
-
-https://ip-with-dots-replaced.server-hash.plex.direct:32400/
-
-The `ip-with-dots-replaced` part can be any IPv4 address, where the dots
-have been replaced with dashes, e.g. `127.0.0.1` becomes `127-0-0-1`.
-
-To get the `server-hash` part, the easiest way is to visit
-
-https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token
-
-This page will list all the available Plex servers for your account
-with at least one `.plex.direct` link for each. Copy one URL and replace
-the IP address with the desired address. This can be used as the
-`plex_url` value.
-
-### Known issues ###
-
-#### Mount and --dir-cache-time ####
-
---dir-cache-time controls the first layer of directory caching which works at the mount layer.
-Being an independent caching mechanism from the `cache` backend, it will manage its own entries
-based on the configured time.
-
-To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct
-one, try to set `--dir-cache-time` to a lower time than `--cache-info-age`. Default values are
-already configured in this way. 
-
-#### Windows support - Experimental ####
-
-There are a couple of issues with Windows `mount` functionality that still require some investigations.
-It should be considered as experimental thus far as fixes come in for this OS.
-
-Most of the issues seem to be related to the difference between filesystems
-on Linux flavors and Windows as cache is heavily dependent on them.
-
-Any reports or feedback on how cache behaves on this OS is greatly appreciated.
- 
-- https://github.com/rclone/rclone/issues/1935
-- https://github.com/rclone/rclone/issues/1907
-- https://github.com/rclone/rclone/issues/1834 
-
-#### Risk of throttling ####
-
-Future iterations of the cache backend will make use of the pooling functionality
-of the cloud provider to synchronize and at the same time make writing through it
-more tolerant to failures. 
-
-There are a couple of enhancements in track to add these but in the meantime
-there is a valid concern that the expiring cache listings can lead to cloud provider
-throttles or bans due to repeated queries on it for very large mounts.
-
-Some recommendations:
-- don't use a very small interval for entry information (`--cache-info-age`)
-- while writes aren't yet optimised, you can still write through `cache` which gives you the advantage
-of adding the file in the cache at the same time if configured to do so.
-
-Future enhancements:
-
-- https://github.com/rclone/rclone/issues/1937
-- https://github.com/rclone/rclone/issues/1936 
-
-#### cache and crypt ####
-
-One common scenario is to keep your data encrypted in the cloud provider
-using the `crypt` remote. `crypt` uses a similar technique to wrap around
-an existing remote and handles this translation in a seamless way.
-
-There is an issue with wrapping the remotes in this order:
-**cloud remote** -> **crypt** -> **cache**
-
-During testing, I experienced a lot of bans with the remotes in this order.
-I suspect it might be related to how crypt opens files on the cloud provider
-which makes it think we're downloading the full file instead of small chunks.
-Organizing the remotes in this order yields better results:
-**cloud remote** -> **cache** -> **crypt**
-
-#### absolute remote paths ####
-
-`cache` can not differentiate between relative and absolute paths for the wrapped remote.
-Any path given in the `remote` config setting and on the command line will be passed to
-the wrapped remote as is, but for storing the chunks on disk the path will be made
-relative by removing any leading `/` character.
-
-This behavior is irrelevant for most backend types, but there are backends where a leading `/`
-changes the effective directory, e.g. in the `sftp` backend paths starting with a `/` are
-relative to the root of the SSH server and paths without are relative to the user home directory.
-As a result `sftp:bin` and `sftp:/bin` will share the same cache folder, even if they represent
-a different directory on the SSH server.
-
-### Cache and Remote Control (--rc) ###
-Cache supports the new `--rc` mode in rclone and can be remote controlled through the following end points:
-By default, the listener is disabled if you do not add the flag.
-
-### rc cache/expire
-Purge a remote from the cache backend. Supports either a directory or a file.
-It supports both encrypted and unencrypted file names if cache is wrapped by crypt.
-
-Params:
-  - **remote** = path to remote **(required)**
-  - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_
-
-
-### Standard Options
-
-Here are the standard options specific to cache (Cache a remote).
-
-#### --cache-remote
-
+Enter a string value. Press Enter for the default ("").
+access_token>
+
+Enter a string value. Press Enter for the default ("user").
+Choose a number from below, or type in your own value
+ 1 / Rclone should act on behalf of a user
+   \ "user"
+ 2 / Rclone should act on behalf of a service account
+   \ "enterprise"
+box_sub_type>
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+client_id = 
+client_secret = 
+token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    See the remote setup docs for how to set it up on a machine with no Internet 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 on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your Box
    
+
    rclone lsd remote:
    
+
    List all the files in your Box
    
+
    rclone ls remote:
    
+
    To copy a local directory to an Box directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Using rclone with an Enterprise account with SSO
    
+
    If you have an "Enterprise" account type with Box with single sign on (SSO), you need to create a password to use Box with rclone. This can be done at your Enterprise Box account by going to Settings, "Account" Tab, and then set the password in the "Authentication" field.
    
+
    Once you have done this, you can setup your Enterprise Box account using the same procedure detailed above in the, using the password you have just set.
    
+
    Invalid refresh token
    
+
    According to the box docs:
    
+
    
+
    Each refresh_token is valid for one use in 60 days.
    
+
    
+
    This means that if you
    
+
      
+
    • Don't use the box remote for 60 days
      • 
+
    • Copy the config file with a box refresh token in and use it in two places
      • 
+
    • Get an error on a token refresh
      • 
+
    
+
    then rclone will return an error which includes the text Invalid refresh token.
    
+
    To fix this you will need to use oauth2 again to update the refresh token. You can use the methods in the remote setup docs, bearing in mind that if you use the copy the config file method, you should not use that remote on the computer you did the authentication on.
    
+
    Here is how to do it.
    
+
    $ rclone config
+Current remotes:
+
+Name                 Type
+====                 ====
+remote               box
+
+e) Edit existing remote
+n) New remote
+d) Delete remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+e/n/d/r/c/s/q> e
+Choose a number from below, or type in an existing value
+ 1 > remote
+remote> remote
+--------------------
+[remote]
+type = box
+token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"}
+--------------------
+Edit remote
+Value "client_id" = ""
+Edit? (y/n)>
+y) Yes
+n) No
+y/n> n
+Value "client_secret" = ""
+Edit? (y/n)>
+y) Yes
+n) No
+y/n> n
+Remote config
+Already have a token - refresh?
+y) Yes
+n) No
+y/n> y
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+type = box
+token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Modified time and hashes
    
+
    Box allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.
    
+
    Box supports SHA1 type hashes, so you can use the --checksum flag.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    \0x5C＼
    
+
    File names can also not end with the following characters. These only get replaced if they are the last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Transfers
    
+
    For files above 50MB rclone will use a chunked transfer. Rclone will upload up to --transfers chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 8MB so increasing --transfers will increase memory use.
    
+
    Deleting files
    
+
    Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash.
    
+
    Emptying the trash is supported via the rclone however cleanup command however this deletes every trashed file and folder individually so it may take a very long time. Emptying the trash via the WebUI does not have this limitation so it is advised to empty the trash via the WebUI.
    
+
    Root folder ID
    
+
    You can set the root_folder_id for rclone. This is the directory (identified by its Folder ID) that rclone considers to be the root of your Box drive.
    
+
    Normally you will leave this blank and rclone will determine the correct root to use itself.
    
+
    However you can set this to restrict rclone to a specific folder hierarchy.
    
+
    In order to do this you will have to find the Folder ID of the directory you wish rclone to display. This will be the last segment of the URL when you open the relevant folder in the Box web interface.
    
+
    So if the folder you want rclone to use has a URL which looks like https://app.box.com/folder/11xxxxxxxxx8 in the browser, then you use 11xxxxxxxxx8 as the root_folder_id in the config.
    
+
    Standard Options
    
+
    Here are the standard options specific to box (Box).
    
+
    --box-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_BOX_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_BOX_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-box-config-file
    
+
    Box App config.json location Leave blank normally.
    
+
    Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.
    
+
      
+
    • Config: box_config_file
      • 
+
    • Env Var: RCLONE_BOX_BOX_CONFIG_FILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-access-token
    
+
    Box App Primary Access Token Leave blank normally.
    
+
      
+
    • Config: access_token
      • 
+
    • Env Var: RCLONE_BOX_ACCESS_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-box-sub-type
    
+
      
+
    • Config: box_sub_type
      • 
+
    • Env Var: RCLONE_BOX_BOX_SUB_TYPE
      • 
+
    • Type: string
      • 
+
    • Default: "user"
      • 
+
    • Examples:
+
        
+
      • "user"
+
          
+
        • Rclone should act on behalf of a user
          • 
+
        • 
+
      • "enterprise"
+
          
+
        • Rclone should act on behalf of a service account
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to box (Box).
    
+
    --box-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_BOX_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_BOX_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_BOX_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-root-folder-id
    
+
    Fill in for rclone to use a non root folder as its starting point.
    
+
      
+
    • Config: root_folder_id
      • 
+
    • Env Var: RCLONE_BOX_ROOT_FOLDER_ID
      • 
+
    • Type: string
      • 
+
    • Default: "0"
      • 
+
    
+
    --box-upload-cutoff
    
+
    Cutoff for switching to multipart upload (>= 50MB).
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_BOX_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 50M
      • 
+
    
+
    --box-commit-retries
    
+
    Max number of times to try committing a multipart file.
    
+
      
+
    • Config: commit_retries
      • 
+
    • Env Var: RCLONE_BOX_COMMIT_RETRIES
      • 
+
    • Type: int
      • 
+
    • Default: 100
      • 
+
    
+
    --box-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_BOX_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    Note that Box is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    Box file names can't have the \ character in. rclone maps this to and from an identical looking unicode equivalent ＼.
    
+
    Box only supports filenames up to 255 characters in length.
    
+
    Cache (BETA)
    
+
    The cache remote wraps another existing remote and stores file structure and its data for long running tasks like rclone mount.
    
+
    Status
    
+
    The cache backend code is working but it currently doesn't have a maintainer so there are outstanding bugs which aren't getting fixed.
    
+
    The cache backend is due to be phased out in favour of the VFS caching layer eventually which is more tightly integrated into rclone.
    
+
    Until this happens we recommend only using the cache backend if you find you can't work without it. There are many docs online describing the use of the cache backend to minimize API hits and by-and-large these are out of date and the cache backend isn't needed in those scenarios any more.
    
+
    Setup
    
+
    To get started you just need to have an existing remote which can be configured with cache.
    
+
    Here is an example of how to make a remote called test-cache. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> test-cache
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Cache a remote
+   \ "cache"
+[snip]
+Storage> cache
 Remote to cache.
 Normally should contain a ':' and a path, eg "myremote:path/to/dir",
 "myremote:bucket" or maybe "myremote:" (not recommended).
-
-- Config:      remote
-- Env Var:     RCLONE_CACHE_REMOTE
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-url
-
-The URL of the Plex server
-
-- Config:      plex_url
-- Env Var:     RCLONE_CACHE_PLEX_URL
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-username
-
-The username of the Plex user
-
-- Config:      plex_username
-- Env Var:     RCLONE_CACHE_PLEX_USERNAME
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-password
-
-The password of the Plex user
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      plex_password
-- Env Var:     RCLONE_CACHE_PLEX_PASSWORD
-- Type:        string
-- Default:     ""
-
-#### --cache-chunk-size
-
-The size of a chunk (partial file data).
-
-Use lower numbers for slower connections. If the chunk size is
-changed, any downloaded chunks will be invalid and cache-chunk-path
-will need to be cleared or unexpected EOF errors will occur.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_CACHE_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     5M
-- Examples:
-    - "1m"
-        - 1MB
-    - "5M"
-        - 5 MB
-    - "10M"
-        - 10 MB
-
-#### --cache-info-age
-
-How long to cache file structure information (directory listings, file size, times etc). 
-If all write operations are done through the cache then you can safely make
-this value very large as the cache store will also be updated in real time.
-
-- Config:      info_age
-- Env Var:     RCLONE_CACHE_INFO_AGE
-- Type:        Duration
-- Default:     6h0m0s
-- Examples:
-    - "1h"
-        - 1 hour
-    - "24h"
-        - 24 hours
-    - "48h"
-        - 48 hours
-
-#### --cache-chunk-total-size
-
-The total size that the chunks can take up on the local disk.
-
-If the cache exceeds this value then it will start to delete the
-oldest chunks until it goes under this value.
-
-- Config:      chunk_total_size
-- Env Var:     RCLONE_CACHE_CHUNK_TOTAL_SIZE
-- Type:        SizeSuffix
-- Default:     10G
-- Examples:
-    - "500M"
-        - 500 MB
-    - "1G"
-        - 1 GB
-    - "10G"
-        - 10 GB
-
-### Advanced Options
-
-Here are the advanced options specific to cache (Cache a remote).
-
-#### --cache-plex-token
-
-The plex token for authentication - auto set normally
-
-- Config:      plex_token
-- Env Var:     RCLONE_CACHE_PLEX_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-insecure
-
-Skip all certificate verification when connecting to the Plex server
-
-- Config:      plex_insecure
-- Env Var:     RCLONE_CACHE_PLEX_INSECURE
-- Type:        string
-- Default:     ""
-
-#### --cache-db-path
-
-Directory to store file structure metadata DB.
-The remote name is used as the DB file name.
-
-- Config:      db_path
-- Env Var:     RCLONE_CACHE_DB_PATH
-- Type:        string
-- Default:     "$HOME/.cache/rclone/cache-backend"
-
-#### --cache-chunk-path
-
-Directory to cache chunk files.
-
-Path to where partial file data (chunks) are stored locally. The remote
-name is appended to the final path.
-
-This config follows the "--cache-db-path". If you specify a custom
-location for "--cache-db-path" and don't specify one for "--cache-chunk-path"
-then "--cache-chunk-path" will use the same path as "--cache-db-path".
-
-- Config:      chunk_path
-- Env Var:     RCLONE_CACHE_CHUNK_PATH
-- Type:        string
-- Default:     "$HOME/.cache/rclone/cache-backend"
-
-#### --cache-db-purge
-
-Clear all the cached data for this remote on start.
-
-- Config:      db_purge
-- Env Var:     RCLONE_CACHE_DB_PURGE
-- Type:        bool
-- Default:     false
-
-#### --cache-chunk-clean-interval
-
-How often should the cache perform cleanups of the chunk storage.
-The default value should be ok for most people. If you find that the
-cache goes over "cache-chunk-total-size" too often then try to lower
-this value to force it to perform cleanups more often.
-
-- Config:      chunk_clean_interval
-- Env Var:     RCLONE_CACHE_CHUNK_CLEAN_INTERVAL
-- Type:        Duration
-- Default:     1m0s
-
-#### --cache-read-retries
-
-How many times to retry a read from a cache storage.
-
-Since reading from a cache stream is independent from downloading file
-data, readers can get to a point where there's no more data in the
-cache.  Most of the times this can indicate a connectivity issue if
-cache isn't able to provide file data anymore.
-
-For really slow connections, increase this to a point where the stream is
-able to provide data but your experience will be very stuttering.
-
-- Config:      read_retries
-- Env Var:     RCLONE_CACHE_READ_RETRIES
-- Type:        int
-- Default:     10
-
-#### --cache-workers
-
-How many workers should run in parallel to download chunks.
-
-Higher values will mean more parallel processing (better CPU needed)
-and more concurrent requests on the cloud provider.  This impacts
-several aspects like the cloud provider API limits, more stress on the
-hardware that rclone runs on but it also means that streams will be
-more fluid and data will be available much more faster to readers.
-
-**Note**: If the optional Plex integration is enabled then this
-setting will adapt to the type of reading performed and the value
-specified here will be used as a maximum number of workers to use.
-
-- Config:      workers
-- Env Var:     RCLONE_CACHE_WORKERS
-- Type:        int
-- Default:     4
-
-#### --cache-chunk-no-memory
-
-Disable the in-memory cache for storing chunks during streaming.
-
-By default, cache will keep file data during streaming in RAM as well
-to provide it to readers as fast as possible.
-
-This transient data is evicted as soon as it is read and the number of
-chunks stored doesn't exceed the number of workers. However, depending
-on other settings like "cache-chunk-size" and "cache-workers" this footprint
-can increase if there are parallel streams too (multiple files being read
-at the same time).
-
-If the hardware permits it, use this feature to provide an overall better
-performance during streaming but it can also be disabled if RAM is not
-available on the local machine.
-
-- Config:      chunk_no_memory
-- Env Var:     RCLONE_CACHE_CHUNK_NO_MEMORY
-- Type:        bool
-- Default:     false
-
-#### --cache-rps
-
-Limits the number of requests per second to the source FS (-1 to disable)
-
-This setting places a hard limit on the number of requests per second
-that cache will be doing to the cloud provider remote and try to
-respect that value by setting waits between reads.
-
-If you find that you're getting banned or limited on the cloud
-provider through cache and know that a smaller number of requests per
-second will allow you to work with it then you can use this setting
-for that.
-
-A good balance of all the other settings should make this setting
-useless but it is available to set for more special cases.
-
-**NOTE**: This will limit the number of requests during streams but
-other API calls to the cloud provider like directory listings will
-still pass.
-
-- Config:      rps
-- Env Var:     RCLONE_CACHE_RPS
-- Type:        int
-- Default:     -1
-
-#### --cache-writes
-
-Cache file data on writes through the FS
-
-If you need to read files immediately after you upload them through
-cache you can enable this flag to have their data stored in the
-cache store at the same time during upload.
-
-- Config:      writes
-- Env Var:     RCLONE_CACHE_WRITES
-- Type:        bool
-- Default:     false
-
-#### --cache-tmp-upload-path
-
-Directory to keep temporary files until they are uploaded.
-
-This is the path where cache will use as a temporary storage for new
-files that need to be uploaded to the cloud provider.
-
-Specifying a value will enable this feature. Without it, it is
-completely disabled and files will be uploaded directly to the cloud
-provider
-
-- Config:      tmp_upload_path
-- Env Var:     RCLONE_CACHE_TMP_UPLOAD_PATH
-- Type:        string
-- Default:     ""
-
-#### --cache-tmp-wait-time
-
-How long should files be stored in local cache before being uploaded
-
-This is the duration that a file must wait in the temporary location
-_cache-tmp-upload-path_ before it is selected for upload.
-
-Note that only one file is uploaded at a time and it can take longer
-to start the upload if a queue formed for this purpose.
-
-- Config:      tmp_wait_time
-- Env Var:     RCLONE_CACHE_TMP_WAIT_TIME
-- Type:        Duration
-- Default:     15s
-
-#### --cache-db-wait-time
-
-How long to wait for the DB to be available - 0 is unlimited
-
-Only one process can have the DB open at any one time, so rclone waits
-for this duration for the DB to become available before it gives an
-error.
-
-If you set it to 0 then it will wait forever.
-
-- Config:      db_wait_time
-- Env Var:     RCLONE_CACHE_DB_WAIT_TIME
-- Type:        Duration
-- Default:     1s
-
-### Backend commands
-
-Here are the commands specific to the cache backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### stats
-
-Print stats on the cache backend in JSON format.
-
-    rclone backend stats remote: [options] [<arguments>+]
-
-
-
-Chunker (BETA)
-----------------------------------------
-
-The `chunker` overlay transparently splits large files into smaller chunks
-during upload to wrapped remote and transparently assembles them back
-when the file is downloaded. This allows to effectively overcome size limits
-imposed by storage providers.
-
-To use it, first set up the underlying remote following the configuration
-instructions for that remote. You can also use a local pathname instead of
-a remote.
-
-First check your chosen remote is working - we'll call it `remote:path` here.
-Note that anything inside `remote:path` will be chunked and anything outside
-won't. This means that if you are using a bucket based remote (eg S3, B2, swift)
-then you should probably put the bucket in the remote `s3:bucket`.
-
-Now configure `chunker` using `rclone config`. We will call this one `overlay`
-to separate it from the `remote` itself.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> overlay Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Transparently chunk/split large files  "chunker" [snip] Storage> chunker Remote to chunk/unchunk. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). Enter a string value. Press Enter for the default (""). remote> remote:path Files larger than chunk size will be split in chunks. Enter a size with suffix k,M,G,T. Press Enter for the default ("2G"). chunk_size> 100M Choose how chunker handles hash sums. All modes but "none" require metadata. Enter a string value. Press Enter for the default ("md5"). Choose a number from below, or type in your own value 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise  "none" 2 / MD5 for composite files  "md5" 3 / SHA1 for composite files  "sha1" 4 / MD5 for all files  "md5all" 5 / SHA1 for all files  "sha1all" 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported  "md5quick" 7 / Similar to "md5quick" but prefers SHA1 over MD5  "sha1quick" hash_type> md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [overlay] type = chunker remote = remote:bucket chunk_size = 100M hash_type = md5 -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-### Specifying the remote
-
-In normal use, make sure the remote has a `:` in. If you specify the remote
-without a `:` then rclone will use a local directory of that name.
-So if you use a remote of `/path/to/secret/files` then rclone will
-chunk stuff in that directory. If you use a remote of `name` then rclone
-will put files in a directory called `name` in the current directory.
-
-
-### Chunking
-
-When rclone starts a file upload, chunker checks the file size. If it
-doesn't exceed the configured chunk size, chunker will just pass the file
-to the wrapped remote. If a file is large, chunker will transparently cut
-data in pieces with temporary names and stream them one by one, on the fly.
-Each data chunk will contain the specified number of bytes, except for the
-last one which may have less data. If file size is unknown in advance
-(this is called a streaming upload), chunker will internally create
-a temporary copy, record its size and repeat the above process.
-
-When upload completes, temporary chunk files are finally renamed.
-This scheme guarantees that operations can be run in parallel and look
-from outside as atomic.
-A similar method with hidden temporary chunks is used for other operations
-(copy/move/rename etc). If an operation fails, hidden chunks are normally
-destroyed, and the target composite file stays intact.
-
-When a composite file download is requested, chunker transparently
-assembles it by concatenating data chunks in order. As the split is trivial
-one could even manually concatenate data chunks together to obtain the
-original content.
-
-When the `list` rclone command scans a directory on wrapped remote,
-the potential chunk files are accounted for, grouped and assembled into
-composite directory entries. Any temporary chunks are hidden.
-
-List and other commands can sometimes come across composite files with
-missing or invalid chunks, eg. shadowed by like-named directory or
-another file. This usually means that wrapped file system has been directly
-tampered with or damaged. If chunker detects a missing chunk it will
-by default print warning, skip the whole incomplete group of chunks but
-proceed with current command.
-You can set the `--chunker-fail-hard` flag to have commands abort with
-error message in such cases.
-
-
-#### Chunk names
-
-The default chunk name format is `*.rclone_chunk.###`, hence by default
-chunk names are `BIG_FILE_NAME.rclone_chunk.001`,
-`BIG_FILE_NAME.rclone_chunk.002` etc. You can configure another name format
-using the `name_format` configuration file option. The format uses asterisk
-`*` as a placeholder for the base file name and one or more consecutive
-hash characters `#` as a placeholder for sequential chunk number.
-There must be one and only one asterisk. The number of consecutive hash
-characters defines the minimum length of a string representing a chunk number.
-If decimal chunk number has less digits than the number of hashes, it is
-left-padded by zeros. If the decimal string is longer, it is left intact.
-By default numbering starts from 1 but there is another option that allows
-user to start from 0, eg. for compatibility with legacy software.
-
-For example, if name format is `big_*-##.part` and original file name is
-`data.txt` and numbering starts from 0, then the first chunk will be named
-`big_data.txt-00.part`, the 99th chunk will be `big_data.txt-98.part`
-and the 302nd chunk will become `big_data.txt-301.part`.
-
-Note that `list` assembles composite directory entries only when chunk names
-match the configured format and treats non-conforming file names as normal
-non-chunked files.
-
-
-### Metadata
-
-Besides data chunks chunker will by default create metadata object for
-a composite file. The object is named after the original file.
-Chunker allows user to disable metadata completely (the `none` format).
-Note that metadata is normally not created for files smaller than the
-configured chunk size. This may change in future rclone releases.
-
-#### Simple JSON metadata format
-
-This is the default format. It supports hash sums and chunk validation
-for composite files. Meta objects carry the following fields:
-
-- `ver`     - version of format, currently `1`
-- `size`    - total size of composite file
-- `nchunks` - number of data chunks in file
-- `md5`     - MD5 hashsum of composite file (if present)
-- `sha1`    - SHA1 hashsum (if present)
-
-There is no field for composite file name as it's simply equal to the name
-of meta object on the wrapped remote. Please refer to respective sections
-for details on hashsums and modified time handling.
-
-#### No metadata
-
-You can disable meta objects by setting the meta format option to `none`.
-In this mode chunker will scan directory for all files that follow
-configured chunk name format, group them by detecting chunks with the same
-base name and show group names as virtual composite files.
-This method is more prone to missing chunk errors (especially missing
-last chunk) than format with metadata enabled.
-
-
-### Hashsums
-
-Chunker supports hashsums only when a compatible metadata is present.
-Hence, if you choose metadata format of `none`, chunker will report hashsum
-as `UNSUPPORTED`.
-
-Please note that by default metadata is stored only for composite files.
-If a file is smaller than configured chunk size, chunker will transparently
-redirect hash requests to wrapped remote, so support depends on that.
-You will see the empty string as a hashsum of requested type for small
-files if the wrapped remote doesn't support it.
-
-Many storage backends support MD5 and SHA1 hash types, so does chunker.
-With chunker you can choose one or another but not both.
-MD5 is set by default as the most supported type.
-Since chunker keeps hashes for composite files and falls back to the
-wrapped remote hash for non-chunked ones, we advise you to choose the same
-hash type as supported by wrapped remote so that your file listings
-look coherent.
-
-If your storage backend does not support MD5 or SHA1 but you need consistent
-file hashing, configure chunker with `md5all` or `sha1all`. These two modes
-guarantee given hash for all files. If wrapped remote doesn't support it,
-chunker will then add metadata to all files, even small. However, this can
-double the amount of small files in storage and incur additional service charges.
-You can even use chunker to force md5/sha1 support in any other remote
-at expense of sidecar meta objects by setting eg. `chunk_type=sha1all`
-to force hashsums and `chunk_size=1P` to effectively disable chunking.
-
-Normally, when a file is copied to chunker controlled remote, chunker
-will ask the file source for compatible file hash and revert to on-the-fly
-calculation if none is found. This involves some CPU overhead but provides
-a guarantee that given hashsum is available. Also, chunker will reject
-a server-side copy or move operation if source and destination hashsum
-types are different resulting in the extra network bandwidth, too.
-In some rare cases this may be undesired, so chunker provides two optional
-choices: `sha1quick` and `md5quick`. If the source does not support primary
-hash type and the quick mode is enabled, chunker will try to fall back to
-the secondary type. This will save CPU and bandwidth but can result in empty
-hashsums at destination. Beware of consequences: the `sync` command will
-revert (sometimes silently) to time/size comparison if compatible hashsums
-between source and target are not found.
-
-
-### Modified time
-
-Chunker stores modification times using the wrapped remote so support
-depends on that. For a small non-chunked file the chunker overlay simply
-manipulates modification time of the wrapped remote file.
-For a composite file with metadata chunker will get and set
-modification time of the metadata object on the wrapped remote.
-If file is chunked but metadata format is `none` then chunker will
-use modification time of the first data chunk.
-
-
-### Migrations
-
-The idiomatic way to migrate to a different chunk size, hash type or
-chunk naming scheme is to:
-
-- Collect all your chunked files under a directory and have your
-  chunker remote point to it.
-- Create another directory (most probably on the same cloud storage)
-  and configure a new remote with desired metadata format,
-  hash type, chunk naming etc.
-- Now run `rclone sync -i oldchunks: newchunks:` and all your data
-  will be transparently converted in transfer.
-  This may take some time, yet chunker will try server-side
-  copy if possible.
-- After checking data integrity you may remove configuration section
-  of the old remote.
-
-If rclone gets killed during a long operation on a big composite file,
-hidden temporary chunks may stay in the directory. They will not be
-shown by the `list` command but will eat up your account quota.
-Please note that the `deletefile` command deletes only active
-chunks of a file. As a workaround, you can use remote of the wrapped
-file system to see them.
-An easy way to get rid of hidden garbage is to copy littered directory
-somewhere using the chunker remote and purge the original directory.
-The `copy` command will copy only active chunks while the `purge` will
-remove everything including garbage.
-
-
-### Caveats and Limitations
-
-Chunker requires wrapped remote to support server side `move` (or `copy` +
-`delete`) operations, otherwise it will explicitly refuse to start.
-This is because it internally renames temporary chunk files to their final
-names when an operation completes successfully.
-
-Chunker encodes chunk number in file name, so with default `name_format`
-setting it adds 17 characters. Also chunker adds 7 characters of temporary
-suffix during operations. Many file systems limit base file name without path
-by 255 characters. Using rclone's crypt remote as a base file system limits
-file name by 143 characters. Thus, maximum name length is 231 for most files
-and 119 for chunker-over-crypt. A user in need can change name format to
-eg. `*.rcc##` and save 10 characters (provided at most 99 chunks per file).
-
-Note that a move implemented using the copy-and-delete method may incur
-double charging with some cloud storage providers.
-
-Chunker will not automatically rename existing chunks when you run
-`rclone config` on a live remote and change the chunk name format.
-Beware that in result of this some files which have been treated as chunks
-before the change can pop up in directory listings as normal files
-and vice versa. The same warning holds for the chunk size.
-If you desperately need to change critical chunking settings, you should
-run data migration as described above.
-
-If wrapped remote is case insensitive, the chunker overlay will inherit
-that property (so you can't have a file called "Hello.doc" and "hello.doc"
-in the same directory).
-
-
-
-### Standard Options
-
-Here are the standard options specific to chunker (Transparently chunk/split large files).
-
-#### --chunker-remote
-
+remote> local:/test
+Optional: The URL of the Plex server
+plex_url> http://127.0.0.1:32400
+Optional: The username of the Plex user
+plex_username> dummyusername
+Optional: The password of the Plex user
+y) Yes type in my own password
+g) Generate random password
+n) No leave this optional password blank
+y/g/n> y
+Enter the password:
+password:
+Confirm the password:
+password:
+The size of a chunk. Lower value good for slow connections but can affect seamless reading.
+Default: 5M
+Choose a number from below, or type in your own value
+ 1 / 1MB
+   \ "1m"
+ 2 / 5 MB
+   \ "5M"
+ 3 / 10 MB
+   \ "10M"
+chunk_size> 2
+How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache.
+Accepted units are: "s", "m", "h".
+Default: 5m
+Choose a number from below, or type in your own value
+ 1 / 1 hour
+   \ "1h"
+ 2 / 24 hours
+   \ "24h"
+ 3 / 24 hours
+   \ "48h"
+info_age> 2
+The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted.
+Default: 10G
+Choose a number from below, or type in your own value
+ 1 / 500 MB
+   \ "500M"
+ 2 / 1 GB
+   \ "1G"
+ 3 / 10 GB
+   \ "10G"
+chunk_total_size> 3
+Remote config
+--------------------
+[test-cache]
+remote = local:/test
+plex_url = http://127.0.0.1:32400
+plex_username = dummyusername
+plex_password = *** ENCRYPTED ***
+chunk_size = 5M
+info_age = 48h
+chunk_total_size = 10G
    
+
    You can then use it like this,
    
+
    List directories in top level of your drive
    
+
    rclone lsd test-cache:
    
+
    List all the files in your drive
    
+
    rclone ls test-cache:
    
+
    To start a cached mount
    
+
    rclone mount --allow-other test-cache: /var/tmp/test-cache
    
+
    Write Features
    
+
    Offline uploading
    
+
    In an effort to make writing through cache more reliable, the backend now supports this feature which can be activated by specifying a cache-tmp-upload-path.
    
+
    A files goes through these states when using this feature:
    
+
      
+
    1. An upload is started (usually by copying a file on the cache remote)
      2. 
+
    2. When the copy to the temporary location is complete the file is part of the cached remote and looks and behaves like any other file (reading included)
      3. 
+
    3. After cache-tmp-wait-time passes and the file is next in line, rclone move is used to move the file to the cloud provider
      4. 
+
    4. Reading the file still works during the upload but most modifications on it will be prohibited
      5. 
+
    5. Once the move is complete the file is unlocked for modifications as it becomes as any other regular file
      6. 
+
    6. If the file is being read through cache when it's actually deleted from the temporary path then cache will simply swap the source to the cloud provider without interrupting the reading (small blip can happen though)
      7. 
+
    
+
    Files are uploaded in sequence and only one file is uploaded at a time. Uploads will be stored in a queue and be processed based on the order they were added. The queue and the temporary storage is persistent across restarts but can be cleared on startup with the --cache-db-purge flag.
    
+
    Write Support
    
+
    Writes are supported through cache. One caveat is that a mounted cache remote does not add any retry or fallback mechanism to the upload operation. This will depend on the implementation of the wrapped remote. Consider using Offline uploading for reliable writes.
    
+
    One special case is covered with cache-writes which will cache the file data at the same time as the upload when it is enabled making it available from the cache store immediately once the upload is finished.
    
+
    Read Features
    
+
    Multiple connections
    
+
    To counter the high latency between a local PC where rclone is running and cloud providers, the cache remote can split multiple requests to the cloud provider for smaller file chunks and combines them together locally where they can be available almost immediately before the reader usually needs them.
    
+
    This is similar to buffering when media files are played online. Rclone will stay around the current marker but always try its best to stay ahead and prepare the data before.
    
+
    Plex Integration
    
+
    There is a direct integration with Plex which allows cache to detect during reading if the file is in playback or not. This helps cache to adapt how it queries the cloud provider depending on what is needed for.
    
+
    Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers.
    
+
    This integration opens the doorway to additional performance improvements which will be explored in the near future.
    
+
    Note: If Plex options are not configured, cache will function with its configured options without adapting any of its settings.
    
+
    How to enable? Run rclone config and add all the Plex options (endpoint, username and password) in your remote and it will be automatically enabled.
    
+
    Affected settings: - cache-workers: Configured value during confirmed playback or 1 all the other times
    
+
    Certificate Validation
    
+
    When the Plex server is configured to only accept secure connections, it is possible to use .plex.direct URLs to ensure certificate validation succeeds. These URLs are used by Plex internally to connect to the Plex server securely.
    
+
    The format for these URLs is the following:
    
+
    https://ip-with-dots-replaced.server-hash.plex.direct:32400/
    
+
    The ip-with-dots-replaced part can be any IPv4 address, where the dots have been replaced with dashes, e.g. 127.0.0.1 becomes 127-0-0-1.
    
+
    To get the server-hash part, the easiest way is to visit
    
+
    https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token
    
+
    This page will list all the available Plex servers for your account with at least one .plex.direct link for each. Copy one URL and replace the IP address with the desired address. This can be used as the plex_url value.
    
+
    Known issues
    
+
    Mount and --dir-cache-time
    
+
    --dir-cache-time controls the first layer of directory caching which works at the mount layer. Being an independent caching mechanism from the cache backend, it will manage its own entries based on the configured time.
    
+
    To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct one, try to set --dir-cache-time to a lower time than --cache-info-age. Default values are already configured in this way.
    
+
    Windows support - Experimental
    
+
    There are a couple of issues with Windows mount functionality that still require some investigations. It should be considered as experimental thus far as fixes come in for this OS.
    
+
    Most of the issues seem to be related to the difference between filesystems on Linux flavors and Windows as cache is heavily dependent on them.
    
+
    Any reports or feedback on how cache behaves on this OS is greatly appreciated.
    
+
      
+
    • https://github.com/rclone/rclone/issues/1935
      • 
+
    • https://github.com/rclone/rclone/issues/1907
      • 
+
    • https://github.com/rclone/rclone/issues/1834
      • 
+
    
+
    Risk of throttling
    
+
    Future iterations of the cache backend will make use of the pooling functionality of the cloud provider to synchronize and at the same time make writing through it more tolerant to failures.
    
+
    There are a couple of enhancements in track to add these but in the meantime there is a valid concern that the expiring cache listings can lead to cloud provider throttles or bans due to repeated queries on it for very large mounts.
    
+
    Some recommendations: - don't use a very small interval for entry information (--cache-info-age) - while writes aren't yet optimised, you can still write through cache which gives you the advantage of adding the file in the cache at the same time if configured to do so.
    
+
    Future enhancements:
    
+
      
+
    • https://github.com/rclone/rclone/issues/1937
      • 
+
    • https://github.com/rclone/rclone/issues/1936
      • 
+
    
+
    cache and crypt
    
+
    One common scenario is to keep your data encrypted in the cloud provider using the crypt remote. crypt uses a similar technique to wrap around an existing remote and handles this translation in a seamless way.
    
+
    There is an issue with wrapping the remotes in this order: cloud remote -> crypt -> cache
    
+
    During testing, I experienced a lot of bans with the remotes in this order. I suspect it might be related to how crypt opens files on the cloud provider which makes it think we're downloading the full file instead of small chunks. Organizing the remotes in this order yields better results: cloud remote -> cache -> crypt
    
+
    absolute remote paths
    
+
    cache can not differentiate between relative and absolute paths for the wrapped remote. Any path given in the remote config setting and on the command line will be passed to the wrapped remote as is, but for storing the chunks on disk the path will be made relative by removing any leading / character.
    
+
    This behavior is irrelevant for most backend types, but there are backends where a leading / changes the effective directory, e.g. in the sftp backend paths starting with a / are relative to the root of the SSH server and paths without are relative to the user home directory. As a result sftp:bin and sftp:/bin will share the same cache folder, even if they represent a different directory on the SSH server.
    
+
    Cache and Remote Control (--rc)
    
+
    Cache supports the new --rc mode in rclone and can be remote controlled through the following end points: By default, the listener is disabled if you do not add the flag.
    
+
    rc cache/expire
    
+
    Purge a remote from the cache backend. Supports either a directory or a file. It supports both encrypted and unencrypted file names if cache is wrapped by crypt.
    
+
    Params: - remote = path to remote (required) - withData = true/false to delete cached data (chunks) as well (optional, false by default)
    
+
    Standard Options
    
+
    Here are the standard options specific to cache (Cache a remote).
    
+
    --cache-remote
    
+
    Remote to cache. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_CACHE_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-url
    
+
    The URL of the Plex server
    
+
      
+
    • Config: plex_url
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-username
    
+
    The username of the Plex user
    
+
      
+
    • Config: plex_username
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_USERNAME
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-password
    
+
    The password of the Plex user
    
+
    NB Input to this must be obscured - see rclone obscure.
    
+
      
+
    • Config: plex_password
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_PASSWORD
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-chunk-size
    
+
    The size of a chunk (partial file data).
    
+
    Use lower numbers for slower connections. If the chunk size is changed, any downloaded chunks will be invalid and cache-chunk-path will need to be cleared or unexpected EOF errors will occur.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 5M
      • 
+
    • Examples:
+
        
+
      • "1m"
+
          
+
        • 1MB
          • 
+
        • 
+
      • "5M"
+
          
+
        • 5 MB
          • 
+
        • 
+
      • "10M"
+
          
+
        • 10 MB
          • 
+
        • 
+
      • 
+
    
+
    --cache-info-age
    
+
    How long to cache file structure information (directory listings, file size, times etc). If all write operations are done through the cache then you can safely make this value very large as the cache store will also be updated in real time.
    
+
      
+
    • Config: info_age
      • 
+
    • Env Var: RCLONE_CACHE_INFO_AGE
      • 
+
    • Type: Duration
      • 
+
    • Default: 6h0m0s
      • 
+
    • Examples:
+
        
+
      • "1h"
+
          
+
        • 1 hour
          • 
+
        • 
+
      • "24h"
+
          
+
        • 24 hours
          • 
+
        • 
+
      • "48h"
+
          
+
        • 48 hours
          • 
+
        • 
+
      • 
+
    
+
    --cache-chunk-total-size
    
+
    The total size that the chunks can take up on the local disk.
    
+
    If the cache exceeds this value then it will start to delete the oldest chunks until it goes under this value.
    
+
      
+
    • Config: chunk_total_size
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 10G
      • 
+
    • Examples:
+
        
+
      • "500M"
+
          
+
        • 500 MB
          • 
+
        • 
+
      • "1G"
+
          
+
        • 1 GB
          • 
+
        • 
+
      • "10G"
+
          
+
        • 10 GB
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to cache (Cache a remote).
    
+
    --cache-plex-token
    
+
    The plex token for authentication - auto set normally
    
+
      
+
    • Config: plex_token
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-insecure
    
+
    Skip all certificate verification when connecting to the Plex server
    
+
      
+
    • Config: plex_insecure
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_INSECURE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-db-path
    
+
    Directory to store file structure metadata DB. The remote name is used as the DB file name.
    
+
      
+
    • Config: db_path
      • 
+
    • Env Var: RCLONE_CACHE_DB_PATH
      • 
+
    • Type: string
      • 
+
    • Default: "$HOME/.cache/rclone/cache-backend"
      • 
+
    
+
    --cache-chunk-path
    
+
    Directory to cache chunk files.
    
+
    Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path.
    
+
    This config follows the "--cache-db-path". If you specify a custom location for "--cache-db-path" and don't specify one for "--cache-chunk-path" then "--cache-chunk-path" will use the same path as "--cache-db-path".
    
+
      
+
    • Config: chunk_path
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_PATH
      • 
+
    • Type: string
      • 
+
    • Default: "$HOME/.cache/rclone/cache-backend"
      • 
+
    
+
    --cache-db-purge
    
+
    Clear all the cached data for this remote on start.
    
+
      
+
    • Config: db_purge
      • 
+
    • Env Var: RCLONE_CACHE_DB_PURGE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --cache-chunk-clean-interval
    
+
    How often should the cache perform cleanups of the chunk storage. The default value should be ok for most people. If you find that the cache goes over "cache-chunk-total-size" too often then try to lower this value to force it to perform cleanups more often.
    
+
      
+
    • Config: chunk_clean_interval
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL
      • 
+
    • Type: Duration
      • 
+
    • Default: 1m0s
      • 
+
    
+
    --cache-read-retries
    
+
    How many times to retry a read from a cache storage.
    
+
    Since reading from a cache stream is independent from downloading file data, readers can get to a point where there's no more data in the cache. Most of the times this can indicate a connectivity issue if cache isn't able to provide file data anymore.
    
+
    For really slow connections, increase this to a point where the stream is able to provide data but your experience will be very stuttering.
    
+
      
+
    • Config: read_retries
      • 
+
    • Env Var: RCLONE_CACHE_READ_RETRIES
      • 
+
    • Type: int
      • 
+
    • Default: 10
      • 
+
    
+
    --cache-workers
    
+
    How many workers should run in parallel to download chunks.
    
+
    Higher values will mean more parallel processing (better CPU needed) and more concurrent requests on the cloud provider. This impacts several aspects like the cloud provider API limits, more stress on the hardware that rclone runs on but it also means that streams will be more fluid and data will be available much more faster to readers.
    
+
    Note: If the optional Plex integration is enabled then this setting will adapt to the type of reading performed and the value specified here will be used as a maximum number of workers to use.
    
+
      
+
    • Config: workers
      • 
+
    • Env Var: RCLONE_CACHE_WORKERS
      • 
+
    • Type: int
      • 
+
    • Default: 4
      • 
+
    
+
    --cache-chunk-no-memory
    
+
    Disable the in-memory cache for storing chunks during streaming.
    
+
    By default, cache will keep file data during streaming in RAM as well to provide it to readers as fast as possible.
    
+
    This transient data is evicted as soon as it is read and the number of chunks stored doesn't exceed the number of workers. However, depending on other settings like "cache-chunk-size" and "cache-workers" this footprint can increase if there are parallel streams too (multiple files being read at the same time).
    
+
    If the hardware permits it, use this feature to provide an overall better performance during streaming but it can also be disabled if RAM is not available on the local machine.
    
+
      
+
    • Config: chunk_no_memory
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --cache-rps
    
+
    Limits the number of requests per second to the source FS (-1 to disable)
    
+
    This setting places a hard limit on the number of requests per second that cache will be doing to the cloud provider remote and try to respect that value by setting waits between reads.
    
+
    If you find that you're getting banned or limited on the cloud provider through cache and know that a smaller number of requests per second will allow you to work with it then you can use this setting for that.
    
+
    A good balance of all the other settings should make this setting useless but it is available to set for more special cases.
    
+
    NOTE: This will limit the number of requests during streams but other API calls to the cloud provider like directory listings will still pass.
    
+
      
+
    • Config: rps
      • 
+
    • Env Var: RCLONE_CACHE_RPS
      • 
+
    • Type: int
      • 
+
    • Default: -1
      • 
+
    
+
    --cache-writes
    
+
    Cache file data on writes through the FS
    
+
    If you need to read files immediately after you upload them through cache you can enable this flag to have their data stored in the cache store at the same time during upload.
    
+
      
+
    • Config: writes
      • 
+
    • Env Var: RCLONE_CACHE_WRITES
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --cache-tmp-upload-path
    
+
    Directory to keep temporary files until they are uploaded.
    
+
    This is the path where cache will use as a temporary storage for new files that need to be uploaded to the cloud provider.
    
+
    Specifying a value will enable this feature. Without it, it is completely disabled and files will be uploaded directly to the cloud provider
    
+
      
+
    • Config: tmp_upload_path
      • 
+
    • Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-tmp-wait-time
    
+
    How long should files be stored in local cache before being uploaded
    
+
    This is the duration that a file must wait in the temporary location cache-tmp-upload-path before it is selected for upload.
    
+
    Note that only one file is uploaded at a time and it can take longer to start the upload if a queue formed for this purpose.
    
+
      
+
    • Config: tmp_wait_time
      • 
+
    • Env Var: RCLONE_CACHE_TMP_WAIT_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 15s
      • 
+
    
+
    --cache-db-wait-time
    
+
    How long to wait for the DB to be available - 0 is unlimited
    
+
    Only one process can have the DB open at any one time, so rclone waits for this duration for the DB to become available before it gives an error.
    
+
    If you set it to 0 then it will wait forever.
    
+
      
+
    • Config: db_wait_time
      • 
+
    • Env Var: RCLONE_CACHE_DB_WAIT_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 1s
      • 
+
    
+
    Backend commands
    
+
    Here are the commands specific to the cache backend.
    
+
    Run them with
    
+
    rclone backend COMMAND remote:
    
+
    The help below will explain what arguments each command takes.
    
+
    See the "rclone backend" command for more info on how to pass options and arguments.
    
+
    These can be run on a running backend using the rc command backend/command.
    
+
    stats
    
+
    Print stats on the cache backend in JSON format.
    
+
    rclone backend stats remote: [options] [<arguments>+]
    
+
    Chunker (BETA)
    
+
    The chunker overlay transparently splits large files into smaller chunks during upload to wrapped remote and transparently assembles them back when the file is downloaded. This allows to effectively overcome size limits imposed by storage providers.
    
+
    To use it, first set up the underlying remote following the configuration instructions for that remote. You can also use a local pathname instead of a remote.
    
+
    First check your chosen remote is working - we'll call it remote:path here. Note that anything inside remote:path will be chunked and anything outside won't. This means that if you are using a bucket based remote (eg S3, B2, swift) then you should probably put the bucket in the remote s3:bucket.
    
+
    Now configure chunker using rclone config. We will call this one overlay to separate it from the remote itself.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> overlay
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Transparently chunk/split large files
+   \ "chunker"
+[snip]
+Storage> chunker
 Remote to chunk/unchunk.
 Normally should contain a ':' and a path, eg "myremote:path/to/dir",
 "myremote:bucket" or maybe "myremote:" (not recommended).
-
-- Config:      remote
-- Env Var:     RCLONE_CHUNKER_REMOTE
-- Type:        string
-- Default:     ""
-
-#### --chunker-chunk-size
-
+Enter a string value. Press Enter for the default ("").
+remote> remote:path
 Files larger than chunk size will be split in chunks.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_CHUNKER_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     2G
-
-#### --chunker-hash-type
-
+Enter a size with suffix k,M,G,T. Press Enter for the default ("2G").
+chunk_size> 100M
 Choose how chunker handles hash sums. All modes but "none" require metadata.
-
-- Config:      hash_type
-- Env Var:     RCLONE_CHUNKER_HASH_TYPE
-- Type:        string
-- Default:     "md5"
-- Examples:
-    - "none"
-        - Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise
-    - "md5"
-        - MD5 for composite files
-    - "sha1"
-        - SHA1 for composite files
-    - "md5all"
-        - MD5 for all files
-    - "sha1all"
-        - SHA1 for all files
-    - "md5quick"
-        - Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
-    - "sha1quick"
-        - Similar to "md5quick" but prefers SHA1 over MD5
-
-### Advanced Options
-
-Here are the advanced options specific to chunker (Transparently chunk/split large files).
-
-#### --chunker-name-format
-
-String format of chunk file names.
-The two placeholders are: base file name (*) and chunk number (#...).
-There must be one and only one asterisk and one or more consecutive hash characters.
-If chunk number has less digits than the number of hashes, it is left-padded by zeros.
-If there are more digits in the number, they are left as is.
-Possible chunk files are ignored if their name does not match given format.
-
-- Config:      name_format
-- Env Var:     RCLONE_CHUNKER_NAME_FORMAT
-- Type:        string
-- Default:     "*.rclone_chunk.###"
-
-#### --chunker-start-from
-
-Minimum valid chunk number. Usually 0 or 1.
-By default chunk numbers start from 1.
-
-- Config:      start_from
-- Env Var:     RCLONE_CHUNKER_START_FROM
-- Type:        int
-- Default:     1
-
-#### --chunker-meta-format
-
-Format of the metadata object or "none". By default "simplejson".
-Metadata is a small JSON file named after the composite file.
-
-- Config:      meta_format
-- Env Var:     RCLONE_CHUNKER_META_FORMAT
-- Type:        string
-- Default:     "simplejson"
-- Examples:
-    - "none"
-        - Do not use metadata files at all. Requires hash type "none".
-    - "simplejson"
-        - Simple JSON supports hash sums and chunk validation.
-        - It has the following fields: ver, size, nchunks, md5, sha1.
-
-#### --chunker-fail-hard
-
-Choose how chunker should handle files with missing or invalid chunks.
-
-- Config:      fail_hard
-- Env Var:     RCLONE_CHUNKER_FAIL_HARD
-- Type:        bool
-- Default:     false
-- Examples:
-    - "true"
-        - Report errors and abort current command.
-    - "false"
-        - Warn user, skip incomplete file and proceed.
-
-
-
-##  Citrix ShareFile
-
-[Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business.
-
-The initial setup for Citrix ShareFile involves getting a token from
-Citrix ShareFile which you can in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value XX / Citrix Sharefile  "sharefile" Storage> sharefile ** See help for sharefile backend at: https://rclone.org/sharefile/ **
    
-
    ID of the root folder
    
-
    Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID). Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Access the Personal Folders. (Default)  "" 2 / Access the Favorites folder.  "favorites" 3 / Access all the shared folders.  "allshared" 4 / Access all the individual connectors.  "connectors" 5 / Access the home, favorites, and shared folders as well as the connectors.  "top" root_folder_id> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = sharefile endpoint = https://XXX.sharefile.com token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
-machine with no Internet 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 code.  This
-is on `http://127.0.0.1:53682/` and this it may require you to unblock
-it temporarily if you are running a host firewall.
-
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your ShareFile
-
-    rclone lsd remote:
-
-List all the files in your ShareFile
-
-    rclone ls remote:
-
-To copy a local directory to an ShareFile directory called backup
-
-    rclone copy /home/source remote:backup
-
-Paths may be as deep as required, eg `remote:directory/subdirectory`.
-
-### Modified time and hashes ###
-
-ShareFile allows modification times to be set on objects accurate to 1
-second.  These will be used to detect whether objects need syncing or
-not.
-
-ShareFile supports MD5 type hashes, so you can use the `--checksum`
-flag.
-
-### Transfers ###
-
-For files above 128MB rclone will use a chunked transfer.  Rclone will
-upload up to `--transfers` chunks at the same time (shared among all
-the multipart uploads).  Chunks are buffered in memory and are
-normally 64MB so increasing `--transfers` will increase memory use.
-
-### Limitations ###
-
-Note that ShareFile is case insensitive so you can't have a file called
-"Hello.doc" and one called "hello.doc".
-
-ShareFile only supports filenames up to 256 characters in length.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \\        | 0x5C  | ＼           |
-| *         | 0x2A  | ＊           |
-| <         | 0x3C  | ＜           |
-| >         | 0x3E  | ＞           |
-| ?         | 0x3F  | ？           |
-| :         | 0x3A  | ：           |
-| \|        | 0x7C  | ｜           |
-| "         | 0x22  | ＂           |
-
-File names can also not start or end with the following characters.
-These only get replaced if they are the first or last character in the
-name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-| .         | 0x2E  | ．           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to sharefile (Citrix Sharefile).
-
-#### --sharefile-root-folder-id
+Enter a string value. Press Enter for the default ("md5").
+Choose a number from below, or type in your own value
+ 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise
+   \ "none"
+ 2 / MD5 for composite files
+   \ "md5"
+ 3 / SHA1 for composite files
+   \ "sha1"
+ 4 / MD5 for all files
+   \ "md5all"
+ 5 / SHA1 for all files
+   \ "sha1all"
+ 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
+   \ "md5quick"
+ 7 / Similar to "md5quick" but prefers SHA1 over MD5
+   \ "sha1quick"
+hash_type> md5
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+--------------------
+[overlay]
+type = chunker
+remote = remote:bucket
+chunk_size = 100M
+hash_type = md5
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Specifying the remote
    
+
    In normal use, make sure the remote has a : in. If you specify the remote without a : then rclone will use a local directory of that name. So if you use a remote of /path/to/secret/files then rclone will chunk stuff in that directory. If you use a remote of name then rclone will put files in a directory called name in the current directory.
    
+
    Chunking
    
+
    When rclone starts a file upload, chunker checks the file size. If it doesn't exceed the configured chunk size, chunker will just pass the file to the wrapped remote. If a file is large, chunker will transparently cut data in pieces with temporary names and stream them one by one, on the fly. Each data chunk will contain the specified number of bytes, except for the last one which may have less data. If file size is unknown in advance (this is called a streaming upload), chunker will internally create a temporary copy, record its size and repeat the above process.
    
+
    When upload completes, temporary chunk files are finally renamed. This scheme guarantees that operations can be run in parallel and look from outside as atomic. A similar method with hidden temporary chunks is used for other operations (copy/move/rename etc). If an operation fails, hidden chunks are normally destroyed, and the target composite file stays intact.
    
+
    When a composite file download is requested, chunker transparently assembles it by concatenating data chunks in order. As the split is trivial one could even manually concatenate data chunks together to obtain the original content.
    
+
    When the list rclone command scans a directory on wrapped remote, the potential chunk files are accounted for, grouped and assembled into composite directory entries. Any temporary chunks are hidden.
    
+
    List and other commands can sometimes come across composite files with missing or invalid chunks, eg. shadowed by like-named directory or another file. This usually means that wrapped file system has been directly tampered with or damaged. If chunker detects a missing chunk it will by default print warning, skip the whole incomplete group of chunks but proceed with current command. You can set the --chunker-fail-hard flag to have commands abort with error message in such cases.
    
+
    Chunk names
    
+
    The default chunk name format is *.rclone_chunk.###, hence by default chunk names are BIG_FILE_NAME.rclone_chunk.001, BIG_FILE_NAME.rclone_chunk.002 etc. You can configure another name format using the name_format configuration file option. The format uses asterisk * as a placeholder for the base file name and one or more consecutive hash characters # as a placeholder for sequential chunk number. There must be one and only one asterisk. The number of consecutive hash characters defines the minimum length of a string representing a chunk number. If decimal chunk number has less digits than the number of hashes, it is left-padded by zeros. If the decimal string is longer, it is left intact. By default numbering starts from 1 but there is another option that allows user to start from 0, eg. for compatibility with legacy software.
    
+
    For example, if name format is big_*-##.part and original file name is data.txt and numbering starts from 0, then the first chunk will be named big_data.txt-00.part, the 99th chunk will be big_data.txt-98.part and the 302nd chunk will become big_data.txt-301.part.
    
+
    Note that list assembles composite directory entries only when chunk names match the configured format and treats non-conforming file names as normal non-chunked files.
    
+
    Metadata
    
+
    Besides data chunks chunker will by default create metadata object for a composite file. The object is named after the original file. Chunker allows user to disable metadata completely (the none format). Note that metadata is normally not created for files smaller than the configured chunk size. This may change in future rclone releases.
    
+
    Simple JSON metadata format
    
+
    This is the default format. It supports hash sums and chunk validation for composite files. Meta objects carry the following fields:
    
+
      
+
    • ver - version of format, currently 1
      • 
+
    • size - total size of composite file
      • 
+
    • nchunks - number of data chunks in file
      • 
+
    • md5 - MD5 hashsum of composite file (if present)
      • 
+
    • sha1 - SHA1 hashsum (if present)
      • 
+
    
+
    There is no field for composite file name as it's simply equal to the name of meta object on the wrapped remote. Please refer to respective sections for details on hashsums and modified time handling.
    
+
    No metadata
    
+
    You can disable meta objects by setting the meta format option to none. In this mode chunker will scan directory for all files that follow configured chunk name format, group them by detecting chunks with the same base name and show group names as virtual composite files. This method is more prone to missing chunk errors (especially missing last chunk) than format with metadata enabled.
    
+
    Hashsums
    
+
    Chunker supports hashsums only when a compatible metadata is present. Hence, if you choose metadata format of none, chunker will report hashsum as UNSUPPORTED.
    
+
    Please note that by default metadata is stored only for composite files. If a file is smaller than configured chunk size, chunker will transparently redirect hash requests to wrapped remote, so support depends on that. You will see the empty string as a hashsum of requested type for small files if the wrapped remote doesn't support it.
    
+
    Many storage backends support MD5 and SHA1 hash types, so does chunker. With chunker you can choose one or another but not both. MD5 is set by default as the most supported type. Since chunker keeps hashes for composite files and falls back to the wrapped remote hash for non-chunked ones, we advise you to choose the same hash type as supported by wrapped remote so that your file listings look coherent.
    
+
    If your storage backend does not support MD5 or SHA1 but you need consistent file hashing, configure chunker with md5all or sha1all. These two modes guarantee given hash for all files. If wrapped remote doesn't support it, chunker will then add metadata to all files, even small. However, this can double the amount of small files in storage and incur additional service charges. You can even use chunker to force md5/sha1 support in any other remote at expense of sidecar meta objects by setting eg. chunk_type=sha1all to force hashsums and chunk_size=1P to effectively disable chunking.
    
+
    Normally, when a file is copied to chunker controlled remote, chunker will ask the file source for compatible file hash and revert to on-the-fly calculation if none is found. This involves some CPU overhead but provides a guarantee that given hashsum is available. Also, chunker will reject a server-side copy or move operation if source and destination hashsum types are different resulting in the extra network bandwidth, too. In some rare cases this may be undesired, so chunker provides two optional choices: sha1quick and md5quick. If the source does not support primary hash type and the quick mode is enabled, chunker will try to fall back to the secondary type. This will save CPU and bandwidth but can result in empty hashsums at destination. Beware of consequences: the sync command will revert (sometimes silently) to time/size comparison if compatible hashsums between source and target are not found.
    
+
    Modified time
    
+
    Chunker stores modification times using the wrapped remote so support depends on that. For a small non-chunked file the chunker overlay simply manipulates modification time of the wrapped remote file. For a composite file with metadata chunker will get and set modification time of the metadata object on the wrapped remote. If file is chunked but metadata format is none then chunker will use modification time of the first data chunk.
    
+
    Migrations
    
+
    The idiomatic way to migrate to a different chunk size, hash type or chunk naming scheme is to:
    
+
      
+
    • Collect all your chunked files under a directory and have your chunker remote point to it.
      • 
+
    • Create another directory (most probably on the same cloud storage) and configure a new remote with desired metadata format, hash type, chunk naming etc.
      • 
+
    • Now run rclone sync -i oldchunks: newchunks: and all your data will be transparently converted in transfer. This may take some time, yet chunker will try server-side copy if possible.
      • 
+
    • After checking data integrity you may remove configuration section of the old remote.
      • 
+
    
+
    If rclone gets killed during a long operation on a big composite file, hidden temporary chunks may stay in the directory. They will not be shown by the list command but will eat up your account quota. Please note that the deletefile command deletes only active chunks of a file. As a workaround, you can use remote of the wrapped file system to see them. An easy way to get rid of hidden garbage is to copy littered directory somewhere using the chunker remote and purge the original directory. The copy command will copy only active chunks while the purge will remove everything including garbage.
    
+
    Caveats and Limitations
    
+
    Chunker requires wrapped remote to support server side move (or copy + delete) operations, otherwise it will explicitly refuse to start. This is because it internally renames temporary chunk files to their final names when an operation completes successfully.
    
+
    Chunker encodes chunk number in file name, so with default name_format setting it adds 17 characters. Also chunker adds 7 characters of temporary suffix during operations. Many file systems limit base file name without path by 255 characters. Using rclone's crypt remote as a base file system limits file name by 143 characters. Thus, maximum name length is 231 for most files and 119 for chunker-over-crypt. A user in need can change name format to eg. *.rcc## and save 10 characters (provided at most 99 chunks per file).
    
+
    Note that a move implemented using the copy-and-delete method may incur double charging with some cloud storage providers.
    
+
    Chunker will not automatically rename existing chunks when you run rclone config on a live remote and change the chunk name format. Beware that in result of this some files which have been treated as chunks before the change can pop up in directory listings as normal files and vice versa. The same warning holds for the chunk size. If you desperately need to change critical chunking settings, you should run data migration as described above.
    
+
    If wrapped remote is case insensitive, the chunker overlay will inherit that property (so you can't have a file called "Hello.doc" and "hello.doc" in the same directory).
    
+
    Standard Options
    
+
    Here are the standard options specific to chunker (Transparently chunk/split large files).
    
+
    --chunker-remote
    
+
    Remote to chunk/unchunk. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_CHUNKER_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --chunker-chunk-size
    
+
    Files larger than chunk size will be split in chunks.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_CHUNKER_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 2G
      • 
+
    
+
    --chunker-hash-type
    
+
    Choose how chunker handles hash sums. All modes but "none" require metadata.
    
+
      
+
    • Config: hash_type
      • 
+
    • Env Var: RCLONE_CHUNKER_HASH_TYPE
      • 
+
    • Type: string
      • 
+
    • Default: "md5"
      • 
+
    • Examples:
+
        
+
      • "none"
+
          
+
        • Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise
          • 
+
        • 
+
      • "md5"
+
          
+
        • MD5 for composite files
          • 
+
        • 
+
      • "sha1"
+
          
+
        • SHA1 for composite files
          • 
+
        • 
+
      • "md5all"
+
          
+
        • MD5 for all files
          • 
+
        • 
+
      • "sha1all"
+
          
+
        • SHA1 for all files
          • 
+
        • 
+
      • "md5quick"
+
          
+
        • Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
          • 
+
        • 
+
      • "sha1quick"
+
          
+
        • Similar to "md5quick" but prefers SHA1 over MD5
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to chunker (Transparently chunk/split large files).
    
+
    --chunker-name-format
    
+
    String format of chunk file names. The two placeholders are: base file name (*) and chunk number (#...). There must be one and only one asterisk and one or more consecutive hash characters. If chunk number has less digits than the number of hashes, it is left-padded by zeros. If there are more digits in the number, they are left as is. Possible chunk files are ignored if their name does not match given format.
    
+
      
+
    • Config: name_format
      • 
+
    • Env Var: RCLONE_CHUNKER_NAME_FORMAT
      • 
+
    • Type: string
      • 
+
    • Default: "*.rclone_chunk.###"
      • 
+
    
+
    --chunker-start-from
    
+
    Minimum valid chunk number. Usually 0 or 1. By default chunk numbers start from 1.
    
+
      
+
    • Config: start_from
      • 
+
    • Env Var: RCLONE_CHUNKER_START_FROM
      • 
+
    • Type: int
      • 
+
    • Default: 1
      • 
+
    
+
    --chunker-meta-format
    
+
    Format of the metadata object or "none". By default "simplejson". Metadata is a small JSON file named after the composite file.
    
+
      
+
    • Config: meta_format
      • 
+
    • Env Var: RCLONE_CHUNKER_META_FORMAT
      • 
+
    • Type: string
      • 
+
    • Default: "simplejson"
      • 
+
    • Examples:
+
        
+
      • "none"
+
          
+
        • Do not use metadata files at all. Requires hash type "none".
          • 
+
        • 
+
      • "simplejson"
+
          
+
        • Simple JSON supports hash sums and chunk validation.
          • 
+
        • It has the following fields: ver, size, nchunks, md5, sha1.
          • 
+
        • 
+
      • 
+
    
+
    --chunker-fail-hard
    
+
    Choose how chunker should handle files with missing or invalid chunks.
    
+
      
+
    • Config: fail_hard
      • 
+
    • Env Var: RCLONE_CHUNKER_FAIL_HARD
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    • Examples:
+
        
+
      • "true"
+
          
+
        • Report errors and abort current command.
          • 
+
        • 
+
      • "false"
+
          
+
        • Warn user, skip incomplete file and proceed.
          • 
+
        • 
+
      • 
+
    
+
    Citrix ShareFile
    
+
    Citrix ShareFile is a secure file sharing and transfer service aimed as business.
    
+
    The initial setup for Citrix ShareFile involves getting a token from Citrix ShareFile which you can in your browser. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+XX / Citrix Sharefile
+   \ "sharefile"
+Storage> sharefile
+** See help for sharefile backend at: https://rclone.org/sharefile/ **
 
 ID of the root folder
 
 Leave blank to access "Personal Folders".  You can use one of the
 standard values here or any folder ID (long hex number ID).
-
-- Config:      root_folder_id
-- Env Var:     RCLONE_SHAREFILE_ROOT_FOLDER_ID
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Access the Personal Folders. (Default)
-    - "favorites"
-        - Access the Favorites folder.
-    - "allshared"
-        - Access all the shared folders.
-    - "connectors"
-        - Access all the individual connectors.
-    - "top"
-        - Access the home, favorites, and shared folders as well as the connectors.
-
-### Advanced Options
-
-Here are the advanced options specific to sharefile (Citrix Sharefile).
-
-#### --sharefile-upload-cutoff
-
-Cutoff for switching to multipart upload.
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_SHAREFILE_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     128M
-
-#### --sharefile-chunk-size
-
-Upload chunk size. Must a power of 2 >= 256k.
-
-Making this larger will improve performance, but note that each chunk
-is buffered in memory one per transfer.
-
-Reducing this will reduce memory usage but decrease performance.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_SHAREFILE_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     64M
-
-#### --sharefile-endpoint
-
-Endpoint for API calls.
-
-This is usually auto discovered as part of the oauth process, but can
-be set manually to something like: https://XXX.sharefile.com
-
-
-- Config:      endpoint
-- Env Var:     RCLONE_SHAREFILE_ENDPOINT
-- Type:        string
-- Default:     ""
-
-#### --sharefile-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_SHAREFILE_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
-
-
-
-Crypt
-----------------------------------------
-
-The `crypt` remote encrypts and decrypts another remote.
-
-To use it first set up the underlying remote following the config
-instructions for that remote.  You can also use a local pathname
-instead of a remote which will encrypt and decrypt from that directory
-which might be useful for encrypting onto a USB stick for example.
-
-First check your chosen remote is working - we'll call it
-`remote:path` in these docs.  Note that anything inside `remote:path`
-will be encrypted and anything outside won't.  This means that if you
-are using a bucket based remote (eg S3, B2, swift) then you should
-probably put the bucket in the remote `s3:bucket`. If you just use
-`s3:` then rclone will make encrypted bucket names too (if using file
-name encryption) which may or may not be what you want.
-
-Now configure `crypt` using `rclone config`. We will call this one
-`secret` to differentiate it from the `remote`.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n
    
-name> secret Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Encrypt/Decrypt a remote  "crypt" [snip] Storage> crypt Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). remote> remote:path How to encrypt the filenames. Choose a number from below, or type in your own value 1 / Don't encrypt the file names. Adds a ".bin" extension only.  "off" 2 / Encrypt the filenames see the docs for the details.  "standard" 3 / Very simple filename obfuscation.  "obfuscate" filename_encryption> 2 Option to either encrypt directory names or leave them intact. Choose a number from below, or type in your own value 1 / Encrypt directory names.  "true" 2 / Don't encrypt directory names, leave them intact.  "false" filename_encryption> 1 Password or pass phrase for encryption. y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> g Password strength in bits. 64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ Use this password? y) Yes n) No y/n> y Remote config -------------------- [secret] remote = remote:path filename_encryption = standard password = *** ENCRYPTED  password2 =  ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-**Important** The password is stored in the config file is lightly
-obscured so it isn't immediately obvious what it is.  It is in no way
-secure unless you use config file encryption.
-
-A long passphrase is recommended, or you can use a random one.
-
-The obscured password is created by using AES-CTR with a static key, with
-the salt stored verbatim at the beginning of the obscured password. This
-static key is shared by between all versions of rclone.
-
-If you reconfigure rclone with the same passwords/passphrases
-elsewhere it will be compatible, but the obscured version will be different
-due to the different salt.
-
-Note that rclone does not encrypt
-
-  * file length - this can be calculated within 16 bytes
-  * modification time - used for syncing
-
-## Specifying the remote ##
-
-In normal use, make sure the remote has a `:` in. If you specify the
-remote without a `:` then rclone will use a local directory of that
-name.  So if you use a remote of `/path/to/secret/files` then rclone
-will encrypt stuff to that directory.  If you use a remote of `name`
-then rclone will put files in a directory called `name` in the current
-directory.
-
-If you specify the remote as `remote:path/to/dir` then rclone will
-store encrypted files in `path/to/dir` on the remote. If you are using
-file name encryption, then when you save files to
-`secret:subdir/subfile` this will store them in the unencrypted path
-`path/to/dir` but the `subdir/subpath` bit will be encrypted.
-
-Note that unless you want encrypted bucket names (which are difficult
-to manage because you won't know what directory they represent in web
-interfaces etc), you should probably specify a bucket, eg
-`remote:secretbucket` when using bucket based remotes such as S3,
-Swift, Hubic, B2, GCS.
-
-## Example ##
-
-To test I made a little directory of files using "standard" file name
-encryption.
-
    
-
    plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── file3.txt └── subsubdir └── file4.txt
    
-
    
-Copy these to the remote and list them back
-
    
-
    $ rclone -q copy plaintext secret: $ rclone -q ls secret: 7 file1.txt 6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 subdir/file3.txt
    
-
    
-Now see what that looked like when encrypted
-
    
-
    $ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 v05749mltvv1tf4onltun46gls 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps
    
-
    
-Note that this retains the directory structure which means you can do this
-
    
-
    $ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 subsubdir/file4.txt
    
-
    
-If don't use file name encryption then the remote will look like this
-- note the `.bin` extensions added to prevent the cloud provider
-attempting to interpret the data.
-
    
-
    $ rclone -q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin
    
-
    
-### File name encryption modes ###
-
-Here are some of the features of the file name encryption modes
-
-Off
-
-  * doesn't hide file names or directory structure
-  * allows for longer file names (~246 characters)
-  * can use sub paths and copy single files
-
-Standard
-
-  * file names encrypted
-  * file names can't be as long (~143 characters)
-  * can use sub paths and copy single files
-  * directory structure visible
-  * identical files names will have identical uploaded names
-  * can use shortcuts to shorten the directory recursion
-
-Obfuscation
-
-This is a simple "rotate" of the filename, with each file having a rot
-distance based on the filename. We store the distance at the beginning
-of the filename. So a file called "hello" may become "53.jgnnq".
-
-This is not a strong encryption of filenames, but it may stop automated
-scanning tools from picking up on filename patterns. As such it's an
-intermediate between "off" and "standard". The advantage is that it
-allows for longer path segment names.
-
-There is a possibility with some unicode based filenames that the
-obfuscation is weak and may map lower case characters to upper case
-equivalents.  You can not rely on this for strong protection.
-
-  * file names very lightly obfuscated
-  * file names can be longer than standard encryption
-  * can use sub paths and copy single files
-  * directory structure visible
-  * identical files names will have identical uploaded names
-
-Cloud storage systems have various limits on file name length and
-total path length which you are more likely to hit using "Standard"
-file name encryption.  If you keep your file names to below 156
-characters in length then you should be OK on all providers.
-
-There may be an even more secure file name encryption mode in the
-future which will address the long file name problem.
-
-### Directory name encryption ###
-Crypt offers the option of encrypting dir names or leaving them intact.
-There are two options:
-
-True
-
-Encrypts the whole file path including directory names
-Example:
-`1/12/123.txt` is encrypted to
-`p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0`
-
-False
-
-Only encrypts file names, skips directory names
-Example:
-`1/12/123.txt` is encrypted to
-`1/12/qgm4avr35m5loi1th53ato71v0`
-
-
-### Modified time and hashes ###
-
-Crypt stores modification times using the underlying remote so support
-depends on that.
-
-Hashes are not stored for crypt.  However the data integrity is
-protected by an extremely strong crypto authenticator.
-
-Note that you should use the `rclone cryptcheck` command to check the
-integrity of a crypted remote instead of `rclone check` which can't
-check the checksums properly.
-
-
-### Standard Options
-
-Here are the standard options specific to crypt (Encrypt/Decrypt a remote).
-
-#### --crypt-remote
-
-Remote to encrypt/decrypt.
-Normally should contain a ':' and a path, eg "myremote:path/to/dir",
-"myremote:bucket" or maybe "myremote:" (not recommended).
-
-- Config:      remote
-- Env Var:     RCLONE_CRYPT_REMOTE
-- Type:        string
-- Default:     ""
-
-#### --crypt-filename-encryption
-
-How to encrypt the filenames.
-
-- Config:      filename_encryption
-- Env Var:     RCLONE_CRYPT_FILENAME_ENCRYPTION
-- Type:        string
-- Default:     "standard"
-- Examples:
-    - "standard"
-        - Encrypt the filenames see the docs for the details.
-    - "obfuscate"
-        - Very simple filename obfuscation.
-    - "off"
-        - Don't encrypt the file names.  Adds a ".bin" extension only.
-
-#### --crypt-directory-name-encryption
-
-Option to either encrypt directory names or leave them intact.
-
-NB If filename_encryption is "off" then this option will do nothing.
-
-- Config:      directory_name_encryption
-- Env Var:     RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION
-- Type:        bool
-- Default:     true
-- Examples:
-    - "true"
-        - Encrypt directory names.
-    - "false"
-        - Don't encrypt directory names, leave them intact.
-
-#### --crypt-password
-
-Password or pass phrase for encryption.
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      password
-- Env Var:     RCLONE_CRYPT_PASSWORD
-- Type:        string
-- Default:     ""
-
-#### --crypt-password2
-
-Password or pass phrase for salt. Optional but recommended.
-Should be different to the previous password.
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      password2
-- Env Var:     RCLONE_CRYPT_PASSWORD2
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to crypt (Encrypt/Decrypt a remote).
-
-#### --crypt-server-side-across-configs
-
-Allow server side operations (eg copy) to work across different crypt configs.
-
-Normally this option is not what you want, but if you have two crypts
-pointing to the same backend you can use it.
-
-This can be used, for example, to change file name encryption type
-without re-uploading all the data. Just make two crypt backends
-pointing to two different directories with the single changed
-parameter and use rclone move to move the files between the crypt
-remotes.
-
-- Config:      server_side_across_configs
-- Env Var:     RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS
-- Type:        bool
-- Default:     false
-
-#### --crypt-show-mapping
-
-For all files listed show how the names encrypt.
-
-If this flag is set then for each file that the remote is asked to
-list, it will log (at level INFO) a line stating the decrypted file
-name and the encrypted file name.
-
-This is so you can work out which encrypted names are which decrypted
-names just in case you need to do something with the encrypted file
-names, or for debugging purposes.
-
-- Config:      show_mapping
-- Env Var:     RCLONE_CRYPT_SHOW_MAPPING
-- Type:        bool
-- Default:     false
-
-### Backend commands
-
-Here are the commands specific to the crypt backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### encode
-
-Encode the given filename(s)
-
-    rclone backend encode remote: [options] [<arguments>+]
-
-This encodes the filenames given as arguments returning a list of
-strings of the encoded results.
-
-Usage Example:
-
-    rclone backend encode crypt: file1 [file2...]
-    rclone rc backend/command command=encode fs=crypt: file1 [file2...]
-
-
-#### decode
-
-Decode the given filename(s)
-
-    rclone backend decode remote: [options] [<arguments>+]
-
-This decodes the filenames given as arguments returning a list of
-strings of the decoded results. It will return an error if any of the
-inputs are invalid.
-
-Usage Example:
-
-    rclone backend decode crypt: encryptedfile1 [encryptedfile2...]
-    rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]
-
-
-
-
-## Backing up a crypted remote ##
-
-If you wish to backup a crypted remote, it is recommended that you use
-`rclone sync` on the encrypted files, and make sure the passwords are
-the same in the new encrypted remote.
-
-This will have the following advantages
-
-  * `rclone sync` will check the checksums while copying
-  * you can use `rclone check` between the encrypted remotes
-  * you don't decrypt and encrypt unnecessarily
-
-For example, let's say you have your original remote at `remote:` with
-the encrypted version at `eremote:` with path `remote:crypt`.  You
-would then set up the new remote `remote2:` and then the encrypted
-version `eremote2:` with path `remote2:crypt` using the same passwords
-as `eremote:`.
-
-To sync the two remotes you would do
-
-    rclone sync -i remote:crypt remote2:crypt
-
-And to check the integrity you would do
-
-    rclone check remote:crypt remote2:crypt
-
-## File formats ##
-
-### File encryption ###
-
-Files are encrypted 1:1 source file to destination object.  The file
-has a header and is divided into chunks.
-
-#### Header ####
-
-  * 8 bytes magic string `RCLONE\x00\x00`
-  * 24 bytes Nonce (IV)
-
-The initial nonce is generated from the operating systems crypto
-strong random number generator.  The nonce is incremented for each
-chunk read making sure each nonce is unique for each block written.
-The chance of a nonce being re-used is minuscule.  If you wrote an
-exabyte of data (10¹⁸ bytes) you would have a probability of
-approximately 2×10⁻³² of re-using a nonce.
-
-#### Chunk ####
-
-Each chunk will contain 64kB of data, except for the last one which
-may have less data.  The data chunk is in standard NACL secretbox
-format. Secretbox uses XSalsa20 and Poly1305 to encrypt and
-authenticate messages.
-
-Each chunk contains:
-
-  * 16 Bytes of Poly1305 authenticator
-  * 1 - 65536 bytes XSalsa20 encrypted data
-
-64k chunk size was chosen as the best performing chunk size (the
-authenticator takes too much time below this and the performance drops
-off due to cache effects above this).  Note that these chunks are
-buffered in memory so they can't be too big.
-
-This uses a 32 byte (256 bit key) key derived from the user password.
-
-#### Examples ####
-
-1 byte file will encrypt to
-
-  * 32 bytes header
-  * 17 bytes data chunk
-
-49 bytes total
-
-1MB (1048576 bytes) file will encrypt to
-
-  * 32 bytes header
-  * 16 chunks of 65568 bytes
-
-1049120 bytes total (a 0.05% overhead).  This is the overhead for big
-files.
-
-### Name encryption ###
-
-File names are encrypted segment by segment - the path is broken up
-into `/` separated strings and these are encrypted individually.
-
-File segments are padded using PKCS#7 to a multiple of 16 bytes
-before encryption.
-
-They are then encrypted with EME using AES with 256 bit key. EME
-(ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003
-paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway.
-
-This makes for deterministic encryption which is what we want - the
-same filename must encrypt to the same thing otherwise we can't find
-it on the cloud storage system.
-
-This means that
-
-  * filenames with the same name will encrypt the same
-  * filenames which start the same won't have a common prefix
-
-This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of
-which are derived from the user password.
-
-After encryption they are written out using a modified version of
-standard `base32` encoding as described in RFC4648.  The standard
-encoding is modified in two ways:
-
-  * it becomes lower case (no-one likes upper case filenames!)
-  * we strip the padding character `=`
-
-`base32` is used rather than the more efficient `base64` so rclone can be
-used on case insensitive remotes (eg Windows, Amazon Drive).
-
-### Key derivation ###
-
-Rclone uses `scrypt` with parameters `N=16384, r=8, p=1` with an
-optional user supplied salt (password2) to derive the 32+32+16 = 80
-bytes of key material required.  If the user doesn't supply a salt
-then rclone uses an internal one.
-
-`scrypt` makes it impractical to mount a dictionary attack on rclone
-encrypted data.  For full protection against this you should always use
-a salt.
-
- Dropbox
----------------------------------
-
-Paths are specified as `remote:path`
-
-Dropbox paths may be as deep as required, eg
-`remote:directory/subdirectory`.
-
-The initial setup for dropbox involves getting a token from Dropbox
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
      
-
    1. New remote
      2. 
-
    2. Delete remote
      3. 
-
    3. Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Dropbox  "dropbox" [snip] Storage> dropbox Dropbox App Key - leave blank normally. app_key> Dropbox App Secret - leave blank normally. app_secret> Remote config Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX -------------------- [remote] app_key = app_secret = token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX --------------------
      4. 
-
    4. Yes this is OK
      5. 
-
    5. Edit this remote
      6. 
-
    6. Delete this remote y/e/d> y
      7. 
-
    
-
    
-You can then use it like this,
-
-List directories in top level of your dropbox
-
-    rclone lsd remote:
-
-List all the files in your dropbox
-
-    rclone ls remote:
-
-To copy a local directory to a dropbox directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Dropbox for business ###
-
-Rclone supports Dropbox for business and Team Folders.
-
-When using Dropbox for business `remote:` and `remote:path/to/file`
-will refer to your personal folder.
-
-If you wish to see Team Folders you must use a leading `/` in the
-path, so `rclone lsd remote:/` will refer to the root and show you all
-Team Folders and your User Folder.
-
-You can then use team folders like this `remote:/TeamFolder` and
-`remote:/TeamFolder/path/to/file`.
-
-A leading `/` for a Dropbox personal account will do nothing, but it
-will take an extra HTTP transaction so it should be avoided.
-
-### Modified time and Hashes ###
-
-Dropbox supports modified times, but the only way to set a
-modification time is to re-upload the file.
-
-This means that if you uploaded your data with an older version of
-rclone which didn't support the v2 API and modified times, rclone will
-decide to upload all your old data to fix the modification times.  If
-you don't want this to happen use `--size-only` or `--checksum` flag
-to stop it.
-
-Dropbox supports [its own hash
-type](https://www.dropbox.com/developers/reference/content-hash) which
-is checked for all transfers.
-
-#### Restricted filename characters
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| /         | 0x2F  | ／           |
-| DEL       | 0x7F  | ␡           |
-| \         | 0x5C  | ＼           |
-
-File names can also not end with the following characters.
-These only get replaced if they are the last character in the name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to dropbox (Dropbox).
-
-#### --dropbox-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_DROPBOX_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --dropbox-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_DROPBOX_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to dropbox (Dropbox).
-
-#### --dropbox-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_DROPBOX_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --dropbox-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_DROPBOX_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --dropbox-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_DROPBOX_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --dropbox-chunk-size
-
-Upload chunk size. (< 150M).
-
-Any files larger than this will be uploaded in chunks of this size.
-
-Note that chunks are buffered in memory (one at a time) so rclone can
-deal with retries.  Setting this larger will increase the speed
-slightly (at most 10% for 128MB in tests) at the cost of using more
-memory.  It can be set smaller if you are tight on memory.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_DROPBOX_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     48M
-
-#### --dropbox-impersonate
-
-Impersonate this user when using a business account.
-
-- Config:      impersonate
-- Env Var:     RCLONE_DROPBOX_IMPERSONATE
-- Type:        string
-- Default:     ""
-
-#### --dropbox-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_DROPBOX_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot
-
-
-
-### Limitations ###
-
-Note that Dropbox is case insensitive so you can't have a file called
-"Hello.doc" and one called "hello.doc".
-
-There are some file names such as `thumbs.db` which Dropbox can't
-store.  There is a full list of them in the ["Ignored Files" section
-of this document](https://www.dropbox.com/en/help/145).  Rclone will
-issue an error message `File name disallowed - not uploading` if it
-attempts to upload one of those file names, but the sync won't fail.
-
-Some errors may occur if you try to sync copyright-protected files
-because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that
-prevents this sort of file being downloaded. This will return the error `ERROR :
-/path/to/your/file: Failed to copy: failed to open source object:
-path/restricted_content/.`
-
-If you have more than 10,000 files in a directory then `rclone purge
-dropbox:dir` will return the error `Failed to purge: There are too
-many files involved in this operation`.  As a work-around do an
-`rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir`.
-
-### Get your own Dropbox App ID ###
-
-When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users.
-
-Here is how to create your own Dropbox App ID for rclone:
-
-1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not
-to be the same account as the Dropbox you want to access)
-
-2. Choose an API => Usually this should be `Dropbox API`
-
-3. Choose the type of access you want to use => `Full Dropbox` or `App Folder`
-
-4. Name your App. The app name is global, so you can't use `rclone` for example
-
-5. Click the button `Create App`
-
-5. Fill `Redirect URIs` as `http://localhost:53682/`
-
-6. Find the `App key` and `App secret` Use these values in rclone config to add a new remote or edit an existing remote.
-
- FTP
-------------------------------
-
-FTP is the File Transfer Protocol. FTP support is provided using the
-[github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp)
-package.
-
-Paths are specified as `remote:path`. If the path does not begin with
-a `/` it is relative to the home directory of the user.  An empty path
-`remote:` refers to the user's home directory.
-
-Here is an example of making an FTP configuration.  First run
-
-    rclone config
-
-This will guide you through an interactive setup process. An FTP remote only
-needs a host together with and a username and a password. With anonymous FTP
-server, you will need to use `anonymous` as username and your email address as
-the password.
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / FTP Connection  "ftp" [snip] Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ **
    
-
    FTP host to connect to Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com  "ftp.example.com" host> ftp.example.com FTP username, leave blank for current username, ncw Enter a string value. Press Enter for the default (""). user> FTP port, leave blank to use default (21) Enter a string value. Press Enter for the default (""). port> FTP password y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Use FTP over TLS (Implicit) Enter a boolean value (true or false). Press Enter for the default ("false"). tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). Press Enter for the default ("false"). explicit_tls> Remote config -------------------- [remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-This remote is called `remote` and can now be used like this
-
-See all directories in the home directory
-
-    rclone lsd remote:
-
-Make a new directory
-
-    rclone mkdir remote:path/to/directory
-
-List the contents of a directory
-
-    rclone ls remote:path/to/directory
-
-Sync `/home/local/directory` to the remote directory, deleting any
-excess files in the directory.
-
-    rclone sync -i /home/local/directory remote:directory
-
-### Modified time ###
-
-FTP does not support modified times.  Any times you see on the server
-will be time of upload.
-
-### Checksums ###
-
-FTP does not support any checksums.
-
-### Usage without a config file ###
-
-An example how to use the ftp remote without a config file:
-
-    rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy`
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-File names can also not end with the following characters.
-These only get replaced if they are the last character in the name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Note that not all FTP servers can have all characters in file names, for example:
-
-| FTP Server| Forbidden characters |
-| --------- |:--------------------:|
-| proftpd   | `*`                  |
-| pureftpd  | `\ [ ]`              |
-
-### Implicit TLS ###
-
-FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled
-in the config for the remote. The default FTPS port is `990` so the
-port will likely have to be explicitly set in the config for the remote.
-
-
-### Standard Options
-
-Here are the standard options specific to ftp (FTP Connection).
-
-#### --ftp-host
-
-FTP host to connect to
-
-- Config:      host
-- Env Var:     RCLONE_FTP_HOST
-- Type:        string
-- Default:     ""
-- Examples:
-    - "ftp.example.com"
-        - Connect to ftp.example.com
-
-#### --ftp-user
-
-FTP username, leave blank for current username, $USER
-
-- Config:      user
-- Env Var:     RCLONE_FTP_USER
-- Type:        string
-- Default:     ""
-
-#### --ftp-port
-
-FTP port, leave blank to use default (21)
-
-- Config:      port
-- Env Var:     RCLONE_FTP_PORT
-- Type:        string
-- Default:     ""
-
-#### --ftp-pass
-
-FTP password
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      pass
-- Env Var:     RCLONE_FTP_PASS
-- Type:        string
-- Default:     ""
-
-#### --ftp-tls
-
-Use FTPS over TLS (Implicit)
-When using implicit FTP over TLS the client will connect using TLS
-right from the start, which in turn breaks the compatibility with
-non-TLS-aware servers. This is usually served over port 990 rather
-than port 21. Cannot be used in combination with explicit FTP.
-
-- Config:      tls
-- Env Var:     RCLONE_FTP_TLS
-- Type:        bool
-- Default:     false
-
-#### --ftp-explicit-tls
-
-Use FTP over TLS (Explicit)
-When using explicit FTP over TLS the client explicitly request
-security from the server in order to upgrade a plain text connection
-to an encrypted one. Cannot be used in combination with implicit FTP.
-
-- Config:      explicit_tls
-- Env Var:     RCLONE_FTP_EXPLICIT_TLS
-- Type:        bool
-- Default:     false
-
-### Advanced Options
-
-Here are the advanced options specific to ftp (FTP Connection).
-
-#### --ftp-concurrency
-
-Maximum number of FTP simultaneous connections, 0 for unlimited
-
-- Config:      concurrency
-- Env Var:     RCLONE_FTP_CONCURRENCY
-- Type:        int
-- Default:     0
-
-#### --ftp-no-check-certificate
-
-Do not verify the TLS certificate of the server
-
-- Config:      no_check_certificate
-- Env Var:     RCLONE_FTP_NO_CHECK_CERTIFICATE
-- Type:        bool
-- Default:     false
-
-#### --ftp-disable-epsv
-
-Disable using EPSV even if server advertises support
-
-- Config:      disable_epsv
-- Env Var:     RCLONE_FTP_DISABLE_EPSV
-- Type:        bool
-- Default:     false
-
-#### --ftp-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_FTP_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,Del,Ctl,RightSpace,Dot
-
-
-
-### Limitations ###
-
-Note that FTP does have its own implementation of : `--dump headers`,
-`--dump bodies`, `--dump auth` for debugging which isn't the same as
-the HTTP based backends - it has less fine grained control.
-
-Note that `--timeout` isn't supported (but `--contimeout` is).
-
-Note that `--bind` isn't supported.
-
-FTP could support server side move but doesn't yet.
-
-Note that the ftp backend does not support the `ftp_proxy` environment
-variable yet.
-
- Google Cloud Storage
--------------------------------------------------
-
-Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
-command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
-
-The initial setup for google cloud storage involves getting a token from Google Cloud Storage
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
      
-
    1. New remote
      2. 
-
    2. Delete remote
      3. 
-
    3. Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Cloud Storage (this is not Google Drive)  "google cloud storage" [snip] Storage> google cloud storage Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Project number optional - needed only for list/create/delete buckets - see your developer console. project_number> 12345678 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Access Control List for new objects. Choose a number from below, or type in your own value 1 / Object owner gets OWNER access, and all Authenticated Users get READER access.  "authenticatedRead" 2 / Object owner gets OWNER access, and project team owners get OWNER access.  "bucketOwnerFullControl" 3 / Object owner gets OWNER access, and project team owners get READER access.  "bucketOwnerRead" 4 / Object owner gets OWNER access [default if left blank].  "private" 5 / Object owner gets OWNER access, and project team members get access according to their roles.  "projectPrivate" 6 / Object owner gets OWNER access, and all Users get READER access.  "publicRead" object_acl> 4 Access Control List for new buckets. Choose a number from below, or type in your own value 1 / Project team owners get OWNER access, and all Authenticated Users get READER access.  "authenticatedRead" 2 / Project team owners get OWNER access [default if left blank].  "private" 3 / Project team members get access according to their roles.  "projectPrivate" 4 / Project team owners get OWNER access, and all Users get READER access.  "publicRead" 5 / Project team owners get OWNER access, and all Users get WRITER access.  "publicReadWrite" bucket_acl> 2 Location for the newly created buckets. Choose a number from below, or type in your own value 1 / Empty for default location (US).  "" 2 / Multi-regional location for Asia.  "asia" 3 / Multi-regional location for Europe.  "eu" 4 / Multi-regional location for United States.  "us" 5 / Taiwan.  "asia-east1" 6 / Tokyo.  "asia-northeast1" 7 / Singapore.  "asia-southeast1" 8 / Sydney.  "australia-southeast1" 9 / Belgium.  "europe-west1" 10 / London.  "europe-west2" 11 / Iowa.  "us-central1" 12 / South Carolina.  "us-east1" 13 / Northern Virginia.  "us-east4" 14 / Oregon.  "us-west1" location> 12 The storage class to use when storing objects in Google Cloud Storage. Choose a number from below, or type in your own value 1 / Default  "" 2 / Multi-regional storage class  "MULTI_REGIONAL" 3 / Regional storage class  "REGIONAL" 4 / Nearline storage class  "NEARLINE" 5 / Coldline storage class  "COLDLINE" 6 / Durable reduced availability storage class  "DURABLE_REDUCED_AVAILABILITY" storage_class> 5 Remote config Use auto config?
      4. 
-
    
-
      
-
    • Say Y if not sure
      • 
-
    • Say N if you are working on a remote or headless machine or Y didn't work
      • 
-
    
-
      
-
    1. Yes
      2. 
-
    2. No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = google cloud storage client_id = client_secret = token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} project_number = 12345678 object_acl = private bucket_acl = private --------------------
      3. 
-
    3. Yes this is OK
      4. 
-
    4. Edit this remote
      5. 
-
    5. Delete this remote y/e/d> y
      6. 
-
    
-
    
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Google if you use auto config mode. This only
-runs from the moment it opens your browser to the moment you get back
-the verification code.  This is on `http://127.0.0.1:53682/` and this
-it may require you to unblock it temporarily if you are running a host
-firewall, or use manual mode.
-
-This remote is called `remote` and can now be used like this
-
-See all the buckets in your project
-
-    rclone lsd remote:
-
-Make a new bucket
-
-    rclone mkdir remote:bucket
-
-List the contents of a bucket
-
-    rclone ls remote:bucket
-
-Sync `/home/local/directory` to the remote bucket, deleting any excess
-files in the bucket.
-
-    rclone sync -i /home/local/directory remote:bucket
-
-### Service Account support ###
-
-You can set up rclone with Google Cloud Storage in an unattended mode,
-i.e. not tied to a specific end-user Google account. This is useful
-when you want to synchronise files onto machines that don't have
-actively logged-in users, for example build machines.
-
-To get credentials for Google Cloud Platform
-[IAM Service Accounts](https://cloud.google.com/iam/docs/service-accounts),
-please head to the
-[Service Account](https://console.cloud.google.com/permissions/serviceaccounts)
-section of the Google Developer Console. Service Accounts behave just
-like normal `User` permissions in
-[Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access-control),
-so you can limit their access (e.g. make them read only). After
-creating an account, a JSON file containing the Service Account's
-credentials will be downloaded onto your machines. These credentials
-are what rclone will use for authentication.
-
-To use a Service Account instead of OAuth2 token flow, enter the path
-to your Service Account credentials at the `service_account_file`
-prompt and rclone won't use the browser based authentication
-flow. If you'd rather stuff the contents of the credentials file into
-the rclone config file, you can set `service_account_credentials` with
-the actual contents of the file instead, or set the equivalent
-environment variable.
-
-### Anonymous Access ###
-
-For downloads of objects that permit public access you can configure rclone
-to use anonymous access by setting `anonymous` to `true`.
-With unauthorized access you can't write or create files but only read or list
-those buckets and objects that have public read access.
-
-### Application Default Credentials ###
-
-If no other source of credentials is provided, rclone will fall back
-to
-[Application Default Credentials](https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials)
-this is useful both when you already have configured authentication
-for your developer account, or in production when running on a google
-compute host. Note that if running in docker, you may need to run
-additional commands on your google compute machine -
-[see this page](https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper).
-
-Note that in the case application default credentials are used, there
-is no need to explicitly configure a project number.
-
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-### Custom upload headers ###
-
-You can set custom upload headers with the `--header-upload`
-flag. Google Cloud Storage supports the headers as described in the
-[working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata)
-
-- Cache-Control
-- Content-Disposition
-- Content-Encoding
-- Content-Language
-- Content-Type
-- X-Goog-Meta-
-
-Eg `--header-upload "Content-Type text/potato"`
-
-Note that the last of these is for setting custom metadata in the form
-`--header-upload "x-goog-meta-key: value"`
-
-### Modified time ###
-
-Google google cloud storage stores md5sums natively and rclone stores
-modification times as metadata on the object, under the "mtime" key in
-RFC3339 format accurate to 1ns.
-
-#### Restricted filename characters
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| LF        | 0x0A  | ␊           |
-| CR        | 0x0D  | ␍           |
-| /         | 0x2F  | ／          |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
-
-#### --gcs-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_GCS_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --gcs-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_GCS_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-#### --gcs-project-number
-
-Project number.
-Optional - needed only for list/create/delete buckets - see your developer console.
-
-- Config:      project_number
-- Env Var:     RCLONE_GCS_PROJECT_NUMBER
-- Type:        string
-- Default:     ""
-
-#### --gcs-service-account-file
-
-Service Account Credentials JSON file path
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
-
-
-- Config:      service_account_file
-- Env Var:     RCLONE_GCS_SERVICE_ACCOUNT_FILE
-- Type:        string
-- Default:     ""
-
-#### --gcs-service-account-credentials
-
-Service Account Credentials JSON blob
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-- Config:      service_account_credentials
-- Env Var:     RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS
-- Type:        string
-- Default:     ""
-
-#### --gcs-anonymous
-
-Access public buckets and objects without credentials
-Set to 'true' if you just want to download files and don't configure credentials.
-
-- Config:      anonymous
-- Env Var:     RCLONE_GCS_ANONYMOUS
-- Type:        bool
-- Default:     false
-
-#### --gcs-object-acl
-
-Access Control List for new objects.
-
-- Config:      object_acl
-- Env Var:     RCLONE_GCS_OBJECT_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "authenticatedRead"
-        - Object owner gets OWNER access, and all Authenticated Users get READER access.
-    - "bucketOwnerFullControl"
-        - Object owner gets OWNER access, and project team owners get OWNER access.
-    - "bucketOwnerRead"
-        - Object owner gets OWNER access, and project team owners get READER access.
-    - "private"
-        - Object owner gets OWNER access [default if left blank].
-    - "projectPrivate"
-        - Object owner gets OWNER access, and project team members get access according to their roles.
-    - "publicRead"
-        - Object owner gets OWNER access, and all Users get READER access.
-
-#### --gcs-bucket-acl
-
-Access Control List for new buckets.
-
-- Config:      bucket_acl
-- Env Var:     RCLONE_GCS_BUCKET_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "authenticatedRead"
-        - Project team owners get OWNER access, and all Authenticated Users get READER access.
-    - "private"
-        - Project team owners get OWNER access [default if left blank].
-    - "projectPrivate"
-        - Project team members get access according to their roles.
-    - "publicRead"
-        - Project team owners get OWNER access, and all Users get READER access.
-    - "publicReadWrite"
-        - Project team owners get OWNER access, and all Users get WRITER access.
-
-#### --gcs-bucket-policy-only
-
-Access checks should use bucket-level IAM policies.
-
-If you want to upload objects to a bucket with Bucket Policy Only set
-then you will need to set this.
-
-When it is set, rclone:
-
-- ignores ACLs set on buckets
-- ignores ACLs set on objects
-- creates buckets with Bucket Policy Only set
-
-Docs: https://cloud.google.com/storage/docs/bucket-policy-only
-
-
-- Config:      bucket_policy_only
-- Env Var:     RCLONE_GCS_BUCKET_POLICY_ONLY
-- Type:        bool
-- Default:     false
-
-#### --gcs-location
-
-Location for the newly created buckets.
-
-- Config:      location
-- Env Var:     RCLONE_GCS_LOCATION
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Empty for default location (US).
-    - "asia"
-        - Multi-regional location for Asia.
-    - "eu"
-        - Multi-regional location for Europe.
-    - "us"
-        - Multi-regional location for United States.
-    - "asia-east1"
-        - Taiwan.
-    - "asia-east2"
-        - Hong Kong.
-    - "asia-northeast1"
-        - Tokyo.
-    - "asia-south1"
-        - Mumbai.
-    - "asia-southeast1"
-        - Singapore.
-    - "australia-southeast1"
-        - Sydney.
-    - "europe-north1"
-        - Finland.
-    - "europe-west1"
-        - Belgium.
-    - "europe-west2"
-        - London.
-    - "europe-west3"
-        - Frankfurt.
-    - "europe-west4"
-        - Netherlands.
-    - "us-central1"
-        - Iowa.
-    - "us-east1"
-        - South Carolina.
-    - "us-east4"
-        - Northern Virginia.
-    - "us-west1"
-        - Oregon.
-    - "us-west2"
-        - California.
-
-#### --gcs-storage-class
-
-The storage class to use when storing objects in Google Cloud Storage.
-
-- Config:      storage_class
-- Env Var:     RCLONE_GCS_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "MULTI_REGIONAL"
-        - Multi-regional storage class
-    - "REGIONAL"
-        - Regional storage class
-    - "NEARLINE"
-        - Nearline storage class
-    - "COLDLINE"
-        - Coldline storage class
-    - "ARCHIVE"
-        - Archive storage class
-    - "DURABLE_REDUCED_AVAILABILITY"
-        - Durable reduced availability storage class
-
-### Advanced Options
-
-Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
-
-#### --gcs-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_GCS_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --gcs-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_GCS_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --gcs-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_GCS_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --gcs-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_GCS_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,CrLf,InvalidUtf8,Dot
-
-
-
- Google Drive
------------------------------------------
-
-Paths are specified as `drive:path`
-
-Drive paths may be as deep as required, eg `drive:directory/subdirectory`.
-
-The initial setup for drive involves getting a token from Google drive
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Drive  "drive" [snip] Storage> drive Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Scope that rclone should use when requesting access from drive. Choose a number from below, or type in your own value 1 / Full access all files, excluding Application Data Folder.  "drive" 2 / Read-only access to file metadata and file contents.  "drive.readonly" / Access to files created by rclone only. 3 | These are visible in the drive website. | File authorization is revoked when the user deauthorizes the app.  "drive.file" / Allows read and write access to the Application Data folder. 4 | This is not visible in the drive website.  "drive.appfolder" / Allows read-only access to file metadata but 5 | does not allow any access to read or download file content.  "drive.metadata.readonly" scope> 1 ID of the root folder - leave blank normally. Fill in to access "Computers" folders. (see docs). root_folder_id> Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine or Y didn't work y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Configure this as a team drive? y) Yes n) No y/n> n -------------------- [remote] client_id = client_secret = scope = drive root_folder_id = service_account_file = token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Google if you use auto config mode. This only
-runs from the moment it opens your browser to the moment you get back
-the verification code.  This is on `http://127.0.0.1:53682/` and this
-it may require you to unblock it temporarily if you are running a host
-firewall, or use manual mode.
-
-You can then use it like this,
-
-List directories in top level of your drive
-
-    rclone lsd remote:
-
-List all the files in your drive
-
-    rclone ls remote:
-
-To copy a local directory to a drive directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Scopes ###
-
-Rclone allows you to select which scope you would like for rclone to
-use.  This changes what type of token is granted to rclone.  [The
-scopes are defined
-here](https://developers.google.com/drive/v3/web/about-auth).
-
-The scope are
-
-#### drive ####
-
-This is the default scope and allows full access to all files, except
-for the Application Data Folder (see below).
-
-Choose this one if you aren't sure.
-
-#### drive.readonly ####
-
-This allows read only access to all files.  Files may be listed and
-downloaded but not uploaded, renamed or deleted.
-
-#### drive.file ####
-
-With this scope rclone can read/view/modify only those files and
-folders it creates.
-
-So if you uploaded files to drive via the web interface (or any other
-means) they will not be visible to rclone.
-
-This can be useful if you are using rclone to backup data and you want
-to be sure confidential data on your drive is not visible to rclone.
-
-Files created with this scope are visible in the web interface.
-
-#### drive.appfolder ####
-
-This gives rclone its own private area to store files.  Rclone will
-not be able to see any other files on your drive and you won't be able
-to see rclone's files from the web interface either.
-
-#### drive.metadata.readonly ####
-
-This allows read only access to file names only.  It does not allow
-rclone to download or upload data, or rename or delete files or
-directories.
-
-### Root folder ID ###
-
-You can set the `root_folder_id` for rclone.  This is the directory
-(identified by its `Folder ID`) that rclone considers to be the root
-of your drive.
-
-Normally you will leave this blank and rclone will determine the
-correct root to use itself.
-
-However you can set this to restrict rclone to a specific folder
-hierarchy or to access data within the "Computers" tab on the drive
-web interface (where files from Google's Backup and Sync desktop
-program go).
-
-In order to do this you will have to find the `Folder ID` of the
-directory you wish rclone to display.  This will be the last segment
-of the URL when you open the relevant folder in the drive web
-interface.
-
-So if the folder you want rclone to use has a URL which looks like
-`https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh`
-in the browser, then you use `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` as
-the `root_folder_id` in the config.
-
-**NB** folders under the "Computers" tab seem to be read only (drive
-gives a 500 error) when using rclone.
-
-There doesn't appear to be an API to discover the folder IDs of the
-"Computers" tab - please contact us if you know otherwise!
-
-Note also that rclone can't access any data under the "Backups" tab on
-the google drive web interface yet.
-
-### Service Account support ###
-
-You can set up rclone with Google Drive in an unattended mode,
-i.e. not tied to a specific end-user Google account. This is useful
-when you want to synchronise files onto machines that don't have
-actively logged-in users, for example build machines.
-
-To use a Service Account instead of OAuth2 token flow, enter the path
-to your Service Account credentials at the `service_account_file`
-prompt during `rclone config` and rclone won't use the browser based
-authentication flow. If you'd rather stuff the contents of the
-credentials file into the rclone config file, you can set
-`service_account_credentials` with the actual contents of the file
-instead, or set the equivalent environment variable.
-
-#### Use case - Google Apps/G-suite account and individual Drive ####
-
-Let's say that you are the administrator of a Google Apps (old) or
-G-suite account.
-The goal is to store data on an individual's Drive account, who IS
-a member of the domain.
-We'll call the domain **example.com**, and the user
-**foo@example.com**.
-
-There's a few steps we need to go through to accomplish this:
-
-##### 1. Create a service account for example.com #####
-  - To create a service account and obtain its credentials, go to the
-[Google Developer Console](https://console.developers.google.com).
-  - You must have a project - create one if you don't.
-  - Then go to "IAM & admin" -> "Service Accounts".
-  - Use the "Create Credentials" button. Fill in "Service account name"
-with something that identifies your client. "Role" can be empty.
-  - Tick "Furnish a new private key" - select "Key type JSON".
-  - Tick "Enable G Suite Domain-wide Delegation". This option makes
-"impersonation" possible, as documented here:
-[Delegating domain-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority)
-  - These credentials are what rclone will use for authentication.
-If you ever need to remove access, press the "Delete service
-account key" button.
-
-##### 2. Allowing API access to example.com Google Drive #####
-  - Go to example.com's admin console
-  - Go into "Security" (or use the search bar)
-  - Select "Show more" and then "Advanced settings"
-  - Select "Manage API client access" in the "Authentication" section
-  - In the "Client Name" field enter the service account's
-"Client ID" - this can be found in the Developer Console under
-"IAM & Admin" -> "Service Accounts", then "View Client ID" for
-the newly created service account.
-It is a ~21 character numerical string.
-  - In the next field, "One or More API Scopes", enter
-`https://www.googleapis.com/auth/drive`
-to grant access to Google Drive specifically.
-
-##### 3. Configure rclone, assuming a new install #####
-
    
-
    rclone config
    
-
    n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select the number shown for Google Drive client_id> # Can be left blank client_secret> # Can be left blank scope> # Select your scope, 1 for example root_folder_id> # Can be left blank service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # Auto config, y
    
-
    
-##### 4. Verify that it's working #####
-  - `rclone -v --drive-impersonate foo@example.com lsf gdrive:backup`
-  - The arguments do:
-    - `-v` - verbose logging
-    - `--drive-impersonate foo@example.com` - this is what does
-the magic, pretending to be user foo.
-    - `lsf` - list files in a parsing friendly way
-    - `gdrive:backup` - use the remote called gdrive, work in
-the folder named backup.
-
-Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using `--drive-impersonate`, do this instead:
-  - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1
-  - use rclone without specifying the `--drive-impersonate` option, like this:
-        `rclone -v foo@example.com lsf gdrive:backup`
-
-
-### Team drives ###
-
-If you want to configure the remote to point to a Google Team Drive
-then answer `y` to the question `Configure this as a team drive?`.
-
-This will fetch the list of Team Drives from google and allow you to
-configure which one you want to use.  You can also type in a team
-drive ID if you prefer.
-
-For example:
-
    
-
    Configure this as a team drive? y) Yes n) No y/n> y Fetching team drive list... Choose a number from below, or type in your own value 1 / Rclone Test  "xxxxxxxxxxxxxxxxxxxx" 2 / Rclone Test 2  "yyyyyyyyyyyyyyyyyyyy" 3 / Rclone Test 3  "zzzzzzzzzzzzzzzzzzzz" Enter a Team Drive ID> 1 -------------------- [remote] client_id = client_secret = token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} team_drive = xxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-It does this by combining multiple `list` calls into a single API request.
-
-This works by combining many `'%s' in parents` filters into one expression.
-To list the contents of directories a, b and c, the following requests will be send by the regular `List` function:
    
-
    trashed=false and 'a' in parents trashed=false and 'b' in parents trashed=false and 'c' in parents
    
-
    These can now be combined into a single request:
    
-
    trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)
    
-
    
-The implementation of `ListR` will put up to 50 `parents` filters into one request.
-It will  use the `--checkers` value to specify the number of requests to run in parallel.
-
-In tests, these batch requests were up to 20x faster than the regular method.
-Running the following command against different sized folders gives:
    
-
    rclone lsjson -vv -R --checkers=6 gdrive:folder
    
-
    
-small folder (220 directories, 700 files):
-
-- without `--fast-list`: 38s
-- with `--fast-list`: 10s
-
-large folder (10600 directories, 39000 files):
-
-- without `--fast-list`: 22:05 min
-- with `--fast-list`: 58s
-
-### Modified time ###
-
-Google drive stores modification times accurate to 1 ms.
-
-#### Restricted filename characters
-
-Only Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-In contrast to other backends, `/` can also be used in names and `.`
-or `..` are valid names.
-
-### Revisions ###
-
-Google drive stores revisions of files.  When you upload a change to
-an existing file to google drive using rclone it will create a new
-revision of that file.
-
-Revisions follow the standard google policy which at time of writing
-was
-
-  * They are deleted after 30 days or 100 revisions (whatever comes first).
-  * They do not count towards a user storage quota.
-
-### Deleting files ###
-
-By default rclone will send all files to the trash when deleting
-files.  If deleting them permanently is required then use the
-`--drive-use-trash=false` flag, or set the equivalent environment
-variable.
-
-### Shortcuts ###
-
-In March 2020 Google introduced a new feature in Google Drive called
-[drive shortcuts](https://support.google.com/drive/answer/9700156)
-([API](https://developers.google.com/drive/api/v3/shortcuts)). These
-will (by September 2020) [replace the ability for files or folders to
-be in multiple folders at once](https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models).
-
-Shortcuts are files that link to other files on Google Drive somewhat
-like a symlink in unix, except they point to the underlying file data
-(eg the inode in unix terms) so they don't break if the source is
-renamed or moved about.
-
-Be default rclone treats these as follows.
-
-For shortcuts pointing to files:
-
-- When listing a file shortcut appears as the destination file.
-- When downloading the contents of the destination file is downloaded.
-- When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut.
-- When server side moving (renaming) the shortcut is renamed, not the destination file.
-- When server side copying the shortcut is copied, not the contents of the shortcut.
-- When deleting the shortcut is deleted not the linked file.
-- When setting the modification time, the modification time of the linked file will be set.
-
-For shortcuts pointing to folders:
-
-- When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders)
-- When downloading the contents of the linked folder and sub contents are downloaded
-- When uploading to a shortcut folder the file will be placed in the linked folder
-- When server side moving (renaming) the shortcut is renamed, not the destination folder
-- When server side copying the contents of the linked folder is copied, not the shortcut.
-- When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder.
-- **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted.
-
-The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts.  
-
-Shortcuts can be completely ignored with the `--drive-skip-shortcuts` flag
-or the corresponding `skip_shortcuts` configuration setting.
-
-### Emptying trash ###
-
-If you wish to empty your trash you can use the `rclone cleanup remote:`
-command which will permanently delete all your trashed files. This command
-does not take any path arguments.
-
-Note that Google Drive takes some time (minutes to days) to empty the
-trash even though the command returns within a few seconds.  No output
-is echoed, so there will be no confirmation even using -v or -vv.
-
-### Quota information ###
-
-To view your current quota you can use the `rclone about remote:`
-command which will display your usage limit (quota), the usage in Google
-Drive, the size of all files in the Trash and the space used by other
-Google services such as Gmail. This command does not take any path
-arguments.
-
-#### Import/Export of google documents ####
-
-Google documents can be exported from and uploaded to Google Drive.
-
-When rclone downloads a Google doc it chooses a format to download
-depending upon the `--drive-export-formats` setting.
-By default the export formats are `docx,xlsx,pptx,svg` which are a
-sensible default for an editable document.
-
-When choosing a format, rclone runs down the list provided in order
-and chooses the first file format the doc can be exported as from the
-list. If the file can't be exported to a format on the formats list,
-then rclone will choose a format from the default list.
-
-If you prefer an archive copy then you might use `--drive-export-formats
-pdf`, or if you prefer openoffice/libreoffice formats you might use
-`--drive-export-formats ods,odt,odp`.
-
-Note that rclone adds the extension to the google doc, so if it is
-called `My Spreadsheet` on google docs, it will be exported as `My
-Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc.
-
-When importing files into Google Drive, rclone will convert all
-files with an extension in `--drive-import-formats` to their
-associated document type.
-rclone will not convert any files by default, since the conversion
-is lossy process.
-
-The conversion must result in a file with the same extension when
-the `--drive-export-formats` rules are applied to the uploaded document.
-
-Here are some examples for allowed and prohibited conversions.
-
-| export-formats | import-formats | Upload Ext | Document Ext | Allowed |
-| -------------- | -------------- | ---------- | ------------ | ------- |
-| odt | odt | odt | odt | Yes |
-| odt | docx,odt | odt | odt | Yes |
-|  | docx | docx | docx | Yes |
-|  | odt | odt | docx | No |
-| odt,docx | docx,odt | docx | odt | No |
-| docx,odt | docx,odt | docx | docx | Yes |
-| docx,odt | docx,odt | odt | docx | No |
-
-This limitation can be disabled by specifying `--drive-allow-import-name-change`.
-When using this flag, rclone can convert multiple files types resulting
-in the same document type at once, eg with `--drive-import-formats docx,odt,txt`,
-all files having these extension would result in a document represented as a docx file.
-This brings the additional risk of overwriting a document, if multiple files
-have the same stem. Many rclone operations will not handle this name change
-in any way. They assume an equal name when copying files and might copy the
-file again or delete them when the name changes. 
-
-Here are the possible export extensions with their corresponding mime types.
-Most of these can also be used for importing, but there more that are not
-listed here. Some of these additional ones might only be available when
-the operating system provides the correct MIME type entries.
-
-This list can be changed by Google Drive at any time and might not
-represent the currently available conversions.
-
-| Extension | Mime Type | Description |
-| --------- |-----------| ------------|
-| csv  | text/csv | Standard CSV format for Spreadsheets |
-| docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Office Document |
-| epub | application/epub+zip | E-book format |
-| html | text/html | An HTML Document |
-| jpg  | image/jpeg | A JPEG Image File |
-| json | application/vnd.google-apps.script+json | JSON Text Format |
-| odp  | application/vnd.oasis.opendocument.presentation | Openoffice Presentation |
-| ods  | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet |
-| ods  | application/x-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet |
-| odt  | application/vnd.oasis.opendocument.text | Openoffice Document |
-| pdf  | application/pdf | Adobe PDF Format |
-| png  | image/png | PNG Image Format|
-| pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation | Microsoft Office Powerpoint |
-| rtf  | application/rtf | Rich Text Format |
-| svg  | image/svg+xml | Scalable Vector Graphics Format |
-| tsv  | text/tab-separated-values | Standard TSV format for spreadsheets |
-| txt  | text/plain | Plain Text |
-| xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet |
-| zip  | application/zip | A ZIP file of HTML, Images CSS |
-
-Google documents can also be exported as link files. These files will
-open a browser window for the Google Docs website of that document
-when opened. The link file extension has to be specified as a
-`--drive-export-formats` parameter. They will match all available
-Google Documents.
-
-| Extension | Description | OS Support |
-| --------- | ----------- | ---------- |
-| desktop | freedesktop.org specified desktop entry | Linux |
-| link.html | An HTML Document with a redirect | All |
-| url | INI style link file | macOS, Windows |
-| webloc | macOS specific XML format | macOS |
-
-
-### Standard Options
-
-Here are the standard options specific to drive (Google Drive).
-
-#### --drive-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_DRIVE_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --drive-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_DRIVE_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-#### --drive-scope
-
-Scope that rclone should use when requesting access from drive.
-
-- Config:      scope
-- Env Var:     RCLONE_DRIVE_SCOPE
-- Type:        string
-- Default:     ""
-- Examples:
-    - "drive"
-        - Full access all files, excluding Application Data Folder.
-    - "drive.readonly"
-        - Read-only access to file metadata and file contents.
-    - "drive.file"
-        - Access to files created by rclone only.
-        - These are visible in the drive website.
-        - File authorization is revoked when the user deauthorizes the app.
-    - "drive.appfolder"
-        - Allows read and write access to the Application Data folder.
-        - This is not visible in the drive website.
-    - "drive.metadata.readonly"
-        - Allows read-only access to file metadata but
-        - does not allow any access to read or download file content.
-
-#### --drive-root-folder-id
-
-ID of the root folder
-Leave blank normally.
-
-Fill in to access "Computers" folders (see docs), or for rclone to use
-a non root folder as its starting point.
-
-
-- Config:      root_folder_id
-- Env Var:     RCLONE_DRIVE_ROOT_FOLDER_ID
-- Type:        string
-- Default:     ""
-
-#### --drive-service-account-file
-
-Service Account Credentials JSON file path 
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
-
-
-- Config:      service_account_file
-- Env Var:     RCLONE_DRIVE_SERVICE_ACCOUNT_FILE
-- Type:        string
-- Default:     ""
-
-#### --drive-alternate-export
-
-Deprecated: no longer needed
-
-- Config:      alternate_export
-- Env Var:     RCLONE_DRIVE_ALTERNATE_EXPORT
-- Type:        bool
-- Default:     false
-
-### Advanced Options
-
-Here are the advanced options specific to drive (Google Drive).
-
-#### --drive-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_DRIVE_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --drive-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_DRIVE_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --drive-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_DRIVE_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --drive-service-account-credentials
-
-Service Account Credentials JSON blob
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-- Config:      service_account_credentials
-- Env Var:     RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS
-- Type:        string
-- Default:     ""
-
-#### --drive-team-drive
-
-ID of the Team Drive
-
-- Config:      team_drive
-- Env Var:     RCLONE_DRIVE_TEAM_DRIVE
-- Type:        string
-- Default:     ""
-
-#### --drive-auth-owner-only
-
-Only consider files owned by the authenticated user.
-
-- Config:      auth_owner_only
-- Env Var:     RCLONE_DRIVE_AUTH_OWNER_ONLY
-- Type:        bool
-- Default:     false
-
-#### --drive-use-trash
-
-Send files to the trash instead of deleting permanently.
-Defaults to true, namely sending files to the trash.
-Use `--drive-use-trash=false` to delete files permanently instead.
-
-- Config:      use_trash
-- Env Var:     RCLONE_DRIVE_USE_TRASH
-- Type:        bool
-- Default:     true
-
-#### --drive-skip-gdocs
-
-Skip google documents in all listings.
-If given, gdocs practically become invisible to rclone.
-
-- Config:      skip_gdocs
-- Env Var:     RCLONE_DRIVE_SKIP_GDOCS
-- Type:        bool
-- Default:     false
-
-#### --drive-skip-checksum-gphotos
-
-Skip MD5 checksum on Google photos and videos only.
-
-Use this if you get checksum errors when transferring Google photos or
-videos.
-
-Setting this flag will cause Google photos and videos to return a
-blank MD5 checksum.
-
-Google photos are identified by being in the "photos" space.
-
-Corrupted checksums are caused by Google modifying the image/video but
-not updating the checksum.
-
-- Config:      skip_checksum_gphotos
-- Env Var:     RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS
-- Type:        bool
-- Default:     false
-
-#### --drive-shared-with-me
-
-Only show files that are shared with me.
-
-Instructs rclone to operate on your "Shared with me" folder (where
-Google Drive lets you access the files and folders others have shared
-with you).
-
-This works both with the "list" (lsd, lsl, etc) and the "copy"
-commands (copy, sync, etc), and with all other commands too.
-
-- Config:      shared_with_me
-- Env Var:     RCLONE_DRIVE_SHARED_WITH_ME
-- Type:        bool
-- Default:     false
-
-#### --drive-trashed-only
-
-Only show files that are in the trash.
-This will show trashed files in their original directory structure.
-
-- Config:      trashed_only
-- Env Var:     RCLONE_DRIVE_TRASHED_ONLY
-- Type:        bool
-- Default:     false
-
-#### --drive-starred-only
-
-Only show files that are starred.
-
-- Config:      starred_only
-- Env Var:     RCLONE_DRIVE_STARRED_ONLY
-- Type:        bool
-- Default:     false
-
-#### --drive-formats
-
-Deprecated: see export_formats
-
-- Config:      formats
-- Env Var:     RCLONE_DRIVE_FORMATS
-- Type:        string
-- Default:     ""
-
-#### --drive-export-formats
-
-Comma separated list of preferred formats for downloading Google docs.
-
-- Config:      export_formats
-- Env Var:     RCLONE_DRIVE_EXPORT_FORMATS
-- Type:        string
-- Default:     "docx,xlsx,pptx,svg"
-
-#### --drive-import-formats
-
-Comma separated list of preferred formats for uploading Google docs.
-
-- Config:      import_formats
-- Env Var:     RCLONE_DRIVE_IMPORT_FORMATS
-- Type:        string
-- Default:     ""
-
-#### --drive-allow-import-name-change
-
-Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.
-
-- Config:      allow_import_name_change
-- Env Var:     RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE
-- Type:        bool
-- Default:     false
-
-#### --drive-use-created-date
-
-Use file created date instead of modified date.,
-
-Useful when downloading data and you want the creation date used in
-place of the last modified date.
-
-**WARNING**: This flag may have some unexpected consequences.
-
-When uploading to your drive all files will be overwritten unless they
-haven't been modified since their creation. And the inverse will occur
-while downloading.  This side effect can be avoided by using the
-"--checksum" flag.
-
-This feature was implemented to retain photos capture date as recorded
-by google photos. You will first need to check the "Create a Google
-Photos folder" option in your google drive settings. You can then copy
-or move the photos locally and use the date the image was taken
-(created) set as the modification date.
-
-- Config:      use_created_date
-- Env Var:     RCLONE_DRIVE_USE_CREATED_DATE
-- Type:        bool
-- Default:     false
-
-#### --drive-use-shared-date
-
-Use date file was shared instead of modified date.
-
-Note that, as with "--drive-use-created-date", this flag may have
-unexpected consequences when uploading/downloading files.
-
-If both this flag and "--drive-use-created-date" are set, the created
-date is used.
-
-- Config:      use_shared_date
-- Env Var:     RCLONE_DRIVE_USE_SHARED_DATE
-- Type:        bool
-- Default:     false
-
-#### --drive-list-chunk
-
-Size of listing chunk 100-1000. 0 to disable.
-
-- Config:      list_chunk
-- Env Var:     RCLONE_DRIVE_LIST_CHUNK
-- Type:        int
-- Default:     1000
-
-#### --drive-impersonate
-
-Impersonate this user when using a service account.
-
-- Config:      impersonate
-- Env Var:     RCLONE_DRIVE_IMPERSONATE
-- Type:        string
-- Default:     ""
-
-#### --drive-upload-cutoff
-
-Cutoff for switching to chunked upload
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_DRIVE_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     8M
-
-#### --drive-chunk-size
-
-Upload chunk size. Must a power of 2 >= 256k.
-
-Making this larger will improve performance, but note that each chunk
-is buffered in memory one per transfer.
-
-Reducing this will reduce memory usage but decrease performance.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_DRIVE_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     8M
-
-#### --drive-acknowledge-abuse
-
-Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
-
-If downloading a file returns the error "This file has been identified
-as malware or spam and cannot be downloaded" with the error code
-"cannotDownloadAbusiveFile" then supply this flag to rclone to
-indicate you acknowledge the risks of downloading the file and rclone
-will download it anyway.
-
-- Config:      acknowledge_abuse
-- Env Var:     RCLONE_DRIVE_ACKNOWLEDGE_ABUSE
-- Type:        bool
-- Default:     false
-
-#### --drive-keep-revision-forever
-
-Keep new head revision of each file forever.
-
-- Config:      keep_revision_forever
-- Env Var:     RCLONE_DRIVE_KEEP_REVISION_FOREVER
-- Type:        bool
-- Default:     false
-
-#### --drive-size-as-quota
-
-Show sizes as storage quota usage, not actual size.
-
-Show the size of a file as the storage quota used. This is the
-current version plus any older versions that have been set to keep
-forever.
-
-**WARNING**: This flag may have some unexpected consequences.
-
-It is not recommended to set this flag in your config - the
-recommended usage is using the flag form --drive-size-as-quota when
-doing rclone ls/lsl/lsf/lsjson/etc only.
-
-If you do use this flag for syncing (not recommended) then you will
-need to use --ignore size also.
-
-- Config:      size_as_quota
-- Env Var:     RCLONE_DRIVE_SIZE_AS_QUOTA
-- Type:        bool
-- Default:     false
-
-#### --drive-v2-download-min-size
-
-If Object's are greater, use drive v2 API to download.
-
-- Config:      v2_download_min_size
-- Env Var:     RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE
-- Type:        SizeSuffix
-- Default:     off
-
-#### --drive-pacer-min-sleep
-
-Minimum time to sleep between API calls.
-
-- Config:      pacer_min_sleep
-- Env Var:     RCLONE_DRIVE_PACER_MIN_SLEEP
-- Type:        Duration
-- Default:     100ms
-
-#### --drive-pacer-burst
-
-Number of API calls to allow without sleeping.
-
-- Config:      pacer_burst
-- Env Var:     RCLONE_DRIVE_PACER_BURST
-- Type:        int
-- Default:     100
-
-#### --drive-server-side-across-configs
-
-Allow server side operations (eg copy) to work across different drive configs.
-
-This can be useful if you wish to do a server side copy between two
-different Google drives.  Note that this isn't enabled by default
-because it isn't easy to tell if it will work between any two
-configurations.
-
-- Config:      server_side_across_configs
-- Env Var:     RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS
-- Type:        bool
-- Default:     false
-
-#### --drive-disable-http2
-
-Disable drive using http2
-
-There is currently an unsolved issue with the google drive backend and
-HTTP/2.  HTTP/2 is therefore disabled by default for the drive backend
-but can be re-enabled here.  When the issue is solved this flag will
-be removed.
-
-See: https://github.com/rclone/rclone/issues/3631
-
-
-
-- Config:      disable_http2
-- Env Var:     RCLONE_DRIVE_DISABLE_HTTP2
-- Type:        bool
-- Default:     true
-
-#### --drive-stop-on-upload-limit
-
-Make upload limit errors be fatal
-
-At the time of writing it is only possible to upload 750GB of data to
-Google Drive a day (this is an undocumented limit). When this limit is
-reached Google Drive produces a slightly different error message. When
-this flag is set it causes these errors to be fatal.  These will stop
-the in-progress sync.
-
-Note that this detection is relying on error message strings which
-Google don't document so it may break in the future.
-
-See: https://github.com/rclone/rclone/issues/3857
-
-
-- Config:      stop_on_upload_limit
-- Env Var:     RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT
-- Type:        bool
-- Default:     false
-
-#### --drive-skip-shortcuts
-
-If set skip shortcut files
-
-Normally rclone dereferences shortcut files making them appear as if
-they are the original file (see [the shortcuts section](#shortcuts)).
-If this flag is set then rclone will ignore shortcut files completely.
-
-
-- Config:      skip_shortcuts
-- Env Var:     RCLONE_DRIVE_SKIP_SHORTCUTS
-- Type:        bool
-- Default:     false
-
-#### --drive-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_DRIVE_ENCODING
-- Type:        MultiEncoder
-- Default:     InvalidUtf8
-
-### Backend commands
-
-Here are the commands specific to the drive backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### get
-
-Get command for fetching the drive config parameters
-
-    rclone backend get remote: [options] [<arguments>+]
-
-This is a get command which will be used to fetch the various drive config parameters
-
-Usage Examples:
-
-    rclone backend get drive: [-o service_account_file] [-o chunk_size]
-    rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]
-
-
-Options:
-
-- "chunk_size": show the current upload chunk size
-- "service_account_file": show the current service account file
-
-#### set
-
-Set command for updating the drive config parameters
-
-    rclone backend set remote: [options] [<arguments>+]
-
-This is a set command which will be used to update the various drive config parameters
-
-Usage Examples:
-
-    rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
-    rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
-
-
-Options:
-
-- "chunk_size": update the current upload chunk size
-- "service_account_file": update the current service account file
-
-#### shortcut
-
-Create shortcuts from files or directories
-
-    rclone backend shortcut remote: [options] [<arguments>+]
-
-This command creates shortcuts from files or directories.
-
-Usage:
-
-    rclone backend shortcut drive: source_item destination_shortcut
-    rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut
-
-In the first example this creates a shortcut from the "source_item"
-which can be a file or a directory to the "destination_shortcut". The
-"source_item" and the "destination_shortcut" should be relative paths
-from "drive:"
-
-In the second example this creates a shortcut from the "source_item"
-relative to "drive:" to the "destination_shortcut" relative to
-"drive2:". This may fail with a permission error if the user
-authenticated with "drive2:" can't read files from "drive:".
-
-
-Options:
-
-- "target": optional target remote for the shortcut destination
-
-#### drives
-
-List the shared drives available to this account
-
-    rclone backend drives remote: [options] [<arguments>+]
-
-This command lists the shared drives (teamdrives) available to this
-account.
-
-Usage:
-
-    rclone backend drives drive:
-
-This will return a JSON list of objects like this
-
-    [
-        {
-            "id": "0ABCDEF-01234567890",
-            "kind": "drive#teamDrive",
-            "name": "My Drive"
-        },
-        {
-            "id": "0ABCDEFabcdefghijkl",
-            "kind": "drive#teamDrive",
-            "name": "Test Drive"
-        }
-    ]
-
-
-
-#### untrash
-
-Untrash files and directories
-
-    rclone backend untrash remote: [options] [<arguments>+]
-
-This command untrashes all the files and directories in the directory
-passed in recursively.
-
-Usage:
-
-This takes an optional directory to trash which make this easier to
-use via the API.
-
-    rclone backend untrash drive:directory
-    rclone backend -i untrash drive:directory subdir
-
-Use the -i flag to see what would be restored before restoring it.
-
-Result:
-
-    {
-        "Untrashed": 17,
-        "Errors": 0
-    }
-
-
-
-
-### Limitations ###
-
-Drive has quite a lot of rate limiting.  This causes rclone to be
-limited to transferring about 2 files per second only.  Individual
-files may be transferred much faster at 100s of MBytes/s but lots of
-small files can take a long time.
-
-Server side copies are also subject to a separate rate limit. If you
-see User rate limit exceeded errors, wait at least 24 hours and retry.
-You can disable server side copies with `--disable copy` to download
-and upload the files if you prefer.
-
-#### Limitations of Google Docs ####
-
-Google docs will appear as size -1 in `rclone ls` and as size 0 in
-anything which uses the VFS layer, eg `rclone mount`, `rclone serve`.
-
-This is because rclone can't find out the size of the Google docs
-without downloading them.
-
-Google docs will transfer correctly with `rclone sync`, `rclone copy`
-etc as rclone knows to ignore the size when doing the transfer.
-
-However an unfortunate consequence of this is that you may not be able
-to download Google docs using `rclone mount`. If it doesn't work you
-will get a 0 sized file.  If you try again the doc may gain its
-correct size and be downloadable. Whether it will work on not depends
-on the application accessing the mount and the OS you are running -
-experiment to find out if it does work for you!
-
-### Duplicated files ###
-
-Sometimes, for no reason I've been able to track down, drive will
-duplicate a file that rclone uploads.  Drive unlike all the other
-remotes can have duplicated files.
-
-Duplicated files cause problems with the syncing and you will see
-messages in the log about duplicates.
-
-Use `rclone dedupe` to fix duplicated files.
-
-Note that this isn't just a problem with rclone, even Google Photos on
-Android duplicates files on drive sometimes.
-
-### Rclone appears to be re-copying files it shouldn't ###
-
-The most likely cause of this is the duplicated file issue above - run
-`rclone dedupe` and check your logs for duplicate object or directory
-messages.
-
-This can also be caused by a delay/caching on google drive's end when
-comparing directory listings. Specifically with team drives used in
-combination with --fast-list. Files that were uploaded recently may
-not appear on the directory list sent to rclone when using --fast-list.
-
-Waiting a moderate period of time between attempts (estimated to be
-approximately 1 hour) and/or not using --fast-list both seem to be
-effective in preventing the problem.
-
-### Making your own client_id ###
-
-When you use rclone with Google drive in its default configuration you
-are using rclone's client_id.  This is shared between all the rclone
-users.  There is a global rate limit on the number of queries per
-second that each client_id can do set by Google.  rclone already has a
-high quota and I will continue to make sure it is high enough by
-contacting Google.
-
-It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower.
-
-Here is how to create your own Google Drive client ID for rclone:
-
-1. Log into the [Google API
-Console](https://console.developers.google.com/) with your Google
-account. It doesn't matter what Google account you use. (It need not
-be the same account as the Google Drive you want to access)
-
-2. Select a project or create a new project.
-
-3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the
-"Google Drive API".
-
-4. Click "Credentials" in the left-side panel (not "Create
-credentials", which opens the wizard), then "Create credentials"
-
-5. If you already configured an "Oauth Consent Screen", then skip
-to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button 
-(near the top right corner of the right panel), then select "External"
-and click on "CREATE"; on the next screen, enter an "Application name"
-("rclone" is OK) then click on "Save" (all other data is optional). 
-Click again on "Credentials" on the left panel to go back to the 
-"Credentials" screen.
-
-(PS: if you are a GSuite user, you could also select "Internal" instead
-of "External" above, but this has not been tested/documented so far). 
-
-6.  Click on the "+ CREATE CREDENTIALS" button at the top of the screen,
-then select "OAuth client ID".
-
-7. Choose an application type of "Desktop app" if you using a Google account or "Other" if 
-you using a GSuite account and click "Create". (the default name is fine)
-
-8. It will show you a client ID and client secret.  Use these values
-in rclone config to add a new remote or edit an existing remote.
-
-Be aware that, due to the "enhanced security" recently introduced by
-Google, you are theoretically expected to "submit your app for verification"
-and then wait a few weeks(!) for their response; in practice, you can go right
-ahead and use the client ID and client secret with rclone, the only issue will
-be a very scary confirmation screen shown when you connect via your browser 
-for rclone to be able to get its token-id (but as this only happens during 
-the remote configuration, it's not such a big deal). 
-
-(Thanks to @balazer on github for these instructions.)
-
-Sometimes, creation of an OAuth consent in Google API Console fails due to an error message
-“The request failed because changes to one of the field of the resource is not supported”.
-As a convenient workaround, the necessary Google Drive API key can be created on the
-[Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page.
-Just push the Enable the Drive API button to receive the Client ID and Secret.
-Note that it will automatically create a new project in the API Console.
-
- Google Photos
--------------------------------------------------
-
-The rclone backend for [Google Photos](https://www.google.com/photos/about/) is
-a specialized backend for transferring photos and videos to and from
-Google Photos.
-
-**NB** The Google Photos API which rclone uses has quite a few
-limitations, so please read the [limitations section](#limitations)
-carefully to make sure it is suitable for your use.
-
-## Configuring Google Photos
-
-The initial setup for google cloud storage involves getting a token from Google Photos
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Google Photos  "google photos" [snip] Storage> google photos ** See help for google photos backend at: https://rclone.org/googlephotos/ **
    
-
    Google Application Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). client_id> Google Application Client Secret Leave blank normally. Enter a string value. Press Enter for the default (""). client_secret> Set to make the Google Photos backend read only.
    
-
    If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. Enter a boolean value (true or false). Press Enter for the default ("false"). read_only> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code
    
-
    *** IMPORTANT: All media items uploaded to Google Photos with rclone *** are stored in full resolution at original quality. These uploads *** will count towards storage in your Google Account.
    
-
---
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Access the Personal Folders. (Default)
+   \ ""
+ 2 / Access the Favorites folder.
+   \ "favorites"
+ 3 / Access all the shared folders.
+   \ "allshared"
+ 4 / Access all the individual connectors.
+   \ "connectors"
+ 5 / Access the home, favorites, and shared folders as well as the connectors.
+   \ "top"
+root_folder_id> 
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+type = sharefile
+endpoint = https://XXX.sharefile.com
+token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+
    See the remote setup docs for how to set it up on a machine with no Internet 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 code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your ShareFile
    
+
    rclone lsd remote:
    
+
    List all the files in your ShareFile
    
+
    rclone ls remote:
    
+
    To copy a local directory to an ShareFile directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Paths may be as deep as required, eg remote:directory/subdirectory.
    
+
    Modified time and hashes
    
+
    ShareFile allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.
    
+
    ShareFile supports MD5 type hashes, so you can use the --checksum flag.
    
+
    Transfers
    
+
    For files above 128MB rclone will use a chunked transfer. Rclone will upload up to --transfers chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 64MB so increasing --transfers will increase memory use.
    
+
    Limitations
    
+
    Note that ShareFile is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    ShareFile only supports filenames up to 256 characters in length.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
    


    
-
+
+
+
-
+
+
+
-
+
+
+
-
+
+
+
-
+
+
+
-
+
+
+
-
+
+
+
-
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
    
 
 
    [remote] type = google photos token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"}CharacterValueReplacement
 
    
     
 
 
    y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ```\0x5C＼
 
    
 
    Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode.*0x2A＊
 
    
 
    This remote is called remote and can now be used like this<0x3C＜
 
    
 
    See all the albums in your photos>0x3E＞
 
    
 
    rclone lsd remote:album?0x3F？
 
    
 
    Make a new album:0x3A：
 
    
 
    rclone mkdir remote:album/newAlbum|0x7C｜
 
    
 
    List the contents of an album
    rclone ls remote:album/newAlbum
    Sync /home/local/images to the Google Photos, removing any excess files in the album.
    rclone sync -i /home/local/image remote:album/newAlbum
    ## Layout
    As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it.
    The directories under media show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup remote:media/by-month. (NB remote:media/by-day is rather slow at the moment so avoid for syncing.)
    Note that all your photos and videos will appear somewhere under media, but they may not appear under album unless you've put them into albums.
    / - upload - file1.jpg - file2.jpg - ... - media - all - file1.jpg - file2.jpg - ... - by-year - 2000 - file1.jpg - ... - 2001 - file2.jpg - ... - ... - by-month - 2000 - 2000-01 - file1.jpg - ... - 2000-02 - file2.jpg - ... - ... - by-day - 2000 - 2000-01-01 - file1.jpg - ... - 2000-01-02 - file2.jpg - ... - ... - album - album name - album name/sub - shared-album - album name - album name/sub - feature - favorites - file1.jpg - file2.jpg
    There are two writable parts of the tree, the upload directory and sub directories of the album directory.
    The upload directory is for uploading files you don't want to put into albums. This will be empty to start with and will contain the files you've uploaded for one rclone session only, becoming empty again when you restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to album will work better.
    Directories within the album directory are also writeable and you may create new directories (albums) under album. If you copy files with a directory hierarchy in there then rclone will create albums with the / character in them. For example if you do
    rclone copy /path/to/images remote:album/images
    and the images directory contains
    images - file1.jpg dir file2.jpg dir2 dir3 file3.jpg
    Then rclone will create the following albums with the following files in
    - images - file1.jpg - images/dir - file2.jpg - images/dir2/dir3 - file3.jpg
    This means that you can use the album path pretty much like a normal filesystem and it is a good target for repeated syncing.
    The shared-album directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface.
    ## Limitations
    Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn't understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item.
    Note that all media items uploaded to Google Photos through the API are stored in full resolution at "original quality" and will count towards your storage quota in your Google Account. The API does not offer a way to upload in "high quality" mode..
    ### Downloading Images
    When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115.
    The current google API does not allow photos to be downloaded at original resolution. This is very important if you are, for example, relying on "Google Photos" as a backup of your photos. You will not be able to use rclone to redownload original images. You could use 'google takeout' to recover the original photos as a last resort
    ### Downloading Videos
    When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044.
    ### Duplicates
    If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called file.jpg would then appear as file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer alas!).
    If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may confuse rclone. For example if you uploaded an image to upload then uploaded the same image to album/my_album the filename of the image in album/my_album will be what it was uploaded with initially, not what you uploaded it with to album. In practise this shouldn't cause too many problems.
    ### Modified time
    The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known.
    This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes.
    ### Size
    The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check.
    It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is very slow and uses up a lot of transactions. This can be enabled with the --gphotos-read-size option or the read_size = true config parameter.
    If you want to use the backend with rclone mount you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You'll need to experiment to see if it works for you without the flag.
    ### Albums
    Rclone can only upload files to albums it created. This is a limitation of the Google Photos API.
    Rclone can remove files it uploaded from albums it created only.
    ### Deleting files
    Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781.
    Rclone cannot delete files anywhere except under album.
    ### Deleting albums
    The Google Photos API does not support deleting albums - see bug #135714733.
    ### Standard Options
    Here are the standard options specific to google photos (Google Photos).
    #### --gphotos-client-id
    OAuth Client Id Leave blank normally.
    - Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Default: ""
    #### --gphotos-client-secret
    OAuth Client Secret Leave blank normally.
    - Config: client_secret - Env Var: RCLONE_GPHOTOS_CLIENT_SECRET - Type: string - Default: ""
    #### --gphotos-read-only
    Set to make the Google Photos backend read only.
    If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access.
    - Config: read_only - Env Var: RCLONE_GPHOTOS_READ_ONLY - Type: bool - Default: false
    ### Advanced Options
    Here are the advanced options specific to google photos (Google Photos).
    #### --gphotos-token
    OAuth Access Token as a JSON blob.
    - Config: token - Env Var: RCLONE_GPHOTOS_TOKEN - Type: string - Default: ""
    #### --gphotos-auth-url
    Auth server URL. Leave blank to use the provider defaults.
    - Config: auth_url - Env Var: RCLONE_GPHOTOS_AUTH_URL - Type: string - Default: ""
    #### --gphotos-token-url
    Token server url. Leave blank to use the provider defaults.
    - Config: token_url - Env Var: RCLONE_GPHOTOS_TOKEN_URL - Type: string - Default: ""
    #### --gphotos-read-size
    Set to read the size of media items.
    Normally rclone does not read the size of media items since this takes another transaction. This isn't necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media.
    - Config: read_size - Env Var: RCLONE_GPHOTOS_READ_SIZE - Type: bool - Default: false
    #### --gphotos-start-year
    Year limits the photos to be downloaded to those which are uploaded after the given year
    - Config: start_year - Env Var: RCLONE_GPHOTOS_START_YEAR - Type: int - Default: 2000
    HTTP"0x22＂
 
    
     
 
    
+
    File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    .0x2E．
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Standard Options
    
+
    Here are the standard options specific to sharefile (Citrix Sharefile).
    
+
    --sharefile-root-folder-id
    
+
    ID of the root folder
    
+
    Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID).
    
+
      
+
    • Config: root_folder_id
      • 
+
    • Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Access the Personal Folders. (Default)
          • 
+
        • 
+
      • "favorites"
+
          
+
        • Access the Favorites folder.
          • 
+
        • 
+
      • "allshared"
+
          
+
        • Access all the shared folders.
          • 
+
        • 
+
      • "connectors"
+
          
+
        • Access all the individual connectors.
          • 
+
        • 
+
      • "top"
+
          
+
        • Access the home, favorites, and shared folders as well as the connectors.
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to sharefile (Citrix Sharefile).
    
+
    --sharefile-upload-cutoff
    
+
    Cutoff for switching to multipart upload.
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 128M
      • 
+
    
+
    --sharefile-chunk-size
    
+
    Upload chunk size. Must a power of 2 >= 256k.
    
+
    Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer.
    
+
    Reducing this will reduce memory usage but decrease performance.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_SHAREFILE_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 64M
      • 
+
    
+
    --sharefile-endpoint
    
+
    Endpoint for API calls.
    
+
    This is usually auto discovered as part of the oauth process, but can be set manually to something like: https://XXX.sharefile.com
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_SHAREFILE_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --sharefile-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_SHAREFILE_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
      • 
+
    
+
    Crypt
    
+
    The crypt remote encrypts and decrypts another remote.
    
+
    To use it first set up the underlying remote following the config instructions for that remote. You can also use a local pathname instead of a remote which will encrypt and decrypt from that directory which might be useful for encrypting onto a USB stick for example.
    
+
    First check your chosen remote is working - we'll call it remote:path in these docs. Note that anything inside remote:path will be encrypted and anything outside won't. This means that if you are using a bucket based remote (eg S3, B2, swift) then you should probably put the bucket in the remote s3:bucket. If you just use s3: then rclone will make encrypted bucket names too (if using file name encryption) which may or may not be what you want.
    
+
    Now configure crypt using rclone config. We will call this one secret to differentiate it from the remote.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n   
+name> secret
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Encrypt/Decrypt a remote
+   \ "crypt"
+[snip]
+Storage> crypt
+Remote to encrypt/decrypt.
+Normally should contain a ':' and a path, eg "myremote:path/to/dir",
+"myremote:bucket" or maybe "myremote:" (not recommended).
+remote> remote:path
+How to encrypt the filenames.
+Choose a number from below, or type in your own value
+ 1 / Don't encrypt the file names.  Adds a ".bin" extension only.
+   \ "off"
+ 2 / Encrypt the filenames see the docs for the details.
+   \ "standard"
+ 3 / Very simple filename obfuscation.
+   \ "obfuscate"
+filename_encryption> 2
+Option to either encrypt directory names or leave them intact.
+Choose a number from below, or type in your own value
+ 1 / Encrypt directory names.
+   \ "true"
+ 2 / Don't encrypt directory names, leave them intact.
+   \ "false"
+filename_encryption> 1
+Password or pass phrase for encryption.
+y) Yes type in my own password
+g) Generate random password
+y/g> y
+Enter the password:
+password:
+Confirm the password:
+password:
+Password or pass phrase for salt. Optional but recommended.
+Should be different to the previous password.
+y) Yes type in my own password
+g) Generate random password
+n) No leave this optional password blank
+y/g/n> g
+Password strength in bits.
+64 is just about memorable
+128 is secure
+1024 is the maximum
+Bits> 128
+Your password is: JAsJvRcgR-_veXNfy_sGmQ
+Use this password?
+y) Yes
+n) No
+y/n> y
+Remote config
+--------------------
+[secret]
+remote = remote:path
+filename_encryption = standard
+password = *** ENCRYPTED ***
+password2 = *** ENCRYPTED ***
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Important The password is stored in the config file is lightly obscured so it isn't immediately obvious what it is. It is in no way secure unless you use config file encryption.
    
+
    A long passphrase is recommended, or you can use a random one.
    
+
    The obscured password is created by using AES-CTR with a static key, with the salt stored verbatim at the beginning of the obscured password. This static key is shared by between all versions of rclone.
    
+
    If you reconfigure rclone with the same passwords/passphrases elsewhere it will be compatible, but the obscured version will be different due to the different salt.
    
+
    Note that rclone does not encrypt
    
+
      
+
    • file length - this can be calculated within 16 bytes
      • 
+
    • modification time - used for syncing
      • 
+
    
+
    Specifying the remote
    
+
    In normal use, make sure the remote has a : in. If you specify the remote without a : then rclone will use a local directory of that name. So if you use a remote of /path/to/secret/files then rclone will encrypt stuff to that directory. If you use a remote of name then rclone will put files in a directory called name in the current directory.
    
+
    If you specify the remote as remote:path/to/dir then rclone will store encrypted files in path/to/dir on the remote. If you are using file name encryption, then when you save files to secret:subdir/subfile this will store them in the unencrypted path path/to/dir but the subdir/subpath bit will be encrypted.
    
+
    Note that unless you want encrypted bucket names (which are difficult to manage because you won't know what directory they represent in web interfaces etc), you should probably specify a bucket, eg remote:secretbucket when using bucket based remotes such as S3, Swift, Hubic, B2, GCS.
    
+
    Example
    
+
    To test I made a little directory of files using "standard" file name encryption.
    
+
    plaintext/
+├── file0.txt
+├── file1.txt
+└── subdir
+    ├── file2.txt
+    ├── file3.txt
+    └── subsubdir
+        └── file4.txt
    
+
    Copy these to the remote and list them back
    
+
    $ rclone -q copy plaintext secret:
+$ rclone -q ls secret:
+        7 file1.txt
+        6 file0.txt
+        8 subdir/file2.txt
+       10 subdir/subsubdir/file4.txt
+        9 subdir/file3.txt
    
+
    Now see what that looked like when encrypted
    
+
    $ rclone -q ls remote:path
+       55 hagjclgavj2mbiqm6u6cnjjqcg
+       54 v05749mltvv1tf4onltun46gls
+       57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo
+       58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc
+       56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps
    
+
    Note that this retains the directory structure which means you can do this
    
+
    $ rclone -q ls secret:subdir
+        8 file2.txt
+        9 file3.txt
+       10 subsubdir/file4.txt
    
+
    If don't use file name encryption then the remote will look like this - note the .bin extensions added to prevent the cloud provider attempting to interpret the data.
    
+
    $ rclone -q ls remote:path
+       54 file0.txt.bin
+       57 subdir/file3.txt.bin
+       56 subdir/file2.txt.bin
+       58 subdir/subsubdir/file4.txt.bin
+       55 file1.txt.bin
    
+
    File name encryption modes
    
+
    Here are some of the features of the file name encryption modes
    
+
    Off
    
+
      
+
    • doesn't hide file names or directory structure
      • 
+
    • allows for longer file names (~246 characters)
      • 
+
    • can use sub paths and copy single files
      • 
+
    
+
    Standard
    
+
      
+
    • file names encrypted
      • 
+
    • file names can't be as long (~143 characters)
      • 
+
    • can use sub paths and copy single files
      • 
+
    • directory structure visible
      • 
+
    • identical files names will have identical uploaded names
      • 
+
    • can use shortcuts to shorten the directory recursion
      • 
+
    
+
    Obfuscation
    
+
    This is a simple "rotate" of the filename, with each file having a rot distance based on the filename. We store the distance at the beginning of the filename. So a file called "hello" may become "53.jgnnq".
    
+
    This is not a strong encryption of filenames, but it may stop automated scanning tools from picking up on filename patterns. As such it's an intermediate between "off" and "standard". The advantage is that it allows for longer path segment names.
    
+
    There is a possibility with some unicode based filenames that the obfuscation is weak and may map lower case characters to upper case equivalents. You can not rely on this for strong protection.
    
+
      
+
    • file names very lightly obfuscated
      • 
+
    • file names can be longer than standard encryption
      • 
+
    • can use sub paths and copy single files
      • 
+
    • directory structure visible
      • 
+
    • identical files names will have identical uploaded names
      • 
+
    
+
    Cloud storage systems have various limits on file name length and total path length which you are more likely to hit using "Standard" file name encryption. If you keep your file names to below 156 characters in length then you should be OK on all providers.
    
+
    There may be an even more secure file name encryption mode in the future which will address the long file name problem.
    
+
    Directory name encryption
    
+
    Crypt offers the option of encrypting dir names or leaving them intact. There are two options:
    
+
    True
    
+
    Encrypts the whole file path including directory names Example: 1/12/123.txt is encrypted to p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0
    
+
    False
    
+
    Only encrypts file names, skips directory names Example: 1/12/123.txt is encrypted to 1/12/qgm4avr35m5loi1th53ato71v0
    
+
    Modified time and hashes
    
+
    Crypt stores modification times using the underlying remote so support depends on that.
    
+
    Hashes are not stored for crypt. However the data integrity is protected by an extremely strong crypto authenticator.
    
+
    Note that you should use the rclone cryptcheck command to check the integrity of a crypted remote instead of rclone check which can't check the checksums properly.
    
+
    Standard Options
    
+
    Here are the standard options specific to crypt (Encrypt/Decrypt a remote).
    
+
    --crypt-remote
    
+
    Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_CRYPT_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --crypt-filename-encryption
    
+
    How to encrypt the filenames.
    
+
      
+
    • Config: filename_encryption
      • 
+
    • Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION
      • 
+
    • Type: string
      • 
+
    • Default: "standard"
      • 
+
    • Examples:
+
        
+
      • "standard"
+
          
+
        • Encrypt the filenames see the docs for the details.
          • 
+
        • 
+
      • "obfuscate"
+
          
+
        • Very simple filename obfuscation.
          • 
+
        • 
+
      • "off"
+
          
+
        • Don't encrypt the file names. Adds a ".bin" extension only.
          • 
+
        • 
+
      • 
+
    
+
    --crypt-directory-name-encryption
    
+
    Option to either encrypt directory names or leave them intact.
    
+
    NB If filename_encryption is "off" then this option will do nothing.
    
+
      
+
    • Config: directory_name_encryption
      • 
+
    • Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION
      • 
+
    • Type: bool
      • 
+
    • Default: true
      • 
+
    • Examples:
+
        
+
      • "true"
+
          
+
        • Encrypt directory names.
          • 
+
        • 
+
      • "false"
+
          
+
        • Don't encrypt directory names, leave them intact.
          • 
+
        • 
+
      • 
+
    
+
    --crypt-password
    
+
    Password or pass phrase for encryption.
    
+
    NB Input to this must be obscured - see rclone obscure.
    
+
      
+
    • Config: password
      • 
+
    • Env Var: RCLONE_CRYPT_PASSWORD
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --crypt-password2
    
+
    Password or pass phrase for salt. Optional but recommended. Should be different to the previous password.
    
+
    NB Input to this must be obscured - see rclone obscure.
    
+
      
+
    • Config: password2
      • 
+
    • Env Var: RCLONE_CRYPT_PASSWORD2
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to crypt (Encrypt/Decrypt a remote).
    
+
    --crypt-server-side-across-configs
    
+
    Allow server side operations (eg copy) to work across different crypt configs.
    
+
    Normally this option is not what you want, but if you have two crypts pointing to the same backend you can use it.
    
+
    This can be used, for example, to change file name encryption type without re-uploading all the data. Just make two crypt backends pointing to two different directories with the single changed parameter and use rclone move to move the files between the crypt remotes.
    
+
      
+
    • Config: server_side_across_configs
      • 
+
    • Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --crypt-show-mapping
    
+
    For all files listed show how the names encrypt.
    
+
    If this flag is set then for each file that the remote is asked to list, it will log (at level INFO) a line stating the decrypted file name and the encrypted file name.
    
+
    This is so you can work out which encrypted names are which decrypted names just in case you need to do something with the encrypted file names, or for debugging purposes.
    
+
      
+
    • Config: show_mapping
      • 
+
    • Env Var: RCLONE_CRYPT_SHOW_MAPPING
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Backend commands
    
+
    Here are the commands specific to the crypt backend.
    
+
    Run them with
    
+
    rclone backend COMMAND remote:
    
+
    The help below will explain what arguments each command takes.
    
+
    See the "rclone backend" command for more info on how to pass options and arguments.
    
+
    These can be run on a running backend using the rc command backend/command.
    
+
    encode
    
+
    Encode the given filename(s)
    
+
    rclone backend encode remote: [options] [<arguments>+]
    
+
    This encodes the filenames given as arguments returning a list of strings of the encoded results.
    
+
    Usage Example:
    
+
    rclone backend encode crypt: file1 [file2...]
+rclone rc backend/command command=encode fs=crypt: file1 [file2...]
    
+
    decode
    
+
    Decode the given filename(s)
    
+
    rclone backend decode remote: [options] [<arguments>+]
    
+
    This decodes the filenames given as arguments returning a list of strings of the decoded results. It will return an error if any of the inputs are invalid.
    
+
    Usage Example:
    
+
    rclone backend decode crypt: encryptedfile1 [encryptedfile2...]
+rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]
    
+
    Backing up a crypted remote
    
+
    If you wish to backup a crypted remote, it is recommended that you use rclone sync on the encrypted files, and make sure the passwords are the same in the new encrypted remote.
    
+
    This will have the following advantages
    
+
      
+
    • rclone sync will check the checksums while copying
      • 
+
    • you can use rclone check between the encrypted remotes
      • 
+
    • you don't decrypt and encrypt unnecessarily
      • 
+
    
+
    For example, let's say you have your original remote at remote: with the encrypted version at eremote: with path remote:crypt. You would then set up the new remote remote2: and then the encrypted version eremote2: with path remote2:crypt using the same passwords as eremote:.
    
+
    To sync the two remotes you would do
    
+
    rclone sync -i remote:crypt remote2:crypt
    
+
    And to check the integrity you would do
    
+
    rclone check remote:crypt remote2:crypt
    
+
    File formats
    
+
    File encryption
    
+
    Files are encrypted 1:1 source file to destination object. The file has a header and is divided into chunks.
    
+
    Header
    
+
      
+
    • 8 bytes magic string RCLONE\x00\x00
      • 
+
    • 24 bytes Nonce (IV)
      • 
+
    
+
    The initial nonce is generated from the operating systems crypto strong random number generator. The nonce is incremented for each chunk read making sure each nonce is unique for each block written. The chance of a nonce being re-used is minuscule. If you wrote an exabyte of data (10¹⁸ bytes) you would have a probability of approximately 2×10⁻³² of re-using a nonce.
    
+
    Chunk
    
+
    Each chunk will contain 64kB of data, except for the last one which may have less data. The data chunk is in standard NACL secretbox format. Secretbox uses XSalsa20 and Poly1305 to encrypt and authenticate messages.
    
+
    Each chunk contains:
    
+
      
+
    • 16 Bytes of Poly1305 authenticator
      • 
+
    • 1 - 65536 bytes XSalsa20 encrypted data
      • 
+
    
+
    64k chunk size was chosen as the best performing chunk size (the authenticator takes too much time below this and the performance drops off due to cache effects above this). Note that these chunks are buffered in memory so they can't be too big.
    
+
    This uses a 32 byte (256 bit key) key derived from the user password.
    
+
    Examples
    
+
    1 byte file will encrypt to
    
+
      
+
    • 32 bytes header
      • 
+
    • 17 bytes data chunk
      • 
+
    
+
    49 bytes total
    
+
    1MB (1048576 bytes) file will encrypt to
    
+
      
+
    • 32 bytes header
      • 
+
    • 16 chunks of 65568 bytes
      • 
+
    
+
    1049120 bytes total (a 0.05% overhead). This is the overhead for big files.
    
+
    Name encryption
    
+
    File names are encrypted segment by segment - the path is broken up into / separated strings and these are encrypted individually.
    
+
    File segments are padded using PKCS#7 to a multiple of 16 bytes before encryption.
    
+
    They are then encrypted with EME using AES with 256 bit key. EME (ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway.
    
+
    This makes for deterministic encryption which is what we want - the same filename must encrypt to the same thing otherwise we can't find it on the cloud storage system.
    
+
    This means that
    
+
      
+
    • filenames with the same name will encrypt the same
      • 
+
    • filenames which start the same won't have a common prefix
      • 
+
    
+
    This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of which are derived from the user password.
    
+
    After encryption they are written out using a modified version of standard base32 encoding as described in RFC4648. The standard encoding is modified in two ways:
    
+
      
+
    • it becomes lower case (no-one likes upper case filenames!)
      • 
+
    • we strip the padding character =
      • 
+
    
+
    base32 is used rather than the more efficient base64 so rclone can be used on case insensitive remotes (eg Windows, Amazon Drive).
    
+
    Key derivation
    
+
    Rclone uses scrypt with parameters N=16384, r=8, p=1 with an optional user supplied salt (password2) to derive the 32+32+16 = 80 bytes of key material required. If the user doesn't supply a salt then rclone uses an internal one.
    
+
    scrypt makes it impractical to mount a dictionary attack on rclone encrypted data. For full protection against this you should always use a salt.
    
+
    Dropbox
    
+
    Paths are specified as remote:path
    
+
    Dropbox paths may be as deep as required, eg remote:directory/subdirectory.
    
+
    The initial setup for dropbox involves getting a token from Dropbox which you need to do in your browser. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    n) New remote
+d) Delete remote
+q) Quit config
+e/n/d/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Dropbox
+   \ "dropbox"
+[snip]
+Storage> dropbox
+Dropbox App Key - leave blank normally.
+app_key>
+Dropbox App Secret - leave blank normally.
+app_secret>
+Remote config
+Please visit:
+https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code
+Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX
+--------------------
+[remote]
+app_key =
+app_secret =
+token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    You can then use it like this,
    
+
    List directories in top level of your dropbox
    
+
    rclone lsd remote:
    
+
    List all the files in your dropbox
    
+
    rclone ls remote:
    
+
    To copy a local directory to a dropbox directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Dropbox for business
    
+
    Rclone supports Dropbox for business and Team Folders.
    
+
    When using Dropbox for business remote: and remote:path/to/file will refer to your personal folder.
    
+
    If you wish to see Team Folders you must use a leading / in the path, so rclone lsd remote:/ will refer to the root and show you all Team Folders and your User Folder.
    
+
    You can then use team folders like this remote:/TeamFolder and remote:/TeamFolder/path/to/file.
    
+
    A leading / for a Dropbox personal account will do nothing, but it will take an extra HTTP transaction so it should be avoided.
    
+
    Modified time and Hashes
    
+
    Dropbox supports modified times, but the only way to set a modification time is to re-upload the file.
    
+
    This means that if you uploaded your data with an older version of rclone which didn't support the v2 API and modified times, rclone will decide to upload all your old data to fix the modification times. If you don't want this to happen use --size-only or --checksum flag to stop it.
    
+
    Dropbox supports its own hash type which is checked for all transfers.
    
+
    Restricted filename characters
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    DEL0x7F␡
    \0x5C＼
    
+
    File names can also not end with the following characters. These only get replaced if they are the last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Standard Options
    
+
    Here are the standard options specific to dropbox (Dropbox).
    
+
    --dropbox-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_DROPBOX_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --dropbox-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_DROPBOX_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to dropbox (Dropbox).
    
+
    --dropbox-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_DROPBOX_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --dropbox-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_DROPBOX_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --dropbox-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_DROPBOX_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --dropbox-chunk-size
    
+
    Upload chunk size. (< 150M).
    
+
    Any files larger than this will be uploaded in chunks of this size.
    
+
    Note that chunks are buffered in memory (one at a time) so rclone can deal with retries. Setting this larger will increase the speed slightly (at most 10% for 128MB in tests) at the cost of using more memory. It can be set smaller if you are tight on memory.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_DROPBOX_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 48M
      • 
+
    
+
    --dropbox-impersonate
    
+
    Impersonate this user when using a business account.
    
+
      
+
    • Config: impersonate
      • 
+
    • Env Var: RCLONE_DROPBOX_IMPERSONATE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --dropbox-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_DROPBOX_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    Note that Dropbox is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    There are some file names such as thumbs.db which Dropbox can't store. There is a full list of them in the "Ignored Files" section of this document. Rclone will issue an error message File name disallowed - not uploading if it attempts to upload one of those file names, but the sync won't fail.
    
+
    Some errors may occur if you try to sync copyright-protected files because Dropbox has its own copyright detector that prevents this sort of file being downloaded. This will return the error ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/.
    
+
    If you have more than 10,000 files in a directory then rclone purge dropbox:dir will return the error Failed to purge: There are too many files involved in this operation. As a work-around do an rclone delete dropbox:dir followed by an rclone rmdir dropbox:dir.
    
+
    Get your own Dropbox App ID
    
+
    When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users.
    
+
    Here is how to create your own Dropbox App ID for rclone:
    
+
      
+
    1. Log into the Dropbox App console with your Dropbox Account (It need not to be the same account as the Dropbox you want to access)
      2. 
+
    2. Choose an API => Usually this should be Dropbox API
      3. 
+
    3. Choose the type of access you want to use => Full Dropbox or App Folder
      4. 
+
    4. Name your App. The app name is global, so you can't use rclone for example
      5. 
+
    5. Click the button Create App
      6. 
+
    6. Fill Redirect URIs as http://localhost:53682/
      7. 
+
    7. Find the App key and App secret Use these values in rclone config to add a new remote or edit an existing remote.
      8. 
+
    
+
    FTP
    
+
    FTP is the File Transfer Protocol. FTP support is provided using the github.com/jlaffaye/ftp package.
    
+
    Paths are specified as remote:path. If the path does not begin with a / it is relative to the home directory of the user. An empty path remote: refers to the user's home directory.
    
+
    Here is an example of making an FTP configuration. First run
    
+
    rclone config
    
+
    This will guide you through an interactive setup process. An FTP remote only needs a host together with and a username and a password. With anonymous FTP server, you will need to use anonymous as username and your email address as the password.
    
+
    No remotes found - make a new one
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+XX / FTP Connection
+   \ "ftp"
+[snip]
+Storage> ftp
+** See help for ftp backend at: https://rclone.org/ftp/ **
+
+FTP host to connect to
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Connect to ftp.example.com
+   \ "ftp.example.com"
+host> ftp.example.com
+FTP username, leave blank for current username, ncw
+Enter a string value. Press Enter for the default ("").
+user> 
+FTP port, leave blank to use default (21)
+Enter a string value. Press Enter for the default ("").
+port> 
+FTP password
+y) Yes type in my own password
+g) Generate random password
+y/g> y
+Enter the password:
+password:
+Confirm the password:
+password:
+Use FTP over TLS (Implicit)
+Enter a boolean value (true or false). Press Enter for the default ("false").
+tls> 
+Use FTP over TLS (Explicit)
+Enter a boolean value (true or false). Press Enter for the default ("false").
+explicit_tls> 
+Remote config
+--------------------
+[remote]
+type = ftp
+host = ftp.example.com
+pass = *** ENCRYPTED ***
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    This remote is called remote and can now be used like this
    
+
    See all directories in the home directory
    
+
    rclone lsd remote:
    
+
    Make a new directory
    
+
    rclone mkdir remote:path/to/directory
    
+
    List the contents of a directory
    
+
    rclone ls remote:path/to/directory
    
+
    Sync /home/local/directory to the remote directory, deleting any excess files in the directory.
    
+
    rclone sync -i /home/local/directory remote:directory
    
+
    Modified time
    
+
    FTP does not support modified times. Any times you see on the server will be time of upload.
    
+
    Checksums
    
+
    FTP does not support any checksums.
    
+
    Usage without a config file
    
+
    An example how to use the ftp remote without a config file:
    
+
    rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy`
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
    File names can also not end with the following characters. These only get replaced if they are the last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    
+
    Note that not all FTP servers can have all characters in file names, for example:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    FTP ServerForbidden characters
    proftpd*
    pureftpd\ [ ]
    
+
    Implicit TLS
    
+
    FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled in the config for the remote. The default FTPS port is 990 so the port will likely have to be explicitly set in the config for the remote.
    
+
    Standard Options
    
+
    Here are the standard options specific to ftp (FTP Connection).
    
+
    --ftp-host
    
+
    FTP host to connect to
    
+
      
+
    • Config: host
      • 
+
    • Env Var: RCLONE_FTP_HOST
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "ftp.example.com"
+
          
+
        • Connect to ftp.example.com
          • 
+
        • 
+
      • 
+
    
+
    --ftp-user
    
+
    FTP username, leave blank for current username, $USER
    
+
      
+
    • Config: user
      • 
+
    • Env Var: RCLONE_FTP_USER
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --ftp-port
    
+
    FTP port, leave blank to use default (21)
    
+
      
+
    • Config: port
      • 
+
    • Env Var: RCLONE_FTP_PORT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --ftp-pass
    
+
    FTP password
    
+
    NB Input to this must be obscured - see rclone obscure.
    
+
      
+
    • Config: pass
      • 
+
    • Env Var: RCLONE_FTP_PASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --ftp-tls
    
+
    Use FTPS over TLS (Implicit) When using implicit FTP over TLS the client will connect using TLS right from the start, which in turn breaks the compatibility with non-TLS-aware servers. This is usually served over port 990 rather than port 21. Cannot be used in combination with explicit FTP.
    
+
      
+
    • Config: tls
      • 
+
    • Env Var: RCLONE_FTP_TLS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --ftp-explicit-tls
    
+
    Use FTP over TLS (Explicit) When using explicit FTP over TLS the client explicitly request security from the server in order to upgrade a plain text connection to an encrypted one. Cannot be used in combination with implicit FTP.
    
+
      
+
    • Config: explicit_tls
      • 
+
    • Env Var: RCLONE_FTP_EXPLICIT_TLS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to ftp (FTP Connection).
    
+
    --ftp-concurrency
    
+
    Maximum number of FTP simultaneous connections, 0 for unlimited
    
+
      
+
    • Config: concurrency
      • 
+
    • Env Var: RCLONE_FTP_CONCURRENCY
      • 
+
    • Type: int
      • 
+
    • Default: 0
      • 
+
    
+
    --ftp-no-check-certificate
    
+
    Do not verify the TLS certificate of the server
    
+
      
+
    • Config: no_check_certificate
      • 
+
    • Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --ftp-disable-epsv
    
+
    Disable using EPSV even if server advertises support
    
+
      
+
    • Config: disable_epsv
      • 
+
    • Env Var: RCLONE_FTP_DISABLE_EPSV
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --ftp-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_FTP_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,Del,Ctl,RightSpace,Dot
      • 
+
    
+
    Limitations
    
+
    Note that FTP does have its own implementation of : --dump headers, --dump bodies, --dump auth for debugging which isn't the same as the HTTP based backends - it has less fine grained control.
    
+
    Note that --timeout isn't supported (but --contimeout is).
    
+
    Note that --bind isn't supported.
    
+
    FTP could support server side move but doesn't yet.
    
+
    Note that the ftp backend does not support the ftp_proxy environment variable yet.
    
+
    Google Cloud Storage
    
+
    Paths are specified as remote:bucket (or remote: for the lsd command.) You may put subdirectories in too, eg remote:bucket/path/to/dir.
    
+
    The initial setup for google cloud storage involves getting a token from Google Cloud Storage which you need to do in your browser. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    n) New remote
+d) Delete remote
+q) Quit config
+e/n/d/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Google Cloud Storage (this is not Google Drive)
+   \ "google cloud storage"
+[snip]
+Storage> google cloud storage
+Google Application Client Id - leave blank normally.
+client_id>
+Google Application Client Secret - leave blank normally.
+client_secret>
+Project number optional - needed only for list/create/delete buckets - see your developer console.
+project_number> 12345678
+Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login.
+service_account_file>
+Access Control List for new objects.
+Choose a number from below, or type in your own value
+ 1 / Object owner gets OWNER access, and all Authenticated Users get READER access.
+   \ "authenticatedRead"
+ 2 / Object owner gets OWNER access, and project team owners get OWNER access.
+   \ "bucketOwnerFullControl"
+ 3 / Object owner gets OWNER access, and project team owners get READER access.
+   \ "bucketOwnerRead"
+ 4 / Object owner gets OWNER access [default if left blank].
+   \ "private"
+ 5 / Object owner gets OWNER access, and project team members get access according to their roles.
+   \ "projectPrivate"
+ 6 / Object owner gets OWNER access, and all Users get READER access.
+   \ "publicRead"
+object_acl> 4
+Access Control List for new buckets.
+Choose a number from below, or type in your own value
+ 1 / Project team owners get OWNER access, and all Authenticated Users get READER access.
+   \ "authenticatedRead"
+ 2 / Project team owners get OWNER access [default if left blank].
+   \ "private"
+ 3 / Project team members get access according to their roles.
+   \ "projectPrivate"
+ 4 / Project team owners get OWNER access, and all Users get READER access.
+   \ "publicRead"
+ 5 / Project team owners get OWNER access, and all Users get WRITER access.
+   \ "publicReadWrite"
+bucket_acl> 2
+Location for the newly created buckets.
+Choose a number from below, or type in your own value
+ 1 / Empty for default location (US).
+   \ ""
+ 2 / Multi-regional location for Asia.
+   \ "asia"
+ 3 / Multi-regional location for Europe.
+   \ "eu"
+ 4 / Multi-regional location for United States.
+   \ "us"
+ 5 / Taiwan.
+   \ "asia-east1"
+ 6 / Tokyo.
+   \ "asia-northeast1"
+ 7 / Singapore.
+   \ "asia-southeast1"
+ 8 / Sydney.
+   \ "australia-southeast1"
+ 9 / Belgium.
+   \ "europe-west1"
+10 / London.
+   \ "europe-west2"
+11 / Iowa.
+   \ "us-central1"
+12 / South Carolina.
+   \ "us-east1"
+13 / Northern Virginia.
+   \ "us-east4"
+14 / Oregon.
+   \ "us-west1"
+location> 12
+The storage class to use when storing objects in Google Cloud Storage.
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+ 2 / Multi-regional storage class
+   \ "MULTI_REGIONAL"
+ 3 / Regional storage class
+   \ "REGIONAL"
+ 4 / Nearline storage class
+   \ "NEARLINE"
+ 5 / Coldline storage class
+   \ "COLDLINE"
+ 6 / Durable reduced availability storage class
+   \ "DURABLE_REDUCED_AVAILABILITY"
+storage_class> 5
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine or Y didn't work
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+type = google cloud storage
+client_id =
+client_secret =
+token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null}
+project_number = 12345678
+object_acl = private
+bucket_acl = private
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.
    
+
    This remote is called remote and can now be used like this
    
+
    See all the buckets in your project
    
+
    rclone lsd remote:
    
+
    Make a new bucket
    
+
    rclone mkdir remote:bucket
    
+
    List the contents of a bucket
    
+
    rclone ls remote:bucket
    
+
    Sync /home/local/directory to the remote bucket, deleting any excess files in the bucket.
    
+
    rclone sync -i /home/local/directory remote:bucket
    
+
    Service Account support
    
+
    You can set up rclone with Google Cloud Storage in an unattended mode, i.e. not tied to a specific end-user Google account. This is useful when you want to synchronise files onto machines that don't have actively logged-in users, for example build machines.
    
+
    To get credentials for Google Cloud Platform IAM Service Accounts, please head to the Service Account section of the Google Developer Console. Service Accounts behave just like normal User permissions in Google Cloud Storage ACLs, so you can limit their access (e.g. make them read only). After creating an account, a JSON file containing the Service Account's credentials will be downloaded onto your machines. These credentials are what rclone will use for authentication.
    
+
    To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the service_account_file prompt and rclone won't use the browser based authentication flow. If you'd rather stuff the contents of the credentials file into the rclone config file, you can set service_account_credentials with the actual contents of the file instead, or set the equivalent environment variable.
    
+
    Anonymous Access
    
+
    For downloads of objects that permit public access you can configure rclone to use anonymous access by setting anonymous to true. With unauthorized access you can't write or create files but only read or list those buckets and objects that have public read access.
    
+
    Application Default Credentials
    
+
    If no other source of credentials is provided, rclone will fall back to Application Default Credentials this is useful both when you already have configured authentication for your developer account, or in production when running on a google compute host. Note that if running in docker, you may need to run additional commands on your google compute machine - see this page.
    
+
    Note that in the case application default credentials are used, there is no need to explicitly configure a project number.
    
+
    --fast-list
    
+
    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.
    
+
    Custom upload headers
    
+
    You can set custom upload headers with the --header-upload flag. Google Cloud Storage supports the headers as described in the working with metadata documentation
    
+
      
+
    • Cache-Control
      • 
+
    • Content-Disposition
      • 
+
    • Content-Encoding
      • 
+
    • Content-Language
      • 
+
    • Content-Type
      • 
+
    • X-Goog-Meta-
      • 
+
    
+
    Eg --header-upload "Content-Type text/potato"
    
+
    Note that the last of these is for setting custom metadata in the form --header-upload "x-goog-meta-key: value"
    
+
    Modified time
    
+
    Google google cloud storage stores md5sums natively and rclone stores modification times as metadata on the object, under the "mtime" key in RFC3339 format accurate to 1ns.
    
+
    Restricted filename characters
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    LF0x0A␊
    CR0x0D␍
    /0x2F／
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Standard Options
    
+
    Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
    
+
    --gcs-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_GCS_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_GCS_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-project-number
    
+
    Project number. Optional - needed only for list/create/delete buckets - see your developer console.
    
+
      
+
    • Config: project_number
      • 
+
    • Env Var: RCLONE_GCS_PROJECT_NUMBER
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-service-account-file
    
+
    Service Account Credentials JSON file path Leave blank normally. Needed only if you want use SA instead of interactive login.
    
+
    Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.
    
+
      
+
    • Config: service_account_file
      • 
+
    • Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-service-account-credentials
    
+
    Service Account Credentials JSON blob Leave blank normally. Needed only if you want use SA instead of interactive login.
    
+
      
+
    • Config: service_account_credentials
      • 
+
    • Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-anonymous
    
+
    Access public buckets and objects without credentials Set to 'true' if you just want to download files and don't configure credentials.
    
+
      
+
    • Config: anonymous
      • 
+
    • Env Var: RCLONE_GCS_ANONYMOUS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --gcs-object-acl
    
+
    Access Control List for new objects.
    
+
      
+
    • Config: object_acl
      • 
+
    • Env Var: RCLONE_GCS_OBJECT_ACL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "authenticatedRead"
+
          
+
        • Object owner gets OWNER access, and all Authenticated Users get READER access.
          • 
+
        • 
+
      • "bucketOwnerFullControl"
+
          
+
        • Object owner gets OWNER access, and project team owners get OWNER access.
          • 
+
        • 
+
      • "bucketOwnerRead"
+
          
+
        • Object owner gets OWNER access, and project team owners get READER access.
          • 
+
        • 
+
      • "private"
+
          
+
        • Object owner gets OWNER access [default if left blank].
          • 
+
        • 
+
      • "projectPrivate"
+
          
+
        • Object owner gets OWNER access, and project team members get access according to their roles.
          • 
+
        • 
+
      • "publicRead"
+
          
+
        • Object owner gets OWNER access, and all Users get READER access.
          • 
+
        • 
+
      • 
+
    
+
    --gcs-bucket-acl
    
+
    Access Control List for new buckets.
    
+
      
+
    • Config: bucket_acl
      • 
+
    • Env Var: RCLONE_GCS_BUCKET_ACL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "authenticatedRead"
+
          
+
        • Project team owners get OWNER access, and all Authenticated Users get READER access.
          • 
+
        • 
+
      • "private"
+
          
+
        • Project team owners get OWNER access [default if left blank].
          • 
+
        • 
+
      • "projectPrivate"
+
          
+
        • Project team members get access according to their roles.
          • 
+
        • 
+
      • "publicRead"
+
          
+
        • Project team owners get OWNER access, and all Users get READER access.
          • 
+
        • 
+
      • "publicReadWrite"
+
          
+
        • Project team owners get OWNER access, and all Users get WRITER access.
          • 
+
        • 
+
      • 
+
    
+
    --gcs-bucket-policy-only
    
+
    Access checks should use bucket-level IAM policies.
    
+
    If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this.
    
+
    When it is set, rclone:
    
+
      
+
    • ignores ACLs set on buckets
      • 
+
    • ignores ACLs set on objects
      • 
+
    • creates buckets with Bucket Policy Only set
      • 
+
    
+
    Docs: https://cloud.google.com/storage/docs/bucket-policy-only
    
+
      
+
    • Config: bucket_policy_only
      • 
+
    • Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --gcs-location
    
+
    Location for the newly created buckets.
    
+
      
+
    • Config: location
      • 
+
    • Env Var: RCLONE_GCS_LOCATION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Empty for default location (US).
          • 
+
        • 
+
      • "asia"
+
          
+
        • Multi-regional location for Asia.
          • 
+
        • 
+
      • "eu"
+
          
+
        • Multi-regional location for Europe.
          • 
+
        • 
+
      • "us"
+
          
+
        • Multi-regional location for United States.
          • 
+
        • 
+
      • "asia-east1"
+
          
+
        • Taiwan.
          • 
+
        • 
+
      • "asia-east2"
+
          
+
        • Hong Kong.
          • 
+
        • 
+
      • "asia-northeast1"
+
          
+
        • Tokyo.
          • 
+
        • 
+
      • "asia-south1"
+
          
+
        • Mumbai.
          • 
+
        • 
+
      • "asia-southeast1"
+
          
+
        • Singapore.
          • 
+
        • 
+
      • "australia-southeast1"
+
          
+
        • Sydney.
          • 
+
        • 
+
      • "europe-north1"
+
          
+
        • Finland.
          • 
+
        • 
+
      • "europe-west1"
+
          
+
        • Belgium.
          • 
+
        • 
+
      • "europe-west2"
+
          
+
        • London.
          • 
+
        • 
+
      • "europe-west3"
+
          
+
        • Frankfurt.
          • 
+
        • 
+
      • "europe-west4"
+
          
+
        • Netherlands.
          • 
+
        • 
+
      • "us-central1"
+
          
+
        • Iowa.
          • 
+
        • 
+
      • "us-east1"
+
          
+
        • South Carolina.
          • 
+
        • 
+
      • "us-east4"
+
          
+
        • Northern Virginia.
          • 
+
        • 
+
      • "us-west1"
+
          
+
        • Oregon.
          • 
+
        • 
+
      • "us-west2"
+
          
+
        • California.
          • 
+
        • 
+
      • 
+
    
+
    --gcs-storage-class
    
+
    The storage class to use when storing objects in Google Cloud Storage.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_GCS_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "MULTI_REGIONAL"
+
          
+
        • Multi-regional storage class
          • 
+
        • 
+
      • "REGIONAL"
+
          
+
        • Regional storage class
          • 
+
        • 
+
      • "NEARLINE"
+
          
+
        • Nearline storage class
          • 
+
        • 
+
      • "COLDLINE"
+
          
+
        • Coldline storage class
          • 
+
        • 
+
      • "ARCHIVE"
+
          
+
        • Archive storage class
          • 
+
        • 
+
      • "DURABLE_REDUCED_AVAILABILITY"
+
          
+
        • Durable reduced availability storage class
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
    
+
    --gcs-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_GCS_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_GCS_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_GCS_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gcs-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_GCS_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,CrLf,InvalidUtf8,Dot
      • 
+
    
+
    Google Drive
    
+
    Paths are specified as drive:path
    
+
    Drive paths may be as deep as required, eg drive:directory/subdirectory.
    
+
    The initial setup for drive involves getting a token from Google drive which you need to do in your browser. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Google Drive
+   \ "drive"
+[snip]
+Storage> drive
+Google Application Client Id - leave blank normally.
+client_id>
+Google Application Client Secret - leave blank normally.
+client_secret>
+Scope that rclone should use when requesting access from drive.
+Choose a number from below, or type in your own value
+ 1 / Full access all files, excluding Application Data Folder.
+   \ "drive"
+ 2 / Read-only access to file metadata and file contents.
+   \ "drive.readonly"
+   / Access to files created by rclone only.
+ 3 | These are visible in the drive website.
+   | File authorization is revoked when the user deauthorizes the app.
+   \ "drive.file"
+   / Allows read and write access to the Application Data folder.
+ 4 | This is not visible in the drive website.
+   \ "drive.appfolder"
+   / Allows read-only access to file metadata but
+ 5 | does not allow any access to read or download file content.
+   \ "drive.metadata.readonly"
+scope> 1
+ID of the root folder - leave blank normally.  Fill in to access "Computers" folders. (see docs).
+root_folder_id> 
+Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login.
+service_account_file>
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine or Y didn't work
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+Configure this as a team drive?
+y) Yes
+n) No
+y/n> n
+--------------------
+[remote]
+client_id = 
+client_secret = 
+scope = drive
+root_folder_id = 
+service_account_file =
+token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall, or use manual mode.
    
+
    You can then use it like this,
    
+
    List directories in top level of your drive
    
+
    rclone lsd remote:
    
+
    List all the files in your drive
    
+
    rclone ls remote:
    
+
    To copy a local directory to a drive directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Scopes
    
+
    Rclone allows you to select which scope you would like for rclone to use. This changes what type of token is granted to rclone. The scopes are defined here.
    
+
    The scope are
    
+
    drive
    
+
    This is the default scope and allows full access to all files, except for the Application Data Folder (see below).
    
+
    Choose this one if you aren't sure.
    
+
    drive.readonly
    
+
    This allows read only access to all files. Files may be listed and downloaded but not uploaded, renamed or deleted.
    
+
    drive.file
    
+
    With this scope rclone can read/view/modify only those files and folders it creates.
    
+
    So if you uploaded files to drive via the web interface (or any other means) they will not be visible to rclone.
    
+
    This can be useful if you are using rclone to backup data and you want to be sure confidential data on your drive is not visible to rclone.
    
+
    Files created with this scope are visible in the web interface.
    
+
    drive.appfolder
    
+
    This gives rclone its own private area to store files. Rclone will not be able to see any other files on your drive and you won't be able to see rclone's files from the web interface either.
    
+
    drive.metadata.readonly
    
+
    This allows read only access to file names only. It does not allow rclone to download or upload data, or rename or delete files or directories.
    
+
    Root folder ID
    
+
    You can set the root_folder_id for rclone. This is the directory (identified by its Folder ID) that rclone considers to be the root of your drive.
    
+
    Normally you will leave this blank and rclone will determine the correct root to use itself.
    
+
    However you can set this to restrict rclone to a specific folder hierarchy or to access data within the "Computers" tab on the drive web interface (where files from Google's Backup and Sync desktop program go).
    
+
    In order to do this you will have to find the Folder ID of the directory you wish rclone to display. This will be the last segment of the URL when you open the relevant folder in the drive web interface.
    
+
    So if the folder you want rclone to use has a URL which looks like https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh in the browser, then you use 1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh as the root_folder_id in the config.
    
+
    NB folders under the "Computers" tab seem to be read only (drive gives a 500 error) when using rclone.
    
+
    There doesn't appear to be an API to discover the folder IDs of the "Computers" tab - please contact us if you know otherwise!
    
+
    Note also that rclone can't access any data under the "Backups" tab on the google drive web interface yet.
    
+
    Service Account support
    
+
    You can set up rclone with Google Drive in an unattended mode, i.e. not tied to a specific end-user Google account. This is useful when you want to synchronise files onto machines that don't have actively logged-in users, for example build machines.
    
+
    To use a Service Account instead of OAuth2 token flow, enter the path to your Service Account credentials at the service_account_file prompt during rclone config and rclone won't use the browser based authentication flow. If you'd rather stuff the contents of the credentials file into the rclone config file, you can set service_account_credentials with the actual contents of the file instead, or set the equivalent environment variable.
    
+
    Use case - Google Apps/G-suite account and individual Drive
    
+
    Let's say that you are the administrator of a Google Apps (old) or G-suite account. The goal is to store data on an individual's Drive account, who IS a member of the domain. We'll call the domain example.com, and the user foo@example.com.
    
+
    There's a few steps we need to go through to accomplish this:
    
+
    1. Create a service account for example.com
    
+
      
+
    • To create a service account and obtain its credentials, go to the Google Developer Console.
      • 
+
    • You must have a project - create one if you don't.
      • 
+
    • Then go to "IAM & admin" -> "Service Accounts".
      • 
+
    • Use the "Create Credentials" button. Fill in "Service account name" with something that identifies your client. "Role" can be empty.
      • 
+
    • Tick "Furnish a new private key" - select "Key type JSON".
      • 
+
    • Tick "Enable G Suite Domain-wide Delegation". This option makes "impersonation" possible, as documented here: Delegating domain-wide authority to the service account
      • 
+
    • These credentials are what rclone will use for authentication. If you ever need to remove access, press the "Delete service account key" button.
      • 
+
    
+
    2. Allowing API access to example.com Google Drive
    
+
      
+
    • Go to example.com's admin console
      • 
+
    • Go into "Security" (or use the search bar)
      • 
+
    • Select "Show more" and then "Advanced settings"
      • 
+
    • Select "Manage API client access" in the "Authentication" section
      • 
+
    • In the "Client Name" field enter the service account's "Client ID" - this can be found in the Developer Console under "IAM & Admin" -> "Service Accounts", then "View Client ID" for the newly created service account. It is a ~21 character numerical string.
      • 
+
    • In the next field, "One or More API Scopes", enter https://www.googleapis.com/auth/drive to grant access to Google Drive specifically.
      • 
+
    
+
    3. Configure rclone, assuming a new install
    
+
    rclone config
+
+n/s/q> n         # New
+name>gdrive      # Gdrive is an example name
+Storage>         # Select the number shown for Google Drive
+client_id>       # Can be left blank
+client_secret>   # Can be left blank
+scope>           # Select your scope, 1 for example
+root_folder_id>  # Can be left blank
+service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes!
+y/n>             # Auto config, y
+
    
+
    4. Verify that it's working
    
+
      
+
    • rclone -v --drive-impersonate foo@example.com lsf gdrive:backup
      • 
+
    • The arguments do:
+
        
+
      • -v - verbose logging
        • 
+
      • --drive-impersonate foo@example.com - this is what does the magic, pretending to be user foo.
        • 
+
      • lsf - list files in a parsing friendly way
        • 
+
      • gdrive:backup - use the remote called gdrive, work in the folder named backup.
        • 
+
      • 
+
    
+
    Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using --drive-impersonate, do this instead: - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 - use rclone without specifying the --drive-impersonate option, like this: rclone -v foo@example.com lsf gdrive:backup
    
+
    Team drives
    
+
    If you want to configure the remote to point to a Google Team Drive then answer y to the question Configure this as a team drive?.
    
+
    This will fetch the list of Team Drives from google and allow you to configure which one you want to use. You can also type in a team drive ID if you prefer.
    
+
    For example:
    
+
    Configure this as a team drive?
+y) Yes
+n) No
+y/n> y
+Fetching team drive list...
+Choose a number from below, or type in your own value
+ 1 / Rclone Test
+   \ "xxxxxxxxxxxxxxxxxxxx"
+ 2 / Rclone Test 2
+   \ "yyyyyyyyyyyyyyyyyyyy"
+ 3 / Rclone Test 3
+   \ "zzzzzzzzzzzzzzzzzzzz"
+Enter a Team Drive ID> 1
+--------------------
+[remote]
+client_id =
+client_secret =
+token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null}
+team_drive = xxxxxxxxxxxxxxxxxxxx
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    --fast-list
    
+
    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.
    
+
    It does this by combining multiple list calls into a single API request.
    
+
    This works by combining many '%s' in parents filters into one expression. To list the contents of directories a, b and c, the following requests will be send by the regular List function:
    
+
    trashed=false and 'a' in parents
+trashed=false and 'b' in parents
+trashed=false and 'c' in parents
    
+
    These can now be combined into a single request:
    
+
    trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)
    
+
    The implementation of ListR will put up to 50 parents filters into one request. It will use the --checkers value to specify the number of requests to run in parallel.
    
+
    In tests, these batch requests were up to 20x faster than the regular method. Running the following command against different sized folders gives:
    
+
    rclone lsjson -vv -R --checkers=6 gdrive:folder
    
+
    small folder (220 directories, 700 files):
    
+
      
+
    • without --fast-list: 38s
      • 
+
    • with --fast-list: 10s
      • 
+
    
+
    large folder (10600 directories, 39000 files):
    
+
      
+
    • without --fast-list: 22:05 min
      • 
+
    • with --fast-list: 58s
      • 
+
    
+
    Modified time
    
+
    Google drive stores modification times accurate to 1 ms.
    
+
    Restricted filename characters
    
+
    Only Invalid UTF-8 bytes will be replaced, as they can't be used in JSON strings.
    
+
    In contrast to other backends, / can also be used in names and . or .. are valid names.
    
+
    Revisions
    
+
    Google drive stores revisions of files. When you upload a change to an existing file to google drive using rclone it will create a new revision of that file.
    
+
    Revisions follow the standard google policy which at time of writing was
    
+
      
+
    • They are deleted after 30 days or 100 revisions (whatever comes first).
      • 
+
    • They do not count towards a user storage quota.
      • 
+
    
+
    Deleting files
    
+
    By default rclone will send all files to the trash when deleting files. If deleting them permanently is required then use the --drive-use-trash=false flag, or set the equivalent environment variable.
    
+
    Shortcuts
    
+
    In March 2020 Google introduced a new feature in Google Drive called drive shortcuts (API). These will (by September 2020) replace the ability for files or folders to be in multiple folders at once.
    
+
    Shortcuts are files that link to other files on Google Drive somewhat like a symlink in unix, except they point to the underlying file data (eg the inode in unix terms) so they don't break if the source is renamed or moved about.
    
+
    Be default rclone treats these as follows.
    
+
    For shortcuts pointing to files:
    
+
      
+
    • When listing a file shortcut appears as the destination file.
      • 
+
    • When downloading the contents of the destination file is downloaded.
      • 
+
    • When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut.
      • 
+
    • When server side moving (renaming) the shortcut is renamed, not the destination file.
      • 
+
    • When server side copying the shortcut is copied, not the contents of the shortcut.
      • 
+
    • When deleting the shortcut is deleted not the linked file.
      • 
+
    • When setting the modification time, the modification time of the linked file will be set.
      • 
+
    
+
    For shortcuts pointing to folders:
    
+
      
+
    • When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders)
      • 
+
    • When downloading the contents of the linked folder and sub contents are downloaded
      • 
+
    • When uploading to a shortcut folder the file will be placed in the linked folder
      • 
+
    • When server side moving (renaming) the shortcut is renamed, not the destination folder
      • 
+
    • When server side copying the contents of the linked folder is copied, not the shortcut.
      • 
+
    • When deleting with rclone rmdir or rclone purge the shortcut is deleted not the linked folder.
      • 
+
    • NB When deleting with rclone remove or rclone mount the contents of the linked folder will be deleted.
      • 
+
    
+
    The rclone backend command can be used to create shortcuts.
    
+
    Shortcuts can be completely ignored with the --drive-skip-shortcuts flag or the corresponding skip_shortcuts configuration setting.
    
+
    Emptying trash
    
+
    If you wish to empty your trash you can use the rclone cleanup remote: command which will permanently delete all your trashed files. This command does not take any path arguments.
    
+
    Note that Google Drive takes some time (minutes to days) to empty the trash even though the command returns within a few seconds. No output is echoed, so there will be no confirmation even using -v or -vv.
    
+
    Quota information
    
+
    To view your current quota you can use the rclone about remote: command which will display your usage limit (quota), the usage in Google Drive, the size of all files in the Trash and the space used by other Google services such as Gmail. This command does not take any path arguments.
    
+
    Import/Export of google documents
    
+
    Google documents can be exported from and uploaded to Google Drive.
    
+
    When rclone downloads a Google doc it chooses a format to download depending upon the --drive-export-formats setting. By default the export formats are docx,xlsx,pptx,svg which are a sensible default for an editable document.
    
+
    When choosing a format, rclone runs down the list provided in order and chooses the first file format the doc can be exported as from the list. If the file can't be exported to a format on the formats list, then rclone will choose a format from the default list.
    
+
    If you prefer an archive copy then you might use --drive-export-formats pdf, or if you prefer openoffice/libreoffice formats you might use --drive-export-formats ods,odt,odp.
    
+
    Note that rclone adds the extension to the google doc, so if it is called My Spreadsheet on google docs, it will be exported as My Spreadsheet.xlsx or My Spreadsheet.pdf etc.
    
+
    When importing files into Google Drive, rclone will convert all files with an extension in --drive-import-formats to their associated document type. rclone will not convert any files by default, since the conversion is lossy process.
    
+
    The conversion must result in a file with the same extension when the --drive-export-formats rules are applied to the uploaded document.
    
+
    Here are some examples for allowed and prohibited conversions.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    export-formatsimport-formatsUpload ExtDocument ExtAllowed
    odtodtodtodtYes
    odtdocx,odtodtodtYes
    docxdocxdocxYes
    odtodtdocxNo
    odt,docxdocx,odtdocxodtNo
    docx,odtdocx,odtdocxdocxYes
    docx,odtdocx,odtodtdocxNo
    
+
    This limitation can be disabled by specifying --drive-allow-import-name-change. When using this flag, rclone can convert multiple files types resulting in the same document type at once, eg with --drive-import-formats docx,odt,txt, all files having these extension would result in a document represented as a docx file. This brings the additional risk of overwriting a document, if multiple files have the same stem. Many rclone operations will not handle this name change in any way. They assume an equal name when copying files and might copy the file again or delete them when the name changes.
    
+
    Here are the possible export extensions with their corresponding mime types. Most of these can also be used for importing, but there more that are not listed here. Some of these additional ones might only be available when the operating system provides the correct MIME type entries.
    
+
    This list can be changed by Google Drive at any time and might not represent the currently available conversions.
    
+
+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    




    ExtensionMime TypeDescription
    csvtext/csvStandard CSV format for Spreadsheets
    docxapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentMicrosoft Office Document
    epubapplication/epub+zipE-book format
    htmltext/htmlAn HTML Document
    jpgimage/jpegA JPEG Image File
    jsonapplication/vnd.google-apps.script+jsonJSON Text Format
    odpapplication/vnd.oasis.opendocument.presentationOpenoffice Presentation
    odsapplication/vnd.oasis.opendocument.spreadsheetOpenoffice Spreadsheet
    odsapplication/x-vnd.oasis.opendocument.spreadsheetOpenoffice Spreadsheet
    odtapplication/vnd.oasis.opendocument.textOpenoffice Document
    pdfapplication/pdfAdobe PDF Format
    pngimage/pngPNG Image Format
    pptxapplication/vnd.openxmlformats-officedocument.presentationml.presentationMicrosoft Office Powerpoint
    rtfapplication/rtfRich Text Format
    svgimage/svg+xmlScalable Vector Graphics Format
    tsvtext/tab-separated-valuesStandard TSV format for spreadsheets
    txttext/plainPlain Text
    xlsxapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetMicrosoft Office Spreadsheet
    zipapplication/zipA ZIP file of HTML, Images CSS
    
+
    Google documents can also be exported as link files. These files will open a browser window for the Google Docs website of that document when opened. The link file extension has to be specified as a --drive-export-formats parameter. They will match all available Google Documents.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    ExtensionDescriptionOS Support
    desktopfreedesktop.org specified desktop entryLinux
    link.htmlAn HTML Document with a redirectAll
    urlINI style link filemacOS, Windows
    weblocmacOS specific XML formatmacOS
    
+
    Standard Options
    
+
    Here are the standard options specific to drive (Google Drive).
    
+
    --drive-client-id
    
+
    Google Application Client Id Setting your own is recommended. See https://rclone.org/drive/#making-your-own-client-id for how to create your own. If you leave this blank, it will use an internal key which is low performance.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_DRIVE_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_DRIVE_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-scope
    
+
    Scope that rclone should use when requesting access from drive.
    
+
      
+
    • Config: scope
      • 
+
    • Env Var: RCLONE_DRIVE_SCOPE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "drive"
+
          
+
        • Full access all files, excluding Application Data Folder.
          • 
+
        • 
+
      • "drive.readonly"
+
          
+
        • Read-only access to file metadata and file contents.
          • 
+
        • 
+
      • "drive.file"
+
          
+
        • Access to files created by rclone only.
          • 
+
        • These are visible in the drive website.
          • 
+
        • File authorization is revoked when the user deauthorizes the app.
          • 
+
        • 
+
      • "drive.appfolder"
+
          
+
        • Allows read and write access to the Application Data folder.
          • 
+
        • This is not visible in the drive website.
          • 
+
        • 
+
      • "drive.metadata.readonly"
+
          
+
        • Allows read-only access to file metadata but
          • 
+
        • does not allow any access to read or download file content.
          • 
+
        • 
+
      • 
+
    
+
    --drive-root-folder-id
    
+
    ID of the root folder Leave blank normally.
    
+
    Fill in to access "Computers" folders (see docs), or for rclone to use a non root folder as its starting point.
    
+
      
+
    • Config: root_folder_id
      • 
+
    • Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-service-account-file
    
+
    Service Account Credentials JSON file path Leave blank normally. Needed only if you want use SA instead of interactive login.
    
+
    Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.
    
+
      
+
    • Config: service_account_file
      • 
+
    • Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-alternate-export
    
+
    Deprecated: no longer needed
    
+
      
+
    • Config: alternate_export
      • 
+
    • Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to drive (Google Drive).
    
+
    --drive-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_DRIVE_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_DRIVE_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_DRIVE_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-service-account-credentials
    
+
    Service Account Credentials JSON blob Leave blank normally. Needed only if you want use SA instead of interactive login.
    
+
      
+
    • Config: service_account_credentials
      • 
+
    • Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-team-drive
    
+
    ID of the Team Drive
    
+
      
+
    • Config: team_drive
      • 
+
    • Env Var: RCLONE_DRIVE_TEAM_DRIVE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-auth-owner-only
    
+
    Only consider files owned by the authenticated user.
    
+
      
+
    • Config: auth_owner_only
      • 
+
    • Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-use-trash
    
+
    Send files to the trash instead of deleting permanently. Defaults to true, namely sending files to the trash. Use --drive-use-trash=false to delete files permanently instead.
    
+
      
+
    • Config: use_trash
      • 
+
    • Env Var: RCLONE_DRIVE_USE_TRASH
      • 
+
    • Type: bool
      • 
+
    • Default: true
      • 
+
    
+
    --drive-skip-gdocs
    
+
    Skip google documents in all listings. If given, gdocs practically become invisible to rclone.
    
+
      
+
    • Config: skip_gdocs
      • 
+
    • Env Var: RCLONE_DRIVE_SKIP_GDOCS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-skip-checksum-gphotos
    
+
    Skip MD5 checksum on Google photos and videos only.
    
+
    Use this if you get checksum errors when transferring Google photos or videos.
    
+
    Setting this flag will cause Google photos and videos to return a blank MD5 checksum.
    
+
    Google photos are identified by being in the "photos" space.
    
+
    Corrupted checksums are caused by Google modifying the image/video but not updating the checksum.
    
+
      
+
    • Config: skip_checksum_gphotos
      • 
+
    • Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-shared-with-me
    
+
    Only show files that are shared with me.
    
+
    Instructs rclone to operate on your "Shared with me" folder (where Google Drive lets you access the files and folders others have shared with you).
    
+
    This works both with the "list" (lsd, lsl, etc) and the "copy" commands (copy, sync, etc), and with all other commands too.
    
+
      
+
    • Config: shared_with_me
      • 
+
    • Env Var: RCLONE_DRIVE_SHARED_WITH_ME
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-trashed-only
    
+
    Only show files that are in the trash. This will show trashed files in their original directory structure.
    
+
      
+
    • Config: trashed_only
      • 
+
    • Env Var: RCLONE_DRIVE_TRASHED_ONLY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-starred-only
    
+
    Only show files that are starred.
    
+
      
+
    • Config: starred_only
      • 
+
    • Env Var: RCLONE_DRIVE_STARRED_ONLY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-formats
    
+
    Deprecated: see export_formats
    
+
      
+
    • Config: formats
      • 
+
    • Env Var: RCLONE_DRIVE_FORMATS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-export-formats
    
+
    Comma separated list of preferred formats for downloading Google docs.
    
+
      
+
    • Config: export_formats
      • 
+
    • Env Var: RCLONE_DRIVE_EXPORT_FORMATS
      • 
+
    • Type: string
      • 
+
    • Default: "docx,xlsx,pptx,svg"
      • 
+
    
+
    --drive-import-formats
    
+
    Comma separated list of preferred formats for uploading Google docs.
    
+
      
+
    • Config: import_formats
      • 
+
    • Env Var: RCLONE_DRIVE_IMPORT_FORMATS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-allow-import-name-change
    
+
    Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.
    
+
      
+
    • Config: allow_import_name_change
      • 
+
    • Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-use-created-date
    
+
    Use file created date instead of modified date.,
    
+
    Useful when downloading data and you want the creation date used in place of the last modified date.
    
+
    WARNING: This flag may have some unexpected consequences.
    
+
    When uploading to your drive all files will be overwritten unless they haven't been modified since their creation. And the inverse will occur while downloading. This side effect can be avoided by using the "--checksum" flag.
    
+
    This feature was implemented to retain photos capture date as recorded by google photos. You will first need to check the "Create a Google Photos folder" option in your google drive settings. You can then copy or move the photos locally and use the date the image was taken (created) set as the modification date.
    
+
      
+
    • Config: use_created_date
      • 
+
    • Env Var: RCLONE_DRIVE_USE_CREATED_DATE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-use-shared-date
    
+
    Use date file was shared instead of modified date.
    
+
    Note that, as with "--drive-use-created-date", this flag may have unexpected consequences when uploading/downloading files.
    
+
    If both this flag and "--drive-use-created-date" are set, the created date is used.
    
+
      
+
    • Config: use_shared_date
      • 
+
    • Env Var: RCLONE_DRIVE_USE_SHARED_DATE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-list-chunk
    
+
    Size of listing chunk 100-1000. 0 to disable.
    
+
      
+
    • Config: list_chunk
      • 
+
    • Env Var: RCLONE_DRIVE_LIST_CHUNK
      • 
+
    • Type: int
      • 
+
    • Default: 1000
      • 
+
    
+
    --drive-impersonate
    
+
    Impersonate this user when using a service account.
    
+
      
+
    • Config: impersonate
      • 
+
    • Env Var: RCLONE_DRIVE_IMPERSONATE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --drive-upload-cutoff
    
+
    Cutoff for switching to chunked upload
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 8M
      • 
+
    
+
    --drive-chunk-size
    
+
    Upload chunk size. Must a power of 2 >= 256k.
    
+
    Making this larger will improve performance, but note that each chunk is buffered in memory one per transfer.
    
+
    Reducing this will reduce memory usage but decrease performance.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_DRIVE_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 8M
      • 
+
    
+
    --drive-acknowledge-abuse
    
+
    Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
    
+
    If downloading a file returns the error "This file has been identified as malware or spam and cannot be downloaded" with the error code "cannotDownloadAbusiveFile" then supply this flag to rclone to indicate you acknowledge the risks of downloading the file and rclone will download it anyway.
    
+
      
+
    • Config: acknowledge_abuse
      • 
+
    • Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-keep-revision-forever
    
+
    Keep new head revision of each file forever.
    
+
      
+
    • Config: keep_revision_forever
      • 
+
    • Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-size-as-quota
    
+
    Show sizes as storage quota usage, not actual size.
    
+
    Show the size of a file as the storage quota used. This is the current version plus any older versions that have been set to keep forever.
    
+
    WARNING: This flag may have some unexpected consequences.
    
+
    It is not recommended to set this flag in your config - the recommended usage is using the flag form --drive-size-as-quota when doing rclone ls/lsl/lsf/lsjson/etc only.
    
+
    If you do use this flag for syncing (not recommended) then you will need to use --ignore size also.
    
+
      
+
    • Config: size_as_quota
      • 
+
    • Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-v2-download-min-size
    
+
    If Object's are greater, use drive v2 API to download.
    
+
      
+
    • Config: v2_download_min_size
      • 
+
    • Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: off
      • 
+
    
+
    --drive-pacer-min-sleep
    
+
    Minimum time to sleep between API calls.
    
+
      
+
    • Config: pacer_min_sleep
      • 
+
    • Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP
      • 
+
    • Type: Duration
      • 
+
    • Default: 100ms
      • 
+
    
+
    --drive-pacer-burst
    
+
    Number of API calls to allow without sleeping.
    
+
      
+
    • Config: pacer_burst
      • 
+
    • Env Var: RCLONE_DRIVE_PACER_BURST
      • 
+
    • Type: int
      • 
+
    • Default: 100
      • 
+
    
+
    --drive-server-side-across-configs
    
+
    Allow server side operations (eg copy) to work across different drive configs.
    
+
    This can be useful if you wish to do a server side copy between two different Google drives. Note that this isn't enabled by default because it isn't easy to tell if it will work between any two configurations.
    
+
      
+
    • Config: server_side_across_configs
      • 
+
    • Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-disable-http2
    
+
    Disable drive using http2
    
+
    There is currently an unsolved issue with the google drive backend and HTTP/2. HTTP/2 is therefore disabled by default for the drive backend but can be re-enabled here. When the issue is solved this flag will be removed.
    
+
    See: https://github.com/rclone/rclone/issues/3631
    
+
      
+
    • Config: disable_http2
      • 
+
    • Env Var: RCLONE_DRIVE_DISABLE_HTTP2
      • 
+
    • Type: bool
      • 
+
    • Default: true
      • 
+
    
+
    --drive-stop-on-upload-limit
    
+
    Make upload limit errors be fatal
    
+
    At the time of writing it is only possible to upload 750GB of data to Google Drive a day (this is an undocumented limit). When this limit is reached Google Drive produces a slightly different error message. When this flag is set it causes these errors to be fatal. These will stop the in-progress sync.
    
+
    Note that this detection is relying on error message strings which Google don't document so it may break in the future.
    
+
    See: https://github.com/rclone/rclone/issues/3857
    
+
      
+
    • Config: stop_on_upload_limit
      • 
+
    • Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-skip-shortcuts
    
+
    If set skip shortcut files
    
+
    Normally rclone dereferences shortcut files making them appear as if they are the original file (see the shortcuts section). If this flag is set then rclone will ignore shortcut files completely.
    
+
      
+
    • Config: skip_shortcuts
      • 
+
    • Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --drive-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_DRIVE_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: InvalidUtf8
      • 
+
    
+
    Backend commands
    
+
    Here are the commands specific to the drive backend.
    
+
    Run them with
    
+
    rclone backend COMMAND remote:
    
+
    The help below will explain what arguments each command takes.
    
+
    See the "rclone backend" command for more info on how to pass options and arguments.
    
+
    These can be run on a running backend using the rc command backend/command.
    
+
    get
    
+
    Get command for fetching the drive config parameters
    
+
    rclone backend get remote: [options] [<arguments>+]
    
+
    This is a get command which will be used to fetch the various drive config parameters
    
+
    Usage Examples:
    
+
    rclone backend get drive: [-o service_account_file] [-o chunk_size]
+rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]
    
+
    Options:
    
+
      
+
    • "chunk_size": show the current upload chunk size
      • 
+
    • "service_account_file": show the current service account file
      • 
+
    
+
    set
    
+
    Set command for updating the drive config parameters
    
+
    rclone backend set remote: [options] [<arguments>+]
    
+
    This is a set command which will be used to update the various drive config parameters
    
+
    Usage Examples:
    
+
    rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
+rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
    
+
    Options:
    
+
      
+
    • "chunk_size": update the current upload chunk size
      • 
+
    • "service_account_file": update the current service account file
      • 
+
    
+
    shortcut
    
+
    Create shortcuts from files or directories
    
+
    rclone backend shortcut remote: [options] [<arguments>+]
    
+
    This command creates shortcuts from files or directories.
    
+
    Usage:
    
+
    rclone backend shortcut drive: source_item destination_shortcut
+rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut
    
+
    In the first example this creates a shortcut from the "source_item" which can be a file or a directory to the "destination_shortcut". The "source_item" and the "destination_shortcut" should be relative paths from "drive:"
    
+
    In the second example this creates a shortcut from the "source_item" relative to "drive:" to the "destination_shortcut" relative to "drive2:". This may fail with a permission error if the user authenticated with "drive2:" can't read files from "drive:".
    
+
    Options:
    
+
      
+
    • "target": optional target remote for the shortcut destination
      • 
+
    
+
    drives
    
+
    List the shared drives available to this account
    
+
    rclone backend drives remote: [options] [<arguments>+]
    
+
    This command lists the shared drives (teamdrives) available to this account.
    
+
    Usage:
    
+
    rclone backend drives drive:
    
+
    This will return a JSON list of objects like this
    
+
    [
+    {
+        "id": "0ABCDEF-01234567890",
+        "kind": "drive#teamDrive",
+        "name": "My Drive"
+    },
+    {
+        "id": "0ABCDEFabcdefghijkl",
+        "kind": "drive#teamDrive",
+        "name": "Test Drive"
+    }
+]
    
+
    untrash
    
+
    Untrash files and directories
    
+
    rclone backend untrash remote: [options] [<arguments>+]
    
+
    This command untrashes all the files and directories in the directory passed in recursively.
    
+
    Usage:
    
+
    This takes an optional directory to trash which make this easier to use via the API.
    
+
    rclone backend untrash drive:directory
+rclone backend -i untrash drive:directory subdir
    
+
    Use the -i flag to see what would be restored before restoring it.
    
+
    Result:
    
+
    {
+    "Untrashed": 17,
+    "Errors": 0
+}
    
+
    Limitations
    
+
    Drive has quite a lot of rate limiting. This causes rclone to be limited to transferring about 2 files per second only. Individual files may be transferred much faster at 100s of MBytes/s but lots of small files can take a long time.
    
+
    Server side copies are also subject to a separate rate limit. If you see User rate limit exceeded errors, wait at least 24 hours and retry. You can disable server side copies with --disable copy to download and upload the files if you prefer.
    
+
    Limitations of Google Docs
    
+
    Google docs will appear as size -1 in rclone ls and as size 0 in anything which uses the VFS layer, eg rclone mount, rclone serve.
    
+
    This is because rclone can't find out the size of the Google docs without downloading them.
    
+
    Google docs will transfer correctly with rclone sync, rclone copy etc as rclone knows to ignore the size when doing the transfer.
    
+
    However an unfortunate consequence of this is that you may not be able to download Google docs using rclone mount. If it doesn't work you will get a 0 sized file. If you try again the doc may gain its correct size and be downloadable. Whether it will work on not depends on the application accessing the mount and the OS you are running - experiment to find out if it does work for you!
    
+
    Duplicated files
    
+
    Sometimes, for no reason I've been able to track down, drive will duplicate a file that rclone uploads. Drive unlike all the other remotes can have duplicated files.
    
+
    Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.
    
+
    Use rclone dedupe to fix duplicated files.
    
+
    Note that this isn't just a problem with rclone, even Google Photos on Android duplicates files on drive sometimes.
    
+
    Rclone appears to be re-copying files it shouldn't
    
+
    The most likely cause of this is the duplicated file issue above - run rclone dedupe and check your logs for duplicate object or directory messages.
    
+
    This can also be caused by a delay/caching on google drive's end when comparing directory listings. Specifically with team drives used in combination with --fast-list. Files that were uploaded recently may not appear on the directory list sent to rclone when using --fast-list.
    
+
    Waiting a moderate period of time between attempts (estimated to be approximately 1 hour) and/or not using --fast-list both seem to be effective in preventing the problem.
    
+
    Making your own client_id
    
+
    When you use rclone with Google drive in its default configuration you are using rclone's client_id. This is shared between all the rclone users. There is a global rate limit on the number of queries per second that each client_id can do set by Google. rclone already has a high quota and I will continue to make sure it is high enough by contacting Google.
    
+
    It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower.
    
+
    Here is how to create your own Google Drive client ID for rclone:
    
+
      
+
    1. Log into the Google API Console with your Google account. It doesn't matter what Google account you use. (It need not be the same account as the Google Drive you want to access)
      2. 
+
    2. Select a project or create a new project.
      3. 
+
    3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API".
      4. 
+
    4. Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials"
      5. 
+
    5. If you already configured an "Oauth Consent Screen", then skip to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button (near the top right corner of the right panel), then select "External" and click on "CREATE"; on the next screen, enter an "Application name" ("rclone" is OK) then click on "Save" (all other data is optional). Click again on "Credentials" on the left panel to go back to the "Credentials" screen.
      6. 
+
    
+
    (PS: if you are a GSuite user, you could also select "Internal" instead of "External" above, but this has not been tested/documented so far).
    
+
      
+
    1. Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID".
      2. 
+
    2. Choose an application type of "Desktop app" if you using a Google account or "Other" if you using a GSuite account and click "Create". (the default name is fine)
      3. 
+
    3. It will show you a client ID and client secret. Use these values in rclone config to add a new remote or edit an existing remote.
      4. 
+
    
+
    Be aware that, due to the "enhanced security" recently introduced by Google, you are theoretically expected to "submit your app for verification" and then wait a few weeks(!) for their response; in practice, you can go right ahead and use the client ID and client secret with rclone, the only issue will be a very scary confirmation screen shown when you connect via your browser for rclone to be able to get its token-id (but as this only happens during the remote configuration, it's not such a big deal).
    
+
    (Thanks to @balazer on github for these instructions.)
    
+
    Sometimes, creation of an OAuth consent in Google API Console fails due to an error message “The request failed because changes to one of the field of the resource is not supported”. As a convenient workaround, the necessary Google Drive API key can be created on the Python Quickstart page. Just push the Enable the Drive API button to receive the Client ID and Secret. Note that it will automatically create a new project in the API Console.
    
+
    Google Photos
    
+
    The rclone backend for Google Photos is a specialized backend for transferring photos and videos to and from Google Photos.
    
+
    NB The Google Photos API which rclone uses has quite a few limitations, so please read the limitations section carefully to make sure it is suitable for your use.
    
+
    Configuring Google Photos
    
+
    The initial setup for google cloud storage involves getting a token from Google Photos which you need to do in your browser. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+XX / Google Photos
+   \ "google photos"
+[snip]
+Storage> google photos
+** See help for google photos backend at: https://rclone.org/googlephotos/ **
+
+Google Application Client Id
+Leave blank normally.
+Enter a string value. Press Enter for the default ("").
+client_id> 
+Google Application Client Secret
+Leave blank normally.
+Enter a string value. Press Enter for the default ("").
+client_secret> 
+Set to make the Google Photos backend read only.
+
+If you choose read only then rclone will only request read only access
+to your photos, otherwise rclone will request full access.
+Enter a boolean value (true or false). Press Enter for the default ("false").
+read_only> 
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+
+*** IMPORTANT: All media items uploaded to Google Photos with rclone
+*** are stored in full resolution at original quality.  These uploads
+*** will count towards storage in your Google Account.
+
+--------------------
+[remote]
+type = google photos
+token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode.
    
+
    This remote is called remote and can now be used like this
    
+
    See all the albums in your photos
    
+
    rclone lsd remote:album
    
+
    Make a new album
    
+
    rclone mkdir remote:album/newAlbum
    
+
    List the contents of an album
    
+
    rclone ls remote:album/newAlbum
    
+
    Sync /home/local/images to the Google Photos, removing any excess files in the album.
    
+
    rclone sync -i /home/local/image remote:album/newAlbum
    
+
    Layout
    
+
    As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it.
    
+
    The directories under media show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup remote:media/by-month. (NB remote:media/by-day is rather slow at the moment so avoid for syncing.)
    
+
    Note that all your photos and videos will appear somewhere under media, but they may not appear under album unless you've put them into albums.
    
+
    /
+- upload
+    - file1.jpg
+    - file2.jpg
+    - ...
+- media
+    - all
+        - file1.jpg
+        - file2.jpg
+        - ...
+    - by-year
+        - 2000
+            - file1.jpg
+            - ...
+        - 2001
+            - file2.jpg
+            - ...
+        - ...
+    - by-month
+        - 2000
+            - 2000-01
+                - file1.jpg
+                - ...
+            - 2000-02
+                - file2.jpg
+                - ...
+        - ...
+    - by-day
+        - 2000
+            - 2000-01-01
+                - file1.jpg
+                - ...
+            - 2000-01-02
+                - file2.jpg
+                - ...
+        - ...
+- album
+    - album name
+    - album name/sub
+- shared-album
+    - album name
+    - album name/sub
+- feature
+    - favorites
+        - file1.jpg
+        - file2.jpg
    
+
    There are two writable parts of the tree, the upload directory and sub directories of the album directory.
    
+
    The upload directory is for uploading files you don't want to put into albums. This will be empty to start with and will contain the files you've uploaded for one rclone session only, becoming empty again when you restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to album will work better.
    
+
    Directories within the album directory are also writeable and you may create new directories (albums) under album. If you copy files with a directory hierarchy in there then rclone will create albums with the / character in them. For example if you do
    
+
    rclone copy /path/to/images remote:album/images
    
+
    and the images directory contains
    
+
    images
+    - file1.jpg
+    dir
+        file2.jpg
+    dir2
+        dir3
+            file3.jpg
    
+
    Then rclone will create the following albums with the following files in
    
+
      
+
    • images
+
        
+
      • file1.jpg
        • 
+
      • 
+
    • images/dir
+
        
+
      • file2.jpg
        • 
+
      • 
+
    • images/dir2/dir3
+
        
+
      • file3.jpg
        • 
+
      • 
+
    
+
    This means that you can use the album path pretty much like a normal filesystem and it is a good target for repeated syncing.
    
+
    The shared-album directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface.
    
+
    Limitations
    
+
    Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn't understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item.
    
+
    Note that all media items uploaded to Google Photos through the API are stored in full resolution at "original quality" and will count towards your storage quota in your Google Account. The API does not offer a way to upload in "high quality" mode..
    
+
    Downloading Images
    
+
    When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115.
    
+
    The current google API does not allow photos to be downloaded at original resolution. This is very important if you are, for example, relying on "Google Photos" as a backup of your photos. You will not be able to use rclone to redownload original images. You could use 'google takeout' to recover the original photos as a last resort
    
+
    Downloading Videos
    
+
    When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044.
    
+
    Duplicates
    
+
    If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called file.jpg would then appear as file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer alas!).
    
+
    If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may confuse rclone. For example if you uploaded an image to upload then uploaded the same image to album/my_album the filename of the image in album/my_album will be what it was uploaded with initially, not what you uploaded it with to album. In practise this shouldn't cause too many problems.
    
+
    Modified time
    
+
    The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known.
    
+
    This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes.
    
+
    Size
    
+
    The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check.
    
+
    It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is very slow and uses up a lot of transactions. This can be enabled with the --gphotos-read-size option or the read_size = true config parameter.
    
+
    If you want to use the backend with rclone mount you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You'll need to experiment to see if it works for you without the flag.
    
+
    Albums
    
+
    Rclone can only upload files to albums it created. This is a limitation of the Google Photos API.
    
+
    Rclone can remove files it uploaded from albums it created only.
    
+
    Deleting files
    
+
    Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781.
    
+
    Rclone cannot delete files anywhere except under album.
    
+
    Deleting albums
    
+
    The Google Photos API does not support deleting albums - see bug #135714733.
    
+
    Standard Options
    
+
    Here are the standard options specific to google photos (Google Photos).
    
+
    --gphotos-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_GPHOTOS_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gphotos-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_GPHOTOS_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gphotos-read-only
    
+
    Set to make the Google Photos backend read only.
    
+
    If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access.
    
+
      
+
    • Config: read_only
      • 
+
    • Env Var: RCLONE_GPHOTOS_READ_ONLY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to google photos (Google Photos).
    
+
    --gphotos-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_GPHOTOS_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gphotos-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_GPHOTOS_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gphotos-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_GPHOTOS_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --gphotos-read-size
    
+
    Set to read the size of media items.
    
+
    Normally rclone does not read the size of media items since this takes another transaction. This isn't necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media.
    
+
      
+
    • Config: read_size
      • 
+
    • Env Var: RCLONE_GPHOTOS_READ_SIZE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --gphotos-start-year
    
+
    Year limits the photos to be downloaded to those which are uploaded after the given year
    
+
      
+
    • Config: start_year
      • 
+
    • Env Var: RCLONE_GPHOTOS_START_YEAR
      • 
+
    • Type: int
      • 
+
    • Default: 2000
      • 
+
    
+
    HTTP
    
 
    The HTTP remote is a read only remote for reading files of a webserver. The webserver should provide file listings which rclone will read and turn into a remote. This has been tested with common webservers such as Apache/Nginx/Caddy and will likely work with file listings from most web servers. (If it doesn't then please file an issue, or send a pull request!)
    
 
    Paths are specified as remote: or remote:path/to/dir.
    
 
    Here is an example of how to make a remote called remote. First run:
    
@@ -12477,14 +13563,14 @@ e/n/d/r/c/s/q> q
    
 
    rclone sync -i remote:directory /home/local/directory
    
 
    Read only
    
 
    This remote is read only - you can't upload files to an HTTP server.
    
-
    Modified time
    
+
    Modified time
    
 
    Most HTTP servers store time accurate to 1 second.
    
 
    Checksum
    
 
    No checksums are stored.
    
-
    Usage without a config file
    
+
    Usage without a config file
    
 
    Since the http remote only has one config parameter it is easy to use without a config file:
    
 
    rclone lsd --http-url https://beta.rclone.org :http:
    
-
    Standard Options
    
+
    Standard Options
    
 
    Here are the standard options specific to http (http Connection).
    
 
    --http-url
    
 
    URL of http host to connect to
    
@@ -12505,7 +13591,7 @@ e/n/d/r/c/s/q> q
    
 
 
 
-
    Advanced Options
    
+
    Advanced Options
    
 
    Here are the advanced options specific to http (http Connection).
    
 
    --http-headers
    
 
    Set HTTP headers for all transactions
    
@@ -12602,13 +13688,13 @@ y/e/d> y
    
 
    rclone copy /home/source remote:backup
    
 
    If you want the directory to be visible in the official Hubic browser, you need to copy your files to the default directory
    
 
    rclone copy /home/source remote:default/backup
    
-
    --fast-list
    
+
    --fast-list
    
 
    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.
    
-
    Modified time
    
+
    Modified time
    
 
    The modified time is stored as metadata on the object as X-Object-Meta-Mtime as floating point since the epoch accurate to 1 ns.
    
 
    This is a de facto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.
    
 
    Note that Hubic wraps the Swift backend, so most of the properties of are the same.
    
-
    Standard Options
    
+
    Standard Options
    
 
    Here are the standard options specific to hubic (Hubic).
    
 
    --hubic-client-id
    
 
    OAuth Client Id Leave blank normally.
    
@@ -12626,7 +13712,7 @@ y/e/d> y
    
 
  • Type: string
    • 
 
  • Default: ""
    • 
 
-
    Advanced Options
    
+
    Advanced Options
    
 
    Here are the advanced options specific to hubic (Hubic).
    
 
    --hubic-token
    
 
    OAuth Access Token as a JSON blob.
    
@@ -12681,7 +13767,7 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,InvalidUtf8
    • -

    Limitations

    +

    Limitations

    This uses the normal OpenStack Swift mechanism to refresh the Swift API credentials and ignores the expires field returned by the Hubic API.

    The Swift API doesn't return a correct MD5SUM for segmented files (Dynamic or Static Large Objects) so rclone won't check or use the MD5SUM for these.

    Jottacloud

    @@ -12689,7 +13775,7 @@ y/e/d> y

    In addition to the official service at jottacloud.com, there are also several whitelabel versions which should work with this backend.

    Paths are specified as remote:path

    Paths may be as deep as required, eg remote:directory/subdirectory.

    -

    Setup

    +

    Setup

    Default Setup

    To configure Jottacloud you will need to generate a personal security token in the Jottacloud web interface. You will the option to do in your account security settings (for whitelabel version you need to find this page in its web interface). Note that the web interface may refer to this token as a JottaCli token.

    Legacy Setup

    @@ -12766,14 +13852,14 @@ y/e/d> y

    Devices and Mountpoints

    The official Jottacloud client registers a device for each computer you install it on, and then creates a mountpoint for each folder you select for Backup. The web interface uses a special device called Jotta for the Archive and Sync mountpoints. In most cases you'll want to use the Jotta/Archive device/mountpoint, however if you want to access files uploaded by any of the official clients rclone provides the option to select other devices and mountpoints during config.

    The built-in Jotta device may also contain several other mountpoints, such as: Latest, Links, Shared and Trash. These are special mountpoints with a different internal representation than the "regular" mountpoints. Rclone will only to a very limited degree support them. Generally you should avoid these, unless you know what you are doing.

    -

    --fast-list

    +

    --fast-list

    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.

    Note that the implementation in Jottacloud always uses only a single API request to get the entire list, so for large folders this could lead to long wait time before the first results are shown.

    -

    Modified time and hashes

    +

    Modified time and hashes

    Jottacloud allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.

    Jottacloud supports MD5 type hashes, so you can use the --checksum flag.

    -

    Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (wherever the TMPDIR environment variable points to) before it is uploaded. Small files will be cached in memory - see the --jottacloud-md5-memory-limit flag.

    -

    Restricted filename characters

    +

    Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (wherever the TMPDIR environment variable points to) before it is uploaded. Small files will be cached in memory - see the --jottacloud-md5-memory-limit flag. When uploading from local disk the source checksum is always available, so this does not apply. Starting with rclone version 1.52 the same is true for crypted remotes (in older versions the crypt backend would not calculate hashes for uploads from local disk, so the Jottacloud backend had to do it as described above).

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -12822,13 +13908,13 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in XML strings.

    -

    Deleting files

    +

    Deleting files

    By default rclone will send all files to the trash when deleting files. They will be permanently deleted automatically after 30 days. You may bypass the trash and permanently delete files immediately by using the --jottacloud-hard-delete flag, or set the equivalent environment variable. Emptying the trash is supported by the cleanup command.

    -

    Versions

    +

    Versions

    Jottacloud supports file versioning. When rclone uploads a new version of a file it creates a new version of it. Currently rclone only supports retrieving the current version but older versions can be accessed via the Jottacloud Website.

    -

    Quota information

    +

    Quota information

    To view your current quota you can use the rclone about remote: command which will display your usage limit (unless it is unlimited) and the current usage.

    -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to jottacloud (Jottacloud).

    --jottacloud-md5-memory-limit

    Files bigger than this will be cached on disk to calculate the MD5 if required.

    @@ -12871,7 +13957,7 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    Note that Jottacloud is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".

    There are quite a few characters that can't be in Jottacloud file names. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a ? in it will be mapped to ？ instead.

    Jottacloud only supports filenames up to 255 characters in length.

    @@ -12935,7 +14021,7 @@ y/e/d> y 
    rclone ls koofr:

    To copy a local directory to an Koofr directory called backup

    rclone copy /home/source remote:backup
    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -12954,7 +14040,7 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in XML strings.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to koofr (Koofr).

    --koofr-user

    Your Koofr user name

    @@ -12973,7 +14059,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to koofr (Koofr).

    --koofr-endpoint

    The Koofr API endpoint to use

    @@ -13008,7 +14094,7 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    Note that Koofr is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".

    Mail.ru Cloud

    Mail.ru Cloud is a cloud storage provided by a Russian internet company Mail.Ru Group. The official desktop client is Disk-O:, available only on Windows. (Please note that official sites are in Russian)

    @@ -13090,15 +14176,15 @@ y/e/d> y 
    rclone ls remote:directory

    Sync /home/local/directory to the remote path, deleting any excess files in the path.

    rclone sync -i /home/local/directory remote:directory
    -

    Modified time

    +

    Modified time

    Files support a modification time attribute with up to 1 second precision. Directories do not have a modification time, which is shown as "Jan 1 1970".

    Hash checksums

    Hash sums use a custom Mail.ru algorithm based on SHA1. If file size is less than or equal to the SHA1 block size (20 bytes), its hash is simply its data right-padded with zero bytes. Hash sum of a larger file is computed as a SHA1 sum of the file data bytes concatenated with a decimal representation of the data length.

    -

    Emptying Trash

    +

    Emptying Trash

    Removing a file or directory actually moves it to the trash, which is not visible to rclone but can be seen in a web browser. The trashed file still occupies part of total quota. If you wish to empty your trash and free some quota, you can use the rclone cleanup remote: command, which will permanently delete all your trashed files. This command does not take any path arguments.

    -

    Quota information

    +

    Quota information

    To view your current quota you can use the rclone about remote: command which will display your usage limit (quota) and the current usage.

    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -13152,10 +14238,10 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Limitations

    +

    Limitations

    File size limits depend on your account. A single file size is limited by 2G for a free account and unlimited for paid tariffs. Please refer to the Mail.ru site for the total uploaded size limits.

    Note that Mailru is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to mailru (Mail.ru Cloud).

    --mailru-user

    User name (usually email)

    @@ -13193,7 +14279,7 @@ y/e/d> y -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to mailru (Mail.ru Cloud).

    --mailru-speedup-file-patterns

    Comma separated list of file name patterns eligible for speedup (put by hash). Patterns are case insensitive and can contain '*' or '?' meta characters.

    @@ -13363,9 +14449,9 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an Mega directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

    Mega does not support modification times or hashes yet.

    -

    Restricted filename characters

    +

    Restricted filename characters

    @@ -13388,7 +14474,7 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Duplicated files

    +

    Duplicated files

    Mega can have two files with exactly the same name and path (unlike a normal file system).

    Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.

    Use rclone dedupe to fix duplicated files.

    @@ -13403,7 +14489,7 @@ y/e/d> y

    Note that once blocked, the use of other tools (such as megacmd) is not a sure workaround: following megacmd login times have been observed in succession for blocked remote: 7 minutes, 20 min, 30min, 30 min, 30min. Web access looks unaffected though.

    Investigation is continuing in relation to workarounds based on timeouts, pacers, retrials and tpslimits - if you discover something relevant, please post on the forum.

    So, if rclone was working nicely and suddenly you are unable to log-in and you are sure the user and the password are correct, likely you have got the remote blocked for a while.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to mega (Mega).

    --mega-user

    User name

    @@ -13422,7 +14508,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to mega (Mega).

    --mega-debug

    Output more debug from Mega.

    @@ -13451,7 +14537,7 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    This backend uses the go-mega go library which is an opensource go library implementing the Mega API. There doesn't appear to be any documentation for the mega protocol beyond the mega C++ SDK source code so there are likely quite a few errors still remaining in this library.

    Mega allows duplicate files which may confuse rclone.

    Memory

    @@ -13488,9 +14574,9 @@ y/e/d> y 
    rclone mount :memory: /mnt/tmp
 rclone serve webdav :memory:
 rclone serve sftp :memory:
    -

    Modified time and hashes

    +

    Modified time and hashes

    The memory backend supports MD5 hashes and modification times accurate to 1 nS.

    -

    Restricted filename characters

    +

    Restricted filename characters

    The memory backend replaces the default restricted characters set.

    Microsoft Azure Blob Storage

    Paths are specified as remote:container (or remote: for the lsd command.) You may put subdirectories in too, eg remote:container/path/to/dir.

    @@ -13535,11 +14621,11 @@ y/e/d> y 
    rclone ls remote:container

    Sync /home/local/directory to the remote container, deleting any excess files in the container.

    rclone sync -i /home/local/directory remote:container
    -

    --fast-list

    +

    --fast-list

    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.

    -

    Modified time

    +

    Modified time

    The modified time is stored as metadata on the object with the mtime key. It is stored using RFC3339 Format time with nanosecond precision. The metadata is supplied during directory listings so there is no overhead to using it.

    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -13598,12 +14684,12 @@ container/

    Note that you can't see or access any other containers - this will fail

    rclone ls azureblob:othercontainer

    Container level SAS URLs are useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment such as a CI build server.

    -

    Multipart uploads

    +

    Multipart uploads

    Rclone supports multipart uploads with Azure Blob storage. Files bigger than 256MB will be uploaded using chunked upload by default.

    The files will be uploaded in parallel in 4MB chunks (by default). Note that these chunks are buffered in memory and there may be up to --transfers of them being uploaded at once.

    Files can't be split into more than 50,000 chunks so by default, so the largest file that can be uploaded with 4MB chunk size is 195GB. Above this rclone will double the chunk size until it creates less than 50,000 chunks. By default this will mean a maximum file size of 3.2TB can be uploaded. This can be raised to 5TB using --azureblob-chunk-size 100M.

    Note that rclone doesn't commit the block list until the end of the upload which means that there is a limit of 9.5TB of multipart uploads in progress as Azure won't allow more than that amount of uncommitted blocks.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to azureblob (Microsoft Azure Blob Storage).

    --azureblob-account

    Storage Account Name (leave blank to use SAS URL or Emulator)

    @@ -13637,7 +14723,7 @@ container/
  • Type: bool
  • Default: false
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage).

    --azureblob-endpoint

    Endpoint for the service Leave blank normally.

    @@ -13717,7 +14803,7 @@ container/
  • Type: MultiEncoder
  • Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8
    • -

    Limitations

    +

    Limitations

    MD5 sums are only uploaded with chunked files if the source has an MD5 sum. This will always be the case for a local to azure copy.

    Azure Storage Emulator Support

    You can test rclone with storage emulator locally, to do this make sure azure storage emulator installed locally and set up a new remote with rclone config follow instructions described in introduction, set use_emulator config as true, you do not need to provide default account name or key if using emulator.

    @@ -13823,7 +14909,7 @@ y/e/d> y

    OneDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.

    OneDrive personal supports SHA1 type hashes. OneDrive for business and Sharepoint Server support QuickXorHash.

    For all types of OneDrive you can use the --checksum flag.

    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -13931,9 +15017,9 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Deleting files

    +

    Deleting files

    Any files you delete with rclone will end up in the trash. Microsoft doesn't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Microsoft's apps or via the OneDrive website.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to onedrive (Microsoft OneDrive).

    --onedrive-client-id

    OAuth Client Id Leave blank normally.

    @@ -13951,7 +15037,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to onedrive (Microsoft OneDrive).

    --onedrive-token

    OAuth Access Token as a JSON blob.

    @@ -14041,7 +15127,7 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    If you don't use rclone for 90 days the refresh token will expire. This will result in authorization problems. This is easy to fix by running the rclone config reconnect remote: command to get a new token and refresh token.

    Naming

    Note that OneDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".

    @@ -14053,7 +15139,7 @@ y/e/d> y

    Number of files

    OneDrive seems to be OK with at least 50,000 files in a folder, but at 100,000 rclone will get errors listing the directory like couldn’t list files: UnknownError:. See #2707 for more info.

    An official document about the limitations for different types of OneDrive can be found here.

    -

    Versions

    +

    Versions

    Every change in a file OneDrive causes the service to create a new version of the the file. This counts against a users quota. For example changing the modification time of a file creates a second version, so the file apparently uses twice the space.

    For example the copy command is affected by this as rclone copies the file and then afterwards sets the modification time to match the source file which uses another version.

    You can use the rclone cleanup command (see below) to remove all old versions.

    @@ -14081,7 +15167,7 @@ y/e/d> y
  • Use rclone to upload or modify files. (I also use the --no-update-modtime flag)
  • Restore the versioning settings after using rclone. (Optional)
    • -

    Cleanup

    +

    Cleanup

    OneDrive supports rclone cleanup which causes rclone to look through every file under the path supplied and delete all version but the current version. Because this involves traversing all the files, then querying each file for versions it can be quite slow. Rclone does --checkers tests in parallel. The command also supports -i which is a great way to see what it would do.

    rclone cleanup -i remote:path/subdir # interactively remove all old version for path/subdir
 rclone cleanup remote:path/subdir    # unconditionally remove all old version for path/subdir
    @@ -14148,9 +15234,9 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an OpenDrive directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and MD5SUMs

    +

    Modified time and MD5SUMs

    OpenDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.

    -

    Restricted filename characters

    +

    Restricted filename characters

    @@ -14250,7 +15336,7 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to opendrive (OpenDrive).

    --opendrive-username

    Username

    @@ -14269,7 +15355,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to opendrive (OpenDrive).

    --opendrive-encoding

    This sets the encoding for the backend.

    @@ -14289,7 +15375,7 @@ y/e/d> y
  • Type: SizeSuffix
  • Default: 10M
    • -

    Limitations

    +

    Limitations

    Note that OpenDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".

    There are quite a few characters that can't be in OpenDrive file names. These can't occur on Windows platforms, but on non-Windows platforms they are common. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a ? in it will be mapped to ？ instead.

    QingStor

    @@ -14361,14 +15447,14 @@ y/e/d> y 
    rclone ls remote:bucket

    Sync /home/local/directory to the remote bucket, deleting any excess files in the bucket.

    rclone sync -i /home/local/directory remote:bucket
    -

    --fast-list

    +

    --fast-list

    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.

    -

    Multipart uploads

    +

    Multipart uploads

    rclone supports multipart uploads with QingStor which means that it can upload files bigger than 5GB. Note that files uploaded with multipart upload don't have an MD5SUM.

    Note that incomplete multipart uploads older than 24 hours can be removed with rclone cleanup remote:bucket just for one bucket rclone cleanup remote: for all buckets. QingStor does not ever remove incomplete multipart uploads so it may be necessary to run this from time to time.

    Buckets and Zone

    With QingStor you can list buckets (rclone lsd) using any zone, but you can only access the content of a bucket from the zone it was created in. If you attempt to access a bucket from the wrong zone, you will get an error, incorrect zone, the bucket is not in 'XXX' zone.

    -

    Authentication

    +

    Authentication

    There are two ways to supply rclone with a set of QingStor credentials. In order of precedence:

    -

    Restricted filename characters

    +

    Restricted filename characters

    The control characters 0x00-0x1F and / are replaced as in the default restricted characters set. Note that 0x7F is not replaced.

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to qingstor (QingCloud Object Storage).

    --qingstor-env-auth

    Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.

    @@ -14459,7 +15545,7 @@ y/e/d> y -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to qingstor (QingCloud Object Storage).

    --qingstor-connection-retries

    Number of connection retries.

    @@ -14650,12 +15736,12 @@ tenant = $OS_TENANT_NAME export RCLONE_CONFIG_MYREMOTE_TYPE=swift export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true rclone lsd myremote: -

    --fast-list

    +

    --fast-list

    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.

    -

    --update and --use-server-modtime

    +

    --update and --use-server-modtime

    As noted below, the modified time is stored on metadata on the object. It is used by default for all operations that require checking the time a file was last updated. It allows rclone to treat the remote more like a true filesystem, but it is inefficient because it requires an extra API call to retrieve the metadata.

    For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is "dirty". By using --update along with --use-server-modtime, you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).

    --swift-env-auth

    Get swift credentials from environment variables in standard OpenStack form.

    @@ -14870,7 +15956,7 @@ rclone lsd myremote: -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)).

    --swift-chunk-size

    Above this size files will be chunked into a _segments container.

    @@ -14901,10 +15987,10 @@ rclone lsd myremote:
  • Type: MultiEncoder
  • Default: Slash,InvalidUtf8
    • -

    Modified time

    +

    Modified time

    The modified time is stored as metadata on the object as X-Object-Meta-Mtime as floating point since the epoch accurate to 1 ns.

    This is a de facto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.

    -

    Restricted filename characters

    +

    Restricted filename characters

    @@ -14927,7 +16013,7 @@ rclone lsd myremote:

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Limitations

    +

    Limitations

    The Swift API doesn't return a correct MD5SUM for segmented files (Dynamic or Static Large Objects) so rclone won't check or use the MD5SUM for these.

    Troubleshooting

    Rclone gives Failed to create file system for "remote:": Bad Request

    @@ -14990,10 +16076,10 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an pCloud directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

    pCloud allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not. In order to set a Modification time pCloud requires the object be re-uploaded.

    pCloud supports MD5 and SHA1 type hashes, so you can use the --checksum flag.

    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -15012,15 +16098,15 @@ y/e/d> y

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Deleting files

    +

    Deleting files

    Deleted files will be moved to the trash. Your subscription level will determine how long items stay in the trash. rclone cleanup can be used to empty the trash.

    -

    Root folder ID

    +

    Root folder ID

    You can set the root_folder_id for rclone. This is the directory (identified by its Folder ID) that rclone considers to be the root of your pCloud drive.

    Normally you will leave this blank and rclone will determine the correct root to use itself.

    However you can set this to restrict rclone to a specific folder hierarchy.

    In order to do this you will have to find the Folder ID of the directory you wish rclone to display. This will be the folder field of the URL when you open the relevant folder in the pCloud web interface.

    So if the folder you want rclone to use has a URL which looks like https://my.pcloud.com/#page=filemanager&folder=5xxxxxxxx8&tpl=foldergrid in the browser, then you use 5xxxxxxxx8 as the root_folder_id in the config.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to pcloud (Pcloud).

    --pcloud-client-id

    OAuth Client Id Leave blank normally.

    @@ -15038,7 +16124,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to pcloud (Pcloud).

    --pcloud-token

    OAuth Access Token as a JSON blob.

    @@ -15153,9 +16239,9 @@ y/e/d> 
    rclone ls remote:

    To copy a local directory to an premiumize.me directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

    premiumize.me does not support modification times or hashes, therefore syncing will default to --size-only checking. Note that using --update will work.

    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -15179,7 +16265,7 @@ y/e/d>

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to premiumizeme (premiumize.me).

    --premiumizeme-api-key

    API Key.

    @@ -15190,7 +16276,7 @@ y/e/d>
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to premiumizeme (premiumize.me).

    --premiumizeme-encoding

    This sets the encoding for the backend.

    @@ -15201,7 +16287,7 @@ y/e/d>
  • Type: MultiEncoder
  • Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot
    • -

    Limitations

    +

    Limitations

    Note that premiumize.me is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".

    premiumize.me file names can't have the \ or " characters in. rclone maps these to and from an identical looking unicode equivalents ＼ and ＂

    premiumize.me only supports filenames up to 255 characters in length.

    @@ -15270,7 +16356,7 @@ e/n/d/r/c/s/q> q 
    rclone ls remote:

    To copy a local directory to a put.io directory called backup

    rclone copy /home/source remote:backup
    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -15289,7 +16375,7 @@ e/n/d/r/c/s/q> q

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to putio (Put.io).

    --putio-encoding

    This sets the encoding for the backend.

    @@ -15459,9 +16545,9 @@ y/e/d> y 
    rclone ls seafile:directory

    Sync /home/local/directory to the remote library, deleting any excess files in the library.

    rclone sync -i /home/local/directory seafile:
    -

    --fast-list

    +

    --fast-list

    Seafile version 7+ supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details. Please note this is not supported on seafile server version 6.x

    -

    Restricted filename characters

    +

    Restricted filename characters

    In addition to the default restricted characters set the following characters are also replaced:

    @@ -15502,7 +16588,7 @@ http://my.seafile.server/d/9ea2455f6f55478bbb0d/

    Compatibility

    It has been actively tested using the seafile docker image of these versions: - 6.3.4 community edition - 7.0.5 community edition - 7.1.3 community edition

    Versions below 6.0 are not supported. Versions between 6.0 and 6.3 haven't been tested and might not work properly.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to seafile (seafile).

    --seafile-url

    URL of seafile host to connect to

    @@ -15569,7 +16655,7 @@ http://my.seafile.server/d/9ea2455f6f55478bbb0d/
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to seafile (seafile).

    --seafile-create-library

    Should rclone create a library if it doesn't exist

    @@ -15674,11 +16760,11 @@ y/e/d> y

    And then at the end of the session

    eval `ssh-agent -k`

    These commands can be used in scripts of course.

    -

    Modified time

    +

    Modified time

    Modified times are stored on the server to 1 second precision.

    Modified times are used in syncing and are fully supported.

    Some SFTP servers disable setting/modifying the file modification time after upload (for example, certain configurations of ProFTPd with mod_sftp). If you are using one of these servers, you can set the option set_modtime = false in your RClone backend configuration to disable this behaviour.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to sftp (SSH/SFTP Connection).

    --sftp-host

    SSH host to connect to

    @@ -15793,7 +16879,7 @@ y/e/d> y
  • Type: bool
  • Default: false
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to sftp (SSH/SFTP Connection).

    --sftp-ask-password

    Allow asking for SFTP password when needed.

    @@ -15866,7 +16952,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Limitations

    +

    Limitations

    SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote's PATH. This remote checksumming (file hashing) is recommended and enabled by default. Disabling the checksumming may be required if you are connecting to SFTP servers which are not under your control, and to which the execution of remote commands is prohibited. Set the configuration option disable_hashcheck to true to disable checksumming.

    SFTP also supports about if the same login has shell access and df are in the remote's PATH. about will return the total space, free space, and used space on the remote for the disk of the specified path on the remote or, if not set, the disk of the root on the remote. about will fail if it does not have shell access or if df is not in the remote's PATH.

    Note that some SFTP servers (eg Synology) the paths are different for SSH and SFTP so the hashes can't be calculated properly. For them using disable_hashcheck is a good idea.

    @@ -15947,15 +17033,15 @@ y/e/d> y

    Paths are specified as remote:path

    Paths may be as deep as required, eg remote:directory/subdirectory.

    NB you can't create files in the top level folder you have to create a folder, which rclone will create as a "Sync Folder" with SugarSync.

    -

    Modified time and hashes

    +

    Modified time and hashes

    SugarSync does not support modification times or hashes, therefore syncing will default to --size-only checking. Note that using --update will work as rclone can read the time files were uploaded.

    -

    Restricted filename characters

    +

    Restricted filename characters

    SugarSync replaces the default restricted characters set except for DEL.

    Invalid UTF-8 bytes will also be replaced, as they can't be used in XML strings.

    -

    Deleting files

    +

    Deleting files

    Deleted files will be moved to the "Deleted items" folder by default.

    However you can supply the flag --sugarsync-hard-delete or set the config parameter hard_delete = true if you would like files to be deleted straight away.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to sugarsync (Sugarsync).

    --sugarsync-app-id

    Sugarsync App ID.

    @@ -15992,7 +17078,7 @@ y/e/d> y
  • Type: bool
  • Default: false
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to sugarsync (Sugarsync).

    --sugarsync-refresh-token

    Sugarsync refresh token

    @@ -16059,7 +17145,7 @@ y/e/d> y

    Tardigrade

    Tardigrade is an encrypted, secure, and cost-effective object storage service that enables you to store, back up, and archive large amounts of data in a decentralized manner.

    -

    Setup

    +

    Setup

    To make a new Tardigrade configuration you need one of the following: * Access Grant that someone else shared with you. * API Key of a Tardigrade project you are a member of.

    Here is an example of how to make a remote called remote. First run:

     rclone config
    @@ -16210,7 +17296,7 @@ y/e/d> y
    rclone sync -i --progress remote-us:bucket/path/to/dir/ remote-europe:bucket/path/to/dir/

    Or even between another cloud storage and Tardigrade.

    rclone sync -i --progress s3:bucket/path/to/dir/ tardigrade:bucket/path/to/dir/
    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to tardigrade (Tardigrade Decentralized Cloud Storage).

    --tardigrade-provider

    Choose an authentication method.

    @@ -16442,7 +17528,7 @@ y/e/d> y
    -

    Setup

    +

    Setup

    Here is an example of how to make a union called remote for local folders. First run:

     rclone config

    This will guide you through an interactive setup process:

    @@ -16506,7 +17592,7 @@ e/n/d/r/c/s/q> q 
    rclone ls remote:

    Copy another local directory to the union directory called source, which will be placed into C:\dir3

    rclone copy C:\source remote:source
    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to union (Union merges the contents of several upstream fs).

    --union-upstreams

    List of space separated upstreams. Can be 'upstreama:test/dir upstreamb:', '"upstreama:test/space:ro dir" upstreamb:', etc.

    @@ -16618,10 +17704,10 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an WebDAV directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

    Plain WebDAV does not support modified times. However when used with Owncloud or Nextcloud rclone will support modified times.

    Likewise plain WebDAV does not support hashes, however when used with Owncloud or Nextcloud rclone will support SHA1 and MD5 hashes. Depending on the exact version of Owncloud or Nextcloud hashes may appear on all objects, or only on objects which had a hash uploaded with them.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to webdav (Webdav).

    --webdav-url

    URL of http host to connect to

    @@ -16690,7 +17776,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to webdav (Webdav).

    --webdav-bearer-token-command

    Command to run to get a bearer token

    @@ -16810,20 +17896,20 @@ y/e/d> y

    Sync /home/local/directory to the remote path, deleting any excess files in the path.

    rclone sync -i /home/local/directory remote:directory

    Yandex paths may be as deep as required, eg remote:directory/subdirectory.

    -

    Modified time

    +

    Modified time

    Modified times are supported and are stored accurate to 1 ns in custom metadata called rclone_modified in RFC3339 with nanoseconds format.

    MD5 checksums

    MD5 checksums are natively supported by Yandex Disk.

    -

    Emptying Trash

    +

    Emptying Trash

    If you wish to empty your trash you can use the rclone cleanup remote: command which will permanently delete all your trashed files. This command does not take any path arguments.

    -

    Quota information

    +

    Quota information

    To view your current quota you can use the rclone about remote: command which will display your usage limit (quota) and the current usage.

    -

    Restricted filename characters

    +

    Restricted filename characters

    The default restricted characters set are replaced.

    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.

    -

    Limitations

    +

    Limitations

    When uploading very large files (bigger than about 5GB) you will need to increase the --timeout parameter. This is because Yandex pauses (perhaps to calculate the MD5SUM for the entire file) before returning confirmation that the file has been uploaded. The default handling of timeouts in rclone is to assume a 5 minute pause is an error and close the connection - you'll see net/http: timeout awaiting response headers errors in the logs if this is happening. Setting the timeout to twice the max size of file in GB should be enough, so if you want to upload a 30GB file set a timeout of 2 * 30 = 60m, that is --timeout 60m.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to yandex (Yandex Disk).

    --yandex-client-id

    OAuth Client Id Leave blank normally.

    @@ -16841,7 +17927,7 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to yandex (Yandex Disk).

    --yandex-token

    OAuth Access Token as a JSON blob.

    @@ -16881,14 +17967,14 @@ y/e/d> y 
    rclone sync -i /home/source /tmp/destination

    Will sync /home/source to /tmp/destination

    These can be configured into the config file for consistencies sake, but it is probably easier not to.

    -

    Modified time

    +

    Modified time

    Rclone reads and writes the modified time using an accuracy determined by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X.

    Filenames

    Filenames should be encoded in UTF-8 on disk. This is the normal case for Windows and OS X.

    There is a bit more uncertainty in the Linux world, but new distributions will have UTF-8 encoded files names. If you are using an old Linux filesystem with non UTF-8 file names (eg latin1) then you can use the convmv tool to convert the filesystem to UTF-8. This tool is available in most distributions' package managers.

    If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes. The name gro\xdf will be transferred as gro‛DF. rclone will emit a debug message in this case (use -v to see), eg

    Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf"
    -

    Restricted characters

    +

    Restricted characters

    On non Windows platforms the following characters are replaced when handling file names.

    @@ -17246,7 +18332,7 @@ $ tree /tmp/b 0 file2

    NB Rclone (like most unix tools such as du, rsync and tar) treats a bind mount to the same device as being on the same filesystem.

    NB This flag is only available on Unix based systems. On systems where it isn't supported (eg Windows) it will be ignored.

    -

    Standard Options

    +

    Standard Options

    Here are the standard options specific to local (Local Disk).

    --local-nounc

    Disable UNC (long path names) conversion on Windows

    @@ -17263,7 +18349,7 @@ $ tree /tmp/b -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to local (Local Disk).

    --copy-links / -L

    Follow symlinks and copy the pointed to item.

    @@ -17367,7 +18453,7 @@ $ tree /tmp/b
  • Type: MultiEncoder
  • Default: Slash,Dot
    • -

    Backend commands

    +

    Backend commands

    Here are the commands specific to the local backend.

    Run them with

    rclone backend COMMAND remote:
    @@ -17384,6 +18470,51 @@ $ tree /tmp/b
  • "error": return an error based on option value

    • Changelog

    +

    v1.53.1 - 2020-09-13

    +

    See commits

    +

    v1.53.0 - 2020-09-02

    See commits

    Bugs and Limitations

    -

    Limitations

    +

    Limitations

    Directory timestamps aren't preserved

    Rclone doesn't currently preserve the timestamps of directories. This is because rclone only really considers objects when syncing.

    Rclone struggles with millions of files in a directory/bucket

    diff --git a/MANUAL.md b/MANUAL.md index 35427b836..923ba8d49 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,6 +1,6 @@ % rclone(1) User Manual % Nick Craig-Wood -% Sep 02, 2020 +% Sep 13, 2020 # Rclone syncs your files to cloud storage @@ -146,6 +146,7 @@ WebDAV or S3, that work out of the box.) - StackPath - SugarSync - Tardigrade +- Tencent Cloud Object Storage (COS) - Wasabi - WebDAV - Yandex Disk @@ -503,7 +504,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone copy -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis @@ -833,7 +834,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are @@ -859,6 +860,7 @@ rclone check source:path dest:path [flags] ``` --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file + --download Check by downloading rather than with hash. --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file @@ -1191,7 +1193,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone cleanup -Clean up the remote if possible +Clean up the remote if possible. ## Synopsis @@ -1915,7 +1917,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone copyto -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis @@ -2040,7 +2042,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are @@ -2434,7 +2436,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone lsf -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. ## Synopsis @@ -2744,6 +2746,9 @@ Stopping the mount manually: # OS X umount /path/to/local/mount +**Note**: As of `rclone` 1.52.2, `rclone mount` now requires Go version 1.13 +or newer on some platforms depending on the underlying FUSE library in use. + ## Installing on Windows To run rclone mount on Windows, you will need to @@ -3052,6 +3057,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -3289,7 +3299,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone obscure -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. ## Synopsis @@ -3754,6 +3764,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -4056,6 +4071,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -4514,6 +4534,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -5035,6 +5060,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -5502,6 +5532,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -6502,6 +6537,8 @@ This can be useful for tracking down problems with syncs in combination with the `-v` flag. See the [Logging section](#logging) for more info. +If FILE exists then rclone will append to it. + Note that if you are using the `logrotate` program to manage rclone's logs, then you should use the `copytruncate` option as rclone doesn't have a signal to rotate logs. @@ -8893,6 +8930,8 @@ OR "result": "" } +``` + **Authentication is required for this call.** ### core/gc: Runs a garbage collection. {#core-gc} @@ -9568,7 +9607,7 @@ This allows you to remove a plugin using it's name This takes parameters -- name: name of the plugin in the format / +- name: name of the plugin in the format `author`/`plugin_name` Eg @@ -9582,7 +9621,7 @@ This allows you to remove a plugin using it's name This takes the following parameters -- name: name of the plugin in the format / +- name: name of the plugin in the format `author`/`plugin_name` Eg @@ -10527,7 +10566,7 @@ These flags are available for every command. --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata - --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.1") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -10626,7 +10665,7 @@ and may be set in the config file. --drive-auth-owner-only Only consider files owned by the authenticated user. --drive-auth-url string Auth server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) - --drive-client-id string OAuth Client Id + --drive-client-id string Google Application Client Id --drive-client-secret string OAuth Client Secret --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) @@ -11475,6 +11514,7 @@ The S3 backend can be used with a number of different providers: - Minio - Scaleway - StackPath +- Tencent Cloud Object Storage (COS) - Wasabi @@ -11912,7 +11952,7 @@ Vault API, so rclone cannot directly access Glacier Vaults. ### Standard Options -Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). +Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)). #### --s3-provider @@ -11943,6 +11983,8 @@ Choose your S3 provider. - Scaleway Object Storage - "StackPath" - StackPath Object Storage + - "TencentCOS" + - Tencent Cloud Object Storage (COS) - "Wasabi" - Wasabi Object Storage - "Other" @@ -12296,6 +12338,54 @@ Endpoint for StackPath Object Storage. #### --s3-endpoint +Endpoint for Tencent COS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "cos.ap-beijing.myqcloud.com" + - Beijing Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-shanghai.myqcloud.com" + - Shanghai Region. + - "cos.ap-guangzhou.myqcloud.com" + - Guangzhou Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-chengdu.myqcloud.com" + - Chengdu Region. + - "cos.ap-chongqing.myqcloud.com" + - Chongqing Region. + - "cos.ap-hongkong.myqcloud.com" + - Hong Kong (China) Region. + - "cos.ap-singapore.myqcloud.com" + - Singapore Region. + - "cos.ap-mumbai.myqcloud.com" + - Mumbai Region. + - "cos.ap-seoul.myqcloud.com" + - Seoul Region. + - "cos.ap-bangkok.myqcloud.com" + - Bangkok Region. + - "cos.ap-tokyo.myqcloud.com" + - Tokyo Region. + - "cos.na-siliconvalley.myqcloud.com" + - Silicon Valley Region. + - "cos.na-ashburn.myqcloud.com" + - Virginia Region. + - "cos.na-toronto.myqcloud.com" + - Toronto Region. + - "cos.eu-frankfurt.myqcloud.com" + - Frankfurt Region. + - "cos.eu-moscow.myqcloud.com" + - Moscow Region. + - "cos.accelerate.myqcloud.com" + - Use Tencent COS Accelerate Endpoint. + +#### --s3-endpoint + Endpoint for S3 API. Required when using an S3 clone. @@ -12463,6 +12553,8 @@ doesn't copy the ACL from the source but rather writes a fresh one. - Type: string - Default: "" - Examples: + - "default" + - Owner gets Full_CONTROL. No one else has access rights (default). - "private" - Owner gets FULL_CONTROL. No one else has access rights (default). - "public-read" @@ -12563,6 +12655,24 @@ The storage class to use when storing new objects in OSS. #### --s3-storage-class +The storage class to use when storing new objects in Tencent COS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "ARCHIVE" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +#### --s3-storage-class + The storage class to use when storing new objects in S3. - Config: storage_class @@ -12579,7 +12689,7 @@ The storage class to use when storing new objects in S3. ### Advanced Options -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). +Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)). #### --s3-bucket-acl @@ -12800,7 +12910,7 @@ if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. -Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to +Some providers (eg AWS, Aliyun OSS, Netease COS or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting. @@ -13669,6 +13779,138 @@ d) Delete this remote y/e/d> y ``` +### Tencent COS {#tencent-cos} + +[Tencent Cloud Object Storage (COS)](https://intl.cloud.tencent.com/product/cos) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost. + +To configure access to Tencent COS, follow the steps below: + +1. Run `rclone config` and select `n` for a new remote. + +``` +rclone config +No remotes found - make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +``` + +2. Give the name of the configuration. For example, name it 'cos'. + +``` +name> cos +``` + +3. Select `s3` storage. + +``` +Choose a number from below, or type in your own value +1 / 1Fichier + \ "fichier" + 2 / Alias for an existing remote + \ "alias" + 3 / Amazon Drive + \ "amazon cloud drive" + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc) + \ "s3" +[snip] +Storage> s3 +``` + +4. Select `TencentCOS` provider. +``` +Choose a number from below, or type in your own value +1 / Amazon Web Services (AWS) S3 + \ "AWS" +[snip] +11 / Tencent Cloud Object Storage (COS) + \ "TencentCOS" +[snip] +provider> TencentCOS +``` + +5. Enter your SecretId and SecretKey of Tencent Cloud. + +``` +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Enter a boolean value (true or false). Press Enter for the default ("false"). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" +env_auth> 1 +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (""). +access_key_id> AKIDxxxxxxxxxx +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (""). +secret_access_key> xxxxxxxxxxx +``` + +6. Select endpoint for Tencent COS. This is the standard endpoint for different region. + +``` + 1 / Beijing Region. + \ "cos.ap-beijing.myqcloud.com" + 2 / Nanjing Region. + \ "cos.ap-nanjing.myqcloud.com" + 3 / Shanghai Region. + \ "cos.ap-shanghai.myqcloud.com" + 4 / Guangzhou Region. + \ "cos.ap-guangzhou.myqcloud.com" +[snip] +endpoint> 4 +``` + +7. Choose acl and storage class. + +``` +Note that this ACL is applied when server side copying objects as S3 +doesn't copy the ACL from the source but rather writes a fresh one. +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Owner gets Full_CONTROL. No one else has access rights (default). + \ "default" +[snip] +acl> 1 +The storage class to use when storing new objects in Tencent COS. +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Default + \ "" +[snip] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +-------------------- +[cos] +type = s3 +provider = TencentCOS +env_auth = false +access_key_id = xxx +secret_access_key = xxx +endpoint = cos.ap-guangzhou.myqcloud.com +acl = default +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: + +Name Type +==== ==== +cos s3 +``` + ### Netease NOS ### For Netease NOS configure as per the configurator `rclone config` @@ -17997,8 +18239,10 @@ Here are the standard options specific to drive (Google Drive). #### --drive-client-id -OAuth Client Id -Leave blank normally. +Google Application Client Id +Setting your own is recommended. +See https://rclone.org/drive/#making-your-own-client-id for how to create your own. +If you leave this blank, it will use an internal key which is low performance. - Config: client_id - Env Var: RCLONE_DRIVE_CLIENT_ID @@ -19688,8 +19932,13 @@ flag. Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (wherever the `TMPDIR` environment variable points -to) before it is uploaded. Small files will be cached in memory - see +to) before it is uploaded. Small files will be cached in memory - see the [--jottacloud-md5-memory-limit](#jottacloud-md5-memory-limit) flag. +When uploading from local disk the source checksum is always available, +so this does not apply. Starting with rclone version 1.52 the same is +true for crypted remotes (in older versions the crypt backend would not +calculate hashes for uploads from local disk, so the Jottacloud +backend had to do it as described above). #### Restricted filename characters @@ -25432,6 +25681,36 @@ Options: # Changelog +## v1.53.1 - 2020-09-13 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1) + +* Bug Fixes + * accounting: Remove new line from end of --stats-one-line display (Nick Craig-Wood) + * check + * Add back missing --download flag (Nick Craig-Wood) + * Fix docs (Nick Craig-Wood) + * docs + * Note --log-file does append (Nick Craig-Wood) + * Add full stops for consistency in rclone --help (edwardxml) + * Add Tencent COS to s3 provider list (wjielai) + * Updated mount command to reflect that it requires Go 1.13 or newer (Evan Harris) + * jottacloud: Mention that uploads from local disk will not need to cache files to disk for md5 calculation (albertony) + * Fix formatting of rc docs page (Nick Craig-Wood) + * build + * Include vendor tar ball in release and fix startdev (Nick Craig-Wood) + * Fix "Illegal instruction" error for ARMv6 builds (Nick Craig-Wood) + * Fix architecture name in ARMv7 build (Nick Craig-Wood) +* VFS + * Fix spurious error "vfs cache: failed to _ensure cache EOF" (Nick Craig-Wood) + * Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood) +* Local + * Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood) +* Drive + * Re-adds special oauth help text (Tim Gallant) +* Opendrive + * Do not retry 400 errors (Evan Harris) + ## v1.53.0 - 2020-09-02 [See commits](https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0) diff --git a/MANUAL.txt b/MANUAL.txt index 59ebf1da2..418f3703f 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ rclone(1) User Manual Nick Craig-Wood -Sep 02, 2020 +Sep 13, 2020 @@ -143,6 +143,7 @@ S3, that work out of the box.) - StackPath - SugarSync - Tardigrade +- Tencent Cloud Object Storage (COS) - Wasabi - WebDAV - Yandex Disk @@ -515,7 +516,7 @@ SEE ALSO RCLONE COPY -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. Synopsis @@ -846,7 +847,7 @@ source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The --differ, --missing-on-dst, --missing-on-src, --src-only and --error +The --differ, --missing-on-dst, --missing-on-src, --match and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and @@ -874,6 +875,7 @@ Options --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file + --download Check by downloading rather than with hash. --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file @@ -1211,7 +1213,7 @@ SEE ALSO RCLONE CLEANUP -Clean up the remote if possible +Clean up the remote if possible. Synopsis @@ -1951,7 +1953,7 @@ SEE ALSO RCLONE COPYTO -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. Synopsis @@ -2074,7 +2076,7 @@ source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The --differ, --missing-on-dst, --missing-on-src, --src-only and --error +The --differ, --missing-on-dst, --missing-on-src, --match and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and @@ -2477,7 +2479,7 @@ SEE ALSO RCLONE LSF -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. Synopsis @@ -2780,6 +2782,9 @@ Stopping the mount manually: # OS X umount /path/to/local/mount +NOTE: As of rclone 1.52.2, rclone mount now requires Go version 1.13 or +newer on some platforms depending on the underlying FUSE library in use. + Installing on Windows @@ -3092,6 +3097,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -3331,7 +3341,7 @@ SEE ALSO RCLONE OBSCURE -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. Synopsis @@ -3800,6 +3810,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -4111,6 +4126,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -4595,6 +4615,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -5150,6 +5175,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -5642,6 +5672,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -6623,6 +6658,8 @@ Log all of rclone's output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination with the -v flag. See the Logging section for more info. +If FILE exists then rclone will append to it. + Note that if you are using the logrotate program to manage rclone's logs, then you should use the copytruncate option as rclone doesn't have a signal to rotate logs. @@ -9005,9197 +9042,10357 @@ Returns "result": "" } - **Authentication is required for this call.** +AUTHENTICATION IS REQUIRED FOR THIS CALL. - ### core/gc: Runs a garbage collection. {#core-gc} +core/gc: Runs a garbage collection. - This tells the go runtime to do a garbage collection run. It isn't - necessary to call this normally, but it can be useful for debugging - memory problems. +This tells the go runtime to do a garbage collection run. It isn't +necessary to call this normally, but it can be useful for debugging +memory problems. - ### core/group-list: Returns list of stats. {#core-group-list} +core/group-list: Returns list of stats. - This returns list of stats groups currently in memory. +This returns list of stats groups currently in memory. - Returns the following values: +Returns the following values: -{ "groups": an array of group names: [ "group1", "group2", ... ] } + { + "groups": an array of group names: + [ + "group1", + "group2", + ... + ] + } +core/memstats: Returns the memory statistics - ### core/memstats: Returns the memory statistics {#core-memstats} +This returns the memory statistics of the running program. What the +values mean are explained in the go docs: +https://golang.org/pkg/runtime/#MemStats - This returns the memory statistics of the running program. What the values mean - are explained in the go docs: https://golang.org/pkg/runtime/#MemStats +The most interesting values for most people are: - The most interesting values for most people are: +- HeapAlloc: This is the amount of memory rclone is actually using +- HeapSys: This is the amount of memory rclone has obtained from the + OS +- Sys: this is the total amount of memory requested from the OS + - It is virtual memory so may include unused memory - * HeapAlloc: This is the amount of memory rclone is actually using - * HeapSys: This is the amount of memory rclone has obtained from the OS - * Sys: this is the total amount of memory requested from the OS - * It is virtual memory so may include unused memory +core/obscure: Obscures a string passed in. - ### core/obscure: Obscures a string passed in. {#core-obscure} +Pass a clear string and rclone will obscure it for the config file: - +clear - string - Pass a clear string and rclone will obscure it for the config file: - - clear - string +Returns - obscured - string - Returns - - obscured - string +core/pid: Return PID of current process - ### core/pid: Return PID of current process {#core-pid} +This returns PID of current process. Useful for stopping rclone process. - This returns PID of current process. - Useful for stopping rclone process. +core/quit: Terminates the app. - ### core/quit: Terminates the app. {#core-quit} +(optional) Pass an exit code to be used for terminating the app: - +exitCode - int - (optional) Pass an exit code to be used for terminating the app: - - exitCode - int +core/stats: Returns stats about current transfers. - ### core/stats: Returns stats about current transfers. {#core-stats} +This returns all available stats: - This returns all available stats: + rclone rc core/stats - rclone rc core/stats +If group is not provided then summed up stats for all groups will be +returned. - If group is not provided then summed up stats for all groups will be - returned. +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +Returns the following values: - Returns the following values: + { + "speed": average speed in bytes/sec since start of the process, + "bytes": total transferred bytes since the start of the process, + "errors": number of errors, + "fatalError": whether there has been at least one FatalError, + "retryError": whether there has been at least one non-NoRetryError, + "checks": number of checked files, + "transfers": number of transferred files, + "deletes" : number of deleted files, + "renames" : number of renamed files, + "transferTime" : total time spent on running jobs, + "elapsedTime": time in seconds since the start of the process, + "lastError": last occurred error, + "transferring": an array of currently active file transfers: + [ + { + "bytes": total transferred bytes for this file, + "eta": estimated time in seconds until file transfer completion + "name": name of the file, + "percentage": progress of the file transfer in percent, + "speed": average speed over the whole transfer in bytes/sec, + "speedAvg": current speed in bytes/sec as an exponentially weighted moving average, + "size": size of the file in bytes + } + ], + "checking": an array of names of currently active file checks + [] + } -{ "speed": average speed in bytes/sec since start of the process, -"bytes": total transferred bytes since the start of the process, -"errors": number of errors, "fatalError": whether there has been at -least one FatalError, "retryError": whether there has been at least one -non-NoRetryError, "checks": number of checked files, "transfers": number -of transferred files, "deletes" : number of deleted files, "renames" : -number of renamed files, "transferTime" : total time spent on running -jobs, "elapsedTime": time in seconds since the start of the process, -"lastError": last occurred error, "transferring": an array of currently -active file transfers: [ { "bytes": total transferred bytes for this -file, "eta": estimated time in seconds until file transfer completion -"name": name of the file, "percentage": progress of the file transfer in -percent, "speed": average speed over the whole transfer in bytes/sec, -"speedAvg": current speed in bytes/sec as an exponentially weighted -moving average, "size": size of the file in bytes } ], "checking": an -array of names of currently active file checks [] } +Values for "transferring", "checking" and "lastError" are only assigned +if data is available. The value for "eta" is null if an eta cannot be +determined. - Values for "transferring", "checking" and "lastError" are only assigned if data is available. - The value for "eta" is null if an eta cannot be determined. +core/stats-delete: Delete stats group. - ### core/stats-delete: Delete stats group. {#core-stats-delete} +This deletes entire stats group - This deletes entire stats group +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +core/stats-reset: Reset stats. - ### core/stats-reset: Reset stats. {#core-stats-reset} +This clears counters, errors and finished transfers for all stats or +specific stats group if group is provided. - This clears counters, errors and finished transfers for all stats or specific - stats group if group is provided. +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +core/transferred: Returns stats about completed transfers. - ### core/transferred: Returns stats about completed transfers. {#core-transferred} +This returns stats about completed transfers: - This returns stats about completed transfers: + rclone rc core/transferred - rclone rc core/transferred +If group is not provided then completed transfers for all groups will be +returned. - If group is not provided then completed transfers for all groups will be - returned. +Note only the last 100 completed transfers are returned. - Note only the last 100 completed transfers are returned. +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +Returns the following values: - Returns the following values: + { + "transferred": an array of completed transfers (including failed ones): + [ + { + "name": name of the file, + "size": size of the file in bytes, + "bytes": total transferred bytes for this file, + "checked": if the transfer is only checked (skipped, deleted), + "timestamp": integer representing millisecond unix epoch, + "error": string description of the error (empty if successful), + "jobid": id of the job that this transfer belongs to + } + ] + } -{ "transferred": an array of completed transfers (including failed -ones): [ { "name": name of the file, "size": size of the file in bytes, -"bytes": total transferred bytes for this file, "checked": if the -transfer is only checked (skipped, deleted), "timestamp": integer -representing millisecond unix epoch, "error": string description of the -error (empty if successful), "jobid": id of the job that this transfer -belongs to } ] } +core/version: Shows the current version of rclone and the go runtime. +This shows the current version of go and the go runtime - ### core/version: Shows the current version of rclone and the go runtime. {#core-version} +- version - rclone version, eg "v1.53.0" +- decomposed - version number as [major, minor, patch] +- isGit - boolean - true if this was compiled from the git version +- isBeta - boolean - true if this is a beta version +- os - OS in use as according to Go +- arch - cpu architecture in use according to Go +- goVersion - version of Go runtime in use - This shows the current version of go and the go runtime +debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. - - version - rclone version, eg "v1.53.0" - - decomposed - version number as [major, minor, patch] - - isGit - boolean - true if this was compiled from the git version - - isBeta - boolean - true if this is a beta version - - os - OS in use as according to Go - - arch - cpu architecture in use according to Go - - goVersion - version of Go runtime in use +SetBlockProfileRate controls the fraction of goroutine blocking events +that are reported in the blocking profile. The profiler aims to sample +an average of one blocking event per rate nanoseconds spent blocked. - ### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate} +To include every blocking event in the profile, pass rate = 1. To turn +off profiling entirely, pass rate <= 0. - SetBlockProfileRate controls the fraction of goroutine blocking events - that are reported in the blocking profile. The profiler aims to sample - an average of one blocking event per rate nanoseconds spent blocked. +After calling this you can use this to see the blocking profile: - To include every blocking event in the profile, pass rate = 1. To turn - off profiling entirely, pass rate <= 0. + go tool pprof http://localhost:5572/debug/pprof/block - After calling this you can use this to see the blocking profile: +Parameters - go tool pprof http://localhost:5572/debug/pprof/block +- rate - int - Parameters +debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. - - rate - int +SetMutexProfileFraction controls the fraction of mutex contention events +that are reported in the mutex profile. On average 1/rate events are +reported. The previous rate is returned. - ### debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug-set-mutex-profile-fraction} +To turn off profiling entirely, pass rate 0. To just read the current +rate, pass rate < 0. (For n>1 the details of sampling may change.) - SetMutexProfileFraction controls the fraction of mutex contention - events that are reported in the mutex profile. On average 1/rate - events are reported. The previous rate is returned. +Once this is set you can look use this to profile the mutex contention: - To turn off profiling entirely, pass rate 0. To just read the current - rate, pass rate < 0. (For n>1 the details of sampling may change.) + go tool pprof http://localhost:5572/debug/pprof/mutex - Once this is set you can look use this to profile the mutex contention: +Parameters - go tool pprof http://localhost:5572/debug/pprof/mutex +- rate - int - Parameters +Results - - rate - int +- previousRate - int - Results +job/list: Lists the IDs of the running jobs - - previousRate - int +Parameters - None - ### job/list: Lists the IDs of the running jobs {#job-list} +Results - Parameters - None +- jobids - array of integer job ids - Results +job/status: Reads the status of the job ID - - jobids - array of integer job ids +Parameters - ### job/status: Reads the status of the job ID {#job-status} +- jobid - id of the job (integer) - Parameters +Results - - jobid - id of the job (integer) +- finished - boolean +- duration - time in seconds that the job ran for +- endTime - time the job finished (eg + "2018-10-26T18:50:20.528746884+01:00") +- error - error from the job or empty string for no error +- finished - boolean whether the job has finished or not +- id - as passed in above +- startTime - time the job started (eg + "2018-10-26T18:50:20.528336039+01:00") +- success - boolean - true for success false otherwise +- output - output of the job as would have been returned if called + synchronously +- progress - output of the progress related to the underlying job - Results +job/stop: Stop the running job - - finished - boolean - - duration - time in seconds that the job ran for - - endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00") - - error - error from the job or empty string for no error - - finished - boolean whether the job has finished or not - - id - as passed in above - - startTime - time the job started (eg "2018-10-26T18:50:20.528336039+01:00") - - success - boolean - true for success false otherwise - - output - output of the job as would have been returned if called synchronously - - progress - output of the progress related to the underlying job +Parameters - ### job/stop: Stop the running job {#job-stop} +- jobid - id of the job (integer) - Parameters +mount/listmounts: Show current mount points - - jobid - id of the job (integer) +This shows currently mounted points, which can be used for performing an +unmount - ### mount/listmounts: Show current mount points {#mount-listmounts} +This takes no parameters and returns - This shows currently mounted points, which can be used for performing an unmount +- mountPoints: list of current mount points - This takes no parameters and returns +Eg - - mountPoints: list of current mount points + rclone rc mount/listmounts - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/listmounts +mount/mount: Create a new mount point - **Authentication is required for this call.** +rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's +cloud storage systems as a file system with FUSE. - ### mount/mount: Create a new mount point {#mount-mount} +If no mountType is provided, the priority is given as follows: 1. mount +2.cmount 3.mount2 - rclone allows Linux, FreeBSD, macOS and Windows to mount any of - Rclone's cloud storage systems as a file system with FUSE. +This takes the following parameters - If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2 +- fs - a remote path to be mounted (required) +- mountPoint: valid path on the local machine (required) +- mountType: One of the values (mount, cmount, mount2) specifies the + mount implementation to use +- mountOpt: a JSON object with Mount options in. +- vfsOpt: a JSON object with VFS options in. - This takes the following parameters +Eg - - fs - a remote path to be mounted (required) - - mountPoint: valid path on the local machine (required) - - mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use - - mountOpt: a JSON object with Mount options in. - - vfsOpt: a JSON object with VFS options in. + rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint + rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount + rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}' - Eg +The vfsOpt are as described in options/get and can be seen in the the +"vfs" section when running and the mountOpt can be seen in the "mount" +section. - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount - rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}' + rclone rc options/get - The vfsOpt are as described in options/get and can be seen in the the - "vfs" section when running and the mountOpt can be seen in the "mount" section. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc options/get +mount/types: Show all possible mount types - **Authentication is required for this call.** +This shows all possible mount types and returns them as a list. - ### mount/types: Show all possible mount types {#mount-types} +This takes no parameters and returns - This shows all possible mount types and returns them as a list. +- mountTypes: list of mount types - This takes no parameters and returns +The mount types are strings like "mount", "mount2", "cmount" and can be +passed to mount/mount as the mountType parameter. - - mountTypes: list of mount types +Eg - The mount types are strings like "mount", "mount2", "cmount" and can - be passed to mount/mount as the mountType parameter. + rclone rc mount/types - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/types +mount/unmount: Unmount selected active mount - **Authentication is required for this call.** +rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's +cloud storage systems as a file system with FUSE. - ### mount/unmount: Unmount selected active mount {#mount-unmount} +This takes the following parameters - rclone allows Linux, FreeBSD, macOS and Windows to - mount any of Rclone's cloud storage systems as a file system with - FUSE. +- mountPoint: valid path on the local machine where the mount was + created (required) - This takes the following parameters +Eg - - mountPoint: valid path on the local machine where the mount was created (required) + rclone rc mount/unmount mountPoint=/home//mountPoint - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/unmount mountPoint=/home//mountPoint +mount/unmountall: Show current mount points - **Authentication is required for this call.** +This shows currently mounted points, which can be used for performing an +unmount - ### mount/unmountall: Show current mount points {#mount-unmountall} +This takes no parameters and returns error if unmount does not succeed. - This shows currently mounted points, which can be used for performing an unmount +Eg - This takes no parameters and returns error if unmount does not succeed. + rclone rc mount/unmountall - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/unmountall +operations/about: Return the space used on the remote - **Authentication is required for this call.** +This takes the following parameters - ### operations/about: Return the space used on the remote {#operations-about} +- fs - a remote name string eg "drive:" - This takes the following parameters +The result is as returned from rclone about --json - - fs - a remote name string eg "drive:" +See the about command command for more information on the above. - The result is as returned from rclone about --json +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above. +operations/cleanup: Remove trashed files in the remote or path - **Authentication is required for this call.** +This takes the following parameters - ### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup} +- fs - a remote name string eg "drive:" - This takes the following parameters +See the cleanup command command for more information on the above. - - fs - a remote name string eg "drive:" +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. +operations/copyfile: Copy a file from source remote to destination remote - **Authentication is required for this call.** +This takes the following parameters - ### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile} +- srcFs - a remote name string eg "drive:" for the source +- srcRemote - a path within that remote eg "file.txt" for the source +- dstFs - a remote name string eg "drive2:" for the destination +- dstRemote - a path within that remote eg "file2.txt" for the + destination - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - srcFs - a remote name string eg "drive:" for the source - - srcRemote - a path within that remote eg "file.txt" for the source - - dstFs - a remote name string eg "drive2:" for the destination - - dstRemote - a path within that remote eg "file2.txt" for the destination +operations/copyurl: Copy the URL to the object - **Authentication is required for this call.** +This takes the following parameters - ### operations/copyurl: Copy the URL to the object {#operations-copyurl} +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" +- url - string, URL to read from +- autoFilename - boolean, set to true to retrieve destination file + name from url See the copyurl command command for more information + on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - url - string, URL to read from - - autoFilename - boolean, set to true to retrieve destination file name from url - See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command for more information on the above. +operations/delete: Remove files in the path - **Authentication is required for this call.** +This takes the following parameters - ### operations/delete: Remove files in the path {#operations-delete} +- fs - a remote name string eg "drive:" - This takes the following parameters +See the delete command command for more information on the above. - - fs - a remote name string eg "drive:" +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above. +operations/deletefile: Remove the single file pointed to - **Authentication is required for this call.** +This takes the following parameters - ### operations/deletefile: Remove the single file pointed to {#operations-deletefile} +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" - This takes the following parameters +See the deletefile command command for more information on the above. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. +operations/fsinfo: Return information about the remote - **Authentication is required for this call.** +This takes the following parameters - ### operations/fsinfo: Return information about the remote {#operations-fsinfo} +- fs - a remote name string eg "drive:" - This takes the following parameters +This returns info about the remote passed in; - - fs - a remote name string eg "drive:" + { + // optional features and whether they are available or not + "Features": { + "About": true, + "BucketBased": false, + "CanHaveEmptyDirectories": true, + "CaseInsensitive": false, + "ChangeNotify": false, + "CleanUp": false, + "Copy": false, + "DirCacheFlush": false, + "DirMove": true, + "DuplicateFiles": false, + "GetTier": false, + "ListR": false, + "MergeDirs": false, + "Move": true, + "OpenWriterAt": true, + "PublicLink": false, + "Purge": true, + "PutStream": true, + "PutUnchecked": false, + "ReadMimeType": false, + "ServerSideAcrossConfigs": false, + "SetTier": false, + "SetWrapper": false, + "UnWrap": false, + "WrapFs": false, + "WriteMimeType": false + }, + // Names of hashes available + "Hashes": [ + "MD5", + "SHA-1", + "DropboxHash", + "QuickXorHash" + ], + "Name": "local", // Name as created + "Precision": 1, // Precision of timestamps in ns + "Root": "/", // Path as created + "String": "Local file system at /" // how the remote will appear in logs + } - This returns info about the remote passed in; +This command does not have a command line equivalent so use this +instead: -{ // optional features and whether they are available or not "Features": -{ "About": true, "BucketBased": false, "CanHaveEmptyDirectories": true, -"CaseInsensitive": false, "ChangeNotify": false, "CleanUp": false, -"Copy": false, "DirCacheFlush": false, "DirMove": true, -"DuplicateFiles": false, "GetTier": false, "ListR": false, "MergeDirs": -false, "Move": true, "OpenWriterAt": true, "PublicLink": false, "Purge": -true, "PutStream": true, "PutUnchecked": false, "ReadMimeType": false, -"ServerSideAcrossConfigs": false, "SetTier": false, "SetWrapper": false, -"UnWrap": false, "WrapFs": false, "WriteMimeType": false }, // Names of -hashes available "Hashes": [ "MD5", "SHA-1", "DropboxHash", -"QuickXorHash" ], "Name": "local", // Name as created "Precision": 1, // -Precision of timestamps in ns "Root": "/", // Path as created "String": -"Local file system at /" // how the remote will appear in logs } + rclone rc --loopback operations/fsinfo fs=remote: +operations/list: List the given remote and path in JSON format - This command does not have a command line equivalent so use this instead: +This takes the following parameters - rclone rc --loopback operations/fsinfo fs=remote: +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" +- opt - a dictionary of options to control the listing (optional) + - recurse - If set recurse directories + - noModTime - If set return modification time + - showEncrypted - If set show decrypted names + - showOrigIDs - If set show the IDs for each item if known + - showHash - If set return a dictionary of hashes - ### operations/list: List the given remote and path in JSON format {#operations-list} +The result is - This takes the following parameters +- list + - This is an array of objects as described in the lsjson command - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - opt - a dictionary of options to control the listing (optional) - - recurse - If set recurse directories - - noModTime - If set return modification time - - showEncrypted - If set show decrypted names - - showOrigIDs - If set show the IDs for each item if known - - showHash - If set return a dictionary of hashes +See the lsjson command for more information on the above and examples. - The result is +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - list - - This is an array of objects as described in the lsjson command +operations/mkdir: Make a destination directory or container - See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" - ### operations/mkdir: Make a destination directory or container {#operations-mkdir} +See the mkdir command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +operations/movefile: Move a file from source remote to destination remote - See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- srcFs - a remote name string eg "drive:" for the source +- srcRemote - a path within that remote eg "file.txt" for the source +- dstFs - a remote name string eg "drive2:" for the destination +- dstRemote - a path within that remote eg "file2.txt" for the + destination - ### operations/movefile: Move a file from source remote to destination remote {#operations-movefile} +AUTHENTICATION IS REQUIRED FOR THIS CALL. - This takes the following parameters +operations/publiclink: Create or retrieve a public link to the given file or folder. - - srcFs - a remote name string eg "drive:" for the source - - srcRemote - a path within that remote eg "file.txt" for the source - - dstFs - a remote name string eg "drive2:" for the destination - - dstRemote - a path within that remote eg "file2.txt" for the destination +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" +- unlink - boolean - if set removes the link rather than adding it + (optional) +- expire - string - the expiry time of the link eg "1d" (optional) - ### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink} +Returns - This takes the following parameters +- url - URL of the resource - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - unlink - boolean - if set removes the link rather than adding it (optional) - - expire - string - the expiry time of the link eg "1d" (optional) +See the link command command for more information on the above. - Returns +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - url - URL of the resource +operations/purge: Remove a directory or container and all of its contents - See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" - ### operations/purge: Remove a directory or container and all of its contents {#operations-purge} +See the purge command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +operations/rmdir: Remove an empty directory or container - See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" - ### operations/rmdir: Remove an empty directory or container {#operations-rmdir} +See the rmdir command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +operations/rmdirs: Remove all the empty directories in the path - See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" +- leaveRoot - boolean, set to true not to delete the root - ### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs} +See the rmdirs command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - leaveRoot - boolean, set to true not to delete the root +operations/size: Count the number of bytes and files in remote - See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:path/to/dir" - ### operations/size: Count the number of bytes and files in remote {#operations-size} +Returns - This takes the following parameters +- count - number of files +- bytes - number of bytes in those files - - fs - a remote name string eg "drive:path/to/dir" +See the size command command for more information on the above. - Returns +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - count - number of files - - bytes - number of bytes in those files +operations/uploadfile: Upload file using multiform/form-data - See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string eg "drive:" +- remote - a path within that remote eg "dir" +- each part in body represents a file to be uploaded See the + uploadfile command command for more information on the above. - ### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile} +AUTHENTICATION IS REQUIRED FOR THIS CALL. - This takes the following parameters +options/blocks: List all the option blocks - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - each part in body represents a file to be uploaded - See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above. +Returns - options - a list of the options block names - **Authentication is required for this call.** +options/get: Get all the options - ### options/blocks: List all the option blocks {#options-blocks} +Returns an object where keys are option block names and values are an +object with the current option values in. - Returns - - options - a list of the options block names +This shows the internal names of the option within rclone which should +map to the external options very easily with a few exceptions. - ### options/get: Get all the options {#options-get} +options/set: Set an option - Returns an object where keys are option block names and values are an - object with the current option values in. +Parameters - This shows the internal names of the option within rclone which should - map to the external options very easily with a few exceptions. +- option block name containing an object with + - key: value - ### options/set: Set an option {#options-set} +Repeated as often as required. - Parameters +Only supply the options you wish to change. If an option is unknown it +will be silently ignored. Not all options will have an effect when +changed like this. - - option block name containing an object with - - key: value +For example: - Repeated as often as required. +This sets DEBUG level logs (-vv) - Only supply the options you wish to change. If an option is unknown - it will be silently ignored. Not all options will have an effect when - changed like this. + rclone rc options/set --json '{"main": {"LogLevel": 8}}' - For example: +And this sets INFO level logs (-v) - This sets DEBUG level logs (-vv) + rclone rc options/set --json '{"main": {"LogLevel": 7}}' - rclone rc options/set --json '{"main": {"LogLevel": 8}}' +And this sets NOTICE level logs (normal without -v) - And this sets INFO level logs (-v) + rclone rc options/set --json '{"main": {"LogLevel": 6}}' - rclone rc options/set --json '{"main": {"LogLevel": 7}}' +pluginsctl/addPlugin: Add a plugin using url - And this sets NOTICE level logs (normal without -v) +used for adding a plugin to the webgui - rclone rc options/set --json '{"main": {"LogLevel": 6}}' +This takes the following parameters - ### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl-addPlugin} +- url: http url of the github repo where the plugin is hosted + (http://github.com/rclone/rclone-webui-react) - used for adding a plugin to the webgui +Eg - This takes the following parameters +rclone rc pluginsctl/addPlugin - - url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react) +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/getPluginsForType: Get plugins with type criteria - rclone rc pluginsctl/addPlugin +This shows all possible plugins by a mime type - **Authentication is required for this call.** +This takes the following parameters - ### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType} +- type: supported mime type by a loaded plugin eg (video/mp4, + audio/mp3) +- pluginType: filter plugins based on their type eg (DASHBOARD, + FILE_HANDLER, TERMINAL) - This shows all possible plugins by a mime type +and returns - This takes the following parameters +- loadedPlugins: list of current production plugins +- testPlugins: list of temporarily loaded development plugins, usually + running on a different server. - - type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3) - - pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) +Eg - and returns +rclone rc pluginsctl/getPluginsForType type=video/mp4 - - loadedPlugins: list of current production plugins - - testPlugins: list of temporarily loaded development plugins, usually running on a different server. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/listPlugins: Get the list of currently loaded plugins - rclone rc pluginsctl/getPluginsForType type=video/mp4 +This allows you to get the currently enabled plugins and their details. - **Authentication is required for this call.** +This takes no parameters and returns - ### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins} +- loadedPlugins: list of current production plugins +- testPlugins: list of temporarily loaded development plugins, usually + running on a different server. - This allows you to get the currently enabled plugins and their details. +Eg - This takes no parameters and returns +rclone rc pluginsctl/listPlugins - - loadedPlugins: list of current production plugins - - testPlugins: list of temporarily loaded development plugins, usually running on a different server. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/listTestPlugins: Show currently loaded test plugins - rclone rc pluginsctl/listPlugins +allows listing of test plugins with the rclone.test set to true in +package.json of the plugin - **Authentication is required for this call.** +This takes no parameters and returns - ### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins} +- loadedTestPlugins: list of currently available test plugins - allows listing of test plugins with the rclone.test set to true in package.json of the plugin +Eg - This takes no parameters and returns + rclone rc pluginsctl/listTestPlugins - - loadedTestPlugins: list of currently available test plugins +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/removePlugin: Remove a loaded plugin - rclone rc pluginsctl/listTestPlugins +This allows you to remove a plugin using it's name - **Authentication is required for this call.** +This takes parameters - ### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin} +- name: name of the plugin in the format author/plugin_name - This allows you to remove a plugin using it's name +Eg - This takes parameters +rclone rc pluginsctl/removePlugin name=rclone/video-plugin - - name: name of the plugin in the format / +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/removeTestPlugin: Remove a test plugin - rclone rc pluginsctl/removePlugin name=rclone/video-plugin +This allows you to remove a plugin using it's name - **Authentication is required for this call.** +This takes the following parameters - ### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl-removeTestPlugin} +- name: name of the plugin in the format author/plugin_name - This allows you to remove a plugin using it's name +Eg - This takes the following parameters + rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react - - name: name of the plugin in the format / +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +rc/error: This returns an error - rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react +This returns an error with the input as part of its error string. Useful +for testing error handling. - **Authentication is required for this call.** +rc/list: List all the registered remote control commands - ### rc/error: This returns an error {#rc-error} +This lists all the registered remote control commands as a JSON map in +the commands response. - This returns an error with the input as part of its error string. - Useful for testing error handling. +rc/noop: Echo the input to the output parameters - ### rc/list: List all the registered remote control commands {#rc-list} +This echoes the input parameters to the output parameters for testing +purposes. It can be used to check that rclone is still alive and to +check that parameter passing is working properly. - This lists all the registered remote control commands as a JSON map in - the commands response. +rc/noopauth: Echo the input to the output parameters requiring auth - ### rc/noop: Echo the input to the output parameters {#rc-noop} +This echoes the input parameters to the output parameters for testing +purposes. It can be used to check that rclone is still alive and to +check that parameter passing is working properly. - This echoes the input parameters to the output parameters for testing - purposes. It can be used to check that rclone is still alive and to - check that parameter passing is working properly. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - ### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth} +sync/copy: copy a directory from source remote to destination remote - This echoes the input parameters to the output parameters for testing - purposes. It can be used to check that rclone is still alive and to - check that parameter passing is working properly. +This takes the following parameters - **Authentication is required for this call.** +- srcFs - a remote name string eg "drive:src" for the source +- dstFs - a remote name string eg "drive:dst" for the destination - ### sync/copy: copy a directory from source remote to destination remote {#sync-copy} +See the copy command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination +sync/move: move a directory from source remote to destination remote +This takes the following parameters - See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above. +- srcFs - a remote name string eg "drive:src" for the source +- dstFs - a remote name string eg "drive:dst" for the destination +- deleteEmptySrcDirs - delete empty src directories if set - **Authentication is required for this call.** +See the move command command for more information on the above. - ### sync/move: move a directory from source remote to destination remote {#sync-move} +AUTHENTICATION IS REQUIRED FOR THIS CALL. - This takes the following parameters +sync/sync: sync a directory from source remote to destination remote - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination - - deleteEmptySrcDirs - delete empty src directories if set +This takes the following parameters +- srcFs - a remote name string eg "drive:src" for the source +- dstFs - a remote name string eg "drive:dst" for the destination - See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above. +See the sync command command for more information on the above. - **Authentication is required for this call.** +AUTHENTICATION IS REQUIRED FOR THIS CALL. - ### sync/sync: sync a directory from source remote to destination remote {#sync-sync} +vfs/forget: Forget files or directories in the directory cache. - This takes the following parameters +This forgets the paths in the directory cache causing them to be re-read +from the remote when needed. - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination +If no paths are passed in then it will forget all the paths in the +directory cache. + rclone rc vfs/forget - See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. +Otherwise pass files or dirs in as file=path or dir=path. Any parameter +key starting with file will forget that file and any starting with dir +will forget that dir, eg - **Authentication is required for this call.** + rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - ### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget} +This command takes an "fs" parameter. If this parameter is not supplied +and if there is only one VFS in use then that VFS will be used. If there +is more than one VFS in use then the "fs" parameter must be supplied. - This forgets the paths in the directory cache causing them to be - re-read from the remote when needed. +vfs/list: List active VFSes. - If no paths are passed in then it will forget all the paths in the - directory cache. +This lists the active VFSes. - rclone rc vfs/forget +It returns a list under the key "vfses" where the values are the VFS +names that could be passed to the other VFS commands in the "fs" +parameter. - Otherwise pass files or dirs in as file=path or dir=path. Any - parameter key starting with file will forget that file and any - starting with dir will forget that dir, eg +vfs/poll-interval: Get the status or update the value of the poll-interval option. - rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - - This command takes an "fs" parameter. If this parameter is not - supplied and if there is only one VFS in use then that VFS will be - used. If there is more than one VFS in use then the "fs" parameter - must be supplied. +Without any parameter given this returns the current status of the +poll-interval setting. - ### vfs/list: List active VFSes. {#vfs-list} +When the interval=duration parameter is set, the poll-interval value is +updated and the polling function is notified. Setting interval=0 +disables poll-interval. - This lists the active VFSes. + rclone rc vfs/poll-interval interval=5m - It returns a list under the key "vfses" where the values are the VFS - names that could be passed to the other VFS commands in the "fs" - parameter. +The timeout=duration parameter can be used to specify a time to wait for +the current poll function to apply the new value. If timeout is less or +equal 0, which is the default, wait indefinitely. - ### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval} +The new poll-interval value will only be active when the timeout is not +reached. - Without any parameter given this returns the current status of the - poll-interval setting. +If poll-interval is updated or disabled temporarily, some changes might +not get picked up by the polling function, depending on the used remote. - When the interval=duration parameter is set, the poll-interval value - is updated and the polling function is notified. - Setting interval=0 disables poll-interval. +This command takes an "fs" parameter. If this parameter is not supplied +and if there is only one VFS in use then that VFS will be used. If there +is more than one VFS in use then the "fs" parameter must be supplied. - rclone rc vfs/poll-interval interval=5m +vfs/refresh: Refresh the directory cache. - The timeout=duration parameter can be used to specify a time to wait - for the current poll function to apply the new value. - If timeout is less or equal 0, which is the default, wait indefinitely. +This reads the directories for the specified paths and freshens the +directory cache. - The new poll-interval value will only be active when the timeout is - not reached. +If no paths are passed in then it will refresh the root directory. - If poll-interval is updated or disabled temporarily, some changes - might not get picked up by the polling function, depending on the - used remote. - - This command takes an "fs" parameter. If this parameter is not - supplied and if there is only one VFS in use then that VFS will be - used. If there is more than one VFS in use then the "fs" parameter - must be supplied. + rclone rc vfs/refresh - ### vfs/refresh: Refresh the directory cache. {#vfs-refresh} +Otherwise pass directories in as dir=path. Any parameter key starting +with dir will refresh that directory, eg - This reads the directories for the specified paths and freshens the - directory cache. + rclone rc vfs/refresh dir=home/junk dir2=data/misc - If no paths are passed in then it will refresh the root directory. +If the parameter recursive=true is given the whole directory tree will +get refreshed. This refresh will use --fast-list if enabled. - rclone rc vfs/refresh +This command takes an "fs" parameter. If this parameter is not supplied +and if there is only one VFS in use then that VFS will be used. If there +is more than one VFS in use then the "fs" parameter must be supplied. - Otherwise pass directories in as dir=path. Any parameter key - starting with dir will refresh that directory, eg - rclone rc vfs/refresh dir=home/junk dir2=data/misc +Accessing the remote control via HTTP - If the parameter recursive=true is given the whole directory tree - will get refreshed. This refresh will use --fast-list if enabled. - - This command takes an "fs" parameter. If this parameter is not - supplied and if there is only one VFS in use then that VFS will be - used. If there is more than one VFS in use then the "fs" parameter - must be supplied. +Rclone implements a simple HTTP based protocol. +Each endpoint takes an JSON object and returns a JSON object or an +error. The JSON objects are essentially a map of string names to values. +All calls must made using POST. - ## Accessing the remote control via HTTP +The input objects can be supplied using URL parameters, POST parameters +or by supplying "Content-Type: application/json" and a JSON blob in the +body. There are examples of these below using curl. - Rclone implements a simple HTTP based protocol. +The response will be a JSON blob in the body of the response. This is +formatted to be reasonably human readable. - Each endpoint takes an JSON object and returns a JSON object or an - error. The JSON objects are essentially a map of string names to - values. +Error returns - All calls must made using POST. +If an error occurs then there will be an HTTP error status (eg 500) and +the body of the response will contain a JSON encoded error object, eg - The input objects can be supplied using URL parameters, POST - parameters or by supplying "Content-Type: application/json" and a JSON - blob in the body. There are examples of these below using `curl`. + { + "error": "Expecting string value for key \"remote\" (was float64)", + "input": { + "fs": "/tmp", + "remote": 3 + }, + "status": 400 + "path": "operations/rmdir", + } - The response will be a JSON blob in the body of the response. This is - formatted to be reasonably human readable. +The keys in the error response are - error - error string - input - the +input parameters to the call - status - the HTTP status code - path - +the path of the call - ### Error returns +CORS - If an error occurs then there will be an HTTP error status (eg 500) - and the body of the response will contain a JSON encoded error object, - eg +The sever implements basic CORS support and allows all origins for that. +The response to a preflight OPTIONS request will echo the requested +"Access-Control-Request-Headers" back. -{ "error": "Expecting string value for key "remote" (was float64)", -"input": { "fs": "/tmp", "remote": 3 }, "status": 400 "path": -"operations/rmdir", } +Using POST with URL parameters only + curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' - The keys in the error response are - - error - error string - - input - the input parameters to the call - - status - the HTTP status code - - path - the path of the call +Response - ### CORS + { + "potato": "1", + "sausage": "2" + } - The sever implements basic CORS support and allows all origins for that. - The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back. +Here is what an error response looks like: - ### Using POST with URL parameters only + curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' -curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' + { + "error": "arbitrary error on input map[potato:1 sausage:2]", + "input": { + "potato": "1", + "sausage": "2" + } + } +Note that curl doesn't return errors to the shell unless you use the -f +option - Response + $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' + curl: (22) The requested URL returned error: 400 Bad Request + $ echo $? + 22 -{ "potato": "1", "sausage": "2" } +Using POST with a form + curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop - Here is what an error response looks like: +Response -curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' + { + "potato": "1", + "sausage": "2" + } -{ "error": "arbitrary error on input map[potato:1 sausage:2]", "input": -{ "potato": "1", "sausage": "2" } } +Note that you can combine these with URL parameters too with the POST +parameters taking precedence. + curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4" - Note that curl doesn't return errors to the shell unless you use the `-f` option +Response -$ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' -curl: (22) The requested URL returned error: 400 Bad Request $ echo $? -22 + { + "potato": "1", + "rutabaga": "3", + "sausage": "4" + } +Using POST with a JSON blob - ### Using POST with a form + curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop -curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop +response + { + "password": "xyz", + "username": "xyz" + } - Response +This can be combined with URL parameters too if required. The JSON blob +takes precedence. -{ "potato": "1", "sausage": "2" } + curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4' + { + "potato": 2, + "rutabaga": "3", + "sausage": 1 + } - Note that you can combine these with URL parameters too with the POST - parameters taking precedence. -curl --data "potato=1" --data "sausage=2" -"http://localhost:5572/rc/noop?rutabaga=3&sausage=4" +Debugging rclone with pprof +If you use the --rc flag this will also enable the use of the go +profiling tools on the same port. - Response +To use these, first install go. -{ "potato": "1", "rutabaga": "3", "sausage": "4" } +Debugging memory use +To profile rclone's memory use you can run: - ### Using POST with a JSON blob + go tool pprof -web http://localhost:5572/debug/pprof/heap -curl -H "Content-Type: application/json" -X POST -d -'{"potato":2,"sausage":1}' http://localhost:5572/rc/noop +This should open a page in your browser showing what is using what +memory. +You can also use the -text flag to produce a textual summary - response + $ go tool pprof -text http://localhost:5572/debug/pprof/heap + Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total + flat flat% sum% cum cum% + 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode + 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 + 0 0% 100% 1024.03kB 66.62% main.init + 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest + 0 0% 100% 513kB 33.38% net/http.(*conn).serve + 0 0% 100% 1024.03kB 66.62% runtime.main -{ "password": "xyz", "username": "xyz" } +Debugging go routine leaks +Memory leaks are most often caused by go routine leaks keeping memory +alive which should have been garbage collected. - This can be combined with URL parameters too if required. The JSON - blob takes precedence. +See all active go routines using -curl -H "Content-Type: application/json" -X POST -d -'{"potato":2,"sausage":1}' -'http://localhost:5572/rc/noop?rutabaga=3&potato=4' + curl http://localhost:5572/debug/pprof/goroutine?debug=1 -{ "potato": 2, "rutabaga": "3", "sausage": 1 } +Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your +browser. +Other profiles to look at - ## Debugging rclone with pprof ## +You can see a summary of profiles available at +http://localhost:5572/debug/pprof/ - If you use the `--rc` flag this will also enable the use of the go - profiling tools on the same port. +Here is how to use some of them: - To use these, first [install go](https://golang.org/doc/install). +- Memory: go tool pprof http://localhost:5572/debug/pprof/heap +- Go routines: + curl http://localhost:5572/debug/pprof/goroutine?debug=1 +- 30-second CPU profile: + go tool pprof http://localhost:5572/debug/pprof/profile +- 5-second execution trace: + wget http://localhost:5572/debug/pprof/trace?seconds=5 +- Goroutine blocking profile + - Enable first with: rclone rc debug/set-block-profile-rate rate=1 + (docs) + - go tool pprof http://localhost:5572/debug/pprof/block +- Contended mutexes: + - Enable first with: + rclone rc debug/set-mutex-profile-fraction rate=1 (docs) + - go tool pprof http://localhost:5572/debug/pprof/mutex - ### Debugging memory use +See the net/http/pprof docs for more info on how to use the profiling +and for a general overview see the Go team's blog post on profiling go +programs. - To profile rclone's memory use you can run: +The profiling hook is zero overhead unless it is used. - go tool pprof -web http://localhost:5572/debug/pprof/heap - This should open a page in your browser showing what is using what - memory. - You can also use the `-text` flag to produce a textual summary +OVERVIEW OF CLOUD STORAGE SYSTEMS -$ go tool pprof -text http://localhost:5572/debug/pprof/heap Showing -nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% -cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode -513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% -1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% -100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% -net/http.(_conn).readRequest 0 0% 100% 513kB 33.38% -net/http.(_conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main +Each cloud storage system is slightly different. Rclone attempts to +provide a unified interface to them, but some underlying differences +show through. - ### Debugging go routine leaks - Memory leaks are most often caused by go routine leaks keeping memory - alive which should have been garbage collected. +Features - See all active go routines using +Here is an overview of the major features of each cloud storage system. - curl http://localhost:5572/debug/pprof/goroutine?debug=1 + Name Hash ModTime Case Insensitive Duplicate Files MIME Type + ------------------------------ -------------- --------- ------------------ ----------------- ----------- + 1Fichier Whirlpool No No Yes R + Amazon Drive MD5 No Yes No R + Amazon S3 MD5 Yes No No R/W + Backblaze B2 SHA1 Yes No No R/W + Box SHA1 Yes Yes No - + Citrix ShareFile MD5 Yes Yes No - + Dropbox DBHASH † Yes Yes No - + FTP - No No No - + Google Cloud Storage MD5 Yes No No R/W + Google Drive MD5 Yes No Yes R/W + Google Photos - No No Yes R + HTTP - No No No R + Hubic MD5 Yes No No R/W + Jottacloud MD5 Yes Yes No R/W + Koofr MD5 No Yes No - + Mail.ru Cloud Mailru ‡‡‡ Yes Yes No - + Mega - No No Yes - + Memory MD5 Yes No No - + Microsoft Azure Blob Storage MD5 Yes No No R/W + Microsoft OneDrive SHA1 ‡‡ Yes Yes No R + OpenDrive MD5 Yes Yes Partial * - + OpenStack Swift MD5 Yes No No R/W + pCloud MD5, SHA1 Yes No No W + premiumize.me - No Yes No R + put.io CRC-32 Yes No Yes R + QingStor MD5 No No No R/W + Seafile - No No No - + SFTP MD5, SHA1 ‡ Yes Depends No - + SugarSync - No No No - + Tardigrade - Yes No No - + WebDAV MD5, SHA1 †† Yes ††† Depends No - + Yandex Disk MD5 Yes No No R/W + The local filesystem All Yes Depends No - - Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. +Hash - ### Other profiles to look at +The cloud storage system supports various hash types of the objects. The +hashes are used when transferring data as an integrity check and can be +specifically used with the --checksum flag in syncs and in the check +command. - You can see a summary of profiles available at http://localhost:5572/debug/pprof/ +To use the verify checksums when transferring between cloud storage +systems they must support a common hash type. - Here is how to use some of them: +† Note that Dropbox supports its own custom hash. This is an SHA256 sum +of all the 4MB block SHA256s. - - Memory: `go tool pprof http://localhost:5572/debug/pprof/heap` - - Go routines: `curl http://localhost:5572/debug/pprof/goroutine?debug=1` - - 30-second CPU profile: `go tool pprof http://localhost:5572/debug/pprof/profile` - - 5-second execution trace: `wget http://localhost:5572/debug/pprof/trace?seconds=5` - - Goroutine blocking profile - - Enable first with: `rclone rc debug/set-block-profile-rate rate=1` ([docs](#debug/set-block-profile-rate)) - - `go tool pprof http://localhost:5572/debug/pprof/block` - - Contended mutexes: - - Enable first with: `rclone rc debug/set-mutex-profile-fraction rate=1` ([docs](#debug/set-mutex-profile-fraction)) - - `go tool pprof http://localhost:5572/debug/pprof/mutex` +‡ SFTP supports checksums if the same login has shell access and md5sum +or sha1sum as well as echo are in the remote's PATH. + +†† WebDAV supports hashes when used with Owncloud and Nextcloud only. + +††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. + +‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive +for business and SharePoint server support Microsoft's own QuickXorHash. + +‡‡‡ Mail.ru uses its own modified SHA1 hash + +ModTime + +The cloud storage system supports setting modification times on objects. +If it does then this enables a using the modification times as part of +the sync. If not then only the size will be checked by default, though +the MD5SUM can be checked with the --checksum flag. + +All cloud storage systems support some kind of date on the object and +these will be set when transferring from the cloud storage system. + +Case Insensitive + +If a cloud storage systems is case sensitive then it is possible to have +two files which differ only in case, eg file.txt and FILE.txt. If a +cloud storage system is case insensitive then that isn't possible. + +This can cause problems when syncing between a case insensitive system +and a case sensitive system. The symptom of this is that no matter how +many times you run the sync it never completes fully. + +The local filesystem and SFTP may or may not be case sensitive depending +on OS. + +- Windows - usually case insensitive, though case is preserved +- OSX - usually case insensitive, though it is possible to format case + sensitive +- Linux - usually case sensitive, but there are case insensitive file + systems (eg FAT formatted USB keys) + +Most of the time this doesn't cause any problems as people tend to avoid +files whose name differs only by case even on case sensitive systems. + +Duplicate files + +If a cloud storage system allows duplicate files then it can have two +objects with the same name. + +This confuses rclone greatly when syncing - use the rclone dedupe +command to rename or remove duplicates. + +* Opendrive does not support creation of duplicate files using their web +client interface or other stock clients, but the underlying storage +platform has been determined to allow duplicate files, and it is +possible to create them with rclone. It may be that this is a mistake or +an unsupported feature. + +Restricted filenames + +Some cloud storage systems might have restrictions on the characters +that are usable in file or directory names. When rclone detects such a +name during a file upload, it will transparently replace the restricted +characters with similar looking Unicode characters. + +This process is designed to avoid ambiguous file names as much as +possible and allow to move files between many cloud storage systems +transparently. + +The name shown by rclone to the user or during log output will only +contain a minimal set of replaced characters to ensure correct +formatting and not necessarily the actual name used on the cloud +storage. + +This transformation is reversed when downloading a file or parsing +rclone arguments. For example, when uploading a file named my file?.txt +to Onedrive will be displayed as my file?.txt on the console, but stored +as my file？.txt (the ? gets replaced by the similar looking ？ +character) to Onedrive. The reverse transformation allows to read a +fileunusual/name.txt from Google Drive, by passing the name +unusual／name.txt (the / needs to be replaced by the similar looking ／ +character) on the command line. + +Default restricted characters + +The table below shows the characters that are replaced by default. + +When a replacement character is found in a filename, this character will +be escaped with the ‛ character to avoid ambiguous file names. (e.g. a +file named ␀.txt would shown as ‛␀.txt) + +Each cloud storage backend can use a different set of characters, which +will be specified in the documentation for each backend. + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + SOH 0x01 ␁ + STX 0x02 ␂ + ETX 0x03 ␃ + EOT 0x04 ␄ + ENQ 0x05 ␅ + ACK 0x06 ␆ + BEL 0x07 ␇ + BS 0x08 ␈ + HT 0x09 ␉ + LF 0x0A ␊ + VT 0x0B ␋ + FF 0x0C ␌ + CR 0x0D ␍ + SO 0x0E ␎ + SI 0x0F ␏ + DLE 0x10 ␐ + DC1 0x11 ␑ + DC2 0x12 ␒ + DC3 0x13 ␓ + DC4 0x14 ␔ + NAK 0x15 ␕ + SYN 0x16 ␖ + ETB 0x17 ␗ + CAN 0x18 ␘ + EM 0x19 ␙ + SUB 0x1A ␚ + ESC 0x1B ␛ + FS 0x1C ␜ + GS 0x1D ␝ + RS 0x1E ␞ + US 0x1F ␟ + / 0x2F ／ + DEL 0x7F ␡ + +The default encoding will also encode these file names as they are +problematic with many cloud storage systems. + + File name Replacement + ----------- ------------- + . ． + .. ．． + +Invalid UTF-8 bytes + +Some backends only support a sequence of well formed UTF-8 bytes as file +or directory names. + +In this case all invalid UTF-8 bytes will be replaced with a quoted +representation of the byte value to allow uploading a file to such a +backend. For example, the invalid byte 0xFE will be encoded as ‛FE. + +A common source of invalid UTF-8 bytes are local filesystems, that store +names in a different encoding than UTF-8 or UTF-16, like latin1. See the +local filenames section for details. + +Encoding option + +Most backends have an encoding options, specified as a flag +--backend-encoding where backend is the name of the backend, or as a +config parameter encoding (you'll need to select the Advanced config in +rclone config to see it). + +This will have default value which encodes and decodes characters in +such a way as to preserve the maximum number of characters (see above). + +However this can be incorrect in some scenarios, for example if you have +a Windows file system with characters such as ＊ and ？ that you want to +remain as those characters on the remote rather than being translated to +* and ?. + +The --backend-encoding flags allow you to change that. You can disable +the encoding completely with --backend-encoding None or set +encoding = None in the config file. + +Encoding takes a comma separated list of encodings. You can see the list +of all available characters by passing an invalid value to this flag, eg +--local-encoding "help" and rclone help flags encoding will show you the +defaults for the backends. + + Encoding Characters + --------------- ------------------------------------------------------------- + Asterisk * + BackQuote ` + BackSlash \ + Colon : + CrLf CR 0x0D, LF 0x0A + Ctl All control characters 0x00-0x1F + Del DEL 0x7F + Dollar $ + Dot . + DoubleQuote " + Hash # + InvalidUtf8 An invalid UTF-8 character (eg latin1) + LeftCrLfHtVt CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string + LeftPeriod . on the left of a string + LeftSpace SPACE on the left of a string + LeftTilde ~ on the left of a string + LtGt <, > + None No characters are encoded + Percent % + Pipe | + Question ? + RightCrLfHtVt CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string + RightPeriod . on the right of a string + RightSpace SPACE on the right of a string + SingleQuote ' + Slash / + +To take a specific example, the FTP backend's default encoding is + + --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot" + +However, let's say the FTP server is running on Windows and can't have +any of the invalid Windows characters in file names. You are backing up +Linux servers to this FTP server which do have those characters in file +names. So you would add the Windows set which are + + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot + +to the existing ones, giving: + + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace + +This can be specified using the --ftp-encoding flag or using an encoding +parameter in the config file. + +Or let's say you have a Windows server but you want to preserve ＊ and +？, you would then have this as the encoding (the Windows encoding minus +Asterisk and Question). + + Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot + +This can be specified using the --local-encoding flag or using an +encoding parameter in the config file. + +MIME Type + +MIME types (also known as media types) classify types of documents using +a simple text classification, eg text/html or application/pdf. + +Some cloud storage systems support reading (R) the MIME type of objects +and some support writing (W) the MIME type of objects. + +The MIME type can be important if you are serving files directly to HTTP +from the storage system. + +If you are copying from a remote which supports reading (R) to a remote +which supports writing (W) then rclone will preserve the MIME types. +Otherwise they will be guessed from the extension, or the remote itself +may assign the MIME type. + + +Optional Features + +All the remotes support a basic set of features, but there are some +optional features supported by some remotes used to make some operations +more efficient. + + Name Purge Copy Move DirMove CleanUp ListR StreamUpload LinkSharing About EmptyDir + ------------------------------ ------- ------ ------ --------- --------- ------- -------------- ------------- ------- ---------- + 1Fichier No No No No No No No No No Yes + Amazon Drive Yes No Yes Yes No #575 No No No #2178 No Yes + Amazon S3 No Yes No No Yes Yes Yes No #2178 No No + Backblaze B2 No Yes No No Yes Yes Yes Yes No No + Box Yes Yes Yes Yes Yes ‡‡ No Yes Yes No Yes + Citrix ShareFile Yes Yes Yes Yes No No Yes No No Yes + Dropbox Yes Yes Yes Yes No #575 No Yes Yes Yes Yes + FTP No No Yes Yes No No Yes No #2178 No Yes + Google Cloud Storage Yes Yes No No No Yes Yes No #2178 No No + Google Drive Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes + Google Photos No No No No No No No No No No + HTTP No No No No No No No No #2178 No Yes + Hubic Yes † Yes No No No Yes Yes No #2178 Yes No + Jottacloud Yes Yes Yes Yes Yes Yes No Yes Yes Yes + Mail.ru Cloud Yes Yes Yes Yes Yes No No Yes Yes Yes + Mega Yes No Yes Yes Yes No No No #2178 Yes Yes + Memory No Yes No No No Yes Yes No No No + Microsoft Azure Blob Storage Yes Yes No No No Yes Yes No #2178 No No + Microsoft OneDrive Yes Yes Yes Yes Yes No No Yes Yes Yes + OpenDrive Yes Yes Yes Yes No No No No No Yes + OpenStack Swift Yes † Yes No No No Yes Yes No #2178 Yes No + pCloud Yes Yes Yes Yes Yes No No Yes Yes Yes + premiumize.me Yes No Yes Yes No No No Yes Yes Yes + put.io Yes No Yes Yes Yes No Yes No #2178 Yes Yes + QingStor No Yes No No Yes Yes No No #2178 No No + Seafile Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes + SFTP No No Yes Yes No No Yes No #2178 Yes Yes + SugarSync Yes Yes Yes Yes No No Yes Yes No Yes + Tardigrade Yes † No No No No Yes Yes No No No + WebDAV Yes Yes Yes Yes No No Yes ‡ No #2178 Yes Yes + Yandex Disk Yes Yes Yes Yes Yes No Yes Yes Yes Yes + The local filesystem Yes No Yes Yes No No Yes No Yes Yes - See the [net/http/pprof docs](https://golang.org/pkg/net/http/pprof/) - for more info on how to use the profiling and for a general overview - see [the Go team's blog post on profiling go programs](https://blog.golang.org/profiling-go-programs). +Purge - The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). +This deletes a directory quicker than just deleting all the files in the +directory. - # Overview of cloud storage systems # +† Note Swift, Hubic, and Tardigrade implement this in order to delete +directory markers but they don't actually have a quicker way of deleting +files other than deleting them individually. - Each cloud storage system is slightly different. Rclone attempts to - provide a unified interface to them, but some underlying differences - show through. +‡ StreamUpload is not supported with Nextcloud - ## Features ## +Copy - Here is an overview of the major features of each cloud storage system. +Used when copying an object to and from the same remote. This known as a +server side copy so you can copy a file without downloading it and +uploading it again. It is used if you use rclone copy or rclone move if +the remote doesn't support Move directly. - | Name | Hash | ModTime | Case Insensitive | Duplicate Files | MIME Type | - | ---------------------------- |:-----------:|:-------:|:----------------:|:---------------:|:---------:| - | 1Fichier | Whirlpool | No | No | Yes | R | - | Amazon Drive | MD5 | No | Yes | No | R | - | Amazon S3 | MD5 | Yes | No | No | R/W | - | Backblaze B2 | SHA1 | Yes | No | No | R/W | - | Box | SHA1 | Yes | Yes | No | - | - | Citrix ShareFile | MD5 | Yes | Yes | No | - | - | Dropbox | DBHASH † | Yes | Yes | No | - | - | FTP | - | No | No | No | - | - | Google Cloud Storage | MD5 | Yes | No | No | R/W | - | Google Drive | MD5 | Yes | No | Yes | R/W | - | Google Photos | - | No | No | Yes | R | - | HTTP | - | No | No | No | R | - | Hubic | MD5 | Yes | No | No | R/W | - | Jottacloud | MD5 | Yes | Yes | No | R/W | - | Koofr | MD5 | No | Yes | No | - | - | Mail.ru Cloud | Mailru ‡‡‡ | Yes | Yes | No | - | - | Mega | - | No | No | Yes | - | - | Memory | MD5 | Yes | No | No | - | - | Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | - | Microsoft OneDrive | SHA1 ‡‡ | Yes | Yes | No | R | - | OpenDrive | MD5 | Yes | Yes | Partial \* | - | - | OpenStack Swift | MD5 | Yes | No | No | R/W | - | pCloud | MD5, SHA1 | Yes | No | No | W | - | premiumize.me | - | No | Yes | No | R | - | put.io | CRC-32 | Yes | No | Yes | R | - | QingStor | MD5 | No | No | No | R/W | - | Seafile | - | No | No | No | - | - | SFTP | MD5, SHA1 ‡ | Yes | Depends | No | - | - | SugarSync | - | No | No | No | - | - | Tardigrade | - | Yes | No | No | - | - | WebDAV | MD5, SHA1 ††| Yes ††† | Depends | No | - | - | Yandex Disk | MD5 | Yes | No | No | R/W | - | The local filesystem | All | Yes | Depends | No | - | - - ### Hash ### - - The cloud storage system supports various hash types of the objects. - The hashes are used when transferring data as an integrity check and - can be specifically used with the `--checksum` flag in syncs and in - the `check` command. - - To use the verify checksums when transferring between cloud storage - systems they must support a common hash type. - - † Note that Dropbox supports [its own custom - hash](https://www.dropbox.com/developers/reference/content-hash). - This is an SHA256 sum of all the 4MB block SHA256s. - - ‡ SFTP supports checksums if the same login has shell access and `md5sum` - or `sha1sum` as well as `echo` are in the remote's PATH. - - †† WebDAV supports hashes when used with Owncloud and Nextcloud only. - - ††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. - - ‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive - for business and SharePoint server support Microsoft's own - [QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). - - ‡‡‡ Mail.ru uses its own modified SHA1 hash - - ### ModTime ### - - The cloud storage system supports setting modification times on - objects. If it does then this enables a using the modification times - as part of the sync. If not then only the size will be checked by - default, though the MD5SUM can be checked with the `--checksum` flag. - - All cloud storage systems support some kind of date on the object and - these will be set when transferring from the cloud storage system. - - ### Case Insensitive ### - - If a cloud storage systems is case sensitive then it is possible to - have two files which differ only in case, eg `file.txt` and - `FILE.txt`. If a cloud storage system is case insensitive then that - isn't possible. - - This can cause problems when syncing between a case insensitive - system and a case sensitive system. The symptom of this is that no - matter how many times you run the sync it never completes fully. - - The local filesystem and SFTP may or may not be case sensitive - depending on OS. - - * Windows - usually case insensitive, though case is preserved - * OSX - usually case insensitive, though it is possible to format case sensitive - * Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys) - - Most of the time this doesn't cause any problems as people tend to - avoid files whose name differs only by case even on case sensitive - systems. - - ### Duplicate files ### - - If a cloud storage system allows duplicate files then it can have two - objects with the same name. - - This confuses rclone greatly when syncing - use the `rclone dedupe` - command to rename or remove duplicates. - - \* Opendrive does not support creation of duplicate files using - their web client interface or other stock clients, but the underlying - storage platform has been determined to allow duplicate files, and it - is possible to create them with `rclone`. It may be that this is a - mistake or an unsupported feature. - - ### Restricted filenames ### - - Some cloud storage systems might have restrictions on the characters - that are usable in file or directory names. - When `rclone` detects such a name during a file upload, it will - transparently replace the restricted characters with similar looking - Unicode characters. - - This process is designed to avoid ambiguous file names as much as - possible and allow to move files between many cloud storage systems - transparently. - - The name shown by `rclone` to the user or during log output will only - contain a minimal set of [replaced characters](#restricted-characters) - to ensure correct formatting and not necessarily the actual name used - on the cloud storage. - - This transformation is reversed when downloading a file or parsing - `rclone` arguments. - For example, when uploading a file named `my file?.txt` to Onedrive - will be displayed as `my file?.txt` on the console, but stored as - `my file？.txt` (the `?` gets replaced by the similar looking `？` - character) to Onedrive. - The reverse transformation allows to read a file`unusual/name.txt` - from Google Drive, by passing the name `unusual／name.txt` (the `/` needs - to be replaced by the similar looking `／` character) on the command line. - - #### Default restricted characters {#restricted-characters} - - The table below shows the characters that are replaced by default. - - When a replacement character is found in a filename, this character - will be escaped with the `‛` character to avoid ambiguous file names. - (e.g. a file named `␀.txt` would shown as `‛␀.txt`) - - Each cloud storage backend can use a different set of characters, - which will be specified in the documentation for each backend. - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | SOH | 0x01 | ␁ | - | STX | 0x02 | ␂ | - | ETX | 0x03 | ␃ | - | EOT | 0x04 | ␄ | - | ENQ | 0x05 | ␅ | - | ACK | 0x06 | ␆ | - | BEL | 0x07 | ␇ | - | BS | 0x08 | ␈ | - | HT | 0x09 | ␉ | - | LF | 0x0A | ␊ | - | VT | 0x0B | ␋ | - | FF | 0x0C | ␌ | - | CR | 0x0D | ␍ | - | SO | 0x0E | ␎ | - | SI | 0x0F | ␏ | - | DLE | 0x10 | ␐ | - | DC1 | 0x11 | ␑ | - | DC2 | 0x12 | ␒ | - | DC3 | 0x13 | ␓ | - | DC4 | 0x14 | ␔ | - | NAK | 0x15 | ␕ | - | SYN | 0x16 | ␖ | - | ETB | 0x17 | ␗ | - | CAN | 0x18 | ␘ | - | EM | 0x19 | ␙ | - | SUB | 0x1A | ␚ | - | ESC | 0x1B | ␛ | - | FS | 0x1C | ␜ | - | GS | 0x1D | ␝ | - | RS | 0x1E | ␞ | - | US | 0x1F | ␟ | - | / | 0x2F | ／ | - | DEL | 0x7F | ␡ | - - The default encoding will also encode these file names as they are - problematic with many cloud storage systems. - - | File name | Replacement | - | --------- |:-----------:| - | . | ． | - | .. | ．． | - - #### Invalid UTF-8 bytes {#invalid-utf8} - - Some backends only support a sequence of well formed UTF-8 bytes - as file or directory names. - - In this case all invalid UTF-8 bytes will be replaced with a quoted - representation of the byte value to allow uploading a file to such a - backend. For example, the invalid byte `0xFE` will be encoded as `‛FE`. - - A common source of invalid UTF-8 bytes are local filesystems, that store - names in a different encoding than UTF-8 or UTF-16, like latin1. See the - [local filenames](https://rclone.org/local/#filenames) section for details. - - #### Encoding option {#encoding} - - Most backends have an encoding options, specified as a flag - `--backend-encoding` where `backend` is the name of the backend, or as - a config parameter `encoding` (you'll need to select the Advanced - config in `rclone config` to see it). - - This will have default value which encodes and decodes characters in - such a way as to preserve the maximum number of characters (see - above). - - However this can be incorrect in some scenarios, for example if you - have a Windows file system with characters such as `＊` and `？` that - you want to remain as those characters on the remote rather than being - translated to `*` and `?`. - - The `--backend-encoding` flags allow you to change that. You can - disable the encoding completely with `--backend-encoding None` or set - `encoding = None` in the config file. - - Encoding takes a comma separated list of encodings. You can see the - list of all available characters by passing an invalid value to this - flag, eg `--local-encoding "help"` and `rclone help flags encoding` - will show you the defaults for the backends. - - | Encoding | Characters | - | --------- | ---------- | - | Asterisk | `*` | - | BackQuote | `` ` `` | - | BackSlash | `\` | - | Colon | `:` | - | CrLf | CR 0x0D, LF 0x0A | - | Ctl | All control characters 0x00-0x1F | - | Del | DEL 0x7F | - | Dollar | `$` | - | Dot | `.` | - | DoubleQuote | `"` | - | Hash | `#` | - | InvalidUtf8 | An invalid UTF-8 character (eg latin1) | - | LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string | - | LeftPeriod | `.` on the left of a string | - | LeftSpace | SPACE on the left of a string | - | LeftTilde | `~` on the left of a string | - | LtGt | `<`, `>` | - | None | No characters are encoded | - | Percent | `%` | - | Pipe | \| | - | Question | `?` | - | RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string | - | RightPeriod | `.` on the right of a string | - | RightSpace | SPACE on the right of a string | - | SingleQuote | `'` | - | Slash | `/` | - - To take a specific example, the FTP backend's default encoding is - - --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot" - - However, let's say the FTP server is running on Windows and can't have - any of the invalid Windows characters in file names. You are backing - up Linux servers to this FTP server which do have those characters in - file names. So you would add the Windows set which are - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - - to the existing ones, giving: - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace - - This can be specified using the `--ftp-encoding` flag or using an `encoding` parameter in the config file. - - Or let's say you have a Windows server but you want to preserve `＊` - and `？`, you would then have this as the encoding (the Windows - encoding minus `Asterisk` and `Question`). - - Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - - This can be specified using the `--local-encoding` flag or using an - `encoding` parameter in the config file. - - ### MIME Type ### - - MIME types (also known as media types) classify types of documents - using a simple text classification, eg `text/html` or - `application/pdf`. - - Some cloud storage systems support reading (`R`) the MIME type of - objects and some support writing (`W`) the MIME type of objects. - - The MIME type can be important if you are serving files directly to - HTTP from the storage system. - - If you are copying from a remote which supports reading (`R`) to a - remote which supports writing (`W`) then rclone will preserve the MIME - types. Otherwise they will be guessed from the extension, or the - remote itself may assign the MIME type. - - ## Optional Features ## - - All the remotes support a basic set of features, but there are some - optional features supported by some remotes used to make some - operations more efficient. - - | Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir | - | ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| :------: | - | 1Fichier | No | No | No | No | No | No | No | No | No | Yes | - | Amazon Drive | Yes | No | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Amazon S3 | No | Yes | No | No | Yes | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | Yes | No | No | - | Box | Yes | Yes | Yes | Yes | Yes ‡‡ | No | Yes | Yes | No | Yes | - | Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | Yes | No | No | Yes | - | Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | Yes | Yes | - | FTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Google Cloud Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Google Drive | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Google Photos | No | No | No | No | No | No | No | No | No | No | - | HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Hubic | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | - | Jottacloud | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | - | Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | Memory | No | Yes | No | No | No | Yes | Yes | No | No | No | - | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Microsoft OneDrive | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | - | OpenStack Swift | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | - | pCloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | premiumize.me | Yes | No | Yes | Yes | No | No | No | Yes | Yes | Yes | - | put.io | Yes | No | Yes | Yes | Yes | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | QingStor | No | Yes | No | No | Yes | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Seafile | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | - | Tardigrade | Yes † | No | No | No | No | Yes | Yes | No | No | No | - | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | - | The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | +If the server doesn't support Copy directly then for copy operations the +file is downloaded then re-uploaded. - ### Purge ### +Move - This deletes a directory quicker than just deleting all the files in - the directory. +Used when moving/renaming an object on the same remote. This is known as +a server side move of a file. This is used in rclone move if the server +doesn't support DirMove. - † Note Swift, Hubic, and Tardigrade implement this in order to delete - directory markers but they don't actually have a quicker way of deleting - files other than deleting them individually. - - ‡ StreamUpload is not supported with Nextcloud - - ### Copy ### - - Used when copying an object to and from the same remote. This known - as a server side copy so you can copy a file without downloading it - and uploading it again. It is used if you use `rclone copy` or - `rclone move` if the remote doesn't support `Move` directly. - - If the server doesn't support `Copy` directly then for copy operations - the file is downloaded then re-uploaded. - - ### Move ### - - Used when moving/renaming an object on the same remote. This is known - as a server side move of a file. This is used in `rclone move` if the - server doesn't support `DirMove`. - - If the server isn't capable of `Move` then rclone simulates it with - `Copy` then delete. If the server doesn't support `Copy` then rclone - will download the file and re-upload it. - - ### DirMove ### - - This is used to implement `rclone move` to move a directory if - possible. If it isn't then it will use `Move` on each file (which - falls back to `Copy` then download and upload - see `Move` section). - - ### CleanUp ### - - This is used for emptying the trash for a remote by `rclone cleanup`. - - If the server can't do `CleanUp` then `rclone cleanup` will return an - error. - - ‡‡ Note that while Box implements this it has to delete every file - idividually so it will be slower than emptying the trash via the WebUI - - ### ListR ### - - The remote supports a recursive list to list all the contents beneath - a directory quickly. This enables the `--fast-list` flag to work. - See the [rclone docs](https://rclone.org/docs/#fast-list) for more details. - - ### StreamUpload ### - - Some remotes allow files to be uploaded without knowing the file size - in advance. This allows certain operations to work without spooling the - file to local disk first, e.g. `rclone rcat`. - - ### LinkSharing ### - - Sets the necessary permissions on a file or folder and prints a link - that allows others to access them, even if they don't have an account - on the particular cloud provider. - - ### About ### - - This is used to fetch quota information from the remote, like bytes - used/free/quota and bytes used in the trash. - - This is also used to return the space used, available for `rclone mount`. - - If the server can't do `About` then `rclone about` will return an - error. - - ### EmptyDir ### - - The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations) - for details. Most Object/Bucket based remotes do not support this. - - # Global Flags - - This describes the global flags available to every rclone command - split into two groups, non backend and backend flags. - - ## Non Backend Flags - - These flags are available for every command. - - --ask-password Allow prompt for password for encrypted configuration. (default true) - --auto-confirm If enabled, do not request console confirmation. - --backup-dir string Make backups into hierarchy based in DIR. - --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. - --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) - --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. - --bwlimit-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. - --ca-cert string CA certificate used to verify servers - --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") - --check-first Do all the checks before starting transfers. - --checkers int Number of checkers to run in parallel. (default 8) - --c, --checksum Skip based on checksum (if available) & size, not -mod-time & size --client-cert string Client SSL certificate (PEM) for -mutual TLS auth --client-key string Client SSL private key (PEM) for -mutual TLS auth --compare-dest string Include additional server-side -path during comparison. --config string Config file. (default -"$HOME/.config/rclone/rclone.conf") --contimeout duration Connect -timeout (default 1m0s) --copy-dest string Implies --compare-dest but -also copies files from path into destination. --cpuprofile string Write -cpu profile to file --cutoff-mode string Mode to stop transfers when -reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") ---delete-after When synchronizing, delete files on destination after -transferring (default) --delete-before When synchronizing, delete files -on destination before transferring --delete-during When synchronizing, -delete files during transfer --delete-excluded Delete files on dest -excluded from sync --disable string Disable a comma separated list of -features. Use help to see a list. -n, --dry-run Do a trial run with no -permanent changes --dump DumpFlags List of items to dump from: -headers,bodies,requests,responses,auth,filters,goroutines,openfiles ---dump-bodies Dump HTTP headers and bodies - may contain sensitive info ---dump-headers Dump HTTP headers - may contain sensitive info ---error-on-no-transfer Sets exit code 9 if no files are transferred, -useful in scripts --exclude stringArray Exclude files matching pattern ---exclude-from stringArray Read exclude patterns from file (use - to -read from stdin) --exclude-if-present string Exclude directories if -filename is present --expect-continue-timeout duration Timeout when -using expect / 100-continue in HTTP (default 1s) --fast-list Use -recursive list if available. Uses more memory but fewer transactions. ---files-from stringArray Read list of source-file names from file (use - -to read from stdin) --files-from-raw stringArray Read list of -source-file names from file without any processing of lines (use - to -read from stdin) -f, --filter stringArray Add a file-filtering rule ---filter-from stringArray Read filtering patterns from a file (use - to -read from stdin) --header stringArray Set HTTP header for all -transactions --header-download stringArray Set HTTP header for download -transactions --header-upload stringArray Set HTTP header for upload -transactions --ignore-case Ignore case in filters (case insensitive) ---ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip -post copy check of checksums. --ignore-errors delete even if there are -I/O errors --ignore-existing Skip all files that exist on destination ---ignore-size Ignore size when skipping use mod-time or checksum. -I, ---ignore-times Don't skip files that match size and time - transfer all -files --immutable Do not modify files. Fail if existing files have been -modified. --include stringArray Include files matching pattern ---include-from stringArray Read include patterns from file (use - to -read from stdin) -i, --interactive Enable interactive mode --log-file -string Log everything to this file --log-format string Comma separated -list of log format options (default "date,time") --log-level string Log -level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") --low-level-retries int -Number of low level retries to do. (default 10) --max-age Duration Only -transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y -(default off) --max-backlog int Maximum number of objects in sync or -check backlog. (default 10000) --max-delete int When synchronizing, -limit the number of deletes (default -1) --max-depth int If set limits -the recursion depth to this. (default -1) --max-duration duration -Maximum duration rclone will transfer data for. --max-size SizeSuffix -Only transfer files smaller than this in k or suffix b|k|M|G (default -off) --max-stats-groups int Maximum number of stats groups to keep in -memory. On max oldest is discarded. (default 1000) --max-transfer -SizeSuffix Maximum size of data to transfer. (default off) --memprofile -string Write memory profile to file --min-age Duration Only transfer -files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) ---min-size SizeSuffix Only transfer files bigger than this in k or -suffix b|k|M|G (default off) --modify-window duration Max time diff to -be considered the same (default 1ns) --multi-thread-cutoff SizeSuffix -Use multi-thread downloads for files above this size. (default 250M) ---multi-thread-streams int Max number of streams to use for multi-thread -downloads. (default 4) --no-check-certificate Do not verify the server -SSL certificate. Insecure. --no-check-dest Don't check the destination, -copy regardless. --no-gzip-encoding Don't set Accept-Encoding: gzip. ---no-traverse Don't traverse destination file system on copy. ---no-unicode-normalization Don't normalize unicode characters in -filenames. --no-update-modtime Don't update destination mod-time if -files identical. --order-by string Instructions on how to order the -transfers, eg 'size,descending' --password-command SpaceSepList Command -for supplying password for encrypted configuration. -P, --progress Show -progress during transfer. -q, --quiet Print as little stuff as possible ---rc Enable the remote control server. --rc-addr string IPaddress:Port -or :Port to bind server to. (default "localhost:5572") --rc-allow-origin -string Set the allowed origin for CORS. --rc-baseurl string Prefix for -URLs - leave blank for root. --rc-cert string SSL PEM key (concatenation -of certificate and CA certificate) --rc-client-ca string Client -certificate authority to verify clients with --rc-enable-metrics Enable -prometheus metrics on /metrics --rc-files string Path to local files to -serve on the HTTP server. --rc-htpasswd string htpasswd file - if not -provided no authentication is done --rc-job-expire-duration duration -expire finished async jobs older than this value (default 1m0s) ---rc-job-expire-interval duration interval to check for expired async -jobs (default 10s) --rc-key string SSL PEM Private key ---rc-max-header-bytes int Maximum size of request header (default 4096) ---rc-no-auth Don't require auth for certain methods. --rc-pass string -Password for authentication. --rc-realm string realm for authentication -(default "rclone") --rc-serve Enable the serving of remote objects. ---rc-server-read-timeout duration Timeout for server reading data -(default 1h0m0s) --rc-server-write-timeout duration Timeout for server -writing data (default 1h0m0s) --rc-template string User Specified -Template. --rc-user string User name for authentication. ---rc-web-fetch-url string URL to fetch the releases for webgui. (default -"https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") ---rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force -update to latest version of web gui --rc-web-gui-no-open-browser Don't -open the browser automatically --rc-web-gui-update Check and update to -latest version of web gui --refresh-times Refresh the modtime of remote -files. --retries int Retry operations this many times if they fail -(default 3) --retries-sleep duration Interval between retrying -operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) --size-only -Skip based on size only, not mod-time or checksum --stats duration -Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) -(default 1m0s) --stats-file-name-length int Max file name length in -stats. 0 for no limit (default 45) --stats-log-level string Log level to -show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") ---stats-one-line Make the stats fit on one line. --stats-one-line-date -Enables --stats-one-line and add current date/time prefix. ---stats-one-line-date-format string Enables --stats-one-line-date and -uses custom formatted date. Enclose date string in double quotes ("). -See https://golang.org/pkg/time/#Time.Format --stats-unit string Show -data rate in stats as either 'bits' or 'bytes'/s (default "bytes") ---streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked -upload if file size is unknown. Upload starts after reaching cutoff or -when file ends. (default 100k) --suffix string Suffix to add to changed -files. --suffix-keep-extension Preserve the extension when using ---suffix. --syslog Use Syslog for logging --syslog-facility string -Facility for syslog, eg KERN,USER,... (default "DAEMON") --timeout -duration IO idle timeout (default 5m0s) --tpslimit float Limit HTTP -transactions per second to this. --tpslimit-burst int Max burst of -transactions for --tpslimit. (default 1) --track-renames When -synchronizing, track file renames and do a server side move if possible ---track-renames-strategy string Strategies to use when synchronizing -using track-renames hash|modtime|leaf (default "hash") --transfers int -Number of file transfers to run in parallel. (default 4) -u, --update -Skip files that are newer on the destination. --use-cookies Enable -session cookiejar. --use-json-log Use json log format. --use-mmap Use -mmap allocator (see docs). --use-server-modtime Use server modified time -instead of object metadata --user-agent string Set the user-agent to a -specified string. The default is rclone/ version (default -"rclone/v1.53.0") -v, --verbose count Print lots more stuff (repeat for -more) - - - ## Backend Flags - - These flags are available for every command. They control the backends - and may be set in the config file. - - --acd-auth-url string Auth server URL. - --acd-client-id string OAuth Client Id - --acd-client-secret string OAuth Client Secret - --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) - --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - --acd-token string OAuth Access Token as a JSON blob. - --acd-token-url string Token server url. - --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) - --alias-remote string Remote or path to alias. - --azureblob-access-tier string Access tier of blob: hot, cool or archive. - --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) - --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) - --azureblob-disable-checksum Don't store MD5 checksum with object metadata. - --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) - --azureblob-endpoint string Endpoint for the service - --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) - --azureblob-list-chunk int Size of blob list. (default 5000) - --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --azureblob-sas-url string SAS URL for container level access only - --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) - --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) - --b2-account string Account ID or Application Key ID - --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) - --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) - --b2-disable-checksum Disable checksums for large (> upload cutoff) files - --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) - --b2-download-url string Custom endpoint for downloads. - --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - --b2-endpoint string Endpoint for the service. - --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. - --b2-key string Application Key - --b2-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - --b2-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. - --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) - --b2-versions Include old versions in directory listings. - --box-access-token string Box App Primary Access Token - --box-auth-url string Auth server URL. - --box-box-config-file string Box App config.json location - --box-box-sub-type string (default "user") - --box-client-id string OAuth Client Id - --box-client-secret string OAuth Client Secret - --box-commit-retries int Max number of times to try committing a multipart file. (default 100) - --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) - --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. - --box-token string OAuth Access Token as a JSON blob. - --box-token-url string Token server url. - --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) - --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) - --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. - --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") - --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) - --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) - --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") - --cache-db-purge Clear all the cached data for this remote on start. - --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) - --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) - --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server - --cache-plex-password string The password of the Plex user (obscured) - --cache-plex-url string The URL of the Plex server - --cache-plex-username string The username of the Plex user - --cache-read-retries int How many times to retry a read from a cache storage. (default 10) - --cache-remote string Remote to cache. - --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) - --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. - --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) - --cache-workers int How many workers should run in parallel to download chunks. (default 4) - --cache-writes Cache file data on writes through the FS - --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) - --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. - --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") - --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") - --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") - --chunker-remote string Remote to chunk/unchunk. - --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) - --L, --copy-links Follow symlinks and copy the pointed to item. ---crypt-directory-name-encryption Option to either encrypt directory -names or leave them intact. (default true) --crypt-filename-encryption -string How to encrypt the filenames. (default "standard") ---crypt-password string Password or pass phrase for encryption. -(obscured) --crypt-password2 string Password or pass phrase for salt. -Optional but recommended. (obscured) --crypt-remote string Remote to -encrypt/decrypt. --crypt-server-side-across-configs Allow server side -operations (eg copy) to work across different crypt configs. ---crypt-show-mapping For all files listed show how the names encrypt. ---drive-acknowledge-abuse Set to allow files which return -cannotDownloadAbusiveFile to be downloaded. ---drive-allow-import-name-change Allow the filetype to change when -uploading Google docs (e.g. file.doc to file.docx). This will confuse -sync and reupload every time. --drive-auth-owner-only Only consider -files owned by the authenticated user. --drive-auth-url string Auth -server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a -power of 2 >= 256k. (default 8M) --drive-client-id string OAuth Client -Id --drive-client-secret string OAuth Client Secret ---drive-disable-http2 Disable drive using http2 (default true) ---drive-encoding MultiEncoder This sets the encoding for the backend. -(default InvalidUtf8) --drive-export-formats string Comma separated list -of preferred formats for downloading Google docs. (default -"docx,xlsx,pptx,svg") --drive-formats string Deprecated: see -export_formats --drive-impersonate string Impersonate this user when -using a service account. --drive-import-formats string Comma separated -list of preferred formats for uploading Google docs. ---drive-keep-revision-forever Keep new head revision of each file -forever. --drive-list-chunk int Size of listing chunk 100-1000. 0 to -disable. (default 1000) --drive-pacer-burst int Number of API calls to -allow without sleeping. (default 100) --drive-pacer-min-sleep Duration -Minimum time to sleep between API calls. (default 100ms) ---drive-root-folder-id string ID of the root folder --drive-scope string -Scope that rclone should use when requesting access from drive. ---drive-server-side-across-configs Allow server side operations (eg -copy) to work across different drive configs. ---drive-service-account-credentials string Service Account Credentials -JSON blob --drive-service-account-file string Service Account -Credentials JSON file path --drive-shared-with-me Only show files that -are shared with me. --drive-size-as-quota Show sizes as storage quota -usage, not actual size. --drive-skip-checksum-gphotos Skip MD5 checksum -on Google photos and videos only. --drive-skip-gdocs Skip google -documents in all listings. --drive-skip-shortcuts If set skip shortcut -files --drive-starred-only Only show files that are starred. ---drive-stop-on-upload-limit Make upload limit errors be fatal ---drive-team-drive string ID of the Team Drive --drive-token string -OAuth Access Token as a JSON blob. --drive-token-url string Token server -url. --drive-trashed-only Only show files that are in the trash. ---drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload -(default 8M) --drive-use-created-date Use file created date instead of -modified date., --drive-use-shared-date Use date file was shared instead -of modified date. --drive-use-trash Send files to the trash instead of -deleting permanently. (default true) --drive-v2-download-min-size -SizeSuffix If Object's are greater, use drive v2 API to download. -(default off) --dropbox-auth-url string Auth server URL. ---dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default -48M) --dropbox-client-id string OAuth Client Id --dropbox-client-secret -string OAuth Client Secret --dropbox-encoding MultiEncoder This sets the -encoding for the backend. (default -Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-impersonate -string Impersonate this user when using a business account. ---dropbox-token string OAuth Access Token as a JSON blob. ---dropbox-token-url string Token server url. --fichier-api-key string -Your API Key, get it from https://1fichier.com/console/params.pl ---fichier-encoding MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) ---fichier-shared-folder string If you want to download a shared folder, -add this parameter --ftp-concurrency int Maximum number of FTP -simultaneous connections, 0 for unlimited --ftp-disable-epsv Disable -using EPSV even if server advertises support --ftp-encoding MultiEncoder -This sets the encoding for the backend. (default -Slash,Del,Ctl,RightSpace,Dot) --ftp-explicit-tls Use FTP over TLS -(Explicit) --ftp-host string FTP host to connect to ---ftp-no-check-certificate Do not verify the TLS certificate of the -server --ftp-pass string FTP password (obscured) --ftp-port string FTP -port, leave blank to use default (21) --ftp-tls Use FTPS over TLS -(Implicit) --ftp-user string FTP username, leave blank for current -username, $USER --gcs-anonymous Access public buckets and objects -without credentials --gcs-auth-url string Auth server URL. ---gcs-bucket-acl string Access Control List for new buckets. ---gcs-bucket-policy-only Access checks should use bucket-level IAM -policies. --gcs-client-id string OAuth Client Id --gcs-client-secret -string OAuth Client Secret --gcs-encoding MultiEncoder This sets the -encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) ---gcs-location string Location for the newly created buckets. ---gcs-object-acl string Access Control List for new objects. ---gcs-project-number string Project number. --gcs-service-account-file -string Service Account Credentials JSON file path --gcs-storage-class -string The storage class to use when storing objects in Google Cloud -Storage. --gcs-token string OAuth Access Token as a JSON blob. ---gcs-token-url string Token server url. --gphotos-auth-url string Auth -server URL. --gphotos-client-id string OAuth Client Id ---gphotos-client-secret string OAuth Client Secret --gphotos-read-only -Set to make the Google Photos backend read only. --gphotos-read-size Set -to read the size of media items. --gphotos-start-year int Year limits -the photos to be downloaded to those which are uploaded after the given -year (default 2000) --gphotos-token string OAuth Access Token as a JSON -blob. --gphotos-token-url string Token server url. --http-headers -CommaSepList Set HTTP headers for all transactions --http-no-head Don't -use HEAD requests to find file sizes in dir listing --http-no-slash Set -this if the site doesn't end directories with / --http-url string URL of -http host to connect to --hubic-auth-url string Auth server URL. ---hubic-chunk-size SizeSuffix Above this size files will be chunked into -a _segments container. (default 5G) --hubic-client-id string OAuth -Client Id --hubic-client-secret string OAuth Client Secret ---hubic-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8) --hubic-no-chunk Don't chunk files during -streaming upload. --hubic-token string OAuth Access Token as a JSON -blob. --hubic-token-url string Token server url. --jottacloud-encoding -MultiEncoder This sets the encoding for the backend. (default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) ---jottacloud-hard-delete Delete files permanently rather than putting -them into the trash. --jottacloud-md5-memory-limit SizeSuffix Files -bigger than this will be cached on disk to calculate the MD5 if -required. (default 10M) --jottacloud-trashed-only Only show files that -are in the trash. --jottacloud-upload-resume-limit SizeSuffix Files -bigger than this can be resumed if the upload fail's. (default 10M) ---koofr-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --koofr-endpoint -string The Koofr API endpoint to use (default "https://app.koofr.net") ---koofr-mountid string Mount ID of the mount to use. If omitted, the -primary mount is used. --koofr-password string Your Koofr password for -rclone (generate one at -https://app.koofr.net/app/admin/preferences/password) (obscured) ---koofr-setmtime Does the backend support setting modification time. Set -this to false if you use a mount ID that points to a Dropbox or Amazon -Drive backend. (default true) --koofr-user string Your Koofr user name --l, --links Translate symlinks to/from regular files with a -'.rclonelink' extension --local-case-insensitive Force the filesystem to -report itself as case insensitive --local-case-sensitive Force the -filesystem to report itself as case sensitive. --local-encoding -MultiEncoder This sets the encoding for the backend. (default Slash,Dot) ---local-no-check-updated Don't check to see if the files change during -upload --local-no-set-modtime Disable setting modtime --local-no-sparse -Disable sparse files for multi-thread downloads ---local-no-unicode-normalization Don't apply unicode normalization to -paths and filenames (Deprecated) --local-nounc string Disable UNC (long -path names) conversion on Windows --mailru-check-hash What should copy -do if file checksum is mismatched or invalid (default true) ---mailru-encoding MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) ---mailru-pass string Password (obscured) --mailru-speedup-enable Skip -full upload if there is another file with same data hash. (default true) ---mailru-speedup-file-patterns string Comma separated list of file name -patterns eligible for speedup (put by hash). (default -"_.mkv,_.avi,_.mp4,_.mp3,_.zip,_.gz,_.rar,_.pdf") ---mailru-speedup-max-disk SizeSuffix This option allows you to disable -speedup (put by hash) for large files (default 3G) ---mailru-speedup-max-memory SizeSuffix Files larger than the size given -below will always be hashed on disk. (default 32M) --mailru-user string -User name (usually email) --mega-debug Output more debug from Mega. ---mega-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8,Dot) --mega-hard-delete Delete files -permanently rather than putting them into the trash. --mega-pass string -Password. (obscured) --mega-user string User name -x, --one-file-system -Don't cross filesystem boundaries (unix/macOS only). --onedrive-auth-url -string Auth server URL. --onedrive-chunk-size SizeSuffix Chunk size to -upload files with - must be multiple of 320k (327,680 bytes). (default -10M) --onedrive-client-id string OAuth Client Id ---onedrive-client-secret string OAuth Client Secret --onedrive-drive-id -string The ID of the drive to use --onedrive-drive-type string The type -of the drive ( personal | business | documentLibrary ) ---onedrive-encoding MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) ---onedrive-expose-onenote-files Set to make OneNote files show up in -directory listings. --onedrive-no-versions Remove all versions on -modifying operations --onedrive-server-side-across-configs Allow server -side operations (eg copy) to work across different onedrive configs. ---onedrive-token string OAuth Access Token as a JSON blob. ---onedrive-token-url string Token server url. --opendrive-chunk-size -SizeSuffix Files will be uploaded in chunks this size. (default 10M) ---opendrive-encoding MultiEncoder This sets the encoding for the -backend. (default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) ---opendrive-password string Password. (obscured) --opendrive-username -string Username --pcloud-auth-url string Auth server URL. ---pcloud-client-id string OAuth Client Id --pcloud-client-secret string -OAuth Client Secret --pcloud-encoding MultiEncoder This sets the -encoding for the backend. (default -Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --pcloud-hostname string -Hostname to connect to. (default "api.pcloud.com") ---pcloud-root-folder-id string Fill in for rclone to use a non root -folder as its starting point. (default "d0") --pcloud-token string OAuth -Access Token as a JSON blob. --pcloud-token-url string Token server url. ---premiumizeme-encoding MultiEncoder This sets the encoding for the -backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) ---putio-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) ---qingstor-access-key-id string QingStor Access Key ID ---qingstor-chunk-size SizeSuffix Chunk size to use for uploading. -(default 4M) --qingstor-connection-retries int Number of connection -retries. (default 3) --qingstor-encoding MultiEncoder This sets the -encoding for the backend. (default Slash,Ctl,InvalidUtf8) ---qingstor-endpoint string Enter an endpoint URL to connection QingStor -API. --qingstor-env-auth Get QingStor credentials from runtime. Only -applies if access_key_id and secret_access_key is blank. ---qingstor-secret-access-key string QingStor Secret Access Key -(password) --qingstor-upload-concurrency int Concurrency for multipart -uploads. (default 1) --qingstor-upload-cutoff SizeSuffix Cutoff for -switching to chunked upload (default 200M) --qingstor-zone string Zone -to connect to. --s3-access-key-id string AWS Access Key ID. --s3-acl -string Canned ACL used when creating buckets and storing or copying -objects. --s3-bucket-acl string Canned ACL used when creating buckets. ---s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) ---s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy -(default 4.656G) --s3-disable-checksum Don't store MD5 checksum with -object metadata --s3-encoding MultiEncoder This sets the encoding for -the backend. (default Slash,InvalidUtf8,Dot) --s3-endpoint string -Endpoint for S3 API. --s3-env-auth Get AWS credentials from runtime -(environment variables or EC2/ECS meta data if no env vars). ---s3-force-path-style If true use path style access if false use virtual -hosted style. (default true) --s3-leave-parts-on-error If true avoid -calling abort upload on a failure, leaving all successfully uploaded -parts on S3 for manual recovery. --s3-list-chunk int Size of listing -chunk (response list for each ListObject S3 request). (default 1000) ---s3-location-constraint string Location constraint - must be set to -match the Region. --s3-max-upload-parts int Maximum number of parts in a -multipart upload. (default 10000) --s3-memory-pool-flush-time Duration -How often internal memory buffer pools will be flushed. (default 1m0s) ---s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory -pool. --s3-no-check-bucket If set don't attempt to check the bucket -exists or create it --s3-profile string Profile to use in the shared -credentials file --s3-provider string Choose your S3 provider. ---s3-region string Region to connect to. --s3-secret-access-key string -AWS Secret Access Key (password) --s3-server-side-encryption string The -server-side encryption algorithm used when storing this object in S3. ---s3-session-token string An AWS session token ---s3-shared-credentials-file string Path to the shared credentials file ---s3-sse-customer-algorithm string If using SSE-C, the server-side -encryption algorithm used when storing this object in S3. ---s3-sse-customer-key string If using SSE-C you must provide the secret -encryption key used to encrypt/decrypt your data. ---s3-sse-customer-key-md5 string If using SSE-C you must provide the -secret encryption key MD5 checksum. --s3-sse-kms-key-id string If using -KMS ID you must provide the ARN of Key. --s3-storage-class string The -storage class to use when storing new objects in S3. ---s3-upload-concurrency int Concurrency for multipart uploads. (default -4) --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload -(default 200M) --s3-use-accelerate-endpoint If true use the AWS S3 -accelerated endpoint. --s3-v2-auth If true use v2 authentication. ---seafile-2fa Two-factor authentication ('true' if the account has 2FA -enabled) --seafile-create-library Should rclone create a library if it -doesn't exist --seafile-encoding MultiEncoder This sets the encoding for -the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) ---seafile-library string Name of the library. Leave blank to access all -non-encrypted libraries. --seafile-library-key string Library password -(for encrypted libraries only). Leave blank if you pass it through the -command line. (obscured) --seafile-pass string Password (obscured) ---seafile-url string URL of seafile host to connect to --seafile-user -string User name (usually email address) --sftp-ask-password Allow -asking for SFTP password when needed. --sftp-disable-hashcheck Disable -the execution of SSH commands to determine if remote file hashing is -available. --sftp-host string SSH host to connect to --sftp-key-file -string Path to PEM-encoded private key file, leave blank or set -key-use-agent to use ssh-agent. --sftp-key-file-pass string The -passphrase to decrypt the PEM-encoded private key file. (obscured) ---sftp-key-pem string Raw PEM-encoded private key, If specified, will -override key_file parameter. --sftp-key-use-agent When set forces the -usage of the ssh-agent. --sftp-md5sum-command string The command used to -read md5 hashes. Leave blank for autodetect. --sftp-pass string SSH -password, leave blank to use ssh-agent. (obscured) --sftp-path-override -string Override path used by SSH connection. --sftp-port string SSH -port, leave blank to use default (22) --sftp-server-command string -Specifies the path or command to run a sftp server on the remote host. ---sftp-set-modtime Set the modified time on the remote if set. (default -true) --sftp-sha1sum-command string The command used to read sha1 -hashes. Leave blank for autodetect. --sftp-skip-links Set to skip any -symlinks and any other non regular files. --sftp-subsystem string -Specifies the SSH2 subsystem on the remote host. (default "sftp") ---sftp-use-insecure-cipher Enable the use of insecure ciphers and key -exchange methods. --sftp-user string SSH username, leave blank for -current username, ncw --sharefile-chunk-size SizeSuffix Upload chunk -size. Must a power of 2 >= 256k. (default 64M) --sharefile-encoding -MultiEncoder This sets the encoding for the backend. (default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) ---sharefile-endpoint string Endpoint for API calls. ---sharefile-root-folder-id string ID of the root folder ---sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart -upload. (default 128M) --skip-links Don't warn about skipped symlinks. ---sugarsync-access-key-id string Sugarsync Access Key ID. ---sugarsync-app-id string Sugarsync App ID. --sugarsync-authorization -string Sugarsync authorization --sugarsync-authorization-expiry string -Sugarsync authorization expiry --sugarsync-deleted-id string Sugarsync -deleted folder id --sugarsync-encoding MultiEncoder This sets the -encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) ---sugarsync-hard-delete Permanently delete files if true ---sugarsync-private-access-key string Sugarsync Private Access Key ---sugarsync-refresh-token string Sugarsync refresh token ---sugarsync-root-id string Sugarsync root id --sugarsync-user string -Sugarsync user --swift-application-credential-id string Application -Credential ID (OS_APPLICATION_CREDENTIAL_ID) ---swift-application-credential-name string Application Credential Name -(OS_APPLICATION_CREDENTIAL_NAME) --swift-application-credential-secret -string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) ---swift-auth string Authentication URL for server (OS_AUTH_URL). ---swift-auth-token string Auth Token from alternate authentication - -optional (OS_AUTH_TOKEN) --swift-auth-version int AuthVersion - optional -- set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) ---swift-chunk-size SizeSuffix Above this size files will be chunked into -a _segments container. (default 5G) --swift-domain string User domain - -optional (v3 auth) (OS_USER_DOMAIN_NAME) --swift-encoding MultiEncoder -This sets the encoding for the backend. (default Slash,InvalidUtf8) ---swift-endpoint-type string Endpoint type to choose from the service -catalogue (OS_ENDPOINT_TYPE) (default "public") --swift-env-auth Get -swift credentials from environment variables in standard OpenStack form. ---swift-key string API key or password (OS_PASSWORD). --swift-no-chunk -Don't chunk files during streaming upload. --swift-region string Region -name - optional (OS_REGION_NAME) --swift-storage-policy string The -storage policy to use when creating a new container --swift-storage-url -string Storage URL - optional (OS_STORAGE_URL) --swift-tenant string -Tenant name - optional for v1 auth, this or tenant_id required otherwise -(OS_TENANT_NAME or OS_PROJECT_NAME) --swift-tenant-domain string Tenant -domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) --swift-tenant-id -string Tenant ID - optional for v1 auth, this or tenant required -otherwise (OS_TENANT_ID) --swift-user string User name to log in -(OS_USERNAME). --swift-user-id string User ID to log in - optional - -most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). ---tardigrade-access-grant string Access Grant. --tardigrade-api-key -string API Key. --tardigrade-passphrase string Encryption Passphrase. To -access existing objects enter passphrase used for uploading. ---tardigrade-provider string Choose an authentication method. (default -"existing") --tardigrade-satellite-address @ -: Satellite Address. Custom satellite address should match the format: @ -:. (default "us-central-1.tardigrade.io") --union-action-policy string -Policy to choose upstream on ACTION category. (default "epall") ---union-cache-time int Cache time of usage and free space (in seconds). -This option is only useful when a path preserving policy is used. -(default 120) --union-create-policy string Policy to choose upstream on -CREATE category. (default "epmfs") --union-search-policy string Policy -to choose upstream on SEARCH category. (default "ff") --union-upstreams -string List of space separated upstreams. --webdav-bearer-token string -Bearer token instead of user/pass (eg a Macaroon) ---webdav-bearer-token-command string Command to run to get a bearer -token --webdav-pass string Password. (obscured) --webdav-url string URL -of http host to connect to --webdav-user string User name ---webdav-vendor string Name of the Webdav site/service/software you are -using --yandex-auth-url string Auth server URL. --yandex-client-id -string OAuth Client Id --yandex-client-secret string OAuth Client Secret ---yandex-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-token string OAuth -Access Token as a JSON blob. --yandex-token-url string Token server url. - - - 1Fichier - ----------------------------------------- - - This is a backend for the [1fichier](https://1fichier.com) cloud - storage service. Note that a Premium subscription is required to use - the API. - - Paths are specified as `remote:path` - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - The initial setup for 1Fichier involves getting the API key from the website which you - need to do in your browser. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value [snip] XX / -1Fichier  "fichier" [snip] Storage> fichier ** See help for fichier -backend at: https://rclone.org/fichier/ ** - -Your API Key, get it from https://1fichier.com/console/params.pl Enter a -string value. Press Enter for the default (""). api_key> example_key - -Edit advanced config? (y/n) y) Yes n) No y/n> Remote config --------------------- [remote] type = fichier api_key = example_key --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - Once configured you can then use `rclone` like this, - - List directories in top level of your 1Fichier account - - rclone lsd remote: - - List all the files in your 1Fichier account - - rclone ls remote: - - To copy a local directory to a 1Fichier directory called backup - - rclone copy /home/source remote:backup - - ### Modified time and hashes ### - - 1Fichier does not support modification times. It supports the Whirlpool hash algorithm. - - ### Duplicated files ### - - 1Fichier can have two files with exactly the same name and path (unlike a - normal file system). - - Duplicated files cause problems with the syncing and you will see - messages in the log about duplicates. - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | - | < | 0x3C | ＜ | - | > | 0x3E | ＞ | - | " | 0x22 | ＂ | - | $ | 0x24 | ＄ | - | ` | 0x60 | ｀ | - | ' | 0x27 | ＇ | - - File names can also not start or end with the following characters. - These only get replaced if they are the first or last character in the - name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to fichier (1Fichier). - - #### --fichier-api-key +If the server isn't capable of Move then rclone simulates it with Copy +then delete. If the server doesn't support Copy then rclone will +download the file and re-upload it. + +DirMove + +This is used to implement rclone move to move a directory if possible. +If it isn't then it will use Move on each file (which falls back to Copy +then download and upload - see Move section). + +CleanUp + +This is used for emptying the trash for a remote by rclone cleanup. + +If the server can't do CleanUp then rclone cleanup will return an error. + +‡‡ Note that while Box implements this it has to delete every file +idividually so it will be slower than emptying the trash via the WebUI + +ListR + +The remote supports a recursive list to list all the contents beneath a +directory quickly. This enables the --fast-list flag to work. See the +rclone docs for more details. + +StreamUpload + +Some remotes allow files to be uploaded without knowing the file size in +advance. This allows certain operations to work without spooling the +file to local disk first, e.g. rclone rcat. + +LinkSharing + +Sets the necessary permissions on a file or folder and prints a link +that allows others to access them, even if they don't have an account on +the particular cloud provider. + +About + +This is used to fetch quota information from the remote, like bytes +used/free/quota and bytes used in the trash. + +This is also used to return the space used, available for rclone mount. + +If the server can't do About then rclone about will return an error. + +EmptyDir + +The remote supports empty directories. See Limitations for details. Most +Object/Bucket based remotes do not support this. + + + +GLOBAL FLAGS + + +This describes the global flags available to every rclone command split +into two groups, non backend and backend flags. + + +Non Backend Flags + +These flags are available for every command. + + --ask-password Allow prompt for password for encrypted configuration. (default true) + --auto-confirm If enabled, do not request console confirmation. + --backup-dir string Make backups into hierarchy based in DIR. + --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) + --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + --bwlimit-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. + --ca-cert string CA certificate used to verify servers + --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") + --check-first Do all the checks before starting transfers. + --checkers int Number of checkers to run in parallel. (default 8) + -c, --checksum Skip based on checksum (if available) & size, not mod-time & size + --client-cert string Client SSL certificate (PEM) for mutual TLS auth + --client-key string Client SSL private key (PEM) for mutual TLS auth + --compare-dest string Include additional server-side path during comparison. + --config string Config file. (default "$HOME/.config/rclone/rclone.conf") + --contimeout duration Connect timeout (default 1m0s) + --copy-dest string Implies --compare-dest but also copies files from path into destination. + --cpuprofile string Write cpu profile to file + --cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") + --delete-after When synchronizing, delete files on destination after transferring (default) + --delete-before When synchronizing, delete files on destination before transferring + --delete-during When synchronizing, delete files during transfer + --delete-excluded Delete files on dest excluded from sync + --disable string Disable a comma separated list of features. Use help to see a list. + -n, --dry-run Do a trial run with no permanent changes + --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + --dump-bodies Dump HTTP headers and bodies - may contain sensitive info + --dump-headers Dump HTTP headers - may contain sensitive info + --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts + --exclude stringArray Exclude files matching pattern + --exclude-from stringArray Read exclude patterns from file (use - to read from stdin) + --exclude-if-present string Exclude directories if filename is present + --expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s) + --fast-list Use recursive list if available. Uses more memory but fewer transactions. + --files-from stringArray Read list of source-file names from file (use - to read from stdin) + --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) + -f, --filter stringArray Add a file-filtering rule + --filter-from stringArray Read filtering patterns from a file (use - to read from stdin) + --header stringArray Set HTTP header for all transactions + --header-download stringArray Set HTTP header for download transactions + --header-upload stringArray Set HTTP header for upload transactions + --ignore-case Ignore case in filters (case insensitive) + --ignore-case-sync Ignore case when synchronizing + --ignore-checksum Skip post copy check of checksums. + --ignore-errors delete even if there are I/O errors + --ignore-existing Skip all files that exist on destination + --ignore-size Ignore size when skipping use mod-time or checksum. + -I, --ignore-times Don't skip files that match size and time - transfer all files + --immutable Do not modify files. Fail if existing files have been modified. + --include stringArray Include files matching pattern + --include-from stringArray Read include patterns from file (use - to read from stdin) + -i, --interactive Enable interactive mode + --log-file string Log everything to this file + --log-format string Comma separated list of log format options (default "date,time") + --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") + --low-level-retries int Number of low level retries to do. (default 10) + --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) + --max-delete int When synchronizing, limit the number of deletes (default -1) + --max-depth int If set limits the recursion depth to this. (default -1) + --max-duration duration Maximum duration rclone will transfer data for. + --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) + --max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) + --max-transfer SizeSuffix Maximum size of data to transfer. (default off) + --memprofile string Write memory profile to file + --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) + --modify-window duration Max time diff to be considered the same (default 1ns) + --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) + --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) + --no-check-certificate Do not verify the server SSL certificate. Insecure. + --no-check-dest Don't check the destination, copy regardless. + --no-gzip-encoding Don't set Accept-Encoding: gzip. + --no-traverse Don't traverse destination file system on copy. + --no-unicode-normalization Don't normalize unicode characters in filenames. + --no-update-modtime Don't update destination mod-time if files identical. + --order-by string Instructions on how to order the transfers, eg 'size,descending' + --password-command SpaceSepList Command for supplying password for encrypted configuration. + -P, --progress Show progress during transfer. + -q, --quiet Print as little stuff as possible + --rc Enable the remote control server. + --rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572") + --rc-allow-origin string Set the allowed origin for CORS. + --rc-baseurl string Prefix for URLs - leave blank for root. + --rc-cert string SSL PEM key (concatenation of certificate and CA certificate) + --rc-client-ca string Client certificate authority to verify clients with + --rc-enable-metrics Enable prometheus metrics on /metrics + --rc-files string Path to local files to serve on the HTTP server. + --rc-htpasswd string htpasswd file - if not provided no authentication is done + --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) + --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) + --rc-key string SSL PEM Private key + --rc-max-header-bytes int Maximum size of request header (default 4096) + --rc-no-auth Don't require auth for certain methods. + --rc-pass string Password for authentication. + --rc-realm string realm for authentication (default "rclone") + --rc-serve Enable the serving of remote objects. + --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) + --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) + --rc-template string User Specified Template. + --rc-user string User name for authentication. + --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") + --rc-web-gui Launch WebGUI on localhost + --rc-web-gui-force-update Force update to latest version of web gui + --rc-web-gui-no-open-browser Don't open the browser automatically + --rc-web-gui-update Check and update to latest version of web gui + --refresh-times Refresh the modtime of remote files. + --retries int Retry operations this many times if they fail (default 3) + --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) + --size-only Skip based on size only, not mod-time or checksum + --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) + --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) + --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") + --stats-one-line Make the stats fit on one line. + --stats-one-line-date Enables --stats-one-line and add current date/time prefix. + --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format + --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") + --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) + --suffix string Suffix to add to changed files. + --suffix-keep-extension Preserve the extension when using --suffix. + --syslog Use Syslog for logging + --syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON") + --timeout duration IO idle timeout (default 5m0s) + --tpslimit float Limit HTTP transactions per second to this. + --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) + --track-renames When synchronizing, track file renames and do a server side move if possible + --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") + --transfers int Number of file transfers to run in parallel. (default 4) + -u, --update Skip files that are newer on the destination. + --use-cookies Enable session cookiejar. + --use-json-log Use json log format. + --use-mmap Use mmap allocator (see docs). + --use-server-modtime Use server modified time instead of object metadata + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.1") + -v, --verbose count Print lots more stuff (repeat for more) + + +Backend Flags + +These flags are available for every command. They control the backends +and may be set in the config file. + + --acd-auth-url string Auth server URL. + --acd-client-id string OAuth Client Id + --acd-client-secret string OAuth Client Secret + --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + --acd-token string OAuth Access Token as a JSON blob. + --acd-token-url string Token server url. + --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) + --alias-remote string Remote or path to alias. + --azureblob-access-tier string Access tier of blob: hot, cool or archive. + --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) + --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) + --azureblob-disable-checksum Don't store MD5 checksum with object metadata. + --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) + --azureblob-endpoint string Endpoint for the service + --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) + --azureblob-list-chunk int Size of blob list. (default 5000) + --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --azureblob-sas-url string SAS URL for container level access only + --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) + --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) + --b2-account string Account ID or Application Key ID + --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) + --b2-disable-checksum Disable checksums for large (> upload cutoff) files + --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + --b2-download-url string Custom endpoint for downloads. + --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --b2-endpoint string Endpoint for the service. + --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. + --b2-key string Application Key + --b2-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --b2-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. + --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + --b2-versions Include old versions in directory listings. + --box-access-token string Box App Primary Access Token + --box-auth-url string Auth server URL. + --box-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") + --box-client-id string OAuth Client Id + --box-client-secret string OAuth Client Secret + --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. + --box-token string OAuth Access Token as a JSON blob. + --box-token-url string Token server url. + --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. + --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") + --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) + --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") + --cache-db-purge Clear all the cached data for this remote on start. + --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) + --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) + --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server + --cache-plex-password string The password of the Plex user (obscured) + --cache-plex-url string The URL of the Plex server + --cache-plex-username string The username of the Plex user + --cache-read-retries int How many times to retry a read from a cache storage. (default 10) + --cache-remote string Remote to cache. + --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) + --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. + --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) + --cache-workers int How many workers should run in parallel to download chunks. (default 4) + --cache-writes Cache file data on writes through the FS + --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. + --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") + --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") + --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") + --chunker-remote string Remote to chunk/unchunk. + --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) + -L, --copy-links Follow symlinks and copy the pointed to item. + --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) + --crypt-filename-encryption string How to encrypt the filenames. (default "standard") + --crypt-password string Password or pass phrase for encryption. (obscured) + --crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) + --crypt-remote string Remote to encrypt/decrypt. + --crypt-server-side-across-configs Allow server side operations (eg copy) to work across different crypt configs. + --crypt-show-mapping For all files listed show how the names encrypt. + --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + --drive-auth-owner-only Only consider files owned by the authenticated user. + --drive-auth-url string Auth server URL. + --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + --drive-client-id string Google Application Client Id + --drive-client-secret string OAuth Client Secret + --drive-disable-http2 Disable drive using http2 (default true) + --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) + --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") + --drive-formats string Deprecated: see export_formats + --drive-impersonate string Impersonate this user when using a service account. + --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. + --drive-keep-revision-forever Keep new head revision of each file forever. + --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) + --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) + --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) + --drive-root-folder-id string ID of the root folder + --drive-scope string Scope that rclone should use when requesting access from drive. + --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. + --drive-service-account-credentials string Service Account Credentials JSON blob + --drive-service-account-file string Service Account Credentials JSON file path + --drive-shared-with-me Only show files that are shared with me. + --drive-size-as-quota Show sizes as storage quota usage, not actual size. + --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. + --drive-skip-gdocs Skip google documents in all listings. + --drive-skip-shortcuts If set skip shortcut files + --drive-starred-only Only show files that are starred. + --drive-stop-on-upload-limit Make upload limit errors be fatal + --drive-team-drive string ID of the Team Drive + --drive-token string OAuth Access Token as a JSON blob. + --drive-token-url string Token server url. + --drive-trashed-only Only show files that are in the trash. + --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + --drive-use-created-date Use file created date instead of modified date., + --drive-use-shared-date Use date file was shared instead of modified date. + --drive-use-trash Send files to the trash instead of deleting permanently. (default true) + --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) + --dropbox-auth-url string Auth server URL. + --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + --dropbox-client-id string OAuth Client Id + --dropbox-client-secret string OAuth Client Secret + --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) + --dropbox-impersonate string Impersonate this user when using a business account. + --dropbox-token string OAuth Access Token as a JSON blob. + --dropbox-token-url string Token server url. + --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl + --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) + --fichier-shared-folder string If you want to download a shared folder, add this parameter + --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited + --ftp-disable-epsv Disable using EPSV even if server advertises support + --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) + --ftp-explicit-tls Use FTP over TLS (Explicit) + --ftp-host string FTP host to connect to + --ftp-no-check-certificate Do not verify the TLS certificate of the server + --ftp-pass string FTP password (obscured) + --ftp-port string FTP port, leave blank to use default (21) + --ftp-tls Use FTPS over TLS (Implicit) + --ftp-user string FTP username, leave blank for current username, $USER + --gcs-anonymous Access public buckets and objects without credentials + --gcs-auth-url string Auth server URL. + --gcs-bucket-acl string Access Control List for new buckets. + --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. + --gcs-client-id string OAuth Client Id + --gcs-client-secret string OAuth Client Secret + --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) + --gcs-location string Location for the newly created buckets. + --gcs-object-acl string Access Control List for new objects. + --gcs-project-number string Project number. + --gcs-service-account-file string Service Account Credentials JSON file path + --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. + --gcs-token string OAuth Access Token as a JSON blob. + --gcs-token-url string Token server url. + --gphotos-auth-url string Auth server URL. + --gphotos-client-id string OAuth Client Id + --gphotos-client-secret string OAuth Client Secret + --gphotos-read-only Set to make the Google Photos backend read only. + --gphotos-read-size Set to read the size of media items. + --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) + --gphotos-token string OAuth Access Token as a JSON blob. + --gphotos-token-url string Token server url. + --http-headers CommaSepList Set HTTP headers for all transactions + --http-no-head Don't use HEAD requests to find file sizes in dir listing + --http-no-slash Set this if the site doesn't end directories with / + --http-url string URL of http host to connect to + --hubic-auth-url string Auth server URL. + --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --hubic-client-id string OAuth Client Id + --hubic-client-secret string OAuth Client Secret + --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --hubic-no-chunk Don't chunk files during streaming upload. + --hubic-token string OAuth Access Token as a JSON blob. + --hubic-token-url string Token server url. + --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) + --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. + --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) + --jottacloud-trashed-only Only show files that are in the trash. + --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net") + --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. + --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) + --koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) + --koofr-user string Your Koofr user name + -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension + --local-case-insensitive Force the filesystem to report itself as case insensitive + --local-case-sensitive Force the filesystem to report itself as case sensitive. + --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) + --local-no-check-updated Don't check to see if the files change during upload + --local-no-set-modtime Disable setting modtime + --local-no-sparse Disable sparse files for multi-thread downloads + --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) + --local-nounc string Disable UNC (long path names) conversion on Windows + --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) + --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --mailru-pass string Password (obscured) + --mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true) + --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf") + --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) + --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) + --mailru-user string User name (usually email) + --mega-debug Output more debug from Mega. + --mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --mega-hard-delete Delete files permanently rather than putting them into the trash. + --mega-pass string Password. (obscured) + --mega-user string User name + -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). + --onedrive-auth-url string Auth server URL. + --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) + --onedrive-client-id string OAuth Client Id + --onedrive-client-secret string OAuth Client Secret + --onedrive-drive-id string The ID of the drive to use + --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. + --onedrive-no-versions Remove all versions on modifying operations + --onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs. + --onedrive-token string OAuth Access Token as a JSON blob. + --onedrive-token-url string Token server url. + --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) + --opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) + --opendrive-password string Password. (obscured) + --opendrive-username string Username + --pcloud-auth-url string Auth server URL. + --pcloud-client-id string OAuth Client Id + --pcloud-client-secret string OAuth Client Secret + --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --pcloud-hostname string Hostname to connect to. (default "api.pcloud.com") + --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") + --pcloud-token string OAuth Access Token as a JSON blob. + --pcloud-token-url string Token server url. + --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --qingstor-access-key-id string QingStor Access Key ID + --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) + --qingstor-connection-retries int Number of connection retries. (default 3) + --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) + --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. + --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + --qingstor-secret-access-key string QingStor Secret Access Key (password) + --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) + --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --qingstor-zone string Zone to connect to. + --s3-access-key-id string AWS Access Key ID. + --s3-acl string Canned ACL used when creating buckets and storing or copying objects. + --s3-bucket-acl string Canned ACL used when creating buckets. + --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) + --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) + --s3-disable-checksum Don't store MD5 checksum with object metadata + --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --s3-endpoint string Endpoint for S3 API. + --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) + --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. + --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) + --s3-location-constraint string Location constraint - must be set to match the Region. + --s3-max-upload-parts int Maximum number of parts in a multipart upload. (default 10000) + --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --s3-no-check-bucket If set don't attempt to check the bucket exists or create it + --s3-profile string Profile to use in the shared credentials file + --s3-provider string Choose your S3 provider. + --s3-region string Region to connect to. + --s3-secret-access-key string AWS Secret Access Key (password) + --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. + --s3-session-token string An AWS session token + --s3-shared-credentials-file string Path to the shared credentials file + --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. + --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. + --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. + --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. + --s3-storage-class string The storage class to use when storing new objects in S3. + --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) + --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. + --s3-v2-auth If true use v2 authentication. + --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) + --seafile-create-library Should rclone create a library if it doesn't exist + --seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) + --seafile-library string Name of the library. Leave blank to access all non-encrypted libraries. + --seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) + --seafile-pass string Password (obscured) + --seafile-url string URL of seafile host to connect to + --seafile-user string User name (usually email address) + --sftp-ask-password Allow asking for SFTP password when needed. + --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + --sftp-host string SSH host to connect to + --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. + --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) + --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. + --sftp-key-use-agent When set forces the usage of the ssh-agent. + --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. + --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) + --sftp-path-override string Override path used by SSH connection. + --sftp-port string SSH port, leave blank to use default (22) + --sftp-server-command string Specifies the path or command to run a sftp server on the remote host. + --sftp-set-modtime Set the modified time on the remote if set. (default true) + --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. + --sftp-skip-links Set to skip any symlinks and any other non regular files. + --sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp") + --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. + --sftp-user string SSH username, leave blank for current username, ncw + --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) + --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) + --sharefile-endpoint string Endpoint for API calls. + --sharefile-root-folder-id string ID of the root folder + --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) + --skip-links Don't warn about skipped symlinks. + --sugarsync-access-key-id string Sugarsync Access Key ID. + --sugarsync-app-id string Sugarsync App ID. + --sugarsync-authorization string Sugarsync authorization + --sugarsync-authorization-expiry string Sugarsync authorization expiry + --sugarsync-deleted-id string Sugarsync deleted folder id + --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) + --sugarsync-hard-delete Permanently delete files if true + --sugarsync-private-access-key string Sugarsync Private Access Key + --sugarsync-refresh-token string Sugarsync refresh token + --sugarsync-root-id string Sugarsync root id + --sugarsync-user string Sugarsync user + --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) + --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) + --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) + --swift-auth string Authentication URL for server (OS_AUTH_URL). + --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) + --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) + --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) + --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") + --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. + --swift-key string API key or password (OS_PASSWORD). + --swift-no-chunk Don't chunk files during streaming upload. + --swift-region string Region name - optional (OS_REGION_NAME) + --swift-storage-policy string The storage policy to use when creating a new container + --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) + --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) + --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) + --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) + --swift-user string User name to log in (OS_USERNAME). + --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). + --tardigrade-access-grant string Access Grant. + --tardigrade-api-key string API Key. + --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. + --tardigrade-provider string Choose an authentication method. (default "existing") + --tardigrade-satellite-address @
    : Satellite Address. Custom satellite address should match the format: @
    :. (default "us-central-1.tardigrade.io") + --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") + --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) + --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") + --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") + --union-upstreams string List of space separated upstreams. + --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) + --webdav-bearer-token-command string Command to run to get a bearer token + --webdav-pass string Password. (obscured) + --webdav-url string URL of http host to connect to + --webdav-user string User name + --webdav-vendor string Name of the Webdav site/service/software you are using + --yandex-auth-url string Auth server URL. + --yandex-client-id string OAuth Client Id + --yandex-client-secret string OAuth Client Secret + --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --yandex-token string OAuth Access Token as a JSON blob. + --yandex-token-url string Token server url. + + +1Fichier + +This is a backend for the 1fichier cloud storage service. Note that a +Premium subscription is required to use the API. + +Paths are specified as remote:path + +Paths may be as deep as required, eg remote:directory/subdirectory. + +The initial setup for 1Fichier involves getting the API key from the +website which you need to do in your browser. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / 1Fichier + \ "fichier" + [snip] + Storage> fichier + ** See help for fichier backend at: https://rclone.org/fichier/ ** Your API Key, get it from https://1fichier.com/console/params.pl + Enter a string value. Press Enter for the default (""). + api_key> example_key - - Config: api_key - - Env Var: RCLONE_FICHIER_API_KEY - - Type: string - - Default: "" + Edit advanced config? (y/n) + y) Yes + n) No + y/n> + Remote config + -------------------- + [remote] + type = fichier + api_key = example_key + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - ### Advanced Options +Once configured you can then use rclone like this, - Here are the advanced options specific to fichier (1Fichier). +List directories in top level of your 1Fichier account - #### --fichier-shared-folder + rclone lsd remote: - If you want to download a shared folder, add this parameter +List all the files in your 1Fichier account - - Config: shared_folder - - Env Var: RCLONE_FICHIER_SHARED_FOLDER - - Type: string - - Default: "" + rclone ls remote: - #### --fichier-encoding +To copy a local directory to a 1Fichier directory called backup - This sets the encoding for the backend. + rclone copy /home/source remote:backup - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Modified time and hashes - - Config: encoding - - Env Var: RCLONE_FICHIER_ENCODING - - Type: MultiEncoder - - Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +1Fichier does not support modification times. It supports the Whirlpool +hash algorithm. + +Duplicated files + +1Fichier can have two files with exactly the same name and path (unlike +a normal file system). + +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. + +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + < 0x3C ＜ + > 0x3E ＞ + " 0x22 ＂ + $ 0x24 ＄ + ` 0x60 ｀ + ' 0x27 ＇ + +File names can also not start or end with the following characters. +These only get replaced if they are the first or last character in the +name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. + +Standard Options + +Here are the standard options specific to fichier (1Fichier). + +--fichier-api-key + +Your API Key, get it from https://1fichier.com/console/params.pl + +- Config: api_key +- Env Var: RCLONE_FICHIER_API_KEY +- Type: string +- Default: "" + +Advanced Options + +Here are the advanced options specific to fichier (1Fichier). + +--fichier-shared-folder + +If you want to download a shared folder, add this parameter + +- Config: shared_folder +- Env Var: RCLONE_FICHIER_SHARED_FOLDER +- Type: string +- Default: "" + +--fichier-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_FICHIER_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +Alias - Alias - ----------------------------------------- +The alias remote provides a new name for another remote. - The `alias` remote provides a new name for another remote. +Paths may be as deep as required or a local path, eg +remote:directory/subdirectory or /directory/subdirectory. - Paths may be as deep as required or a local path, - eg `remote:directory/subdirectory` or `/directory/subdirectory`. +During the initial setup with rclone config you will specify the target +remote. The target remote can either be a local path or another remote. - During the initial setup with `rclone config` you will specify the target - remote. The target remote can either be a local path or another remote. +Subfolders can be used in target remote. Assume an alias remote named +backup with the target mydrive:private/backup. Invoking +rclone mkdir backup:desktop is exactly the same as invoking +rclone mkdir mydrive:private/backup/desktop. - Subfolders can be used in target remote. Assume an alias remote named `backup` - with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop` - is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`. +There will be no special handling of paths containing .. segments. +Invoking rclone mkdir backup:../desktop is exactly the same as invoking +rclone mkdir mydrive:private/backup/../desktop. The empty path is not +allowed as a remote. To alias the current directory use . instead. - There will be no special handling of paths containing `..` segments. - Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking - `rclone mkdir mydrive:private/backup/../desktop`. - The empty path is not allowed as a remote. To alias the current directory - use `.` instead. +Here is an example of how to make an alias called remote for local +folder. First run: - Here is an example of how to make an alias called `remote` for local folder. - First run: + rclone config - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Alias for an existing remote  "alias" [snip] Storage> alias Remote -or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", -"myremote:" or "/local/path". remote> /mnt/storage/backup Remote config --------------------- [remote] remote = /mnt/storage/backup --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y Current remotes: - -Name Type ==== ==== remote alias - -e) Edit existing remote -f) New remote -g) Delete remote -h) Rename remote -i) Copy remote -j) Set configuration password -k) Quit config e/n/d/r/c/s/q> q - - - Once configured you can then use `rclone` like this, - - List directories in top level in `/mnt/storage/backup` - - rclone lsd remote: - - List all the files in `/mnt/storage/backup` - - rclone ls remote: - - Copy another local directory to the alias directory called source - - rclone copy /home/source remote:source - - - ### Standard Options - - Here are the standard options specific to alias (Alias for an existing remote). - - #### --alias-remote +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Alias for an existing remote + \ "alias" + [snip] + Storage> alias Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". + remote> /mnt/storage/backup + Remote config + -------------------- + [remote] + remote = /mnt/storage/backup + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + Current remotes: - - Config: remote - - Env Var: RCLONE_ALIAS_REMOTE - - Type: string - - Default: "" + Name Type + ==== ==== + remote alias + e) Edit existing remote + n) New remote + d) Delete remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + e/n/d/r/c/s/q> q +Once configured you can then use rclone like this, - Amazon Drive - ----------------------------------------- +List directories in top level in /mnt/storage/backup - Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage - service run by Amazon for consumers. + rclone lsd remote: + +List all the files in /mnt/storage/backup + + rclone ls remote: + +Copy another local directory to the alias directory called source + + rclone copy /home/source remote:source + +Standard Options + +Here are the standard options specific to alias (Alias for an existing +remote). + +--alias-remote + +Remote or path to alias. Can be "myremote:path/to/dir", +"myremote:bucket", "myremote:" or "/local/path". + +- Config: remote +- Env Var: RCLONE_ALIAS_REMOTE +- Type: string +- Default: "" + + +Amazon Drive + +Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage +service run by Amazon for consumers. + + +Status + +IMPORTANT: rclone supports Amazon Drive only if you have your own set of +API keys. Unfortunately the Amazon Drive developer program is now closed +to new entries so if you don't already have your own set of keys you +will not be able to use rclone with Amazon Drive. + +For the history on why rclone no longer has a set of Amazon Drive API +keys see the forum. + +If you happen to know anyone who works at Amazon then please ask them to +re-instate rclone into the Amazon Drive developer program - thanks! - ## Status - **Important:** rclone supports Amazon Drive only if you have your own - set of API keys. Unfortunately the [Amazon Drive developer - program](https://developer.amazon.com/amazon-drive) is now closed to - new entries so if you don't already have your own set of keys you will - not be able to use rclone with Amazon Drive. +Setup + +The initial setup for Amazon Drive involves getting a token from Amazon +which you need to do in your browser. rclone config walks you through +it. - For the history on why rclone no longer has a set of Amazon Drive API - keys see [the forum](https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314). +The configuration process for Amazon Drive may involve using an oauth +proxy. This is used to keep the Amazon credentials out of the source +code. The proxy runs in Google's very secure App Engine environment and +doesn't store any credentials which pass through it. - If you happen to know anyone who works at Amazon then please ask them - to re-instate rclone into the Amazon Drive developer program - thanks! +Since rclone doesn't currently have its own Amazon Drive credentials so +you will either need to have your own client_id and client_secret with +Amazon Drive, or use a third party oauth proxy in which case you will +need to enter client_id, client_secret, auth_url and token_url. - ## Setup +Note also if you are not using Amazon's auth_url and token_url, (ie you +filled in something for those) then if setting up on a remote machine +you can only use the copying the config method of configuration - +rclone authorize will not work. - The initial setup for Amazon Drive involves getting a token from - Amazon which you need to do in your browser. `rclone config` walks - you through it. +Here is an example of how to make a remote called remote. First run: - The configuration process for Amazon Drive may involve using an [oauth - proxy](https://github.com/ncw/oauthproxy). This is used to keep the - Amazon credentials out of the source code. The proxy runs in Google's - very secure App Engine environment and doesn't store any credentials - which pass through it. + rclone config - Since rclone doesn't currently have its own Amazon Drive credentials - so you will either need to have your own `client_id` and - `client_secret` with Amazon Drive, or use a third party oauth proxy - in which case you will need to enter `client_id`, `client_secret`, - `auth_url` and `token_url`. +This will guide you through an interactive setup process: - Note also if you are not using Amazon's `auth_url` and `token_url`, - (ie you filled in something for those) then if setting up on a remote - machine you can only use the [copying the config method of - configuration](https://rclone.org/remote_setup/#configuring-by-copying-the-config-file) - - `rclone authorize` will not work. + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon Drive + \ "amazon cloud drive" + [snip] + Storage> amazon cloud drive + Amazon Application Client Id - required. + client_id> your client ID goes here + Amazon Application Client Secret - required. + client_secret> your client secret goes here + Auth server URL - leave blank to use Amazon's. + auth_url> Optional auth URL + Token server url - leave blank to use Amazon's. + token_url> Optional token URL + Remote config + Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + client_id = your client ID goes here + client_secret = your client secret goes here + auth_url = Optional auth URL + token_url = Optional token URL + token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - Here is an example of how to make a remote called `remote`. First run: +See the remote setup docs for how to set it up on a machine with no +Internet browser available. - rclone config +Note that rclone runs a webserver on your local machine to collect the +token as returned from Amazon. This only runs from the moment it opens +your browser to the moment you get back the verification code. This is +on http://127.0.0.1:53682/ and this it may require you to unblock it +temporarily if you are running a host firewall. - This will guide you through an interactive setup process: +Once configured you can then use rclone like this, -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Choose a number from below, or type -in your own value [snip] XX / Amazon Drive  "amazon cloud drive" [snip] -Storage> amazon cloud drive Amazon Application Client Id - required. -client_id> your client ID goes here Amazon Application Client Secret - -required. client_secret> your client secret goes here Auth server URL - -leave blank to use Amazon's. auth_url> Optional auth URL Token server -url - leave blank to use Amazon's. token_url> Optional token URL Remote -config Make sure your Redirect URL is set to "http://127.0.0.1:53682/" -in your custom config. Use auto config? * Say Y if not sure * Say N if -you are working on a remote or headless machine y) Yes n) No y/n> y If -your browser doesn't open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code... Got code -------------------- [remote] client_id = -your client ID goes here client_secret = your client secret goes here -auth_url = Optional auth URL token_url = Optional token URL token = -{"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y +List directories in top level of your Amazon Drive + rclone lsd remote: - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet browser available. +List all the files in your Amazon Drive - Note that rclone runs a webserver on your local machine to collect the - token as returned from Amazon. This only runs from the moment it - opens your browser to the moment you get back the verification - code. This is on `http://127.0.0.1:53682/` and this it may require - you to unblock it temporarily if you are running a host firewall. + rclone ls remote: - Once configured you can then use `rclone` like this, +To copy a local directory to an Amazon Drive directory called backup - List directories in top level of your Amazon Drive + rclone copy /home/source remote:backup - rclone lsd remote: +Modified time and MD5SUMs - List all the files in your Amazon Drive +Amazon Drive doesn't allow modification times to be changed via the API +so these won't be accurate or used for syncing. - rclone ls remote: +It does store MD5SUMs so for a more accurate sync, you can use the +--checksum flag. - To copy a local directory to an Amazon Drive directory called backup +Restricted filename characters - rclone copy /home/source remote:backup + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ - ### Modified time and MD5SUMs ### +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - Amazon Drive doesn't allow modification times to be changed via - the API so these won't be accurate or used for syncing. +Deleting files - It does store MD5SUMs so for a more accurate sync, you can use the - `--checksum` flag. +Any files you delete with rclone will end up in the trash. Amazon don't +provide an API to permanently delete files, nor to empty the trash, so +you will have to do that with one of Amazon's apps or via the Amazon +Drive website. As of November 17, 2016, files are automatically deleted +by Amazon from the trash after 30 days. - #### Restricted filename characters +Using with non .com Amazon accounts - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | +Let's say you usually use amazon.co.uk. When you authenticate with +rclone it will take you to an amazon.com page to log in. Your +amazon.co.uk email and password should work here just fine. - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. +Standard Options - ### Deleting files ### +Here are the standard options specific to amazon cloud drive (Amazon +Drive). - Any files you delete with rclone will end up in the trash. Amazon - don't provide an API to permanently delete files, nor to empty the - trash, so you will have to do that with one of Amazon's apps or via - the Amazon Drive website. As of November 17, 2016, files are - automatically deleted by Amazon from the trash after 30 days. +--acd-client-id - ### Using with non `.com` Amazon accounts ### +OAuth Client Id Leave blank normally. - Let's say you usually use `amazon.co.uk`. When you authenticate with - rclone it will take you to an `amazon.com` page to log in. Your - `amazon.co.uk` email and password should work here just fine. +- Config: client_id +- Env Var: RCLONE_ACD_CLIENT_ID +- Type: string +- Default: "" +--acd-client-secret - ### Standard Options +OAuth Client Secret Leave blank normally. - Here are the standard options specific to amazon cloud drive (Amazon Drive). +- Config: client_secret +- Env Var: RCLONE_ACD_CLIENT_SECRET +- Type: string +- Default: "" - #### --acd-client-id +Advanced Options - OAuth Client Id - Leave blank normally. +Here are the advanced options specific to amazon cloud drive (Amazon +Drive). - - Config: client_id - - Env Var: RCLONE_ACD_CLIENT_ID - - Type: string - - Default: "" +--acd-token - #### --acd-client-secret +OAuth Access Token as a JSON blob. - OAuth Client Secret - Leave blank normally. +- Config: token +- Env Var: RCLONE_ACD_TOKEN +- Type: string +- Default: "" - - Config: client_secret - - Env Var: RCLONE_ACD_CLIENT_SECRET - - Type: string - - Default: "" +--acd-auth-url - ### Advanced Options +Auth server URL. Leave blank to use the provider defaults. - Here are the advanced options specific to amazon cloud drive (Amazon Drive). +- Config: auth_url +- Env Var: RCLONE_ACD_AUTH_URL +- Type: string +- Default: "" - #### --acd-token +--acd-token-url - OAuth Access Token as a JSON blob. +Token server url. Leave blank to use the provider defaults. - - Config: token - - Env Var: RCLONE_ACD_TOKEN - - Type: string - - Default: "" +- Config: token_url +- Env Var: RCLONE_ACD_TOKEN_URL +- Type: string +- Default: "" - #### --acd-auth-url +--acd-checkpoint - Auth server URL. - Leave blank to use the provider defaults. +Checkpoint for internal polling (debug). - - Config: auth_url - - Env Var: RCLONE_ACD_AUTH_URL - - Type: string - - Default: "" +- Config: checkpoint +- Env Var: RCLONE_ACD_CHECKPOINT +- Type: string +- Default: "" - #### --acd-token-url +--acd-upload-wait-per-gb - Token server url. - Leave blank to use the provider defaults. +Additional time per GB to wait after a failed complete upload to see if +it appears. - - Config: token_url - - Env Var: RCLONE_ACD_TOKEN_URL - - Type: string - - Default: "" +Sometimes Amazon Drive gives an error when a file has been fully +uploaded but the file appears anyway after a little while. This happens +sometimes for files over 1GB in size and nearly every time for files +bigger than 10GB. This parameter controls the time rclone waits for the +file to appear. - #### --acd-checkpoint +The default value for this parameter is 3 minutes per GB, so by default +it will wait 3 minutes for every GB uploaded to see if the file appears. - Checkpoint for internal polling (debug). +You can disable this feature by setting it to 0. This may cause conflict +errors as rclone retries the failed upload but the file will most likely +appear correctly eventually. - - Config: checkpoint - - Env Var: RCLONE_ACD_CHECKPOINT - - Type: string - - Default: "" +These values were determined empirically by observing lots of uploads of +big files for a range of file sizes. - #### --acd-upload-wait-per-gb +Upload with the "-v" flag to see more info about what rclone is doing in +this situation. - Additional time per GB to wait after a failed complete upload to see if it appears. +- Config: upload_wait_per_gb +- Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB +- Type: Duration +- Default: 3m0s - Sometimes Amazon Drive gives an error when a file has been fully - uploaded but the file appears anyway after a little while. This - happens sometimes for files over 1GB in size and nearly every time for - files bigger than 10GB. This parameter controls the time rclone waits - for the file to appear. +--acd-templink-threshold - The default value for this parameter is 3 minutes per GB, so by - default it will wait 3 minutes for every GB uploaded to see if the - file appears. +Files >= this size will be downloaded via their tempLink. - You can disable this feature by setting it to 0. This may cause - conflict errors as rclone retries the failed upload but the file will - most likely appear correctly eventually. +Files this size or more will be downloaded via their "tempLink". This is +to work around a problem with Amazon Drive which blocks downloads of +files bigger than about 10GB. The default for this is 9GB which +shouldn't need to be changed. - These values were determined empirically by observing lots of uploads - of big files for a range of file sizes. +To download files above this threshold, rclone requests a "tempLink" +which downloads the file through a temporary URL directly from the +underlying S3 storage. - Upload with the "-v" flag to see more info about what rclone is doing - in this situation. +- Config: templink_threshold +- Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD +- Type: SizeSuffix +- Default: 9G - - Config: upload_wait_per_gb - - Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB - - Type: Duration - - Default: 3m0s +--acd-encoding - #### --acd-templink-threshold +This sets the encoding for the backend. - Files >= this size will be downloaded via their tempLink. +See: the encoding section in the overview for more info. - Files this size or more will be downloaded via their "tempLink". This - is to work around a problem with Amazon Drive which blocks downloads - of files bigger than about 10GB. The default for this is 9GB which - shouldn't need to be changed. +- Config: encoding +- Env Var: RCLONE_ACD_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot - To download files above this threshold, rclone requests a "tempLink" - which downloads the file through a temporary URL directly from the - underlying S3 storage. +Limitations - - Config: templink_threshold - - Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD - - Type: SizeSuffix - - Default: 9G +Note that Amazon Drive is case insensitive so you can't have a file +called "Hello.doc" and one called "hello.doc". - #### --acd-encoding +Amazon Drive has rate limiting so you may notice errors in the sync (429 +errors). rclone will automatically retry the sync up to 3 times by +default (see --retries flag) which should hopefully work around this +problem. - This sets the encoding for the backend. +Amazon Drive has an internal limit of file sizes that can be uploaded to +the service. This limit is not officially published, but all files +larger than this will fail. - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +At the time of writing (Jan 2016) is in the area of 50GB per file. This +means that larger files are likely to fail. - - Config: encoding - - Env Var: RCLONE_ACD_ENCODING - - Type: MultiEncoder - - Default: Slash,InvalidUtf8,Dot +Unfortunately there is no way for rclone to see that this failure is +because of file size, so it will retry the operation, as any other +failure. To avoid this problem, use --max-size 50000M option to limit +the maximum size of uploaded files. Note that --max-size does not split +files into segments, it only ignores files over this size. +Amazon S3 Storage Providers - ### Limitations ### +The S3 backend can be used with a number of different providers: - Note that Amazon Drive is case insensitive so you can't have a - file called "Hello.doc" and one called "hello.doc". +- AWS S3 +- Alibaba Cloud (Aliyun) Object Storage System (OSS) +- Ceph +- DigitalOcean Spaces +- Dreamhost +- IBM COS S3 +- Minio +- Scaleway +- StackPath +- Tencent Cloud Object Storage (COS) +- Wasabi - Amazon Drive has rate limiting so you may notice errors in the - sync (429 errors). rclone will automatically retry the sync up to 3 - times by default (see `--retries` flag) which should hopefully work - around this problem. +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, eg remote:bucket/path/to/dir. - Amazon Drive has an internal limit of file sizes that can be uploaded - to the service. This limit is not officially published, but all files - larger than this will fail. +Once you have made a remote (see the provider specific section above) +you can use it like this: - At the time of writing (Jan 2016) is in the area of 50GB per file. - This means that larger files are likely to fail. +See all buckets - Unfortunately there is no way for rclone to see that this failure is - because of file size, so it will retry the operation, as any other - failure. To avoid this problem, use `--max-size 50000M` option to limit - the maximum size of uploaded files. Note that `--max-size` does not split - files into segments, it only ignores files over this size. + rclone lsd remote: - Amazon S3 Storage Providers - -------------------------------------------------------- - - The S3 backend can be used with a number of different providers: - - - - AWS S3 - - Alibaba Cloud (Aliyun) Object Storage System (OSS) - - Ceph - - DigitalOcean Spaces - - Dreamhost - - IBM COS S3 - - Minio - - Scaleway - - StackPath - - Wasabi - - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - Once you have made a remote (see the provider specific section above) - you can use it like this: - - See all buckets - - rclone lsd remote: - - Make a new bucket - - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any excess - files in the bucket. - - rclone sync -i /home/local/directory remote:bucket - - ## AWS S3 {#amazon-s3} - - Here is an example of making an s3 configuration. First run - - rclone config - - This will guide you through an interactive setup process. - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM -COS, Minio)  "s3" [snip] Storage> s3 Choose your S3 provider. Choose a -number from below, or type in your own value 1 / Amazon Web Services -(AWS) S3  "AWS" 2 / Ceph Object Storage  "Ceph" 3 / Digital Ocean Spaces - "DigitalOcean" 4 / Dreamhost DreamObjects  "Dreamhost" 5 / IBM COS S3 - "IBMCOS" 6 / Minio Object Storage  "Minio" 7 / Wasabi Object Storage - "Wasabi" 8 / Any other S3 compatible provider  "Other" provider> 1 Get -AWS credentials from runtime (environment variables or EC2/ECS meta data -if no env vars). Only applies if access_key_id and secret_access_key is -blank. Choose a number from below, or type in your own value 1 / Enter -AWS credentials in the next step  "false" 2 / Get AWS credentials from -the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID -- leave blank for anonymous access or runtime credentials. -access_key_id> XXX AWS Secret Access Key (password) - leave blank for -anonymous access or runtime credentials. secret_access_key> YYY Region -to connect to. Choose a number from below, or type in your own value / -The default endpoint - a good choice if you are unsure. 1 | US Region, -Northern Virginia or Pacific Northwest. | Leave location constraint -empty.  "us-east-1" / US East (Ohio) Region 2 | Needs location -constraint us-east-2.  "us-east-2" / US West (Oregon) Region 3 | Needs -location constraint us-west-2.  "us-west-2" / US West (Northern -California) Region 4 | Needs location constraint us-west-1.  "us-west-1" -/ Canada (Central) Region 5 | Needs location constraint ca-central-1. - "ca-central-1" / EU (Ireland) Region 6 | Needs location constraint EU -or eu-west-1.  "eu-west-1" / EU (London) Region 7 | Needs location -constraint eu-west-2.  "eu-west-2" / EU (Frankfurt) Region 8 | Needs -location constraint eu-central-1.  "eu-central-1" / Asia Pacific -(Singapore) Region 9 | Needs location constraint ap-southeast-1. - "ap-southeast-1" / Asia Pacific (Sydney) Region 10 | Needs location -constraint ap-southeast-2.  "ap-southeast-2" / Asia Pacific (Tokyo) -Region 11 | Needs location constraint ap-northeast-1.  "ap-northeast-1" -/ Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2. - "ap-northeast-2" / Asia Pacific (Mumbai) 13 | Needs location constraint -ap-south-1.  "ap-south-1" / Asia Patific (Hong Kong) Region 14 | Needs -location constraint ap-east-1.  "ap-east-1" / South America (Sao Paulo) -Region 15 | Needs location constraint sa-east-1.  "sa-east-1" region> 1 -Endpoint for S3 API. Leave blank if using AWS to use the default -endpoint for the region. endpoint> Location constraint - must be set to -match the Region. Used when creating buckets only. Choose a number from -below, or type in your own value 1 / Empty for US Region, Northern -Virginia or Pacific Northwest.  "" 2 / US East (Ohio) Region. - "us-east-2" 3 / US West (Oregon) Region.  "us-west-2" 4 / US West -(Northern California) Region.  "us-west-1" 5 / Canada (Central) Region. - "ca-central-1" 6 / EU (Ireland) Region.  "eu-west-1" 7 / EU (London) -Region.  "eu-west-2" 8 / EU Region.  "EU" 9 / Asia Pacific (Singapore) -Region.  "ap-southeast-1" 10 / Asia Pacific (Sydney) Region. - "ap-southeast-2" 11 / Asia Pacific (Tokyo) Region.  "ap-northeast-1" 12 -/ Asia Pacific (Seoul)  "ap-northeast-2" 13 / Asia Pacific (Mumbai) - "ap-south-1" 14 / Asia Pacific (Hong Kong)  "ap-east-1" 15 / South -America (Sao Paulo) Region.  "sa-east-1" location_constraint> 1 Canned -ACL used when creating buckets and/or storing objects in S3. For more -info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default).  "private" 2 / -Owner gets FULL_CONTROL. The AllUsers group gets READ access. - "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ -and WRITE access. 3 | Granting this on a bucket is generally not -recommended.  "public-read-write" 4 / Owner gets FULL_CONTROL. The -AuthenticatedUsers group gets READ access.  "authenticated-read" / -Object owner gets FULL_CONTROL. Bucket owner gets READ access. 5 | If -you specify this canned ACL when creating a bucket, Amazon S3 ignores -it.  "bucket-owner-read" / Both the object owner and the bucket owner -get FULL_CONTROL over the object. 6 | If you specify this canned ACL -when creating a bucket, Amazon S3 ignores it. - "bucket-owner-full-control" acl> 1 The server-side encryption algorithm -used when storing this object in S3. Choose a number from below, or type -in your own value 1 / None  "" 2 / AES256  "AES256" -server_side_encryption> 1 The storage class to use when storing objects -in S3. Choose a number from below, or type in your own value 1 / Default - "" 2 / Standard storage class  "STANDARD" 3 / Reduced redundancy -storage class  "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access -storage class  "STANDARD_IA" 5 / One Zone Infrequent Access storage -class  "ONEZONE_IA" 6 / Glacier storage class  "GLACIER" 7 / Glacier -Deep Archive storage class  "DEEP_ARCHIVE" 8 / Intelligent-Tiering -storage class  "INTELLIGENT_TIERING" storage_class> 1 Remote config --------------------- [remote] type = s3 provider = AWS env_auth = false -access_key_id = XXX secret_access_key = YYY region = us-east-1 endpoint -= location_constraint = acl = private server_side_encryption = -storage_class = -------------------- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> - - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - ### --update and --use-server-modtime ### - - As noted below, the modified time is stored on metadata on the object. It is - used by default for all operations that require checking the time a file was - last updated. It allows rclone to treat the remote more like a true filesystem, - but it is inefficient because it requires an extra API call to retrieve the - metadata. - - For many operations, the time the object was last uploaded to the remote is - sufficient to determine if it is "dirty". By using `--update` along with - `--use-server-modtime`, you can avoid the extra API call and simply upload - files whose local modtime is newer than the time it was last uploaded. - - ### Modified time ### - - The modified time is stored as metadata on the object as - `X-Amz-Meta-Mtime` as floating point since the epoch accurate to 1 ns. - - If the modification time needs to be updated rclone will attempt to perform a server - side copy to update the modification if the object can be copied in a single part. - In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive - storage the object will be uploaded rather than copied. - - ### Cleanup ### - - If you run `rclone cleanup s3:bucket` then it will remove all pending - multipart uploads older than 24 hours. You can use the `-i` flag to - see exactly what it will do. If you want more control over the expiry - date then run `rclone backend cleanup s3:bucket -o max-age=1h` to - expire all uploads older than one hour. You can use `rclone backend - list-multipart-uploads s3:bucket` to see the pending multipart - uploads. - - #### Restricted filename characters - - S3 allows any valid UTF-8 string as a key. - - Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), as - they can't be used in XML. - - The following characters are replaced since these are problematic when - dealing with the REST API: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - - The encoding will also encode these file names as they don't seem to - work with the SDK properly: - - | File name | Replacement | - | --------- |:-----------:| - | . | ． | - | .. | ．． | - - ### Multipart uploads ### - - rclone supports multipart uploads with S3 which means that it can - upload files bigger than 5GB. - - Note that files uploaded *both* with multipart upload *and* through - crypt remotes do not have MD5 sums. - - rclone switches from single part uploads to multipart uploads at the - point specified by `--s3-upload-cutoff`. This can be a maximum of 5GB - and a minimum of 0 (ie always upload multipart files). - - The chunk sizes used in the multipart upload are specified by - `--s3-chunk-size` and the number of chunks uploaded concurrently is - specified by `--s3-upload-concurrency`. +Make a new bucket - Multipart uploads will use `--transfers` * `--s3-upload-concurrency` * - `--s3-chunk-size` extra memory. Single part uploads to not use extra - memory. + rclone mkdir remote:bucket - Single part transfers can be faster than multipart transfers or slower - depending on your latency from S3 - the more latency, the more likely - single part transfers will be faster. +List the contents of a bucket - Increasing `--s3-upload-concurrency` will increase throughput (8 would - be a sensible value) and increasing `--s3-chunk-size` also increases - throughput (16M would be sensible). Increasing either of these will - use more memory. The default values are high enough to gain most of - the possible performance without using too much memory. + rclone ls remote:bucket +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. - ### Buckets and Regions ### + rclone sync -i /home/local/directory remote:bucket - With Amazon S3 you can list buckets (`rclone lsd`) using any region, - but you can only access the content of a bucket from the region it was - created in. If you attempt to access a bucket from the wrong region, - you will get an error, `incorrect region, the bucket is not in 'XXX' - region`. - ### Authentication ### +AWS S3 - There are a number of ways to supply `rclone` with a set of AWS - credentials, with and without using the environment. +Here is an example of making an s3 configuration. First run - The different authentication methods are tried in this order: + rclone config - - Directly in the rclone configuration file (`env_auth = false` in the config file): - - `access_key_id` and `secret_access_key` are required. - - `session_token` can be optionally set when using AWS STS. - - Runtime configuration (`env_auth = true` in the config file): - - Export the following environment variables before running `rclone`: - - Access Key ID: `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` - - Secret Access Key: `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` - - Session Token: `AWS_SESSION_TOKEN` (optional) - - Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html): - - Profile files are standard files used by AWS CLI tools - - By default it will use the profile in your home directory (eg `~/.aws/credentials` on unix based systems) file and the "default" profile, to change set these environment variables: - - `AWS_SHARED_CREDENTIALS_FILE` to control which file. - - `AWS_PROFILE` to control which profile to use. - - Or, run `rclone` in an ECS task with an IAM role (AWS only). - - Or, run `rclone` on an EC2 instance with an IAM role (AWS only). - - Or, run `rclone` in an EKS pod with an IAM role that is associated with a service account (AWS only). - - If none of these option actually end up providing `rclone` with AWS - credentials then S3 interaction will be non-authenticated (see below). - - ### S3 Permissions ### - - When using the `sync` subcommand of `rclone` the following minimum - permissions are required to be available on the bucket being written to: - - * `ListBucket` - * `DeleteObject` - * `GetObject` - * `PutObject` - * `PutObjectACL` - - When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required. - - Example policy: - -{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", -"Principal": { "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" }, -"Action": [ "s3:ListBucket", "s3:DeleteObject", "s3:GetObject", -"s3:PutObject", "s3:PutObjectAcl" ], "Resource": [ -"arn:aws:s3:::BUCKET_NAME/*", "arn:aws:s3:::BUCKET_NAME" ] }, { -"Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": -"arn:aws:s3:::*" } -] } - - - Notes on above: - - 1. This is a policy that can be used when creating bucket. It assumes - that `USER_NAME` has been created. - 2. The Resource entry must include both resource ARNs, as one implies - the bucket and the other implies the bucket's objects. - - For reference, [here's an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) - that will generate one or more buckets that will work with `rclone sync`. - - ### Key Management System (KMS) ### - - If you are using server side encryption with KMS then you will find - you can't transfer small objects. As a work-around you can use the - `--ignore-checksum` flag. - - A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824). - - ### Glacier and Glacier Deep Archive ### - - You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html). - The bucket can still be synced or copied into normally, but if rclone - tries to access data from the glacier storage class you will see an error like below. - - 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file - - In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) - the object(s) in question before using rclone. - - Note that rclone only speaks the S3 API it does not speak the Glacier - Vault API, so rclone cannot directly access Glacier Vaults. - - - ### Standard Options - - Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - - #### --s3-provider +This will guide you through an interactive setup process. + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) + \ "s3" + [snip] + Storage> s3 Choose your S3 provider. - - - Config: provider - - Env Var: RCLONE_S3_PROVIDER - - Type: string - - Default: "" - - Examples: - - "AWS" - - Amazon Web Services (AWS) S3 - - "Alibaba" - - Alibaba Cloud Object Storage System (OSS) formerly Aliyun - - "Ceph" - - Ceph Object Storage - - "DigitalOcean" - - Digital Ocean Spaces - - "Dreamhost" - - Dreamhost DreamObjects - - "IBMCOS" - - IBM COS S3 - - "Minio" - - Minio Object Storage - - "Netease" - - Netease Object Storage (NOS) - - "Scaleway" - - Scaleway Object Storage - - "StackPath" - - StackPath Object Storage - - "Wasabi" - - Wasabi Object Storage - - "Other" - - Any other S3 compatible provider - - #### --s3-env-auth - - Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). - Only applies if access_key_id and secret_access_key is blank. - - - Config: env_auth - - Env Var: RCLONE_S3_ENV_AUTH - - Type: bool - - Default: false - - Examples: - - "false" - - Enter AWS credentials in the next step - - "true" - - Get AWS credentials from the environment (env vars or IAM) - - #### --s3-access-key-id - - AWS Access Key ID. - Leave blank for anonymous access or runtime credentials. - - - Config: access_key_id - - Env Var: RCLONE_S3_ACCESS_KEY_ID - - Type: string - - Default: "" - - #### --s3-secret-access-key - - AWS Secret Access Key (password) - Leave blank for anonymous access or runtime credentials. - - - Config: secret_access_key - - Env Var: RCLONE_S3_SECRET_ACCESS_KEY - - Type: string - - Default: "" - - #### --s3-region - + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + 2 / Ceph Object Storage + \ "Ceph" + 3 / Digital Ocean Spaces + \ "DigitalOcean" + 4 / Dreamhost DreamObjects + \ "Dreamhost" + 5 / IBM COS S3 + \ "IBMCOS" + 6 / Minio Object Storage + \ "Minio" + 7 / Wasabi Object Storage + \ "Wasabi" + 8 / Any other S3 compatible provider + \ "Other" + provider> 1 + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> XXX + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> YYY Region to connect to. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "us-east-1" - - The default endpoint - a good choice if you are unsure. - - US Region, Northern Virginia or Pacific Northwest. - - Leave location constraint empty. - - "us-east-2" - - US East (Ohio) Region - - Needs location constraint us-east-2. - - "us-west-2" - - US West (Oregon) Region - - Needs location constraint us-west-2. - - "us-west-1" - - US West (Northern California) Region - - Needs location constraint us-west-1. - - "ca-central-1" - - Canada (Central) Region - - Needs location constraint ca-central-1. - - "eu-west-1" - - EU (Ireland) Region - - Needs location constraint EU or eu-west-1. - - "eu-west-2" - - EU (London) Region - - Needs location constraint eu-west-2. - - "eu-north-1" - - EU (Stockholm) Region - - Needs location constraint eu-north-1. - - "eu-central-1" - - EU (Frankfurt) Region - - Needs location constraint eu-central-1. - - "ap-southeast-1" - - Asia Pacific (Singapore) Region - - Needs location constraint ap-southeast-1. - - "ap-southeast-2" - - Asia Pacific (Sydney) Region - - Needs location constraint ap-southeast-2. - - "ap-northeast-1" - - Asia Pacific (Tokyo) Region - - Needs location constraint ap-northeast-1. - - "ap-northeast-2" - - Asia Pacific (Seoul) - - Needs location constraint ap-northeast-2. - - "ap-south-1" - - Asia Pacific (Mumbai) - - Needs location constraint ap-south-1. - - "ap-east-1" - - Asia Patific (Hong Kong) Region - - Needs location constraint ap-east-1. - - "sa-east-1" - - South America (Sao Paulo) Region - - Needs location constraint sa-east-1. - - #### --s3-region - - Region to connect to. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "nl-ams" - - Amsterdam, The Netherlands - - "fr-par" - - Paris, France - - #### --s3-region - - Region to connect to. - Leave blank if you are using an S3 clone and you don't have a region. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "" - - Use this if unsure. Will use v4 signatures and an empty region. - - "other-v2-signature" - - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - - #### --s3-endpoint - + Choose a number from below, or type in your own value + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + / US East (Ohio) Region + 2 | Needs location constraint us-east-2. + \ "us-east-2" + / US West (Oregon) Region + 3 | Needs location constraint us-west-2. + \ "us-west-2" + / US West (Northern California) Region + 4 | Needs location constraint us-west-1. + \ "us-west-1" + / Canada (Central) Region + 5 | Needs location constraint ca-central-1. + \ "ca-central-1" + / EU (Ireland) Region + 6 | Needs location constraint EU or eu-west-1. + \ "eu-west-1" + / EU (London) Region + 7 | Needs location constraint eu-west-2. + \ "eu-west-2" + / EU (Frankfurt) Region + 8 | Needs location constraint eu-central-1. + \ "eu-central-1" + / Asia Pacific (Singapore) Region + 9 | Needs location constraint ap-southeast-1. + \ "ap-southeast-1" + / Asia Pacific (Sydney) Region + 10 | Needs location constraint ap-southeast-2. + \ "ap-southeast-2" + / Asia Pacific (Tokyo) Region + 11 | Needs location constraint ap-northeast-1. + \ "ap-northeast-1" + / Asia Pacific (Seoul) + 12 | Needs location constraint ap-northeast-2. + \ "ap-northeast-2" + / Asia Pacific (Mumbai) + 13 | Needs location constraint ap-south-1. + \ "ap-south-1" + / Asia Patific (Hong Kong) Region + 14 | Needs location constraint ap-east-1. + \ "ap-east-1" + / South America (Sao Paulo) Region + 15 | Needs location constraint sa-east-1. + \ "sa-east-1" + region> 1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - #### --s3-endpoint - - Endpoint for IBM COS S3 API. - Specify if using an IBM COS On Premise. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Endpoint - - "s3.dal.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Dallas Endpoint - - "s3.wdc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Washington DC Endpoint - - "s3.sjc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region San Jose Endpoint - - "s3.private.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Private Endpoint - - "s3.private.dal.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Dallas Private Endpoint - - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Washington DC Private Endpoint - - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region San Jose Private Endpoint - - "s3.us-east.cloud-object-storage.appdomain.cloud" - - US Region East Endpoint - - "s3.private.us-east.cloud-object-storage.appdomain.cloud" - - US Region East Private Endpoint - - "s3.us-south.cloud-object-storage.appdomain.cloud" - - US Region South Endpoint - - "s3.private.us-south.cloud-object-storage.appdomain.cloud" - - US Region South Private Endpoint - - "s3.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Endpoint - - "s3.fra.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Frankfurt Endpoint - - "s3.mil.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Milan Endpoint - - "s3.ams.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Amsterdam Endpoint - - "s3.private.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Private Endpoint - - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Frankfurt Private Endpoint - - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Milan Private Endpoint - - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Amsterdam Private Endpoint - - "s3.eu-gb.cloud-object-storage.appdomain.cloud" - - Great Britain Endpoint - - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud" - - Great Britain Private Endpoint - - "s3.eu-de.cloud-object-storage.appdomain.cloud" - - EU Region DE Endpoint - - "s3.private.eu-de.cloud-object-storage.appdomain.cloud" - - EU Region DE Private Endpoint - - "s3.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Endpoint - - "s3.tok.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Tokyo Endpoint - - "s3.hkg.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional HongKong Endpoint - - "s3.seo.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Seoul Endpoint - - "s3.private.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Private Endpoint - - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Tokyo Private Endpoint - - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional HongKong Private Endpoint - - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Seoul Private Endpoint - - "s3.jp-tok.cloud-object-storage.appdomain.cloud" - - APAC Region Japan Endpoint - - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud" - - APAC Region Japan Private Endpoint - - "s3.au-syd.cloud-object-storage.appdomain.cloud" - - APAC Region Australia Endpoint - - "s3.private.au-syd.cloud-object-storage.appdomain.cloud" - - APAC Region Australia Private Endpoint - - "s3.ams03.cloud-object-storage.appdomain.cloud" - - Amsterdam Single Site Endpoint - - "s3.private.ams03.cloud-object-storage.appdomain.cloud" - - Amsterdam Single Site Private Endpoint - - "s3.che01.cloud-object-storage.appdomain.cloud" - - Chennai Single Site Endpoint - - "s3.private.che01.cloud-object-storage.appdomain.cloud" - - Chennai Single Site Private Endpoint - - "s3.mel01.cloud-object-storage.appdomain.cloud" - - Melbourne Single Site Endpoint - - "s3.private.mel01.cloud-object-storage.appdomain.cloud" - - Melbourne Single Site Private Endpoint - - "s3.osl01.cloud-object-storage.appdomain.cloud" - - Oslo Single Site Endpoint - - "s3.private.osl01.cloud-object-storage.appdomain.cloud" - - Oslo Single Site Private Endpoint - - "s3.tor01.cloud-object-storage.appdomain.cloud" - - Toronto Single Site Endpoint - - "s3.private.tor01.cloud-object-storage.appdomain.cloud" - - Toronto Single Site Private Endpoint - - "s3.seo01.cloud-object-storage.appdomain.cloud" - - Seoul Single Site Endpoint - - "s3.private.seo01.cloud-object-storage.appdomain.cloud" - - Seoul Single Site Private Endpoint - - "s3.mon01.cloud-object-storage.appdomain.cloud" - - Montreal Single Site Endpoint - - "s3.private.mon01.cloud-object-storage.appdomain.cloud" - - Montreal Single Site Private Endpoint - - "s3.mex01.cloud-object-storage.appdomain.cloud" - - Mexico Single Site Endpoint - - "s3.private.mex01.cloud-object-storage.appdomain.cloud" - - Mexico Single Site Private Endpoint - - "s3.sjc04.cloud-object-storage.appdomain.cloud" - - San Jose Single Site Endpoint - - "s3.private.sjc04.cloud-object-storage.appdomain.cloud" - - San Jose Single Site Private Endpoint - - "s3.mil01.cloud-object-storage.appdomain.cloud" - - Milan Single Site Endpoint - - "s3.private.mil01.cloud-object-storage.appdomain.cloud" - - Milan Single Site Private Endpoint - - "s3.hkg02.cloud-object-storage.appdomain.cloud" - - Hong Kong Single Site Endpoint - - "s3.private.hkg02.cloud-object-storage.appdomain.cloud" - - Hong Kong Single Site Private Endpoint - - "s3.par01.cloud-object-storage.appdomain.cloud" - - Paris Single Site Endpoint - - "s3.private.par01.cloud-object-storage.appdomain.cloud" - - Paris Single Site Private Endpoint - - "s3.sng01.cloud-object-storage.appdomain.cloud" - - Singapore Single Site Endpoint - - "s3.private.sng01.cloud-object-storage.appdomain.cloud" - - Singapore Single Site Private Endpoint - - #### --s3-endpoint - - Endpoint for OSS API. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "oss-cn-hangzhou.aliyuncs.com" - - East China 1 (Hangzhou) - - "oss-cn-shanghai.aliyuncs.com" - - East China 2 (Shanghai) - - "oss-cn-qingdao.aliyuncs.com" - - North China 1 (Qingdao) - - "oss-cn-beijing.aliyuncs.com" - - North China 2 (Beijing) - - "oss-cn-zhangjiakou.aliyuncs.com" - - North China 3 (Zhangjiakou) - - "oss-cn-huhehaote.aliyuncs.com" - - North China 5 (Huhehaote) - - "oss-cn-shenzhen.aliyuncs.com" - - South China 1 (Shenzhen) - - "oss-cn-hongkong.aliyuncs.com" - - Hong Kong (Hong Kong) - - "oss-us-west-1.aliyuncs.com" - - US West 1 (Silicon Valley) - - "oss-us-east-1.aliyuncs.com" - - US East 1 (Virginia) - - "oss-ap-southeast-1.aliyuncs.com" - - Southeast Asia Southeast 1 (Singapore) - - "oss-ap-southeast-2.aliyuncs.com" - - Asia Pacific Southeast 2 (Sydney) - - "oss-ap-southeast-3.aliyuncs.com" - - Southeast Asia Southeast 3 (Kuala Lumpur) - - "oss-ap-southeast-5.aliyuncs.com" - - Asia Pacific Southeast 5 (Jakarta) - - "oss-ap-northeast-1.aliyuncs.com" - - Asia Pacific Northeast 1 (Japan) - - "oss-ap-south-1.aliyuncs.com" - - Asia Pacific South 1 (Mumbai) - - "oss-eu-central-1.aliyuncs.com" - - Central Europe 1 (Frankfurt) - - "oss-eu-west-1.aliyuncs.com" - - West Europe (London) - - "oss-me-east-1.aliyuncs.com" - - Middle East 1 (Dubai) - - #### --s3-endpoint - - Endpoint for Scaleway Object Storage. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3.nl-ams.scw.cloud" - - Amsterdam Endpoint - - "s3.fr-par.scw.cloud" - - Paris Endpoint - - #### --s3-endpoint - - Endpoint for StackPath Object Storage. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3.us-east-2.stackpathstorage.com" - - US East Endpoint - - "s3.us-west-1.stackpathstorage.com" - - US West Endpoint - - "s3.eu-central-1.stackpathstorage.com" - - EU Endpoint - - #### --s3-endpoint - - Endpoint for S3 API. - Required when using an S3 clone. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "objects-us-east-1.dream.io" - - Dream Objects endpoint - - "nyc3.digitaloceanspaces.com" - - Digital Ocean Spaces New York 3 - - "ams3.digitaloceanspaces.com" - - Digital Ocean Spaces Amsterdam 3 - - "sgp1.digitaloceanspaces.com" - - Digital Ocean Spaces Singapore 1 - - "s3.wasabisys.com" - - Wasabi US East endpoint - - "s3.us-west-1.wasabisys.com" - - Wasabi US West endpoint - - "s3.eu-central-1.wasabisys.com" - - Wasabi EU Central endpoint - - #### --s3-location-constraint - - Location constraint - must be set to match the Region. - Used when creating buckets only. - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - Examples: - - "" - - Empty for US Region, Northern Virginia or Pacific Northwest. - - "us-east-2" - - US East (Ohio) Region. - - "us-west-2" - - US West (Oregon) Region. - - "us-west-1" - - US West (Northern California) Region. - - "ca-central-1" - - Canada (Central) Region. - - "eu-west-1" - - EU (Ireland) Region. - - "eu-west-2" - - EU (London) Region. - - "eu-north-1" - - EU (Stockholm) Region. - - "EU" - - EU Region. - - "ap-southeast-1" - - Asia Pacific (Singapore) Region. - - "ap-southeast-2" - - Asia Pacific (Sydney) Region. - - "ap-northeast-1" - - Asia Pacific (Tokyo) Region. - - "ap-northeast-2" - - Asia Pacific (Seoul) - - "ap-south-1" - - Asia Pacific (Mumbai) - - "ap-east-1" - - Asia Pacific (Hong Kong) - - "sa-east-1" - - South America (Sao Paulo) Region. - - #### --s3-location-constraint - - Location constraint - must match endpoint when using IBM Cloud Public. - For on-prem COS, do not make a selection from this list, hit enter - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - Examples: - - "us-standard" - - US Cross Region Standard - - "us-vault" - - US Cross Region Vault - - "us-cold" - - US Cross Region Cold - - "us-flex" - - US Cross Region Flex - - "us-east-standard" - - US East Region Standard - - "us-east-vault" - - US East Region Vault - - "us-east-cold" - - US East Region Cold - - "us-east-flex" - - US East Region Flex - - "us-south-standard" - - US South Region Standard - - "us-south-vault" - - US South Region Vault - - "us-south-cold" - - US South Region Cold - - "us-south-flex" - - US South Region Flex - - "eu-standard" - - EU Cross Region Standard - - "eu-vault" - - EU Cross Region Vault - - "eu-cold" - - EU Cross Region Cold - - "eu-flex" - - EU Cross Region Flex - - "eu-gb-standard" - - Great Britain Standard - - "eu-gb-vault" - - Great Britain Vault - - "eu-gb-cold" - - Great Britain Cold - - "eu-gb-flex" - - Great Britain Flex - - "ap-standard" - - APAC Standard - - "ap-vault" - - APAC Vault - - "ap-cold" - - APAC Cold - - "ap-flex" - - APAC Flex - - "mel01-standard" - - Melbourne Standard - - "mel01-vault" - - Melbourne Vault - - "mel01-cold" - - Melbourne Cold - - "mel01-flex" - - Melbourne Flex - - "tor01-standard" - - Toronto Standard - - "tor01-vault" - - Toronto Vault - - "tor01-cold" - - Toronto Cold - - "tor01-flex" - - Toronto Flex - - #### --s3-location-constraint - - Location constraint - must be set to match the Region. - Leave blank if not sure. Used when creating buckets only. - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - #### --s3-acl - - Canned ACL used when creating buckets and storing or copying objects. - - This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. - + endpoint> + Location constraint - must be set to match the Region. Used when creating buckets only. + Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \ "" + 2 / US East (Ohio) Region. + \ "us-east-2" + 3 / US West (Oregon) Region. + \ "us-west-2" + 4 / US West (Northern California) Region. + \ "us-west-1" + 5 / Canada (Central) Region. + \ "ca-central-1" + 6 / EU (Ireland) Region. + \ "eu-west-1" + 7 / EU (London) Region. + \ "eu-west-2" + 8 / EU Region. + \ "EU" + 9 / Asia Pacific (Singapore) Region. + \ "ap-southeast-1" + 10 / Asia Pacific (Sydney) Region. + \ "ap-southeast-2" + 11 / Asia Pacific (Tokyo) Region. + \ "ap-northeast-1" + 12 / Asia Pacific (Seoul) + \ "ap-northeast-2" + 13 / Asia Pacific (Mumbai) + \ "ap-south-1" + 14 / Asia Pacific (Hong Kong) + \ "ap-east-1" + 15 / South America (Sao Paulo) Region. + \ "sa-east-1" + location_constraint> 1 + Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \ "private" + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \ "public-read" + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. + 3 | Granting this on a bucket is generally not recommended. + \ "public-read-write" + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. + \ "authenticated-read" + / Object owner gets FULL_CONTROL. Bucket owner gets READ access. + 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \ "bucket-owner-read" + / Both the object owner and the bucket owner get FULL_CONTROL over the object. + 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \ "bucket-owner-full-control" + acl> 1 + The server-side encryption algorithm used when storing this object in S3. + Choose a number from below, or type in your own value + 1 / None + \ "" + 2 / AES256 + \ "AES256" + server_side_encryption> 1 + The storage class to use when storing objects in S3. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Standard storage class + \ "STANDARD" + 3 / Reduced redundancy storage class + \ "REDUCED_REDUNDANCY" + 4 / Standard Infrequent Access storage class + \ "STANDARD_IA" + 5 / One Zone Infrequent Access storage class + \ "ONEZONE_IA" + 6 / Glacier storage class + \ "GLACIER" + 7 / Glacier Deep Archive storage class + \ "DEEP_ARCHIVE" + 8 / Intelligent-Tiering storage class + \ "INTELLIGENT_TIERING" + storage_class> 1 + Remote config + -------------------- + [remote] + type = s3 + provider = AWS + env_auth = false + access_key_id = XXX + secret_access_key = YYY + region = us-east-1 + endpoint = + location_constraint = + acl = private + server_side_encryption = + storage_class = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> + +--fast-list + +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. + +--update and --use-server-modtime + +As noted below, the modified time is stored on metadata on the object. +It is used by default for all operations that require checking the time +a file was last updated. It allows rclone to treat the remote more like +a true filesystem, but it is inefficient because it requires an extra +API call to retrieve the metadata. + +For many operations, the time the object was last uploaded to the remote +is sufficient to determine if it is "dirty". By using --update along +with --use-server-modtime, you can avoid the extra API call and simply +upload files whose local modtime is newer than the time it was last +uploaded. + +Modified time + +The modified time is stored as metadata on the object as +X-Amz-Meta-Mtime as floating point since the epoch accurate to 1 ns. + +If the modification time needs to be updated rclone will attempt to +perform a server side copy to update the modification if the object can +be copied in a single part. In the case the object is larger than 5Gb or +is in Glacier or Glacier Deep Archive storage the object will be +uploaded rather than copied. + +Cleanup + +If you run rclone cleanup s3:bucket then it will remove all pending +multipart uploads older than 24 hours. You can use the -i flag to see +exactly what it will do. If you want more control over the expiry date +then run rclone backend cleanup s3:bucket -o max-age=1h to expire all +uploads older than one hour. You can use +rclone backend list-multipart-uploads s3:bucket to see the pending +multipart uploads. + +Restricted filename characters + +S3 allows any valid UTF-8 string as a key. + +Invalid UTF-8 bytes will be replaced, as they can't be used in XML. + +The following characters are replaced since these are problematic when +dealing with the REST API: + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + +The encoding will also encode these file names as they don't seem to +work with the SDK properly: + + File name Replacement + ----------- ------------- + . ． + .. ．． + +Multipart uploads + +rclone supports multipart uploads with S3 which means that it can upload +files bigger than 5GB. + +Note that files uploaded _both_ with multipart upload _and_ through +crypt remotes do not have MD5 sums. + +rclone switches from single part uploads to multipart uploads at the +point specified by --s3-upload-cutoff. This can be a maximum of 5GB and +a minimum of 0 (ie always upload multipart files). + +The chunk sizes used in the multipart upload are specified by +--s3-chunk-size and the number of chunks uploaded concurrently is +specified by --s3-upload-concurrency. + +Multipart uploads will use --transfers * --s3-upload-concurrency * +--s3-chunk-size extra memory. Single part uploads to not use extra +memory. + +Single part transfers can be faster than multipart transfers or slower +depending on your latency from S3 - the more latency, the more likely +single part transfers will be faster. + +Increasing --s3-upload-concurrency will increase throughput (8 would be +a sensible value) and increasing --s3-chunk-size also increases +throughput (16M would be sensible). Increasing either of these will use +more memory. The default values are high enough to gain most of the +possible performance without using too much memory. + +Buckets and Regions + +With Amazon S3 you can list buckets (rclone lsd) using any region, but +you can only access the content of a bucket from the region it was +created in. If you attempt to access a bucket from the wrong region, you +will get an error, incorrect region, the bucket is not in 'XXX' region. + +Authentication + +There are a number of ways to supply rclone with a set of AWS +credentials, with and without using the environment. + +The different authentication methods are tried in this order: + +- Directly in the rclone configuration file (env_auth = false in the + config file): + - access_key_id and secret_access_key are required. + - session_token can be optionally set when using AWS STS. +- Runtime configuration (env_auth = true in the config file): + - Export the following environment variables before running + rclone: + - Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY + - Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY + - Session Token: AWS_SESSION_TOKEN (optional) + - Or, use a named profile: + - Profile files are standard files used by AWS CLI tools + - By default it will use the profile in your home directory + (eg ~/.aws/credentials on unix based systems) file and the + "default" profile, to change set these environment + variables: + - AWS_SHARED_CREDENTIALS_FILE to control which file. + - AWS_PROFILE to control which profile to use. + - Or, run rclone in an ECS task with an IAM role (AWS only). + - Or, run rclone on an EC2 instance with an IAM role (AWS only). + - Or, run rclone in an EKS pod with an IAM role that is associated + with a service account (AWS only). + +If none of these option actually end up providing rclone with AWS +credentials then S3 interaction will be non-authenticated (see below). + +S3 Permissions + +When using the sync subcommand of rclone the following minimum +permissions are required to be available on the bucket being written to: + +- ListBucket +- DeleteObject +- GetObject +- PutObject +- PutObjectACL + +When using the lsd subcommand, the ListAllMyBuckets permission is +required. + +Example policy: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" + }, + "Action": [ + "s3:ListBucket", + "s3:DeleteObject", + "s3:GetObject", + "s3:PutObject", + "s3:PutObjectAcl" + ], + "Resource": [ + "arn:aws:s3:::BUCKET_NAME/*", + "arn:aws:s3:::BUCKET_NAME" + ] + }, + { + "Effect": "Allow", + "Action": "s3:ListAllMyBuckets", + "Resource": "arn:aws:s3:::*" + } + ] + } + +Notes on above: + +1. This is a policy that can be used when creating bucket. It assumes + that USER_NAME has been created. +2. The Resource entry must include both resource ARNs, as one implies + the bucket and the other implies the bucket's objects. + +For reference, here's an Ansible script that will generate one or more +buckets that will work with rclone sync. + +Key Management System (KMS) + +If you are using server side encryption with KMS then you will find you +can't transfer small objects. As a work-around you can use the +--ignore-checksum flag. + +A proper fix is being worked on in issue #1824. + +Glacier and Glacier Deep Archive + +You can upload objects using the glacier storage class or transition +them to glacier using a lifecycle policy. The bucket can still be synced +or copied into normally, but if rclone tries to access data from the +glacier storage class you will see an error like below. + + 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file + +In this case you need to restore the object(s) in question before using +rclone. + +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. + +Standard Options + +Here are the standard options specific to s3 (Amazon S3 Compliant +Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, Tencent COS, etc)). + +--s3-provider + +Choose your S3 provider. + +- Config: provider +- Env Var: RCLONE_S3_PROVIDER +- Type: string +- Default: "" +- Examples: + - "AWS" + - Amazon Web Services (AWS) S3 + - "Alibaba" + - Alibaba Cloud Object Storage System (OSS) formerly Aliyun + - "Ceph" + - Ceph Object Storage + - "DigitalOcean" + - Digital Ocean Spaces + - "Dreamhost" + - Dreamhost DreamObjects + - "IBMCOS" + - IBM COS S3 + - "Minio" + - Minio Object Storage + - "Netease" + - Netease Object Storage (NOS) + - "Scaleway" + - Scaleway Object Storage + - "StackPath" + - StackPath Object Storage + - "TencentCOS" + - Tencent Cloud Object Storage (COS) + - "Wasabi" + - Wasabi Object Storage + - "Other" + - Any other S3 compatible provider + +--s3-env-auth + +Get AWS credentials from runtime (environment variables or EC2/ECS meta +data if no env vars). Only applies if access_key_id and +secret_access_key is blank. + +- Config: env_auth +- Env Var: RCLONE_S3_ENV_AUTH +- Type: bool +- Default: false +- Examples: + - "false" + - Enter AWS credentials in the next step + - "true" + - Get AWS credentials from the environment (env vars or IAM) + +--s3-access-key-id + +AWS Access Key ID. Leave blank for anonymous access or runtime +credentials. + +- Config: access_key_id +- Env Var: RCLONE_S3_ACCESS_KEY_ID +- Type: string +- Default: "" + +--s3-secret-access-key + +AWS Secret Access Key (password) Leave blank for anonymous access or +runtime credentials. + +- Config: secret_access_key +- Env Var: RCLONE_S3_SECRET_ACCESS_KEY +- Type: string +- Default: "" + +--s3-region + +Region to connect to. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "us-east-1" + - The default endpoint - a good choice if you are unsure. + - US Region, Northern Virginia or Pacific Northwest. + - Leave location constraint empty. + - "us-east-2" + - US East (Ohio) Region + - Needs location constraint us-east-2. + - "us-west-2" + - US West (Oregon) Region + - Needs location constraint us-west-2. + - "us-west-1" + - US West (Northern California) Region + - Needs location constraint us-west-1. + - "ca-central-1" + - Canada (Central) Region + - Needs location constraint ca-central-1. + - "eu-west-1" + - EU (Ireland) Region + - Needs location constraint EU or eu-west-1. + - "eu-west-2" + - EU (London) Region + - Needs location constraint eu-west-2. + - "eu-north-1" + - EU (Stockholm) Region + - Needs location constraint eu-north-1. + - "eu-central-1" + - EU (Frankfurt) Region + - Needs location constraint eu-central-1. + - "ap-southeast-1" + - Asia Pacific (Singapore) Region + - Needs location constraint ap-southeast-1. + - "ap-southeast-2" + - Asia Pacific (Sydney) Region + - Needs location constraint ap-southeast-2. + - "ap-northeast-1" + - Asia Pacific (Tokyo) Region + - Needs location constraint ap-northeast-1. + - "ap-northeast-2" + - Asia Pacific (Seoul) + - Needs location constraint ap-northeast-2. + - "ap-south-1" + - Asia Pacific (Mumbai) + - Needs location constraint ap-south-1. + - "ap-east-1" + - Asia Patific (Hong Kong) Region + - Needs location constraint ap-east-1. + - "sa-east-1" + - South America (Sao Paulo) Region + - Needs location constraint sa-east-1. + +--s3-region + +Region to connect to. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "nl-ams" + - Amsterdam, The Netherlands + - "fr-par" + - Paris, France + +--s3-region + +Region to connect to. Leave blank if you are using an S3 clone and you +don't have a region. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "" + - Use this if unsure. Will use v4 signatures and an empty + region. + - "other-v2-signature" + - Use this only if v4 signatures don't work, eg pre Jewel/v10 + CEPH. + +--s3-endpoint + +Endpoint for S3 API. Leave blank if using AWS to use the default +endpoint for the region. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" + +--s3-endpoint + +Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Endpoint + - "s3.dal.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Dallas Endpoint + - "s3.wdc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Washington DC Endpoint + - "s3.sjc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region San Jose Endpoint + - "s3.private.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Private Endpoint + - "s3.private.dal.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Dallas Private Endpoint + - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Washington DC Private Endpoint + - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region San Jose Private Endpoint + - "s3.us-east.cloud-object-storage.appdomain.cloud" + - US Region East Endpoint + - "s3.private.us-east.cloud-object-storage.appdomain.cloud" + - US Region East Private Endpoint + - "s3.us-south.cloud-object-storage.appdomain.cloud" + - US Region South Endpoint + - "s3.private.us-south.cloud-object-storage.appdomain.cloud" + - US Region South Private Endpoint + - "s3.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Endpoint + - "s3.fra.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Frankfurt Endpoint + - "s3.mil.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Milan Endpoint + - "s3.ams.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Amsterdam Endpoint + - "s3.private.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Private Endpoint + - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Frankfurt Private Endpoint + - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Milan Private Endpoint + - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Amsterdam Private Endpoint + - "s3.eu-gb.cloud-object-storage.appdomain.cloud" + - Great Britain Endpoint + - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud" + - Great Britain Private Endpoint + - "s3.eu-de.cloud-object-storage.appdomain.cloud" + - EU Region DE Endpoint + - "s3.private.eu-de.cloud-object-storage.appdomain.cloud" + - EU Region DE Private Endpoint + - "s3.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Endpoint + - "s3.tok.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Tokyo Endpoint + - "s3.hkg.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional HongKong Endpoint + - "s3.seo.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Seoul Endpoint + - "s3.private.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Private Endpoint + - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Tokyo Private Endpoint + - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional HongKong Private Endpoint + - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Seoul Private Endpoint + - "s3.jp-tok.cloud-object-storage.appdomain.cloud" + - APAC Region Japan Endpoint + - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud" + - APAC Region Japan Private Endpoint + - "s3.au-syd.cloud-object-storage.appdomain.cloud" + - APAC Region Australia Endpoint + - "s3.private.au-syd.cloud-object-storage.appdomain.cloud" + - APAC Region Australia Private Endpoint + - "s3.ams03.cloud-object-storage.appdomain.cloud" + - Amsterdam Single Site Endpoint + - "s3.private.ams03.cloud-object-storage.appdomain.cloud" + - Amsterdam Single Site Private Endpoint + - "s3.che01.cloud-object-storage.appdomain.cloud" + - Chennai Single Site Endpoint + - "s3.private.che01.cloud-object-storage.appdomain.cloud" + - Chennai Single Site Private Endpoint + - "s3.mel01.cloud-object-storage.appdomain.cloud" + - Melbourne Single Site Endpoint + - "s3.private.mel01.cloud-object-storage.appdomain.cloud" + - Melbourne Single Site Private Endpoint + - "s3.osl01.cloud-object-storage.appdomain.cloud" + - Oslo Single Site Endpoint + - "s3.private.osl01.cloud-object-storage.appdomain.cloud" + - Oslo Single Site Private Endpoint + - "s3.tor01.cloud-object-storage.appdomain.cloud" + - Toronto Single Site Endpoint + - "s3.private.tor01.cloud-object-storage.appdomain.cloud" + - Toronto Single Site Private Endpoint + - "s3.seo01.cloud-object-storage.appdomain.cloud" + - Seoul Single Site Endpoint + - "s3.private.seo01.cloud-object-storage.appdomain.cloud" + - Seoul Single Site Private Endpoint + - "s3.mon01.cloud-object-storage.appdomain.cloud" + - Montreal Single Site Endpoint + - "s3.private.mon01.cloud-object-storage.appdomain.cloud" + - Montreal Single Site Private Endpoint + - "s3.mex01.cloud-object-storage.appdomain.cloud" + - Mexico Single Site Endpoint + - "s3.private.mex01.cloud-object-storage.appdomain.cloud" + - Mexico Single Site Private Endpoint + - "s3.sjc04.cloud-object-storage.appdomain.cloud" + - San Jose Single Site Endpoint + - "s3.private.sjc04.cloud-object-storage.appdomain.cloud" + - San Jose Single Site Private Endpoint + - "s3.mil01.cloud-object-storage.appdomain.cloud" + - Milan Single Site Endpoint + - "s3.private.mil01.cloud-object-storage.appdomain.cloud" + - Milan Single Site Private Endpoint + - "s3.hkg02.cloud-object-storage.appdomain.cloud" + - Hong Kong Single Site Endpoint + - "s3.private.hkg02.cloud-object-storage.appdomain.cloud" + - Hong Kong Single Site Private Endpoint + - "s3.par01.cloud-object-storage.appdomain.cloud" + - Paris Single Site Endpoint + - "s3.private.par01.cloud-object-storage.appdomain.cloud" + - Paris Single Site Private Endpoint + - "s3.sng01.cloud-object-storage.appdomain.cloud" + - Singapore Single Site Endpoint + - "s3.private.sng01.cloud-object-storage.appdomain.cloud" + - Singapore Single Site Private Endpoint + +--s3-endpoint + +Endpoint for OSS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "oss-cn-hangzhou.aliyuncs.com" + - East China 1 (Hangzhou) + - "oss-cn-shanghai.aliyuncs.com" + - East China 2 (Shanghai) + - "oss-cn-qingdao.aliyuncs.com" + - North China 1 (Qingdao) + - "oss-cn-beijing.aliyuncs.com" + - North China 2 (Beijing) + - "oss-cn-zhangjiakou.aliyuncs.com" + - North China 3 (Zhangjiakou) + - "oss-cn-huhehaote.aliyuncs.com" + - North China 5 (Huhehaote) + - "oss-cn-shenzhen.aliyuncs.com" + - South China 1 (Shenzhen) + - "oss-cn-hongkong.aliyuncs.com" + - Hong Kong (Hong Kong) + - "oss-us-west-1.aliyuncs.com" + - US West 1 (Silicon Valley) + - "oss-us-east-1.aliyuncs.com" + - US East 1 (Virginia) + - "oss-ap-southeast-1.aliyuncs.com" + - Southeast Asia Southeast 1 (Singapore) + - "oss-ap-southeast-2.aliyuncs.com" + - Asia Pacific Southeast 2 (Sydney) + - "oss-ap-southeast-3.aliyuncs.com" + - Southeast Asia Southeast 3 (Kuala Lumpur) + - "oss-ap-southeast-5.aliyuncs.com" + - Asia Pacific Southeast 5 (Jakarta) + - "oss-ap-northeast-1.aliyuncs.com" + - Asia Pacific Northeast 1 (Japan) + - "oss-ap-south-1.aliyuncs.com" + - Asia Pacific South 1 (Mumbai) + - "oss-eu-central-1.aliyuncs.com" + - Central Europe 1 (Frankfurt) + - "oss-eu-west-1.aliyuncs.com" + - West Europe (London) + - "oss-me-east-1.aliyuncs.com" + - Middle East 1 (Dubai) + +--s3-endpoint + +Endpoint for Scaleway Object Storage. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.nl-ams.scw.cloud" + - Amsterdam Endpoint + - "s3.fr-par.scw.cloud" + - Paris Endpoint + +--s3-endpoint + +Endpoint for StackPath Object Storage. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.us-east-2.stackpathstorage.com" + - US East Endpoint + - "s3.us-west-1.stackpathstorage.com" + - US West Endpoint + - "s3.eu-central-1.stackpathstorage.com" + - EU Endpoint + +--s3-endpoint + +Endpoint for Tencent COS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "cos.ap-beijing.myqcloud.com" + - Beijing Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-shanghai.myqcloud.com" + - Shanghai Region. + - "cos.ap-guangzhou.myqcloud.com" + - Guangzhou Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-chengdu.myqcloud.com" + - Chengdu Region. + - "cos.ap-chongqing.myqcloud.com" + - Chongqing Region. + - "cos.ap-hongkong.myqcloud.com" + - Hong Kong (China) Region. + - "cos.ap-singapore.myqcloud.com" + - Singapore Region. + - "cos.ap-mumbai.myqcloud.com" + - Mumbai Region. + - "cos.ap-seoul.myqcloud.com" + - Seoul Region. + - "cos.ap-bangkok.myqcloud.com" + - Bangkok Region. + - "cos.ap-tokyo.myqcloud.com" + - Tokyo Region. + - "cos.na-siliconvalley.myqcloud.com" + - Silicon Valley Region. + - "cos.na-ashburn.myqcloud.com" + - Virginia Region. + - "cos.na-toronto.myqcloud.com" + - Toronto Region. + - "cos.eu-frankfurt.myqcloud.com" + - Frankfurt Region. + - "cos.eu-moscow.myqcloud.com" + - Moscow Region. + - "cos.accelerate.myqcloud.com" + - Use Tencent COS Accelerate Endpoint. + +--s3-endpoint + +Endpoint for S3 API. Required when using an S3 clone. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "objects-us-east-1.dream.io" + - Dream Objects endpoint + - "nyc3.digitaloceanspaces.com" + - Digital Ocean Spaces New York 3 + - "ams3.digitaloceanspaces.com" + - Digital Ocean Spaces Amsterdam 3 + - "sgp1.digitaloceanspaces.com" + - Digital Ocean Spaces Singapore 1 + - "s3.wasabisys.com" + - Wasabi US East endpoint + - "s3.us-west-1.wasabisys.com" + - Wasabi US West endpoint + - "s3.eu-central-1.wasabisys.com" + - Wasabi EU Central endpoint + +--s3-location-constraint + +Location constraint - must be set to match the Region. Used when +creating buckets only. + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" +- Examples: + - "" + - Empty for US Region, Northern Virginia or Pacific Northwest. + - "us-east-2" + - US East (Ohio) Region. + - "us-west-2" + - US West (Oregon) Region. + - "us-west-1" + - US West (Northern California) Region. + - "ca-central-1" + - Canada (Central) Region. + - "eu-west-1" + - EU (Ireland) Region. + - "eu-west-2" + - EU (London) Region. + - "eu-north-1" + - EU (Stockholm) Region. + - "EU" + - EU Region. + - "ap-southeast-1" + - Asia Pacific (Singapore) Region. + - "ap-southeast-2" + - Asia Pacific (Sydney) Region. + - "ap-northeast-1" + - Asia Pacific (Tokyo) Region. + - "ap-northeast-2" + - Asia Pacific (Seoul) + - "ap-south-1" + - Asia Pacific (Mumbai) + - "ap-east-1" + - Asia Pacific (Hong Kong) + - "sa-east-1" + - South America (Sao Paulo) Region. + +--s3-location-constraint + +Location constraint - must match endpoint when using IBM Cloud Public. +For on-prem COS, do not make a selection from this list, hit enter + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" +- Examples: + - "us-standard" + - US Cross Region Standard + - "us-vault" + - US Cross Region Vault + - "us-cold" + - US Cross Region Cold + - "us-flex" + - US Cross Region Flex + - "us-east-standard" + - US East Region Standard + - "us-east-vault" + - US East Region Vault + - "us-east-cold" + - US East Region Cold + - "us-east-flex" + - US East Region Flex + - "us-south-standard" + - US South Region Standard + - "us-south-vault" + - US South Region Vault + - "us-south-cold" + - US South Region Cold + - "us-south-flex" + - US South Region Flex + - "eu-standard" + - EU Cross Region Standard + - "eu-vault" + - EU Cross Region Vault + - "eu-cold" + - EU Cross Region Cold + - "eu-flex" + - EU Cross Region Flex + - "eu-gb-standard" + - Great Britain Standard + - "eu-gb-vault" + - Great Britain Vault + - "eu-gb-cold" + - Great Britain Cold + - "eu-gb-flex" + - Great Britain Flex + - "ap-standard" + - APAC Standard + - "ap-vault" + - APAC Vault + - "ap-cold" + - APAC Cold + - "ap-flex" + - APAC Flex + - "mel01-standard" + - Melbourne Standard + - "mel01-vault" + - Melbourne Vault + - "mel01-cold" + - Melbourne Cold + - "mel01-flex" + - Melbourne Flex + - "tor01-standard" + - Toronto Standard + - "tor01-vault" + - Toronto Vault + - "tor01-cold" + - Toronto Cold + - "tor01-flex" + - Toronto Flex + +--s3-location-constraint + +Location constraint - must be set to match the Region. Leave blank if +not sure. Used when creating buckets only. + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" + +--s3-acl + +Canned ACL used when creating buckets and storing or copying objects. + +This ACL is used for creating objects and if bucket_acl isn't set, for +creating buckets too. + +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + +Note that this ACL is applied when server side copying objects as S3 +doesn't copy the ACL from the source but rather writes a fresh one. + +- Config: acl +- Env Var: RCLONE_S3_ACL +- Type: string +- Default: "" +- Examples: + - "default" + - Owner gets Full_CONTROL. No one else has access rights + (default). + - "private" + - Owner gets FULL_CONTROL. No one else has access rights + (default). + - "public-read" + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. + - "public-read-write" + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. + - Granting this on a bucket is generally not recommended. + - "authenticated-read" + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. + - "bucket-owner-read" + - Object owner gets FULL_CONTROL. Bucket owner gets READ + access. + - If you specify this canned ACL when creating a bucket, + Amazon S3 ignores it. + - "bucket-owner-full-control" + - Both the object owner and the bucket owner get FULL_CONTROL + over the object. + - If you specify this canned ACL when creating a bucket, + Amazon S3 ignores it. + - "private" + - Owner gets FULL_CONTROL. No one else has access rights + (default). This acl is available on IBM Cloud (Infra), IBM + Cloud (Storage), On-Premise COS + - "public-read" + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. This acl is available on IBM Cloud (Infra), IBM + Cloud (Storage), On-Premise IBM COS + - "public-read-write" + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. This acl is available on IBM Cloud (Infra), + On-Premise IBM COS + - "authenticated-read" + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. Not supported on Buckets. This acl is available + on IBM Cloud (Infra) and On-Premise IBM COS + +--s3-server-side-encryption + +The server-side encryption algorithm used when storing this object in +S3. + +- Config: server_side_encryption +- Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION +- Type: string +- Default: "" +- Examples: + - "" + - None + - "AES256" + - AES256 + - "aws:kms" + - aws:kms + +--s3-sse-kms-key-id + +If using KMS ID you must provide the ARN of Key. + +- Config: sse_kms_key_id +- Env Var: RCLONE_S3_SSE_KMS_KEY_ID +- Type: string +- Default: "" +- Examples: + - "" + - None + - "arn:aws:kms:us-east-1:*" + - arn:aws:kms:* + +--s3-storage-class + +The storage class to use when storing new objects in S3. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "REDUCED_REDUNDANCY" + - Reduced redundancy storage class + - "STANDARD_IA" + - Standard Infrequent Access storage class + - "ONEZONE_IA" + - One Zone Infrequent Access storage class + - "GLACIER" + - Glacier storage class + - "DEEP_ARCHIVE" + - Glacier Deep Archive storage class + - "INTELLIGENT_TIERING" + - Intelligent-Tiering storage class + +--s3-storage-class + +The storage class to use when storing new objects in OSS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "GLACIER" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +--s3-storage-class + +The storage class to use when storing new objects in Tencent COS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "ARCHIVE" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +--s3-storage-class + +The storage class to use when storing new objects in S3. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - The Standard class for any upload; suitable for on-demand + content like streaming or CDN. + - "GLACIER" + - Archived storage; prices are lower, but it needs to be + restored first to be accessed. + +Advanced Options + +Here are the advanced options specific to s3 (Amazon S3 Compliant +Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, Tencent COS, etc)). + +--s3-bucket-acl + +Canned ACL used when creating buckets. + +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + +Note that this ACL is applied when only when creating buckets. If it +isn't set then "acl" is used instead. + +- Config: bucket_acl +- Env Var: RCLONE_S3_BUCKET_ACL +- Type: string +- Default: "" +- Examples: + - "private" + - Owner gets FULL_CONTROL. No one else has access rights + (default). + - "public-read" + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. + - "public-read-write" + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. + - Granting this on a bucket is generally not recommended. + - "authenticated-read" + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. + +--s3-sse-customer-algorithm + +If using SSE-C, the server-side encryption algorithm used when storing +this object in S3. + +- Config: sse_customer_algorithm +- Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM +- Type: string +- Default: "" +- Examples: + - "" + - None + - "AES256" + - AES256 + +--s3-sse-customer-key + +If using SSE-C you must provide the secret encryption key used to +encrypt/decrypt your data. + +- Config: sse_customer_key +- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY +- Type: string +- Default: "" +- Examples: + - "" + - None + +--s3-sse-customer-key-md5 + +If using SSE-C you must provide the secret encryption key MD5 checksum. + +- Config: sse_customer_key_md5 +- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 +- Type: string +- Default: "" +- Examples: + - "" + - None + +--s3-upload-cutoff + +Cutoff for switching to chunked upload + +Any files larger than this will be uploaded in chunks of chunk_size. The +minimum is 0 and the maximum is 5GB. + +- Config: upload_cutoff +- Env Var: RCLONE_S3_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 200M + +--s3-chunk-size + +Chunk size to use for uploading. + +When uploading files larger than upload_cutoff or files with unknown +size (eg from "rclone rcat" or uploaded with "rclone mount" or google +photos or google docs) they will be uploaded as multipart uploads using +this chunk size. + +Note that "--s3-upload-concurrency" chunks of this size are buffered in +memory per transfer. + +If you are transferring large files over high speed links and you have +enough memory, then increasing this will speed up the transfers. + +Rclone will automatically increase the chunk size when uploading a large +file of known size to stay below the 10,000 chunks limit. + +Files of unknown size are uploaded with the configured chunk_size. Since +the default chunk size is 5MB and there can be at most 10,000 chunks, +this means that by default the maximum size of file you can stream +upload is 48GB. If you wish to stream upload larger files then you will +need to increase chunk_size. + +- Config: chunk_size +- Env Var: RCLONE_S3_CHUNK_SIZE +- Type: SizeSuffix +- Default: 5M + +--s3-max-upload-parts + +Maximum number of parts in a multipart upload. + +This option defines the maximum number of multipart chunks to use when +doing a multipart upload. + +This can be useful if a service does not support the AWS S3 +specification of 10,000 chunks. + +Rclone will automatically increase the chunk size when uploading a large +file of a known size to stay below this number of chunks limit. + +- Config: max_upload_parts +- Env Var: RCLONE_S3_MAX_UPLOAD_PARTS +- Type: int +- Default: 10000 + +--s3-copy-cutoff + +Cutoff for switching to multipart copy + +Any files larger than this that need to be server side copied will be +copied in chunks of this size. + +The minimum is 0 and the maximum is 5GB. + +- Config: copy_cutoff +- Env Var: RCLONE_S3_COPY_CUTOFF +- Type: SizeSuffix +- Default: 4.656G + +--s3-disable-checksum + +Don't store MD5 checksum with object metadata + +Normally rclone will calculate the MD5 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files to +start uploading. + +- Config: disable_checksum +- Env Var: RCLONE_S3_DISABLE_CHECKSUM +- Type: bool +- Default: false + +--s3-shared-credentials-file + +Path to the shared credentials file + +If env_auth = true then rclone can use a shared credentials file. + +If this variable is empty rclone will look for the +"AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it +will default to the current user's home directory. + + Linux/OSX: "$HOME/.aws/credentials" + Windows: "%USERPROFILE%\.aws\credentials" + +- Config: shared_credentials_file +- Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE +- Type: string +- Default: "" + +--s3-profile + +Profile to use in the shared credentials file + +If env_auth = true then rclone can use a shared credentials file. This +variable controls which profile is used in that file. + +If empty it will default to the environment variable "AWS_PROFILE" or +"default" if that environment variable is also not set. + +- Config: profile +- Env Var: RCLONE_S3_PROFILE +- Type: string +- Default: "" + +--s3-session-token + +An AWS session token + +- Config: session_token +- Env Var: RCLONE_S3_SESSION_TOKEN +- Type: string +- Default: "" + +--s3-upload-concurrency + +Concurrency for multipart uploads. + +This is the number of chunks of the same file that are uploaded +concurrently. + +If you are uploading small numbers of large file over high speed link +and these uploads do not fully utilize your bandwidth, then increasing +this may help to speed up the transfers. + +- Config: upload_concurrency +- Env Var: RCLONE_S3_UPLOAD_CONCURRENCY +- Type: int +- Default: 4 + +--s3-force-path-style + +If true use path style access if false use virtual hosted style. + +If this is true (the default) then rclone will use path style access, if +false then rclone will use virtual path style. See the AWS S3 docs for +more info. + +Some providers (eg AWS, Aliyun OSS, Netease COS or Tencent COS) require +this set to false - rclone will do this automatically based on the +provider setting. + +- Config: force_path_style +- Env Var: RCLONE_S3_FORCE_PATH_STYLE +- Type: bool +- Default: true + +--s3-v2-auth + +If true use v2 authentication. + +If this is false (the default) then rclone will use v4 authentication. +If it is set then rclone will use v2 authentication. + +Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. + +- Config: v2_auth +- Env Var: RCLONE_S3_V2_AUTH +- Type: bool +- Default: false + +--s3-use-accelerate-endpoint + +If true use the AWS S3 accelerated endpoint. + +See: AWS S3 Transfer acceleration + +- Config: use_accelerate_endpoint +- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +- Type: bool +- Default: false + +--s3-leave-parts-on-error + +If true avoid calling abort upload on a failure, leaving all +successfully uploaded parts on S3 for manual recovery. + +It should be set to true for resuming uploads across different sessions. + +WARNING: Storing parts of an incomplete multipart upload counts towards +space usage on S3 and will add additional costs if not cleaned up. + +- Config: leave_parts_on_error +- Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR +- Type: bool +- Default: false + +--s3-list-chunk + +Size of listing chunk (response list for each ListObject S3 request). + +This option is also known as "MaxKeys", "max-items", or "page-size" from +the AWS S3 specification. Most services truncate the response list to +1000 objects even if requested more than that. In AWS S3 this is a +global maximum and cannot be changed, see AWS S3. In Ceph, this can be +increased with the "rgw list buckets max chunk" option. + +- Config: list_chunk +- Env Var: RCLONE_S3_LIST_CHUNK +- Type: int +- Default: 1000 + +--s3-no-check-bucket + +If set don't attempt to check the bucket exists or create it + +This can be useful when trying to minimise the number of transactions +rclone does if you know the bucket exists already. + +- Config: no_check_bucket +- Env Var: RCLONE_S3_NO_CHECK_BUCKET +- Type: bool +- Default: false + +--s3-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_S3_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + +--s3-memory-pool-flush-time + +How often internal memory buffer pools will be flushed. Uploads which +requires additional buffers (f.e multipart) will use memory pool for +allocations. This option controls how often unused buffers will be +removed from the pool. + +- Config: memory_pool_flush_time +- Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME +- Type: Duration +- Default: 1m0s + +--s3-memory-pool-use-mmap + +Whether to use mmap buffers in internal memory pool. + +- Config: memory_pool_use_mmap +- Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP +- Type: bool +- Default: false + +Backend commands + +Here are the commands specific to the s3 backend. + +Run them with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See the "rclone backend" command for more info on how to pass options +and arguments. + +These can be run on a running backend using the rc command +backend/command. + +restore + +Restore objects from GLACIER to normal storage + + rclone backend restore remote: [options] [+] + +This command can be used to restore one or more objects from GLACIER to +normal storage. + +Usage Examples: + + rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS] + rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS] + rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS] + +This flag also obeys the filters. Test first with -i/--interactive or +--dry-run flags + + rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard + +All the objects shown will be marked for restore, then + + rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard + +It returns a list of status dictionaries with Remote and Status keys. +The Status will be OK if it was successfull or an error message if not. + + [ + { + "Status": "OK", + "Path": "test.txt" + }, + { + "Status": "OK", + "Path": "test/file4.txt" + } + ] + +Options: + +- "description": The optional description for the job. +- "lifetime": Lifetime of the active copy in days +- "priority": Priority of restore: Standard|Expedited|Bulk + +list-multipart-uploads + +List the unfinished multipart uploads + + rclone backend list-multipart-uploads remote: [options] [+] + +This command lists the unfinished multipart uploads in JSON format. + + rclone backend list-multipart s3:bucket/path/to/object + +It returns a dictionary of buckets with values as lists of unfinished +multipart uploads. + +You can call it with no bucket in which case it lists all bucket, with a +bucket or with a bucket and path. + + { + "rclone": [ + { + "Initiated": "2020-06-26T14:20:36Z", + "Initiator": { + "DisplayName": "XXX", + "ID": "arn:aws:iam::XXX:user/XXX" + }, + "Key": "KEY", + "Owner": { + "DisplayName": null, + "ID": "XXX" + }, + "StorageClass": "STANDARD", + "UploadId": "XXX" + } + ], + "rclone-1000files": [], + "rclone-dst": [] + } + +cleanup + +Remove unfinished multipart uploads. + + rclone backend cleanup remote: [options] [+] + +This command removes unfinished multipart uploads of age greater than +max-age which defaults to 24 hours. + +Note that you can use -i/--dry-run with this command to see what it +would do. + + rclone backend cleanup s3:bucket/path/to/object + rclone backend cleanup -o max-age=7w s3:bucket/path/to/object + +Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. + +Options: + +- "max-age": Max age of upload to delete + +Anonymous access to public buckets + +If you want to use rclone to access a public bucket, configure with a +blank access_key_id and secret_access_key. Your config should end up +looking like this: + + [anons3] + type = s3 + provider = AWS + env_auth = false + access_key_id = + secret_access_key = + region = us-east-1 + endpoint = + location_constraint = + acl = private + server_side_encryption = + storage_class = + +Then use it as normal with the name of the public bucket, eg + + rclone lsd anons3:1000genomes + +You will be able to list and copy data but not upload it. + +Ceph + +Ceph is an open source unified, distributed storage system designed for +excellent performance, reliability and scalability. It has an S3 +compatible object storage interface. + +To use rclone with Ceph, configure as above but leave the region blank +and set the endpoint. You should end up with something like this in your +config: + + [ceph] + type = s3 + provider = Ceph + env_auth = false + access_key_id = XXX + secret_access_key = YYY + region = + endpoint = https://ceph.endpoint.example.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +If you are using an older version of CEPH, eg 10.2.x Jewel, then you may +need to supply the parameter --s3-upload-cutoff 0 or put this in the +config file as upload_cutoff 0 to work around a bug which causes +uploading of small files to fail. + +Note also that Ceph sometimes puts / in the passwords it gives users. If +you read the secret access key using the command line tools you will get +a JSON blob with the / escaped as \/. Make sure you only write / in the +secret access key. + +Eg the dump from Ceph looks something like this (irrelevant keys +removed). + + { + "user_id": "xxx", + "display_name": "xxxx", + "keys": [ + { + "user": "xxx", + "access_key": "xxxxxx", + "secret_key": "xxxxxx\/xxxx" + } + ], + } + +Because this is a json dump, it is encoding the / as \/, so if you use +the secret key as xxxxxx/xxxx it will work fine. + +Dreamhost + +Dreamhost DreamObjects is an object storage system based on CEPH. + +To use rclone with Dreamhost, configure as above but leave the region +blank and set the endpoint. You should end up with something like this +in your config: + + [dreamobjects] + type = s3 + provider = DreamHost + env_auth = false + access_key_id = your_access_key + secret_access_key = your_secret_key + region = + endpoint = objects-us-west-1.dream.io + location_constraint = + acl = private + server_side_encryption = + storage_class = + +DigitalOcean Spaces + +Spaces is an S3-interoperable object storage service from cloud provider +DigitalOcean. + +To connect to DigitalOcean Spaces you will need an access key and secret +key. These can be retrieved on the "Applications & API" page of the +DigitalOcean control panel. They will be needed when prompted by +rclone config for your access_key_id and secret_access_key. + +When prompted for a region or location_constraint, press enter to use +the default value. The region must be included in the endpoint setting +(e.g. nyc3.digitaloceanspaces.com). The default values can be used for +other settings. + +Going through the whole process of creating a new remote by running +rclone config, each prompt should be answered as shown below: + + Storage> s3 + env_auth> 1 + access_key_id> YOUR_ACCESS_KEY + secret_access_key> YOUR_SECRET_KEY + region> + endpoint> nyc3.digitaloceanspaces.com + location_constraint> + acl> + storage_class> + +The resulting configuration file should look like: + + [spaces] + type = s3 + provider = DigitalOcean + env_auth = false + access_key_id = YOUR_ACCESS_KEY + secret_access_key = YOUR_SECRET_KEY + region = + endpoint = nyc3.digitaloceanspaces.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +Once configured, you can create a new Space and begin copying files. For +example: + + rclone mkdir spaces:my-new-space + rclone copy /path/to/files spaces:my-new-space + +IBM COS (S3) + +Information stored with IBM Cloud Object Storage is encrypted and +dispersed across multiple geographic locations, and accessed through an +implementation of the S3 API. This service makes use of the distributed +storage technologies provided by IBM’s Cloud Object Storage System +(formerly Cleversafe). For more information visit: +(http://www.ibm.com/cloud/object-storage) + +To configure access to IBM COS S3, follow the steps below: + +1. Run rclone config and select n for a new remote. + + 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + +2. Enter the name for the configuration + + name> + +3. Select "s3" storage. + + Choose a number from below, or type in your own value + 1 / Alias for an existing remote + \ "alias" + 2 / Amazon Drive + \ "amazon cloud drive" + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + \ "s3" + 4 / Backblaze B2 + \ "b2" + [snip] + 23 / http Connection + \ "http" + Storage> 3 + +4. Select IBM COS as the S3 Storage Provider. + + Choose the S3 provider. + Choose a number from below, or type in your own value + 1 / Choose this option to configure Storage to AWS S3 + \ "AWS" + 2 / Choose this option to configure Storage to Ceph Systems + \ "Ceph" + 3 / Choose this option to configure Storage to Dreamhost + \ "Dreamhost" + 4 / Choose this option to the configure Storage to IBM COS S3 + \ "IBMCOS" + 5 / Choose this option to the configure Storage to Minio + \ "Minio" + Provider>4 + +5. Enter the Access Key and Secret. + + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> <> + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> <> + +6. Specify the endpoint for IBM COS. For Public IBM COS, choose from + the option below. For On Premise IBM COS, enter an enpoint address. + + Endpoint for IBM COS S3 API. + Specify if using an IBM COS On Premise. + Choose a number from below, or type in your own value + 1 / US Cross Region Endpoint + \ "s3-api.us-geo.objectstorage.softlayer.net" + 2 / US Cross Region Dallas Endpoint + \ "s3-api.dal.us-geo.objectstorage.softlayer.net" + 3 / US Cross Region Washington DC Endpoint + \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" + 4 / US Cross Region San Jose Endpoint + \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" + 5 / US Cross Region Private Endpoint + \ "s3-api.us-geo.objectstorage.service.networklayer.com" + 6 / US Cross Region Dallas Private Endpoint + \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" + 7 / US Cross Region Washington DC Private Endpoint + \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" + 8 / US Cross Region San Jose Private Endpoint + \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" + 9 / US Region East Endpoint + \ "s3.us-east.objectstorage.softlayer.net" + 10 / US Region East Private Endpoint + \ "s3.us-east.objectstorage.service.networklayer.com" + 11 / US Region South Endpoint + [snip] + 34 / Toronto Single Site Private Endpoint + \ "s3.tor01.objectstorage.service.networklayer.com" + endpoint>1 + +7. Specify a IBM COS Location Constraint. The location constraint must + match endpoint when using IBM Cloud Public. For on-prem COS, do not + make a selection from this list, hit enter + + 1 / US Cross Region Standard + \ "us-standard" + 2 / US Cross Region Vault + \ "us-vault" + 3 / US Cross Region Cold + \ "us-cold" + 4 / US Cross Region Flex + \ "us-flex" + 5 / US East Region Standard + \ "us-east-standard" + 6 / US East Region Vault + \ "us-east-vault" + 7 / US East Region Cold + \ "us-east-cold" + 8 / US East Region Flex + \ "us-east-flex" + 9 / US South Region Standard + \ "us-south-standard" + 10 / US South Region Vault + \ "us-south-vault" + [snip] + 32 / Toronto Flex + \ "tor01-flex" + location_constraint>1 + +9. Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" + and "private". IBM Cloud(Infra) supports all the canned ACLs. + On-Premise COS supports all the canned ACLs. + + Canned ACL used when creating buckets and/or storing objects in S3. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS + \ "private" + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS + \ "public-read" + 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS + \ "public-read-write" + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS + \ "authenticated-read" + acl> 1 + +12. Review the displayed configuration and accept to save the "remote" + then quit. The config file should look like this + + [xxx] + type = s3 + Provider = IBMCOS + access_key_id = xxx + secret_access_key = yyy + endpoint = s3-api.us-geo.objectstorage.softlayer.net + location_constraint = us-standard + acl = private + +13. Execute rclone commands + + 1) Create a bucket. + rclone mkdir IBM-COS-XREGION:newbucket + 2) List available buckets. + rclone lsd IBM-COS-XREGION: + -1 2017-11-08 21:16:22 -1 test + -1 2018-02-14 20:16:39 -1 newbucket + 3) List contents of a bucket. + rclone ls IBM-COS-XREGION:newbucket + 18685952 test.exe + 4) Copy a file from local to remote. + rclone copy /Users/file.txt IBM-COS-XREGION:newbucket + 5) Copy a file from remote to local. + rclone copy IBM-COS-XREGION:newbucket/file.txt . + 6) Delete a file on remote. + rclone delete IBM-COS-XREGION:newbucket/file.txt + +Minio + +Minio is an object storage server built for cloud application developers +and devops. + +It is very easy to install and provides an S3 compatible server which +can be used by rclone. + +To use it, install Minio following the instructions here. + +When it configures itself Minio will print something like this + + Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 + AccessKey: USWUXHGYZQYFYFFIT3RE + SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + Region: us-east-1 + SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis + + Browser Access: + http://192.168.1.106:9000 http://172.23.0.1:9000 + + Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide + $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + + Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang-client-quickstart-guide + Java: https://docs.minio.io/docs/java-client-quickstart-guide + Python: https://docs.minio.io/docs/python-client-quickstart-guide + JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide + .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide + + Drive Capacity: 26 GiB Free, 165 GiB Total + +These details need to go into rclone config like this. Note that it is +important to put the region in as stated above. + + env_auth> 1 + access_key_id> USWUXHGYZQYFYFFIT3RE + secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + region> us-east-1 + endpoint> http://192.168.1.106:9000 + location_constraint> + server_side_encryption> + +Which makes the config file look like this + + [minio] + type = s3 + provider = Minio + env_auth = false + access_key_id = USWUXHGYZQYFYFFIT3RE + secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + region = us-east-1 + endpoint = http://192.168.1.106:9000 + location_constraint = + server_side_encryption = + +So once set up, for example to copy files into a bucket + + rclone copy /path/to/files minio:bucket + +Scaleway + +Scaleway The Object Storage platform allows you to store anything from +backups, logs and web assets to documents and photos. Files can be +dropped from the Scaleway console or transferred through our API and CLI +or using any S3-compatible tool. + +Scaleway provides an S3 interface which can be configured for use with +rclone like this: + + [scaleway] + type = s3 + provider = Scaleway + env_auth = false + endpoint = s3.nl-ams.scw.cloud + access_key_id = SCWXXXXXXXXXXXXXX + secret_access_key = 1111111-2222-3333-44444-55555555555555 + region = nl-ams + location_constraint = + acl = private + server_side_encryption = + storage_class = + +Wasabi + +Wasabi is a cloud-based object storage service for a broad range of +applications and use cases. Wasabi is designed for individuals and +organizations that require a high-performance, reliable, and secure data +storage infrastructure at minimal cost. + +Wasabi provides an S3 interface which can be configured for use with +rclone like this. + + No remotes found - make a new one + n) New remote + s) Set configuration password + n/s> n + name> wasabi + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon S3 (also Dreamhost, Ceph, Minio) + \ "s3" + [snip] + Storage> s3 + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> YOURACCESSKEY + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> YOURSECRETACCESSKEY + Region to connect to. + Choose a number from below, or type in your own value + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + [snip] + region> us-east-1 + Endpoint for S3 API. + Leave blank if using AWS to use the default endpoint for the region. + Specify if using an S3 clone such as Ceph. + endpoint> s3.wasabisys.com + Location constraint - must be set to match the Region. Used when creating buckets only. + Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \ "" + [snip] + location_constraint> + Canned ACL used when creating buckets and/or storing objects in S3. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \ "private" + [snip] + acl> + The server-side encryption algorithm used when storing this object in S3. + Choose a number from below, or type in your own value + 1 / None + \ "" + 2 / AES256 + \ "AES256" + server_side_encryption> + The storage class to use when storing objects in S3. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Standard storage class + \ "STANDARD" + 3 / Reduced redundancy storage class + \ "REDUCED_REDUNDANCY" + 4 / Standard Infrequent Access storage class + \ "STANDARD_IA" + storage_class> + Remote config + -------------------- + [wasabi] + env_auth = false + access_key_id = YOURACCESSKEY + secret_access_key = YOURSECRETACCESSKEY + region = us-east-1 + endpoint = s3.wasabisys.com + location_constraint = + acl = + server_side_encryption = + storage_class = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +This will leave the config file looking like this. + + [wasabi] + type = s3 + provider = Wasabi + env_auth = false + access_key_id = YOURACCESSKEY + secret_access_key = YOURSECRETACCESSKEY + region = + endpoint = s3.wasabisys.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +Alibaba OSS + +Here is an example of making an Alibaba Cloud (Aliyun) OSS +configuration. First run: + + rclone config + +This will guide you through an interactive setup process. + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> oss + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) + \ "s3" + [snip] + Storage> s3 + Choose your S3 provider. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun + \ "Alibaba" + 3 / Ceph Object Storage + \ "Ceph" + [snip] + provider> Alibaba + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + Only applies if access_key_id and secret_access_key is blank. + Enter a boolean value (true or false). Press Enter for the default ("false"). + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID. + Leave blank for anonymous access or runtime credentials. + Enter a string value. Press Enter for the default (""). + access_key_id> accesskeyid + AWS Secret Access Key (password) + Leave blank for anonymous access or runtime credentials. + Enter a string value. Press Enter for the default (""). + secret_access_key> secretaccesskey + Endpoint for OSS API. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / East China 1 (Hangzhou) + \ "oss-cn-hangzhou.aliyuncs.com" + 2 / East China 2 (Shanghai) + \ "oss-cn-shanghai.aliyuncs.com" + 3 / North China 1 (Qingdao) + \ "oss-cn-qingdao.aliyuncs.com" + [snip] + endpoint> 1 + Canned ACL used when creating buckets and storing or copying objects. Note that this ACL is applied when server side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. - - - Config: acl - - Env Var: RCLONE_S3_ACL - - Type: string - - Default: "" - - Examples: - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - - Granting this on a bucket is generally not recommended. - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - - "bucket-owner-read" - - Object owner gets FULL_CONTROL. Bucket owner gets READ access. - - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - - "bucket-owner-full-control" - - Both the object owner and the bucket owner get FULL_CONTROL over the object. - - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS - - #### --s3-server-side-encryption - - The server-side encryption algorithm used when storing this object in S3. - - - Config: server_side_encryption - - Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION - - Type: string - - Default: "" - - Examples: - - "" - - None - - "AES256" - - AES256 - - "aws:kms" - - aws:kms - - #### --s3-sse-kms-key-id - - If using KMS ID you must provide the ARN of Key. - - - Config: sse_kms_key_id - - Env Var: RCLONE_S3_SSE_KMS_KEY_ID - - Type: string - - Default: "" - - Examples: - - "" - - None - - "arn:aws:kms:us-east-1:*" - - arn:aws:kms:* - - #### --s3-storage-class - - The storage class to use when storing new objects in S3. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - Standard storage class - - "REDUCED_REDUNDANCY" - - Reduced redundancy storage class - - "STANDARD_IA" - - Standard Infrequent Access storage class - - "ONEZONE_IA" - - One Zone Infrequent Access storage class - - "GLACIER" - - Glacier storage class - - "DEEP_ARCHIVE" - - Glacier Deep Archive storage class - - "INTELLIGENT_TIERING" - - Intelligent-Tiering storage class - - #### --s3-storage-class - + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \ "private" + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \ "public-read" + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. + [snip] + acl> 1 The storage class to use when storing new objects in OSS. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - Standard storage class - - "GLACIER" - - Archive storage mode. - - "STANDARD_IA" - - Infrequent access storage mode. - - #### --s3-storage-class - - The storage class to use when storing new objects in S3. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - The Standard class for any upload; suitable for on-demand content like streaming or CDN. - - "GLACIER" - - Archived storage; prices are lower, but it needs to be restored first to be accessed. - - ### Advanced Options - - Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - - #### --s3-bucket-acl - - Canned ACL used when creating buckets. - - For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl - - Note that this ACL is applied when only when creating buckets. If it - isn't set then "acl" is used instead. - - - Config: bucket_acl - - Env Var: RCLONE_S3_BUCKET_ACL - - Type: string - - Default: "" - - Examples: - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - - Granting this on a bucket is generally not recommended. - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - - #### --s3-sse-customer-algorithm - - If using SSE-C, the server-side encryption algorithm used when storing this object in S3. - - - Config: sse_customer_algorithm - - Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM - - Type: string - - Default: "" - - Examples: - - "" - - None - - "AES256" - - AES256 - - #### --s3-sse-customer-key - - If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. - - - Config: sse_customer_key - - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY - - Type: string - - Default: "" - - Examples: - - "" - - None - - #### --s3-sse-customer-key-md5 - - If using SSE-C you must provide the secret encryption key MD5 checksum. - - - Config: sse_customer_key_md5 - - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 - - Type: string - - Default: "" - - Examples: - - "" - - None - - #### --s3-upload-cutoff - - Cutoff for switching to chunked upload - - Any files larger than this will be uploaded in chunks of chunk_size. - The minimum is 0 and the maximum is 5GB. - - - Config: upload_cutoff - - Env Var: RCLONE_S3_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 200M - - #### --s3-chunk-size - - Chunk size to use for uploading. - - When uploading files larger than upload_cutoff or files with unknown - size (eg from "rclone rcat" or uploaded with "rclone mount" or google - photos or google docs) they will be uploaded as multipart uploads - using this chunk size. - - Note that "--s3-upload-concurrency" chunks of this size are buffered - in memory per transfer. - - If you are transferring large files over high speed links and you have - enough memory, then increasing this will speed up the transfers. - - Rclone will automatically increase the chunk size when uploading a - large file of known size to stay below the 10,000 chunks limit. - - Files of unknown size are uploaded with the configured - chunk_size. Since the default chunk size is 5MB and there can be at - most 10,000 chunks, this means that by default the maximum size of - file you can stream upload is 48GB. If you wish to stream upload - larger files then you will need to increase chunk_size. - - - Config: chunk_size - - Env Var: RCLONE_S3_CHUNK_SIZE - - Type: SizeSuffix - - Default: 5M - - #### --s3-max-upload-parts - - Maximum number of parts in a multipart upload. - - This option defines the maximum number of multipart chunks to use - when doing a multipart upload. - - This can be useful if a service does not support the AWS S3 - specification of 10,000 chunks. - - Rclone will automatically increase the chunk size when uploading a - large file of a known size to stay below this number of chunks limit. - - - - Config: max_upload_parts - - Env Var: RCLONE_S3_MAX_UPLOAD_PARTS - - Type: int - - Default: 10000 - - #### --s3-copy-cutoff - - Cutoff for switching to multipart copy - - Any files larger than this that need to be server side copied will be - copied in chunks of this size. - - The minimum is 0 and the maximum is 5GB. - - - Config: copy_cutoff - - Env Var: RCLONE_S3_COPY_CUTOFF - - Type: SizeSuffix - - Default: 4.656G - - #### --s3-disable-checksum - - Don't store MD5 checksum with object metadata - - Normally rclone will calculate the MD5 checksum of the input before - uploading it so it can add it to metadata on the object. This is great - for data integrity checking but can cause long delays for large files - to start uploading. - - - Config: disable_checksum - - Env Var: RCLONE_S3_DISABLE_CHECKSUM - - Type: bool - - Default: false - - #### --s3-shared-credentials-file - - Path to the shared credentials file - - If env_auth = true then rclone can use a shared credentials file. - - If this variable is empty rclone will look for the - "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty - it will default to the current user's home directory. - - Linux/OSX: "$HOME/.aws/credentials" - Windows: "%USERPROFILE%\.aws\credentials" - - - - Config: shared_credentials_file - - Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE - - Type: string - - Default: "" - - #### --s3-profile - - Profile to use in the shared credentials file - - If env_auth = true then rclone can use a shared credentials file. This - variable controls which profile is used in that file. - - If empty it will default to the environment variable "AWS_PROFILE" or - "default" if that environment variable is also not set. - - - - Config: profile - - Env Var: RCLONE_S3_PROFILE - - Type: string - - Default: "" - - #### --s3-session-token - - An AWS session token - - - Config: session_token - - Env Var: RCLONE_S3_SESSION_TOKEN - - Type: string - - Default: "" - - #### --s3-upload-concurrency - - Concurrency for multipart uploads. - - This is the number of chunks of the same file that are uploaded - concurrently. - - If you are uploading small numbers of large file over high speed link - and these uploads do not fully utilize your bandwidth, then increasing - this may help to speed up the transfers. - - - Config: upload_concurrency - - Env Var: RCLONE_S3_UPLOAD_CONCURRENCY - - Type: int - - Default: 4 - - #### --s3-force-path-style - - If true use path style access if false use virtual hosted style. - - If this is true (the default) then rclone will use path style access, - if false then rclone will use virtual path style. See [the AWS S3 - docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) - for more info. - - Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to - false - rclone will do this automatically based on the provider - setting. - - - Config: force_path_style - - Env Var: RCLONE_S3_FORCE_PATH_STYLE - - Type: bool - - Default: true - - #### --s3-v2-auth - - If true use v2 authentication. - - If this is false (the default) then rclone will use v4 authentication. - If it is set then rclone will use v2 authentication. - - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - - - Config: v2_auth - - Env Var: RCLONE_S3_V2_AUTH - - Type: bool - - Default: false - - #### --s3-use-accelerate-endpoint - - If true use the AWS S3 accelerated endpoint. - - See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) - - - Config: use_accelerate_endpoint - - Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT - - Type: bool - - Default: false - - #### --s3-leave-parts-on-error - - If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. - - It should be set to true for resuming uploads across different sessions. - - WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. - - - - Config: leave_parts_on_error - - Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR - - Type: bool - - Default: false - - #### --s3-list-chunk - - Size of listing chunk (response list for each ListObject S3 request). - - This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. - Most services truncate the response list to 1000 objects even if requested more than that. - In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). - In Ceph, this can be increased with the "rgw list buckets max chunk" option. - - - - Config: list_chunk - - Env Var: RCLONE_S3_LIST_CHUNK - - Type: int - - Default: 1000 - - #### --s3-no-check-bucket - - If set don't attempt to check the bucket exists or create it - - This can be useful when trying to minimise the number of transactions - rclone does if you know the bucket exists already. - - - - Config: no_check_bucket - - Env Var: RCLONE_S3_NO_CHECK_BUCKET - - Type: bool - - Default: false - - #### --s3-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_S3_ENCODING - - Type: MultiEncoder - - Default: Slash,InvalidUtf8,Dot - - #### --s3-memory-pool-flush-time - - How often internal memory buffer pools will be flushed. - Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. - This option controls how often unused buffers will be removed from the pool. - - - Config: memory_pool_flush_time - - Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME - - Type: Duration - - Default: 1m0s - - #### --s3-memory-pool-use-mmap - - Whether to use mmap buffers in internal memory pool. - - - Config: memory_pool_use_mmap - - Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP - - Type: bool - - Default: false - - ### Backend commands - - Here are the commands specific to the s3 backend. - - Run them with - - rclone backend COMMAND remote: - - The help below will explain what arguments each command takes. - - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. - - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). - - #### restore - - Restore objects from GLACIER to normal storage - - rclone backend restore remote: [options] [+] - - This command can be used to restore one or more objects from GLACIER - to normal storage. - - Usage Examples: - - rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS] - rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS] - rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS] - - This flag also obeys the filters. Test first with -i/--interactive or --dry-run flags - - rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard - - All the objects shown will be marked for restore, then - - rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard - - It returns a list of status dictionaries with Remote and Status - keys. The Status will be OK if it was successfull or an error message - if not. - - [ - { - "Status": "OK", - "Path": "test.txt" - }, - { - "Status": "OK", - "Path": "test/file4.txt" - } - ] - - - - Options: - - - "description": The optional description for the job. - - "lifetime": Lifetime of the active copy in days - - "priority": Priority of restore: Standard|Expedited|Bulk - - #### list-multipart-uploads - - List the unfinished multipart uploads - - rclone backend list-multipart-uploads remote: [options] [+] - - This command lists the unfinished multipart uploads in JSON format. - - rclone backend list-multipart s3:bucket/path/to/object - - It returns a dictionary of buckets with values as lists of unfinished - multipart uploads. - - You can call it with no bucket in which case it lists all bucket, with - a bucket or with a bucket and path. - - { - "rclone": [ - { - "Initiated": "2020-06-26T14:20:36Z", - "Initiator": { - "DisplayName": "XXX", - "ID": "arn:aws:iam::XXX:user/XXX" - }, - "Key": "KEY", - "Owner": { - "DisplayName": null, - "ID": "XXX" - }, - "StorageClass": "STANDARD", - "UploadId": "XXX" - } - ], - "rclone-1000files": [], - "rclone-dst": [] - } - - - - #### cleanup - - Remove unfinished multipart uploads. - - rclone backend cleanup remote: [options] [+] - - This command removes unfinished multipart uploads of age greater than - max-age which defaults to 24 hours. - - Note that you can use -i/--dry-run with this command to see what it - would do. - - rclone backend cleanup s3:bucket/path/to/object - rclone backend cleanup -o max-age=7w s3:bucket/path/to/object - - Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. - - - Options: - - - "max-age": Max age of upload to delete - - - - ### Anonymous access to public buckets ### - - If you want to use rclone to access a public bucket, configure with a - blank `access_key_id` and `secret_access_key`. Your config should end - up looking like this: - -[anons3] type = s3 provider = AWS env_auth = false access_key_id = -secret_access_key = region = us-east-1 endpoint = location_constraint = -acl = private server_side_encryption = storage_class = - - - Then use it as normal with the name of the public bucket, eg - - rclone lsd anons3:1000genomes - - You will be able to list and copy data but not upload it. - - ### Ceph ### - - [Ceph](https://ceph.com/) is an open source unified, distributed - storage system designed for excellent performance, reliability and - scalability. It has an S3 compatible object storage interface. - - To use rclone with Ceph, configure as above but leave the region blank - and set the endpoint. You should end up with something like this in - your config: - -[ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX -secret_access_key = YYY region = endpoint = -https://ceph.endpoint.example.com location_constraint = acl = -server_side_encryption = storage_class = - - - If you are using an older version of CEPH, eg 10.2.x Jewel, then you - may need to supply the parameter `--s3-upload-cutoff 0` or put this in - the config file as `upload_cutoff 0` to work around a bug which causes - uploading of small files to fail. - - Note also that Ceph sometimes puts `/` in the passwords it gives - users. If you read the secret access key using the command line tools - you will get a JSON blob with the `/` escaped as `\/`. Make sure you - only write `/` in the secret access key. - - Eg the dump from Ceph looks something like this (irrelevant keys - removed). - -{ "user_id": "xxx", "display_name": "xxxx", "keys": [ { "user": "xxx", -"access_key": "xxxxxx", "secret_key": "xxxxxx/xxxx" } ], } - - - Because this is a json dump, it is encoding the `/` as `\/`, so if you - use the secret key as `xxxxxx/xxxx` it will work fine. - - ### Dreamhost ### - - Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is - an object storage system based on CEPH. - - To use rclone with Dreamhost, configure as above but leave the region blank - and set the endpoint. You should end up with something like this in - your config: - -[dreamobjects] type = s3 provider = DreamHost env_auth = false -access_key_id = your_access_key secret_access_key = your_secret_key -region = endpoint = objects-us-west-1.dream.io location_constraint = acl -= private server_side_encryption = storage_class = - - - ### DigitalOcean Spaces ### - - [Spaces](https://www.digitalocean.com/products/object-storage/) is an [S3-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean. - - To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when prompted by `rclone config` for your `access_key_id` and `secret_access_key`. - - When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The default values can be used for other settings. - - Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below: - -Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY -secret_access_key> YOUR_SECRET_KEY region> endpoint> -nyc3.digitaloceanspaces.com location_constraint> acl> storage_class> - - - The resulting configuration file should look like: - -[spaces] type = s3 provider = DigitalOcean env_auth = false -access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY -region = endpoint = nyc3.digitaloceanspaces.com location_constraint = -acl = server_side_encryption = storage_class = - - - Once configured, you can create a new Space and begin copying files. For example: - -rclone mkdir spaces:my-new-space rclone copy /path/to/files -spaces:my-new-space - - - ### IBM COS (S3) ### - - Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage) - - To configure access to IBM COS S3, follow the steps below: - - 1. Run rclone config and select n for a new remote. - - 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Standard storage class + \ "STANDARD" + 3 / Archive storage mode. + \ "GLACIER" + 4 / Infrequent access storage mode. + \ "STANDARD_IA" + storage_class> 1 + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + -------------------- + [oss] + type = s3 + provider = Alibaba + env_auth = false + access_key_id = accesskeyid + secret_access_key = secretaccesskey + endpoint = oss-cn-hangzhou.aliyuncs.com + acl = private + storage_class = Standard + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Tencent COS + +Tencent Cloud Object Storage (COS) is a distributed storage service +offered by Tencent Cloud for unstructured data. It is secure, stable, +massive, convenient, low-delay and low-cost. + +To configure access to Tencent COS, follow the steps below: + +1. Run rclone config and select n for a new remote. + + rclone config No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n +2. Give the name of the configuration. For example, name it 'cos'. - 2. Enter the name for the configuration + name> cos - name> +3. Select s3 storage. - - 3. Select "s3" storage. - -Choose a number from below, or type in your own value 1 / Alias for an -existing remote  "alias" 2 / Amazon Drive  "amazon cloud drive" 3 / -Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) - "s3" 4 / Backblaze B2  "b2" [snip] 23 / http Connection  "http" -Storage> 3 - - - 4. Select IBM COS as the S3 Storage Provider. - -Choose the S3 provider. Choose a number from below, or type in your own -value 1 / Choose this option to configure Storage to AWS S3  "AWS" 2 / -Choose this option to configure Storage to Ceph Systems  "Ceph" 3 / -Choose this option to configure Storage to Dreamhost  "Dreamhost" 4 / -Choose this option to the configure Storage to IBM COS S3  "IBMCOS" 5 / -Choose this option to the configure Storage to Minio  "Minio" Provider>4 - - - 5. Enter the Access Key and Secret. - - AWS Access Key ID - leave blank for anonymous access or runtime credentials. - access_key_id> <> - AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. - secret_access_key> <> - - - 6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address. - - Endpoint for IBM COS S3 API. - Specify if using an IBM COS On Premise. Choose a number from below, or type in your own value - 1 / US Cross Region Endpoint - \ "s3-api.us-geo.objectstorage.softlayer.net" - 2 / US Cross Region Dallas Endpoint - \ "s3-api.dal.us-geo.objectstorage.softlayer.net" - 3 / US Cross Region Washington DC Endpoint - \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" - 4 / US Cross Region San Jose Endpoint - \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" - 5 / US Cross Region Private Endpoint - \ "s3-api.us-geo.objectstorage.service.networklayer.com" - 6 / US Cross Region Dallas Private Endpoint - \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" - 7 / US Cross Region Washington DC Private Endpoint - \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" - 8 / US Cross Region San Jose Private Endpoint - \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" - 9 / US Region East Endpoint - \ "s3.us-east.objectstorage.softlayer.net" - 10 / US Region East Private Endpoint - \ "s3.us-east.objectstorage.service.networklayer.com" - 11 / US Region South Endpoint - -[snip] 34 / Toronto Single Site Private Endpoint - "s3.tor01.objectstorage.service.networklayer.com" endpoint>1 - - - - 7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter - - 1 / US Cross Region Standard - \ "us-standard" - 2 / US Cross Region Vault - \ "us-vault" - 3 / US Cross Region Cold - \ "us-cold" - 4 / US Cross Region Flex - \ "us-flex" - 5 / US East Region Standard - \ "us-east-standard" - 6 / US East Region Vault - \ "us-east-vault" - 7 / US East Region Cold - \ "us-east-cold" - 8 / US East Region Flex - \ "us-east-flex" - 9 / US South Region Standard - \ "us-south-standard" - 10 / US South Region Vault - \ "us-south-vault" - -[snip] 32 / Toronto Flex  "tor01-flex" location_constraint>1 - - - 9. Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs. - -Canned ACL used when creating buckets and/or storing objects in S3. For -more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default). This acl is -available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS - "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ -access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On-Premise IBM COS  "public-read" 3 / Owner gets FULL_CONTROL. The -AllUsers group gets READ and WRITE access. This acl is available on IBM -Cloud (Infra), On-Premise IBM COS  "public-read-write" 4 / Owner gets -FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not -supported on Buckets. This acl is available on IBM Cloud (Infra) and -On-Premise IBM COS  "authenticated-read" acl> 1 - - - - 12. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this - - [xxx] - type = s3 - Provider = IBMCOS - access_key_id = xxx - secret_access_key = yyy - endpoint = s3-api.us-geo.objectstorage.softlayer.net - location_constraint = us-standard - acl = private - - - 13. Execute rclone commands - - 1) Create a bucket. - rclone mkdir IBM-COS-XREGION:newbucket - 2) List available buckets. - rclone lsd IBM-COS-XREGION: - -1 2017-11-08 21:16:22 -1 test - -1 2018-02-14 20:16:39 -1 newbucket - 3) List contents of a bucket. - rclone ls IBM-COS-XREGION:newbucket - 18685952 test.exe - 4) Copy a file from local to remote. - rclone copy /Users/file.txt IBM-COS-XREGION:newbucket - 5) Copy a file from remote to local. - rclone copy IBM-COS-XREGION:newbucket/file.txt . - 6) Delete a file on remote. - rclone delete IBM-COS-XREGION:newbucket/file.txt - - - ### Minio ### - - [Minio](https://minio.io/) is an object storage server built for cloud application developers and devops. - - It is very easy to install and provides an S3 compatible server which can be used by rclone. - - To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio-quickstart-guide). - - When it configures itself Minio will print something like this - -Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: -USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 -Region: us-east-1 SQS ARNs: arn:minio:sqs:us-east-1:1:redis -arn:minio:sqs:us-east-1:2:redis - -Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000 - -Command-line Access: -https://docs.minio.io/docs/minio-client-quickstart-guide $ mc config -host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 - -Object API (Amazon S3 compatible): Go: -https://docs.minio.io/docs/golang-client-quickstart-guide Java: -https://docs.minio.io/docs/java-client-quickstart-guide Python: -https://docs.minio.io/docs/python-client-quickstart-guide JavaScript: -https://docs.minio.io/docs/javascript-client-quickstart-guide .NET: -https://docs.minio.io/docs/dotnet-client-quickstart-guide - -Drive Capacity: 26 GiB Free, 165 GiB Total - - - These details need to go into `rclone config` like this. Note that it - is important to put the region in as stated above. - -env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us-east-1 endpoint> -http://192.168.1.106:9000 location_constraint> server_side_encryption> - - - Which makes the config file look like this - -[minio] type = s3 provider = Minio env_auth = false access_key_id = -USWUXHGYZQYFYFFIT3RE secret_access_key = -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us-east-1 endpoint = -http://192.168.1.106:9000 location_constraint = server_side_encryption = - - - So once set up, for example to copy files into a bucket - -rclone copy /path/to/files minio:bucket - - - ### Scaleway {#scaleway} - - [Scaleway](https://www.scaleway.com/object-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. - Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool. - - Scaleway provides an S3 interface which can be configured for use with rclone like this: - -[scaleway] type = s3 provider = Scaleway env_auth = false endpoint = -s3.nl-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key -= 1111111-2222-3333-44444-55555555555555 region = nl-ams -location_constraint = acl = private server_side_encryption = -storage_class = - - - ### Wasabi ### - - [Wasabi](https://wasabi.com) is a cloud-based object storage service for a - broad range of applications and use cases. Wasabi is designed for - individuals and organizations that require a high-performance, - reliable, and secure data storage infrastructure at minimal cost. - - Wasabi provides an S3 interface which can be configured for use with - rclone like this. - -No remotes found - make a new one n) New remote s) Set configuration -password n/s> n name> wasabi Type of storage to configure. Choose a -number from below, or type in your own value [snip] XX / Amazon S3 (also -Dreamhost, Ceph, Minio)  "s3" [snip] Storage> s3 Get AWS credentials -from runtime (environment variables or EC2/ECS meta data if no env -vars). Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step  "false" 2 / Get AWS credentials from the -environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID - -leave blank for anonymous access or runtime credentials. access_key_id> -YOURACCESSKEY AWS Secret Access Key (password) - leave blank for -anonymous access or runtime credentials. secret_access_key> -YOURSECRETACCESSKEY Region to connect to. Choose a number from below, or -type in your own value / The default endpoint - a good choice if you are -unsure. 1 | US Region, Northern Virginia or Pacific Northwest. | Leave -location constraint empty.  "us-east-1" [snip] region> us-east-1 -Endpoint for S3 API. Leave blank if using AWS to use the default -endpoint for the region. Specify if using an S3 clone such as Ceph. -endpoint> s3.wasabisys.com Location constraint - must be set to match -the Region. Used when creating buckets only. Choose a number from below, -or type in your own value 1 / Empty for US Region, Northern Virginia or -Pacific Northwest.  "" [snip] location_constraint> Canned ACL used when -creating buckets and/or storing objects in S3. For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default).  "private" [snip] -acl> The server-side encryption algorithm used when storing this object -in S3. Choose a number from below, or type in your own value 1 / None - "" 2 / AES256  "AES256" server_side_encryption> The storage class to -use when storing objects in S3. Choose a number from below, or type in -your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 -/ Reduced redundancy storage class  "REDUCED_REDUNDANCY" 4 / Standard -Infrequent Access storage class  "STANDARD_IA" storage_class> Remote -config -------------------- [wasabi] env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = us-east-1 -endpoint = s3.wasabisys.com location_constraint = acl = -server_side_encryption = storage_class = -------------------- y) Yes -this is OK e) Edit this remote d) Delete this remote y/e/d> y - - - This will leave the config file looking like this. - -[wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint -= s3.wasabisys.com location_constraint = acl = server_side_encryption = -storage_class = - - - ### Alibaba OSS {#alibaba-oss} - - Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/) - configuration. First run: - - rclone config - - This will guide you through an interactive setup process. - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> oss Type of storage to configure. -Enter a string value. Press Enter for the default (""). Choose a number -from below, or type in your own value [snip] 4 / Amazon S3 Compliant -Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, -Minio, etc)  "s3" [snip] Storage> s3 Choose your S3 provider. Enter a -string value. Press Enter for the default (""). Choose a number from -below, or type in your own value 1 / Amazon Web Services (AWS) S3  "AWS" -2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun  "Alibaba" -3 / Ceph Object Storage  "Ceph" [snip] provider> Alibaba Get AWS -credentials from runtime (environment variables or EC2/ECS meta data if -no env vars). Only applies if access_key_id and secret_access_key is -blank. Enter a boolean value (true or false). Press Enter for the -default ("false"). Choose a number from below, or type in your own value -1 / Enter AWS credentials in the next step  "false" 2 / Get AWS -credentials from the environment (env vars or IAM)  "true" env_auth> 1 -AWS Access Key ID. Leave blank for anonymous access or runtime -credentials. Enter a string value. Press Enter for the default (""). -access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank -for anonymous access or runtime credentials. Enter a string value. Press -Enter for the default (""). secret_access_key> secretaccesskey Endpoint -for OSS API. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value 1 / East China 1 -(Hangzhou)  "oss-cn-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai) - "oss-cn-shanghai.aliyuncs.com" 3 / North China 1 (Qingdao) - "oss-cn-qingdao.aliyuncs.com" [snip] endpoint> 1 Canned ACL used when -creating buckets and storing or copying objects. - -Note that this ACL is applied when server side copying objects as S3 -doesn't copy the ACL from the source but rather writes a fresh one. -Enter a string value. Press Enter for the default (""). Choose a number -from below, or type in your own value 1 / Owner gets FULL_CONTROL. No -one else has access rights (default).  "private" 2 / Owner gets -FULL_CONTROL. The AllUsers group gets READ access.  "public-read" / -Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. -[snip] acl> 1 The storage class to use when storing new objects in OSS. -Enter a string value. Press Enter for the default (""). Choose a number -from below, or type in your own value 1 / Default  "" 2 / Standard -storage class  "STANDARD" 3 / Archive storage mode.  "GLACIER" 4 / -Infrequent access storage mode.  "STANDARD_IA" storage_class> 1 Edit -advanced config? (y/n) y) Yes n) No y/n> n Remote config --------------------- [oss] type = s3 provider = Alibaba env_auth = false -access_key_id = accesskeyid secret_access_key = secretaccesskey endpoint -= oss-cn-hangzhou.aliyuncs.com acl = private storage_class = Standard --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - ### Netease NOS ### - - For Netease NOS configure as per the configurator `rclone config` - setting the provider `Netease`. This will automatically set - `force_path_style = false` which is necessary for it to run properly. - - Backblaze B2 - ---------------------------------------- - - B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/). - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - Here is an example of making a b2 configuration. First run - - rclone config - - This will guide you through an interactive setup process. To authenticate - you will either need your Account ID (a short hex number) and Master - Application Key (a long hex number) OR an Application Key, which is the - recommended method. See below for further details on generating and using - an Application Key. - -No remotes found - make a new one n) New remote q) Quit config n/q> n -name> remote Type of storage to configure. Choose a number from below, -or type in your own value [snip] XX / Backblaze B2  "b2" [snip] Storage> -b2 Account ID or Application Key ID account> 123456789abc Application -Key key> 0123456789abcdef0123456789abcdef0123456789 Endpoint for the -service - leave blank normally. endpoint> Remote config --------------------- [remote] account = 123456789abc key = -0123456789abcdef0123456789abcdef0123456789 endpoint = --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - This remote is called `remote` and can now be used like this - - See all buckets - - rclone lsd remote: - - Create a new bucket - - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any - excess files in the bucket. - - rclone sync -i /home/local/directory remote:bucket - - ### Application Keys ### - - B2 supports multiple [Application Keys for different access permission - to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html). - - You can use these with rclone too; you will need to use rclone version 1.43 - or later. - - Follow Backblaze's docs to create an Application Key with the required - permission and add the `applicationKeyId` as the `account` and the - `Application Key` itself as the `key`. - - Note that you must put the _applicationKeyId_ as the `account` – you - can't use the master Account ID. If you try then B2 will return 401 - errors. - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - ### Modified time ### - - The modified time is stored as metadata on the object as - `X-Bz-Info-src_last_modified_millis` as milliseconds since 1970-01-01 - in the Backblaze standard. Other tools should be able to use this as - a modified time. - - Modified times are used in syncing and are fully supported. Note that - if a modification time needs to be updated on an object then it will - create a new version of the object. - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - Note that in 2020-05 Backblaze started allowing \ characters in file - names. Rclone hasn't changed its encoding as this could cause syncs to - re-transfer files. If you want rclone not to replace \ then see the - `--b2-encoding` flag below and remove the `BackSlash` from the - string. This can be set in the config. - - ### SHA1 checksums ### - - The SHA1 checksums of the files are checked on upload and download and - will be used in the syncing process. - - Large files (bigger than the limit in `--b2-upload-cutoff`) which are - uploaded in chunks will store their SHA1 on the object as - `X-Bz-Info-large_file_sha1` as recommended by Backblaze. - - For a large file to be uploaded with an SHA1 checksum, the source - needs to support SHA1 checksums. The local disk supports SHA1 - checksums so large file transfers from local disk will have an SHA1. - See [the overview](https://rclone.org/overview/#features) for exactly which remotes - support SHA1. - - Sources which don't support SHA1, in particular `crypt` will upload - large files without SHA1 checksums. This may be fixed in the future - (see [#1767](https://github.com/rclone/rclone/issues/1767)). - - Files sizes below `--b2-upload-cutoff` will always have an SHA1 - regardless of the source. - - ### Transfers ### - - Backblaze recommends that you do lots of transfers simultaneously for - maximum speed. In tests from my SSD equipped laptop the optimum - setting is about `--transfers 32` though higher numbers may be used - for a slight speed improvement. The optimum number for you may vary - depending on your hardware, how big the files are, how much you want - to load your computer, etc. The default of `--transfers 4` is - definitely too low for Backblaze B2 though. - - Note that uploading big files (bigger than 200 MB by default) will use - a 96 MB RAM buffer by default. There can be at most `--transfers` of - these in use at any moment, so this sets the upper limit on the memory - used. - - ### Versions ### - - When rclone uploads a new version of a file it creates a [new version - of it](https://www.backblaze.com/b2/docs/file_versions.html). - Likewise when you delete a file, the old version will be marked hidden - and still be available. Conversely, you may opt in to a "hard delete" - of files with the `--b2-hard-delete` flag which would permanently remove - the file instead of hiding it. - - Old versions of files, where available, are visible using the - `--b2-versions` flag. - - **NB** Note that `--b2-versions` does not work with crypt at the - moment [#1627](https://github.com/rclone/rclone/issues/1627). Using - [--backup-dir](https://rclone.org/docs/#backup-dir-dir) with rclone is the recommended - way of working around this. - - If you wish to remove all the old versions then you can use the - `rclone cleanup remote:bucket` command which will delete all the old - versions of files, leaving the current ones intact. You can also - supply a path and only old versions under that path will be deleted, - eg `rclone cleanup remote:bucket/path/to/stuff`. - - Note that `cleanup` will remove partially uploaded files from the bucket - if they are more than a day old. - - When you `purge` a bucket, the current and the old versions will be - deleted then the bucket will be deleted. - - However `delete` will cause the current versions of the files to - become hidden old versions. - - Here is a session showing the listing and retrieval of an old - version followed by a `cleanup` of the old versions. - - Show current version and all the versions with `--b2-versions` flag. - -$ rclone -q ls b2:cleanup-test 9 one.txt - -$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 -one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 -one-v2016-07-02-155621-000.txt - - - Retrieve an old version - -$ rclone -q --b2-versions copy -b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp - -$ ls -l /tmp/one-v2016-07-04-141003-000.txt -rw-rw-r-- 1 ncw ncw 16 Jul -2 17:46 /tmp/one-v2016-07-04-141003-000.txt - - - Clean up all the old versions and show that they've gone. - -$ rclone -q cleanup b2:cleanup-test - -$ rclone -q ls b2:cleanup-test 9 one.txt - -$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt - - - ### Data usage ### - - It is useful to know how many requests are sent to the server in different scenarios. - - All copy commands send the following 4 requests: - -/b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket -/b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names - - - The `b2_list_file_names` request will be sent once for every 1k files - in the remote path, providing the checksum and modification time of - the listed files. As of version 1.33 issue - [#818](https://github.com/rclone/rclone/issues/818) causes extra requests - to be sent when using B2 with Crypt. When a copy operation does not - require any files to be uploaded, no more requests will be sent. - - Uploading files that do not require chunking, will send 2 requests per - file upload: - -/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ - - - Uploading files requiring chunking, will send 2 requests (one each to - start and finish the upload) and another 2 requests for each chunk: - -/b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url -/b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file - - - #### Versions #### - - Versions can be viewed with the `--b2-versions` flag. When it is set - rclone will show and act on older versions of files. For example - - Listing without `--b2-versions` - -$ rclone -q ls b2:cleanup-test 9 one.txt - - - And with - -$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 -one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 -one-v2016-07-02-155621-000.txt - - - Showing that the current version is unchanged but older versions can - be seen. These have the UTC date that they were uploaded to the - server to the nearest millisecond appended to them. - - Note that when using `--b2-versions` no file write operations are - permitted, so you can't upload files or delete them. - - ### B2 and rclone link ### - - Rclone supports generating file share links for private B2 buckets. - They can either be for a file for example: - -./rclone link B2:bucket/path/to/file.txt -https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx - - - or if run on a directory you will get: - -./rclone link B2:bucket/path -https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx - - - you can then use the authorization token (the part of the url from the - `?Authorization=` on) on any file path under that directory. For example: - -https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx -https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx -https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx - - - - ### Standard Options - - Here are the standard options specific to b2 (Backblaze B2). - - #### --b2-account - - Account ID or Application Key ID - - - Config: account - - Env Var: RCLONE_B2_ACCOUNT - - Type: string - - Default: "" - - #### --b2-key - - Application Key - - - Config: key - - Env Var: RCLONE_B2_KEY - - Type: string - - Default: "" - - #### --b2-hard-delete - - Permanently delete files on remote removal, otherwise hide files. - - - Config: hard_delete - - Env Var: RCLONE_B2_HARD_DELETE - - Type: bool - - Default: false - - ### Advanced Options - - Here are the advanced options specific to b2 (Backblaze B2). - - #### --b2-endpoint - - Endpoint for the service. - Leave blank normally. - - - Config: endpoint - - Env Var: RCLONE_B2_ENDPOINT - - Type: string - - Default: "" - - #### --b2-test-mode - - A flag string for X-Bz-Test-Mode header for debugging. - - This is for debugging purposes only. Setting it to one of the strings - below will cause b2 to return specific errors: - - * "fail_some_uploads" - * "expire_some_account_authorization_tokens" - * "force_cap_exceeded" - - These will be set in the "X-Bz-Test-Mode" header which is documented - in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html). - - - Config: test_mode - - Env Var: RCLONE_B2_TEST_MODE - - Type: string - - Default: "" - - #### --b2-versions - - Include old versions in directory listings. - Note that when using this no file write operations are permitted, - so you can't upload files or delete them. - - - Config: versions - - Env Var: RCLONE_B2_VERSIONS - - Type: bool - - Default: false - - #### --b2-upload-cutoff - - Cutoff for switching to chunked upload. - - Files above this size will be uploaded in chunks of "--b2-chunk-size". - - This value should be set no larger than 4.657GiB (== 5GB). - - - Config: upload_cutoff - - Env Var: RCLONE_B2_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 200M - - #### --b2-copy-cutoff - - Cutoff for switching to multipart copy - - Any files larger than this that need to be server side copied will be - copied in chunks of this size. - - The minimum is 0 and the maximum is 4.6GB. - - - Config: copy_cutoff - - Env Var: RCLONE_B2_COPY_CUTOFF - - Type: SizeSuffix - - Default: 4G - - #### --b2-chunk-size - - Upload chunk size. Must fit in memory. - - When uploading large files, chunk the file into this size. Note that - these chunks are buffered in memory and there might a maximum of - "--transfers" chunks in progress at once. 5,000,000 Bytes is the - minimum size. - - - Config: chunk_size - - Env Var: RCLONE_B2_CHUNK_SIZE - - Type: SizeSuffix - - Default: 96M - - #### --b2-disable-checksum - - Disable checksums for large (> upload cutoff) files - - Normally rclone will calculate the SHA1 checksum of the input before - uploading it so it can add it to metadata on the object. This is great - for data integrity checking but can cause long delays for large files - to start uploading. - - - Config: disable_checksum - - Env Var: RCLONE_B2_DISABLE_CHECKSUM - - Type: bool - - Default: false - - #### --b2-download-url - - Custom endpoint for downloads. - - This is usually set to a Cloudflare CDN URL as Backblaze offers - free egress for data downloaded through the Cloudflare network. - This is probably only useful for a public bucket. - Leave blank if you want to use the endpoint provided by Backblaze. - - - Config: download_url - - Env Var: RCLONE_B2_DOWNLOAD_URL - - Type: string - - Default: "" - - #### --b2-download-auth-duration - - Time before the authorization token will expire in s or suffix ms|s|m|h|d. - - The duration before the download authorization token will expire. - The minimum value is 1 second. The maximum value is one week. - - - Config: download_auth_duration - - Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION - - Type: Duration - - Default: 1w - - #### --b2-memory-pool-flush-time - - How often internal memory buffer pools will be flushed. - Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. - This option controls how often unused buffers will be removed from the pool. - - - Config: memory_pool_flush_time - - Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME - - Type: Duration - - Default: 1m0s - - #### --b2-memory-pool-use-mmap - - Whether to use mmap buffers in internal memory pool. - - - Config: memory_pool_use_mmap - - Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP - - Type: bool - - Default: false - - #### --b2-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_B2_ENCODING - - Type: MultiEncoder - - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - - - - Box - ----------------------------------------- - - Paths are specified as `remote:path` - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - The initial setup for Box involves getting a token from Box which you - can do either in your browser, or with a config.json downloaded from Box - to use JWT authentication. `rclone config` walks you through it. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Box  "box" [snip] Storage> box Box App Client Id - leave blank -normally. client_id> Box App Client Secret - leave blank normally. -client_secret> Box App config.json location Leave blank normally. Enter -a string value. Press Enter for the default (""). box_config_file> Box -App Primary Access Token Leave blank normally. Enter a string value. -Press Enter for the default (""). access_token> - -Enter a string value. Press Enter for the default ("user"). Choose a -number from below, or type in your own value 1 / Rclone should act on -behalf of a user  "user" 2 / Rclone should act on behalf of a service -account  "enterprise" box_sub_type> Remote config Use auto config? * Say -Y if not sure * Say N if you are working on a remote or headless machine -y) Yes n) No y/n> y If your browser doesn't open automatically go to the -following link: http://127.0.0.1:53682/auth Log in and authorize rclone -for access Waiting for code... Got code -------------------- [remote] -client_id = client_secret = token = -{"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet 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 on `http://127.0.0.1:53682/` and this it may require you to unblock - it temporarily if you are running a host firewall. - - Once configured you can then use `rclone` like this, - - List directories in top level of your Box - - rclone lsd remote: - - List all the files in your Box - - rclone ls remote: - - To copy a local directory to an Box directory called backup - - rclone copy /home/source remote:backup - - ### Using rclone with an Enterprise account with SSO ### - - If you have an "Enterprise" account type with Box with single sign on - (SSO), you need to create a password to use Box with rclone. This can - be done at your Enterprise Box account by going to Settings, "Account" - Tab, and then set the password in the "Authentication" field. - - Once you have done this, you can setup your Enterprise Box account - using the same procedure detailed above in the, using the password you - have just set. - - ### Invalid refresh token ### - - According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): - - > Each refresh_token is valid for one use in 60 days. - - This means that if you - - * Don't use the box remote for 60 days - * Copy the config file with a box refresh token in and use it in two places - * Get an error on a token refresh - - then rclone will return an error which includes the text `Invalid - refresh token`. - - To fix this you will need to use oauth2 again to update the refresh - token. You can use the methods in [the remote setup - docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the - config file method, you should not use that remote on the computer you - did the authentication on. - - Here is how to do it. - -$ rclone config Current remotes: - -Name Type ==== ==== remote box - -e) Edit existing remote -f) New remote -g) Delete remote -h) Rename remote -i) Copy remote -j) Set configuration password -k) Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in - an existing value 1 > remote remote> remote -------------------- - [remote] type = box token = - {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} - -------------------- Edit remote Value "client_id" = "" Edit? (y/n)> -l) Yes -m) No y/n> n Value "client_secret" = "" Edit? (y/n)> -n) Yes -o) No y/n> n Remote config Already have a token - refresh? -p) Yes -q) No y/n> y Use auto config? - -- Say Y if not sure -- Say N if you are working on a remote or headless machine - -y) Yes -z) No y/n> y If your browser doesn't open automatically go to the - following link: http://127.0.0.1:53682/auth Log in and authorize - rclone for access Waiting for code... Got code -------------------- - [remote] type = box token = - {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} + 1 / 1Fichier + \ "fichier" + 2 / Alias for an existing remote + \ "alias" + 3 / Amazon Drive + \ "amazon cloud drive" + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc) + \ "s3" + [snip] + Storage> s3 + +4. Select TencentCOS provider. + + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + [snip] + 11 / Tencent Cloud Object Storage (COS) + \ "TencentCOS" + [snip] + provider> TencentCOS + +5. Enter your SecretId and SecretKey of Tencent Cloud. + + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + Only applies if access_key_id and secret_access_key is blank. + Enter a boolean value (true or false). Press Enter for the default ("false"). + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID. + Leave blank for anonymous access or runtime credentials. + Enter a string value. Press Enter for the default (""). + access_key_id> AKIDxxxxxxxxxx + AWS Secret Access Key (password) + Leave blank for anonymous access or runtime credentials. + Enter a string value. Press Enter for the default (""). + secret_access_key> xxxxxxxxxxx + +6. Select endpoint for Tencent COS. This is the standard endpoint for + different region. + + 1 / Beijing Region. + \ "cos.ap-beijing.myqcloud.com" + 2 / Nanjing Region. + \ "cos.ap-nanjing.myqcloud.com" + 3 / Shanghai Region. + \ "cos.ap-shanghai.myqcloud.com" + 4 / Guangzhou Region. + \ "cos.ap-guangzhou.myqcloud.com" + [snip] + endpoint> 4 + +7. Choose acl and storage class. + + Note that this ACL is applied when server side copying objects as S3 + doesn't copy the ACL from the source but rather writes a fresh one. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Owner gets Full_CONTROL. No one else has access rights (default). + \ "default" + [snip] + acl> 1 + The storage class to use when storing new objects in Tencent COS. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Default + \ "" + [snip] + storage_class> 1 + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> n + Remote config -------------------- -a) Yes this is OK -b) Edit this remote -c) Delete this remote y/e/d> y + [cos] + type = s3 + provider = TencentCOS + env_auth = false + access_key_id = xxx + secret_access_key = xxx + endpoint = cos.ap-guangzhou.myqcloud.com + acl = default + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y + Current remotes: + + Name Type + ==== ==== + cos s3 + +Netease NOS + +For Netease NOS configure as per the configurator rclone config setting +the provider Netease. This will automatically set +force_path_style = false which is necessary for it to run properly. - ### Modified time and hashes ### +Backblaze B2 - Box allows modification times to be set on objects accurate to 1 - second. These will be used to detect whether objects need syncing or - not. +B2 is Backblaze's cloud storage system. - Box supports SHA1 type hashes, so you can use the `--checksum` - flag. +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, eg remote:bucket/path/to/dir. - #### Restricted filename characters +Here is an example of making a b2 configuration. First run - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: + rclone config - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | +This will guide you through an interactive setup process. To +authenticate you will either need your Account ID (a short hex number) +and Master Application Key (a long hex number) OR an Application Key, +which is the recommended method. See below for further details on +generating and using an Application Key. - File names can also not end with the following characters. - These only get replaced if they are the last character in the name: + No remotes found - make a new one + n) New remote + q) Quit config + n/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Backblaze B2 + \ "b2" + [snip] + Storage> b2 + Account ID or Application Key ID + account> 123456789abc + Application Key + key> 0123456789abcdef0123456789abcdef0123456789 + Endpoint for the service - leave blank normally. + endpoint> + Remote config + -------------------- + [remote] + account = 123456789abc + key = 0123456789abcdef0123456789abcdef0123456789 + endpoint = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | +This remote is called remote and can now be used like this - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. +See all buckets - ### Transfers ### + rclone lsd remote: - For files above 50MB rclone will use a chunked transfer. Rclone will - upload up to `--transfers` chunks at the same time (shared among all - the multipart uploads). Chunks are buffered in memory and are - normally 8MB so increasing `--transfers` will increase memory use. +Create a new bucket - ### Deleting files ### + rclone mkdir remote:bucket - Depending on the enterprise settings for your user, the item will - either be actually deleted from Box or moved to the trash. +List the contents of a bucket - Emptying the trash is supported via the rclone however cleanup command - however this deletes every trashed file and folder individually so it - may take a very long time. - Emptying the trash via the WebUI does not have this limitation - so it is advised to empty the trash via the WebUI. + rclone ls remote:bucket - ### Root folder ID ### +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. - You can set the `root_folder_id` for rclone. This is the directory - (identified by its `Folder ID`) that rclone considers to be the root - of your Box drive. + rclone sync -i /home/local/directory remote:bucket - Normally you will leave this blank and rclone will determine the - correct root to use itself. +Application Keys - However you can set this to restrict rclone to a specific folder - hierarchy. +B2 supports multiple Application Keys for different access permission to +B2 Buckets. - In order to do this you will have to find the `Folder ID` of the - directory you wish rclone to display. This will be the last segment - of the URL when you open the relevant folder in the Box web - interface. +You can use these with rclone too; you will need to use rclone version +1.43 or later. - So if the folder you want rclone to use has a URL which looks like - `https://app.box.com/folder/11xxxxxxxxx8` - in the browser, then you use `11xxxxxxxxx8` as - the `root_folder_id` in the config. +Follow Backblaze's docs to create an Application Key with the required +permission and add the applicationKeyId as the account and the +Application Key itself as the key. + +Note that you must put the _applicationKeyId_ as the account – you can't +use the master Account ID. If you try then B2 will return 401 errors. + +--fast-list + +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. + +Modified time + +The modified time is stored as metadata on the object as +X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in +the Backblaze standard. Other tools should be able to use this as a +modified time. + +Modified times are used in syncing and are fully supported. Note that if +a modification time needs to be updated on an object then it will create +a new version of the object. + +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. + +Note that in 2020-05 Backblaze started allowing  characters in file +names. Rclone hasn't changed its encoding as this could cause syncs to +re-transfer files. If you want rclone not to replace  then see the +--b2-encoding flag below and remove the BackSlash from the string. This +can be set in the config. + +SHA1 checksums + +The SHA1 checksums of the files are checked on upload and download and +will be used in the syncing process. + +Large files (bigger than the limit in --b2-upload-cutoff) which are +uploaded in chunks will store their SHA1 on the object as +X-Bz-Info-large_file_sha1 as recommended by Backblaze. + +For a large file to be uploaded with an SHA1 checksum, the source needs +to support SHA1 checksums. The local disk supports SHA1 checksums so +large file transfers from local disk will have an SHA1. See the overview +for exactly which remotes support SHA1. + +Sources which don't support SHA1, in particular crypt will upload large +files without SHA1 checksums. This may be fixed in the future (see +#1767). + +Files sizes below --b2-upload-cutoff will always have an SHA1 regardless +of the source. + +Transfers + +Backblaze recommends that you do lots of transfers simultaneously for +maximum speed. In tests from my SSD equipped laptop the optimum setting +is about --transfers 32 though higher numbers may be used for a slight +speed improvement. The optimum number for you may vary depending on your +hardware, how big the files are, how much you want to load your +computer, etc. The default of --transfers 4 is definitely too low for +Backblaze B2 though. + +Note that uploading big files (bigger than 200 MB by default) will use a +96 MB RAM buffer by default. There can be at most --transfers of these +in use at any moment, so this sets the upper limit on the memory used. + +Versions + +When rclone uploads a new version of a file it creates a new version of +it. Likewise when you delete a file, the old version will be marked +hidden and still be available. Conversely, you may opt in to a "hard +delete" of files with the --b2-hard-delete flag which would permanently +remove the file instead of hiding it. + +Old versions of files, where available, are visible using the +--b2-versions flag. + +NB Note that --b2-versions does not work with crypt at the moment #1627. +Using --backup-dir with rclone is the recommended way of working around +this. + +If you wish to remove all the old versions then you can use the +rclone cleanup remote:bucket command which will delete all the old +versions of files, leaving the current ones intact. You can also supply +a path and only old versions under that path will be deleted, eg +rclone cleanup remote:bucket/path/to/stuff. + +Note that cleanup will remove partially uploaded files from the bucket +if they are more than a day old. + +When you purge a bucket, the current and the old versions will be +deleted then the bucket will be deleted. + +However delete will cause the current versions of the files to become +hidden old versions. + +Here is a session showing the listing and retrieval of an old version +followed by a cleanup of the old versions. + +Show current version and all the versions with --b2-versions flag. + + $ rclone -q ls b2:cleanup-test + 9 one.txt + + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt + 8 one-v2016-07-04-141032-000.txt + 16 one-v2016-07-04-141003-000.txt + 15 one-v2016-07-02-155621-000.txt + +Retrieve an old version + + $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp + + $ ls -l /tmp/one-v2016-07-04-141003-000.txt + -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt + +Clean up all the old versions and show that they've gone. + + $ rclone -q cleanup b2:cleanup-test + + $ rclone -q ls b2:cleanup-test + 9 one.txt + + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt + +Data usage + +It is useful to know how many requests are sent to the server in +different scenarios. + +All copy commands send the following 4 requests: + + /b2api/v1/b2_authorize_account + /b2api/v1/b2_create_bucket + /b2api/v1/b2_list_buckets + /b2api/v1/b2_list_file_names + +The b2_list_file_names request will be sent once for every 1k files in +the remote path, providing the checksum and modification time of the +listed files. As of version 1.33 issue #818 causes extra requests to be +sent when using B2 with Crypt. When a copy operation does not require +any files to be uploaded, no more requests will be sent. + +Uploading files that do not require chunking, will send 2 requests per +file upload: + + /b2api/v1/b2_get_upload_url + /b2api/v1/b2_upload_file/ + +Uploading files requiring chunking, will send 2 requests (one each to +start and finish the upload) and another 2 requests for each chunk: + + /b2api/v1/b2_start_large_file + /b2api/v1/b2_get_upload_part_url + /b2api/v1/b2_upload_part/ + /b2api/v1/b2_finish_large_file + +Versions + +Versions can be viewed with the --b2-versions flag. When it is set +rclone will show and act on older versions of files. For example + +Listing without --b2-versions + + $ rclone -q ls b2:cleanup-test + 9 one.txt + +And with + + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt + 8 one-v2016-07-04-141032-000.txt + 16 one-v2016-07-04-141003-000.txt + 15 one-v2016-07-02-155621-000.txt + +Showing that the current version is unchanged but older versions can be +seen. These have the UTC date that they were uploaded to the server to +the nearest millisecond appended to them. + +Note that when using --b2-versions no file write operations are +permitted, so you can't upload files or delete them. + +B2 and rclone link + +Rclone supports generating file share links for private B2 buckets. They +can either be for a file for example: + + ./rclone link B2:bucket/path/to/file.txt + https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx + +or if run on a directory you will get: + + ./rclone link B2:bucket/path + https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx + +you can then use the authorization token (the part of the url from the +?Authorization= on) on any file path under that directory. For example: + + https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx + https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx + https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx + +Standard Options + +Here are the standard options specific to b2 (Backblaze B2). + +--b2-account + +Account ID or Application Key ID + +- Config: account +- Env Var: RCLONE_B2_ACCOUNT +- Type: string +- Default: "" + +--b2-key + +Application Key + +- Config: key +- Env Var: RCLONE_B2_KEY +- Type: string +- Default: "" + +--b2-hard-delete + +Permanently delete files on remote removal, otherwise hide files. + +- Config: hard_delete +- Env Var: RCLONE_B2_HARD_DELETE +- Type: bool +- Default: false + +Advanced Options + +Here are the advanced options specific to b2 (Backblaze B2). + +--b2-endpoint + +Endpoint for the service. Leave blank normally. + +- Config: endpoint +- Env Var: RCLONE_B2_ENDPOINT +- Type: string +- Default: "" + +--b2-test-mode + +A flag string for X-Bz-Test-Mode header for debugging. + +This is for debugging purposes only. Setting it to one of the strings +below will cause b2 to return specific errors: + +- "fail_some_uploads" +- "expire_some_account_authorization_tokens" +- "force_cap_exceeded" + +These will be set in the "X-Bz-Test-Mode" header which is documented in +the b2 integrations checklist. + +- Config: test_mode +- Env Var: RCLONE_B2_TEST_MODE +- Type: string +- Default: "" + +--b2-versions + +Include old versions in directory listings. Note that when using this no +file write operations are permitted, so you can't upload files or delete +them. + +- Config: versions +- Env Var: RCLONE_B2_VERSIONS +- Type: bool +- Default: false + +--b2-upload-cutoff + +Cutoff for switching to chunked upload. + +Files above this size will be uploaded in chunks of "--b2-chunk-size". + +This value should be set no larger than 4.657GiB (== 5GB). + +- Config: upload_cutoff +- Env Var: RCLONE_B2_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 200M + +--b2-copy-cutoff + +Cutoff for switching to multipart copy + +Any files larger than this that need to be server side copied will be +copied in chunks of this size. + +The minimum is 0 and the maximum is 4.6GB. + +- Config: copy_cutoff +- Env Var: RCLONE_B2_COPY_CUTOFF +- Type: SizeSuffix +- Default: 4G + +--b2-chunk-size + +Upload chunk size. Must fit in memory. + +When uploading large files, chunk the file into this size. Note that +these chunks are buffered in memory and there might a maximum of +"--transfers" chunks in progress at once. 5,000,000 Bytes is the minimum +size. + +- Config: chunk_size +- Env Var: RCLONE_B2_CHUNK_SIZE +- Type: SizeSuffix +- Default: 96M + +--b2-disable-checksum + +Disable checksums for large (> upload cutoff) files + +Normally rclone will calculate the SHA1 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files to +start uploading. + +- Config: disable_checksum +- Env Var: RCLONE_B2_DISABLE_CHECKSUM +- Type: bool +- Default: false + +--b2-download-url + +Custom endpoint for downloads. + +This is usually set to a Cloudflare CDN URL as Backblaze offers free +egress for data downloaded through the Cloudflare network. This is +probably only useful for a public bucket. Leave blank if you want to use +the endpoint provided by Backblaze. + +- Config: download_url +- Env Var: RCLONE_B2_DOWNLOAD_URL +- Type: string +- Default: "" + +--b2-download-auth-duration + +Time before the authorization token will expire in s or suffix +ms|s|m|h|d. + +The duration before the download authorization token will expire. The +minimum value is 1 second. The maximum value is one week. + +- Config: download_auth_duration +- Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION +- Type: Duration +- Default: 1w + +--b2-memory-pool-flush-time + +How often internal memory buffer pools will be flushed. Uploads which +requires additional buffers (f.e multipart) will use memory pool for +allocations. This option controls how often unused buffers will be +removed from the pool. + +- Config: memory_pool_flush_time +- Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME +- Type: Duration +- Default: 1m0s + +--b2-memory-pool-use-mmap + +Whether to use mmap buffers in internal memory pool. + +- Config: memory_pool_use_mmap +- Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP +- Type: bool +- Default: false + +--b2-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_B2_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - ### Standard Options +Box - Here are the standard options specific to box (Box). +Paths are specified as remote:path - #### --box-client-id +Paths may be as deep as required, eg remote:directory/subdirectory. - OAuth Client Id - Leave blank normally. +The initial setup for Box involves getting a token from Box which you +can do either in your browser, or with a config.json downloaded from Box +to use JWT authentication. rclone config walks you through it. - - Config: client_id - - Env Var: RCLONE_BOX_CLIENT_ID - - Type: string - - Default: "" +Here is an example of how to make a remote called remote. First run: - #### --box-client-secret + rclone config - OAuth Client Secret - Leave blank normally. - - - Config: client_secret - - Env Var: RCLONE_BOX_CLIENT_SECRET - - Type: string - - Default: "" - - #### --box-box-config-file +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Box + \ "box" + [snip] + Storage> box + Box App Client Id - leave blank normally. + client_id> + Box App Client Secret - leave blank normally. + client_secret> Box App config.json location Leave blank normally. - - Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. - - - - Config: box_config_file - - Env Var: RCLONE_BOX_BOX_CONFIG_FILE - - Type: string - - Default: "" - - #### --box-access-token - + Enter a string value. Press Enter for the default (""). + box_config_file> Box App Primary Access Token Leave blank normally. + Enter a string value. Press Enter for the default (""). + access_token> + + Enter a string value. Press Enter for the default ("user"). + Choose a number from below, or type in your own value + 1 / Rclone should act on behalf of a user + \ "user" + 2 / Rclone should act on behalf of a service account + \ "enterprise" + box_sub_type> + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + client_id = + client_secret = + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs for how to set it up on a machine with no +Internet 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 on +http://127.0.0.1:53682/ and this it may require you to unblock it +temporarily if you are running a host firewall. + +Once configured you can then use rclone like this, + +List directories in top level of your Box + + rclone lsd remote: + +List all the files in your Box + + rclone ls remote: + +To copy a local directory to an Box directory called backup + + rclone copy /home/source remote:backup + +Using rclone with an Enterprise account with SSO + +If you have an "Enterprise" account type with Box with single sign on +(SSO), you need to create a password to use Box with rclone. This can be +done at your Enterprise Box account by going to Settings, "Account" Tab, +and then set the password in the "Authentication" field. + +Once you have done this, you can setup your Enterprise Box account using +the same procedure detailed above in the, using the password you have +just set. + +Invalid refresh token + +According to the box docs: + + Each refresh_token is valid for one use in 60 days. + +This means that if you + +- Don't use the box remote for 60 days +- Copy the config file with a box refresh token in and use it in two + places +- Get an error on a token refresh + +then rclone will return an error which includes the text +Invalid refresh token. + +To fix this you will need to use oauth2 again to update the refresh +token. You can use the methods in the remote setup docs, bearing in mind +that if you use the copy the config file method, you should not use that +remote on the computer you did the authentication on. + +Here is how to do it. + + $ rclone config + Current remotes: + + Name Type + ==== ==== + remote box + + e) Edit existing remote + n) New remote + d) Delete remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + e/n/d/r/c/s/q> e + Choose a number from below, or type in an existing value + 1 > remote + remote> remote + -------------------- + [remote] + type = box + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} + -------------------- + Edit remote + Value "client_id" = "" + Edit? (y/n)> + y) Yes + n) No + y/n> n + Value "client_secret" = "" + Edit? (y/n)> + y) Yes + n) No + y/n> n + Remote config + Already have a token - refresh? + y) Yes + n) No + y/n> y + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = box + token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: access_token - - Env Var: RCLONE_BOX_ACCESS_TOKEN - - Type: string - - Default: "" +Modified time and hashes - #### --box-box-sub-type +Box allows modification times to be set on objects accurate to 1 second. +These will be used to detect whether objects need syncing or not. +Box supports SHA1 type hashes, so you can use the --checksum flag. +Restricted filename characters - - Config: box_sub_type - - Env Var: RCLONE_BOX_BOX_SUB_TYPE - - Type: string - - Default: "user" - - Examples: - - "user" - - Rclone should act on behalf of a user - - "enterprise" - - Rclone should act on behalf of a service account +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + +File names can also not end with the following characters. These only +get replaced if they are the last character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. + +Transfers + +For files above 50MB rclone will use a chunked transfer. Rclone will +upload up to --transfers chunks at the same time (shared among all the +multipart uploads). Chunks are buffered in memory and are normally 8MB +so increasing --transfers will increase memory use. + +Deleting files + +Depending on the enterprise settings for your user, the item will either +be actually deleted from Box or moved to the trash. + +Emptying the trash is supported via the rclone however cleanup command +however this deletes every trashed file and folder individually so it +may take a very long time. Emptying the trash via the WebUI does not +have this limitation so it is advised to empty the trash via the WebUI. + +Root folder ID + +You can set the root_folder_id for rclone. This is the directory +(identified by its Folder ID) that rclone considers to be the root of +your Box drive. + +Normally you will leave this blank and rclone will determine the correct +root to use itself. - ### Advanced Options +However you can set this to restrict rclone to a specific folder +hierarchy. - Here are the advanced options specific to box (Box). +In order to do this you will have to find the Folder ID of the directory +you wish rclone to display. This will be the last segment of the URL +when you open the relevant folder in the Box web interface. - #### --box-token +So if the folder you want rclone to use has a URL which looks like +https://app.box.com/folder/11xxxxxxxxx8 in the browser, then you use +11xxxxxxxxx8 as the root_folder_id in the config. - OAuth Access Token as a JSON blob. +Standard Options - - Config: token - - Env Var: RCLONE_BOX_TOKEN - - Type: string - - Default: "" +Here are the standard options specific to box (Box). - #### --box-auth-url +--box-client-id - Auth server URL. - Leave blank to use the provider defaults. +OAuth Client Id Leave blank normally. - - Config: auth_url - - Env Var: RCLONE_BOX_AUTH_URL - - Type: string - - Default: "" +- Config: client_id +- Env Var: RCLONE_BOX_CLIENT_ID +- Type: string +- Default: "" - #### --box-token-url +--box-client-secret - Token server url. - Leave blank to use the provider defaults. +OAuth Client Secret Leave blank normally. - - Config: token_url - - Env Var: RCLONE_BOX_TOKEN_URL - - Type: string - - Default: "" +- Config: client_secret +- Env Var: RCLONE_BOX_CLIENT_SECRET +- Type: string +- Default: "" - #### --box-root-folder-id +--box-box-config-file - Fill in for rclone to use a non root folder as its starting point. +Box App config.json location Leave blank normally. - - Config: root_folder_id - - Env Var: RCLONE_BOX_ROOT_FOLDER_ID - - Type: string - - Default: "0" +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. - #### --box-upload-cutoff +- Config: box_config_file +- Env Var: RCLONE_BOX_BOX_CONFIG_FILE +- Type: string +- Default: "" - Cutoff for switching to multipart upload (>= 50MB). +--box-access-token - - Config: upload_cutoff - - Env Var: RCLONE_BOX_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 50M +Box App Primary Access Token Leave blank normally. - #### --box-commit-retries +- Config: access_token +- Env Var: RCLONE_BOX_ACCESS_TOKEN +- Type: string +- Default: "" - Max number of times to try committing a multipart file. +--box-box-sub-type - - Config: commit_retries - - Env Var: RCLONE_BOX_COMMIT_RETRIES - - Type: int - - Default: 100 +- Config: box_sub_type +- Env Var: RCLONE_BOX_BOX_SUB_TYPE +- Type: string +- Default: "user" +- Examples: + - "user" + - Rclone should act on behalf of a user + - "enterprise" + - Rclone should act on behalf of a service account - #### --box-encoding +Advanced Options - This sets the encoding for the backend. +Here are the advanced options specific to box (Box). - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +--box-token - - Config: encoding - - Env Var: RCLONE_BOX_ENCODING - - Type: MultiEncoder - - Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot +OAuth Access Token as a JSON blob. +- Config: token +- Env Var: RCLONE_BOX_TOKEN +- Type: string +- Default: "" +--box-auth-url - ### Limitations ### +Auth server URL. Leave blank to use the provider defaults. - Note that Box is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". +- Config: auth_url +- Env Var: RCLONE_BOX_AUTH_URL +- Type: string +- Default: "" - Box file names can't have the `\` character in. rclone maps this to - and from an identical looking unicode equivalent `＼`. +--box-token-url - Box only supports filenames up to 255 characters in length. +Token server url. Leave blank to use the provider defaults. - Cache (BETA) - ----------------------------------------- +- Config: token_url +- Env Var: RCLONE_BOX_TOKEN_URL +- Type: string +- Default: "" - The `cache` remote wraps another existing remote and stores file structure - and its data for long running tasks like `rclone mount`. +--box-root-folder-id - ## Status +Fill in for rclone to use a non root folder as its starting point. - The cache backend code is working but it currently doesn't - have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren't getting fixed. +- Config: root_folder_id +- Env Var: RCLONE_BOX_ROOT_FOLDER_ID +- Type: string +- Default: "0" - The cache backend is due to be phased out in favour of the VFS caching - layer eventually which is more tightly integrated into rclone. +--box-upload-cutoff - Until this happens we recommend only using the cache backend if you - find you can't work without it. There are many docs online describing - the use of the cache backend to minimize API hits and by-and-large - these are out of date and the cache backend isn't needed in those - scenarios any more. +Cutoff for switching to multipart upload (>= 50MB). - ## Setup +- Config: upload_cutoff +- Env Var: RCLONE_BOX_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 50M - To get started you just need to have an existing remote which can be configured - with `cache`. +--box-commit-retries - Here is an example of how to make a remote called `test-cache`. First run: +Max number of times to try committing a multipart file. - rclone config +- Config: commit_retries +- Env Var: RCLONE_BOX_COMMIT_RETRIES +- Type: int +- Default: 100 - This will guide you through an interactive setup process: +--box-encoding -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -test-cache Type of storage to configure. Choose a number from below, or -type in your own value [snip] XX / Cache a remote  "cache" [snip] -Storage> cache Remote to cache. Normally should contain a ':' and a -path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" -(not recommended). remote> local:/test Optional: The URL of the Plex -server plex_url> http://127.0.0.1:32400 Optional: The username of the -Plex user plex_username> dummyusername Optional: The password of the -Plex user y) Yes type in my own password g) Generate random password n) -No leave this optional password blank y/g/n> y Enter the password: -password: Confirm the password: password: The size of a chunk. Lower -value good for slow connections but can affect seamless reading. -Default: 5M Choose a number from below, or type in your own value 1 / -1MB  "1m" 2 / 5 MB  "5M" 3 / 10 MB  "10M" chunk_size> 2 How much time -should object info (file size, file hashes etc) be stored in cache. Use -a very high value if you don't plan on changing the source FS from -outside the cache. Accepted units are: "s", "m", "h". Default: 5m Choose -a number from below, or type in your own value 1 / 1 hour  "1h" 2 / 24 -hours  "24h" 3 / 24 hours  "48h" info_age> 2 The maximum size of stored -chunks. When the storage grows beyond this size, the oldest chunks will -be deleted. Default: 10G Choose a number from below, or type in your own -value 1 / 500 MB  "500M" 2 / 1 GB  "1G" 3 / 10 GB  "10G" -chunk_total_size> 3 Remote config -------------------- [test-cache] -remote = local:/test plex_url = http://127.0.0.1:32400 plex_username = -dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age -= 48h chunk_total_size = 10G +This sets the encoding for the backend. +See: the encoding section in the overview for more info. - You can then use it like this, +- Config: encoding +- Env Var: RCLONE_BOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot - List directories in top level of your drive +Limitations - rclone lsd test-cache: +Note that Box is case insensitive so you can't have a file called +"Hello.doc" and one called "hello.doc". - List all the files in your drive +Box file names can't have the \ character in. rclone maps this to and +from an identical looking unicode equivalent ＼. - rclone ls test-cache: +Box only supports filenames up to 255 characters in length. - To start a cached mount - rclone mount --allow-other test-cache: /var/tmp/test-cache +Cache (BETA) - ### Write Features ### +The cache remote wraps another existing remote and stores file structure +and its data for long running tasks like rclone mount. - ### Offline uploading ### - In an effort to make writing through cache more reliable, the backend - now supports this feature which can be activated by specifying a - `cache-tmp-upload-path`. +Status - A files goes through these states when using this feature: +The cache backend code is working but it currently doesn't have a +maintainer so there are outstanding bugs which aren't getting fixed. - 1. An upload is started (usually by copying a file on the cache remote) - 2. When the copy to the temporary location is complete the file is part - of the cached remote and looks and behaves like any other file (reading included) - 3. After `cache-tmp-wait-time` passes and the file is next in line, `rclone move` - is used to move the file to the cloud provider - 4. Reading the file still works during the upload but most modifications on it will be prohibited - 5. Once the move is complete the file is unlocked for modifications as it - becomes as any other regular file - 6. If the file is being read through `cache` when it's actually - deleted from the temporary path then `cache` will simply swap the source - to the cloud provider without interrupting the reading (small blip can happen though) +The cache backend is due to be phased out in favour of the VFS caching +layer eventually which is more tightly integrated into rclone. - Files are uploaded in sequence and only one file is uploaded at a time. - Uploads will be stored in a queue and be processed based on the order they were added. - The queue and the temporary storage is persistent across restarts but - can be cleared on startup with the `--cache-db-purge` flag. +Until this happens we recommend only using the cache backend if you find +you can't work without it. There are many docs online describing the use +of the cache backend to minimize API hits and by-and-large these are out +of date and the cache backend isn't needed in those scenarios any more. - ### Write Support ### - Writes are supported through `cache`. - One caveat is that a mounted cache remote does not add any retry or fallback - mechanism to the upload operation. This will depend on the implementation - of the wrapped remote. Consider using `Offline uploading` for reliable writes. +Setup - One special case is covered with `cache-writes` which will cache the file - data at the same time as the upload when it is enabled making it available - from the cache store immediately once the upload is finished. +To get started you just need to have an existing remote which can be +configured with cache. - ### Read Features ### +Here is an example of how to make a remote called test-cache. First run: - #### Multiple connections #### + rclone config - To counter the high latency between a local PC where rclone is running - and cloud providers, the cache remote can split multiple requests to the - cloud provider for smaller file chunks and combines them together locally - where they can be available almost immediately before the reader usually - needs them. - - This is similar to buffering when media files are played online. Rclone - will stay around the current marker but always try its best to stay ahead - and prepare the data before. - - #### Plex Integration #### - - There is a direct integration with Plex which allows cache to detect during reading - if the file is in playback or not. This helps cache to adapt how it queries - the cloud provider depending on what is needed for. - - Scans will have a minimum amount of workers (1) while in a confirmed playback cache - will deploy the configured number of workers. - - This integration opens the doorway to additional performance improvements - which will be explored in the near future. - - **Note:** If Plex options are not configured, `cache` will function with its - configured options without adapting any of its settings. - - How to enable? Run `rclone config` and add all the Plex options (endpoint, username - and password) in your remote and it will be automatically enabled. - - Affected settings: - - `cache-workers`: _Configured value_ during confirmed playback or _1_ all the other times - - ##### Certificate Validation ##### - - When the Plex server is configured to only accept secure connections, it is - possible to use `.plex.direct` URLs to ensure certificate validation succeeds. - These URLs are used by Plex internally to connect to the Plex server securely. - - The format for these URLs is the following: - - https://ip-with-dots-replaced.server-hash.plex.direct:32400/ - - The `ip-with-dots-replaced` part can be any IPv4 address, where the dots - have been replaced with dashes, e.g. `127.0.0.1` becomes `127-0-0-1`. - - To get the `server-hash` part, the easiest way is to visit - - https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token - - This page will list all the available Plex servers for your account - with at least one `.plex.direct` link for each. Copy one URL and replace - the IP address with the desired address. This can be used as the - `plex_url` value. - - ### Known issues ### - - #### Mount and --dir-cache-time #### - - --dir-cache-time controls the first layer of directory caching which works at the mount layer. - Being an independent caching mechanism from the `cache` backend, it will manage its own entries - based on the configured time. - - To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct - one, try to set `--dir-cache-time` to a lower time than `--cache-info-age`. Default values are - already configured in this way. - - #### Windows support - Experimental #### - - There are a couple of issues with Windows `mount` functionality that still require some investigations. - It should be considered as experimental thus far as fixes come in for this OS. - - Most of the issues seem to be related to the difference between filesystems - on Linux flavors and Windows as cache is heavily dependent on them. - - Any reports or feedback on how cache behaves on this OS is greatly appreciated. - - - https://github.com/rclone/rclone/issues/1935 - - https://github.com/rclone/rclone/issues/1907 - - https://github.com/rclone/rclone/issues/1834 - - #### Risk of throttling #### - - Future iterations of the cache backend will make use of the pooling functionality - of the cloud provider to synchronize and at the same time make writing through it - more tolerant to failures. - - There are a couple of enhancements in track to add these but in the meantime - there is a valid concern that the expiring cache listings can lead to cloud provider - throttles or bans due to repeated queries on it for very large mounts. - - Some recommendations: - - don't use a very small interval for entry information (`--cache-info-age`) - - while writes aren't yet optimised, you can still write through `cache` which gives you the advantage - of adding the file in the cache at the same time if configured to do so. - - Future enhancements: - - - https://github.com/rclone/rclone/issues/1937 - - https://github.com/rclone/rclone/issues/1936 - - #### cache and crypt #### - - One common scenario is to keep your data encrypted in the cloud provider - using the `crypt` remote. `crypt` uses a similar technique to wrap around - an existing remote and handles this translation in a seamless way. - - There is an issue with wrapping the remotes in this order: - **cloud remote** -> **crypt** -> **cache** - - During testing, I experienced a lot of bans with the remotes in this order. - I suspect it might be related to how crypt opens files on the cloud provider - which makes it think we're downloading the full file instead of small chunks. - Organizing the remotes in this order yields better results: - **cloud remote** -> **cache** -> **crypt** - - #### absolute remote paths #### - - `cache` can not differentiate between relative and absolute paths for the wrapped remote. - Any path given in the `remote` config setting and on the command line will be passed to - the wrapped remote as is, but for storing the chunks on disk the path will be made - relative by removing any leading `/` character. - - This behavior is irrelevant for most backend types, but there are backends where a leading `/` - changes the effective directory, e.g. in the `sftp` backend paths starting with a `/` are - relative to the root of the SSH server and paths without are relative to the user home directory. - As a result `sftp:bin` and `sftp:/bin` will share the same cache folder, even if they represent - a different directory on the SSH server. - - ### Cache and Remote Control (--rc) ### - Cache supports the new `--rc` mode in rclone and can be remote controlled through the following end points: - By default, the listener is disabled if you do not add the flag. - - ### rc cache/expire - Purge a remote from the cache backend. Supports either a directory or a file. - It supports both encrypted and unencrypted file names if cache is wrapped by crypt. - - Params: - - **remote** = path to remote **(required)** - - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - - - ### Standard Options - - Here are the standard options specific to cache (Cache a remote). - - #### --cache-remote +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> test-cache + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Cache a remote + \ "cache" + [snip] + Storage> cache Remote to cache. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). + remote> local:/test + Optional: The URL of the Plex server + plex_url> http://127.0.0.1:32400 + Optional: The username of the Plex user + plex_username> dummyusername + Optional: The password of the Plex user + y) Yes type in my own password + g) Generate random password + n) No leave this optional password blank + y/g/n> y + Enter the password: + password: + Confirm the password: + password: + The size of a chunk. Lower value good for slow connections but can affect seamless reading. + Default: 5M + Choose a number from below, or type in your own value + 1 / 1MB + \ "1m" + 2 / 5 MB + \ "5M" + 3 / 10 MB + \ "10M" + chunk_size> 2 + How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. + Accepted units are: "s", "m", "h". + Default: 5m + Choose a number from below, or type in your own value + 1 / 1 hour + \ "1h" + 2 / 24 hours + \ "24h" + 3 / 24 hours + \ "48h" + info_age> 2 + The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. + Default: 10G + Choose a number from below, or type in your own value + 1 / 500 MB + \ "500M" + 2 / 1 GB + \ "1G" + 3 / 10 GB + \ "10G" + chunk_total_size> 3 + Remote config + -------------------- + [test-cache] + remote = local:/test + plex_url = http://127.0.0.1:32400 + plex_username = dummyusername + plex_password = *** ENCRYPTED *** + chunk_size = 5M + info_age = 48h + chunk_total_size = 10G + +You can then use it like this, + +List directories in top level of your drive + + rclone lsd test-cache: + +List all the files in your drive + + rclone ls test-cache: + +To start a cached mount + + rclone mount --allow-other test-cache: /var/tmp/test-cache + +Write Features + +Offline uploading + +In an effort to make writing through cache more reliable, the backend +now supports this feature which can be activated by specifying a +cache-tmp-upload-path. + +A files goes through these states when using this feature: + +1. An upload is started (usually by copying a file on the cache remote) +2. When the copy to the temporary location is complete the file is part + of the cached remote and looks and behaves like any other file + (reading included) +3. After cache-tmp-wait-time passes and the file is next in line, + rclone move is used to move the file to the cloud provider +4. Reading the file still works during the upload but most + modifications on it will be prohibited +5. Once the move is complete the file is unlocked for modifications as + it becomes as any other regular file +6. If the file is being read through cache when it's actually deleted + from the temporary path then cache will simply swap the source to + the cloud provider without interrupting the reading (small blip can + happen though) + +Files are uploaded in sequence and only one file is uploaded at a time. +Uploads will be stored in a queue and be processed based on the order +they were added. The queue and the temporary storage is persistent +across restarts but can be cleared on startup with the --cache-db-purge +flag. + +Write Support + +Writes are supported through cache. One caveat is that a mounted cache +remote does not add any retry or fallback mechanism to the upload +operation. This will depend on the implementation of the wrapped remote. +Consider using Offline uploading for reliable writes. + +One special case is covered with cache-writes which will cache the file +data at the same time as the upload when it is enabled making it +available from the cache store immediately once the upload is finished. + +Read Features + +Multiple connections + +To counter the high latency between a local PC where rclone is running +and cloud providers, the cache remote can split multiple requests to the +cloud provider for smaller file chunks and combines them together +locally where they can be available almost immediately before the reader +usually needs them. - - Config: remote - - Env Var: RCLONE_CACHE_REMOTE - - Type: string - - Default: "" +This is similar to buffering when media files are played online. Rclone +will stay around the current marker but always try its best to stay +ahead and prepare the data before. - #### --cache-plex-url +Plex Integration - The URL of the Plex server +There is a direct integration with Plex which allows cache to detect +during reading if the file is in playback or not. This helps cache to +adapt how it queries the cloud provider depending on what is needed for. - - Config: plex_url - - Env Var: RCLONE_CACHE_PLEX_URL - - Type: string - - Default: "" +Scans will have a minimum amount of workers (1) while in a confirmed +playback cache will deploy the configured number of workers. - #### --cache-plex-username +This integration opens the doorway to additional performance +improvements which will be explored in the near future. - The username of the Plex user +NOTE: If Plex options are not configured, cache will function with its +configured options without adapting any of its settings. - - Config: plex_username - - Env Var: RCLONE_CACHE_PLEX_USERNAME - - Type: string - - Default: "" +How to enable? Run rclone config and add all the Plex options (endpoint, +username and password) in your remote and it will be automatically +enabled. - #### --cache-plex-password +Affected settings: - cache-workers: _Configured value_ during confirmed +playback or _1_ all the other times - The password of the Plex user +Certificate Validation - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). +When the Plex server is configured to only accept secure connections, it +is possible to use .plex.direct URLs to ensure certificate validation +succeeds. These URLs are used by Plex internally to connect to the Plex +server securely. - - Config: plex_password - - Env Var: RCLONE_CACHE_PLEX_PASSWORD - - Type: string - - Default: "" +The format for these URLs is the following: - #### --cache-chunk-size +https://ip-with-dots-replaced.server-hash.plex.direct:32400/ - The size of a chunk (partial file data). +The ip-with-dots-replaced part can be any IPv4 address, where the dots +have been replaced with dashes, e.g. 127.0.0.1 becomes 127-0-0-1. - Use lower numbers for slower connections. If the chunk size is - changed, any downloaded chunks will be invalid and cache-chunk-path - will need to be cleared or unexpected EOF errors will occur. +To get the server-hash part, the easiest way is to visit - - Config: chunk_size - - Env Var: RCLONE_CACHE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 5M - - Examples: - - "1m" - - 1MB - - "5M" - - 5 MB - - "10M" - - 10 MB +https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token - #### --cache-info-age +This page will list all the available Plex servers for your account with +at least one .plex.direct link for each. Copy one URL and replace the IP +address with the desired address. This can be used as the plex_url +value. - How long to cache file structure information (directory listings, file size, times etc). - If all write operations are done through the cache then you can safely make - this value very large as the cache store will also be updated in real time. +Known issues - - Config: info_age - - Env Var: RCLONE_CACHE_INFO_AGE - - Type: Duration - - Default: 6h0m0s - - Examples: - - "1h" - - 1 hour - - "24h" - - 24 hours - - "48h" - - 48 hours +Mount and --dir-cache-time - #### --cache-chunk-total-size +--dir-cache-time controls the first layer of directory caching which +works at the mount layer. Being an independent caching mechanism from +the cache backend, it will manage its own entries based on the +configured time. - The total size that the chunks can take up on the local disk. +To avoid getting in a scenario where dir cache has obsolete data and +cache would have the correct one, try to set --dir-cache-time to a lower +time than --cache-info-age. Default values are already configured in +this way. - If the cache exceeds this value then it will start to delete the - oldest chunks until it goes under this value. +Windows support - Experimental - - Config: chunk_total_size - - Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE - - Type: SizeSuffix - - Default: 10G - - Examples: - - "500M" - - 500 MB - - "1G" - - 1 GB - - "10G" - - 10 GB +There are a couple of issues with Windows mount functionality that still +require some investigations. It should be considered as experimental +thus far as fixes come in for this OS. - ### Advanced Options +Most of the issues seem to be related to the difference between +filesystems on Linux flavors and Windows as cache is heavily dependent +on them. - Here are the advanced options specific to cache (Cache a remote). +Any reports or feedback on how cache behaves on this OS is greatly +appreciated. - #### --cache-plex-token +- https://github.com/rclone/rclone/issues/1935 +- https://github.com/rclone/rclone/issues/1907 +- https://github.com/rclone/rclone/issues/1834 - The plex token for authentication - auto set normally +Risk of throttling - - Config: plex_token - - Env Var: RCLONE_CACHE_PLEX_TOKEN - - Type: string - - Default: "" +Future iterations of the cache backend will make use of the pooling +functionality of the cloud provider to synchronize and at the same time +make writing through it more tolerant to failures. - #### --cache-plex-insecure +There are a couple of enhancements in track to add these but in the +meantime there is a valid concern that the expiring cache listings can +lead to cloud provider throttles or bans due to repeated queries on it +for very large mounts. - Skip all certificate verification when connecting to the Plex server +Some recommendations: - don't use a very small interval for entry +information (--cache-info-age) - while writes aren't yet optimised, you +can still write through cache which gives you the advantage of adding +the file in the cache at the same time if configured to do so. - - Config: plex_insecure - - Env Var: RCLONE_CACHE_PLEX_INSECURE - - Type: string - - Default: "" +Future enhancements: - #### --cache-db-path +- https://github.com/rclone/rclone/issues/1937 +- https://github.com/rclone/rclone/issues/1936 - Directory to store file structure metadata DB. - The remote name is used as the DB file name. +cache and crypt - - Config: db_path - - Env Var: RCLONE_CACHE_DB_PATH - - Type: string - - Default: "$HOME/.cache/rclone/cache-backend" +One common scenario is to keep your data encrypted in the cloud provider +using the crypt remote. crypt uses a similar technique to wrap around an +existing remote and handles this translation in a seamless way. - #### --cache-chunk-path +There is an issue with wrapping the remotes in this order: CLOUD REMOTE +-> CRYPT -> CACHE - Directory to cache chunk files. +During testing, I experienced a lot of bans with the remotes in this +order. I suspect it might be related to how crypt opens files on the +cloud provider which makes it think we're downloading the full file +instead of small chunks. Organizing the remotes in this order yields +better results: CLOUD REMOTE -> CACHE -> CRYPT - Path to where partial file data (chunks) are stored locally. The remote - name is appended to the final path. +absolute remote paths - This config follows the "--cache-db-path". If you specify a custom - location for "--cache-db-path" and don't specify one for "--cache-chunk-path" - then "--cache-chunk-path" will use the same path as "--cache-db-path". +cache can not differentiate between relative and absolute paths for the +wrapped remote. Any path given in the remote config setting and on the +command line will be passed to the wrapped remote as is, but for storing +the chunks on disk the path will be made relative by removing any +leading / character. - - Config: chunk_path - - Env Var: RCLONE_CACHE_CHUNK_PATH - - Type: string - - Default: "$HOME/.cache/rclone/cache-backend" +This behavior is irrelevant for most backend types, but there are +backends where a leading / changes the effective directory, e.g. in the +sftp backend paths starting with a / are relative to the root of the SSH +server and paths without are relative to the user home directory. As a +result sftp:bin and sftp:/bin will share the same cache folder, even if +they represent a different directory on the SSH server. - #### --cache-db-purge +Cache and Remote Control (--rc) - Clear all the cached data for this remote on start. +Cache supports the new --rc mode in rclone and can be remote controlled +through the following end points: By default, the listener is disabled +if you do not add the flag. - - Config: db_purge - - Env Var: RCLONE_CACHE_DB_PURGE - - Type: bool - - Default: false +rc cache/expire - #### --cache-chunk-clean-interval +Purge a remote from the cache backend. Supports either a directory or a +file. It supports both encrypted and unencrypted file names if cache is +wrapped by crypt. - How often should the cache perform cleanups of the chunk storage. - The default value should be ok for most people. If you find that the - cache goes over "cache-chunk-total-size" too often then try to lower - this value to force it to perform cleanups more often. +Params: - REMOTE = path to remote (REQUIRED) - WITHDATA = true/false to +delete cached data (chunks) as well _(optional, false by default)_ - - Config: chunk_clean_interval - - Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL - - Type: Duration - - Default: 1m0s +Standard Options - #### --cache-read-retries +Here are the standard options specific to cache (Cache a remote). - How many times to retry a read from a cache storage. +--cache-remote - Since reading from a cache stream is independent from downloading file - data, readers can get to a point where there's no more data in the - cache. Most of the times this can indicate a connectivity issue if - cache isn't able to provide file data anymore. +Remote to cache. Normally should contain a ':' and a path, eg +"myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not +recommended). - For really slow connections, increase this to a point where the stream is - able to provide data but your experience will be very stuttering. +- Config: remote +- Env Var: RCLONE_CACHE_REMOTE +- Type: string +- Default: "" - - Config: read_retries - - Env Var: RCLONE_CACHE_READ_RETRIES - - Type: int - - Default: 10 +--cache-plex-url - #### --cache-workers +The URL of the Plex server - How many workers should run in parallel to download chunks. +- Config: plex_url +- Env Var: RCLONE_CACHE_PLEX_URL +- Type: string +- Default: "" - Higher values will mean more parallel processing (better CPU needed) - and more concurrent requests on the cloud provider. This impacts - several aspects like the cloud provider API limits, more stress on the - hardware that rclone runs on but it also means that streams will be - more fluid and data will be available much more faster to readers. +--cache-plex-username - **Note**: If the optional Plex integration is enabled then this - setting will adapt to the type of reading performed and the value - specified here will be used as a maximum number of workers to use. +The username of the Plex user - - Config: workers - - Env Var: RCLONE_CACHE_WORKERS - - Type: int - - Default: 4 +- Config: plex_username +- Env Var: RCLONE_CACHE_PLEX_USERNAME +- Type: string +- Default: "" - #### --cache-chunk-no-memory +--cache-plex-password - Disable the in-memory cache for storing chunks during streaming. +The password of the Plex user - By default, cache will keep file data during streaming in RAM as well - to provide it to readers as fast as possible. +NB Input to this must be obscured - see rclone obscure. - This transient data is evicted as soon as it is read and the number of - chunks stored doesn't exceed the number of workers. However, depending - on other settings like "cache-chunk-size" and "cache-workers" this footprint - can increase if there are parallel streams too (multiple files being read - at the same time). +- Config: plex_password +- Env Var: RCLONE_CACHE_PLEX_PASSWORD +- Type: string +- Default: "" - If the hardware permits it, use this feature to provide an overall better - performance during streaming but it can also be disabled if RAM is not - available on the local machine. +--cache-chunk-size - - Config: chunk_no_memory - - Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY - - Type: bool - - Default: false +The size of a chunk (partial file data). - #### --cache-rps +Use lower numbers for slower connections. If the chunk size is changed, +any downloaded chunks will be invalid and cache-chunk-path will need to +be cleared or unexpected EOF errors will occur. - Limits the number of requests per second to the source FS (-1 to disable) +- Config: chunk_size +- Env Var: RCLONE_CACHE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 5M +- Examples: + - "1m" + - 1MB + - "5M" + - 5 MB + - "10M" + - 10 MB - This setting places a hard limit on the number of requests per second - that cache will be doing to the cloud provider remote and try to - respect that value by setting waits between reads. +--cache-info-age - If you find that you're getting banned or limited on the cloud - provider through cache and know that a smaller number of requests per - second will allow you to work with it then you can use this setting - for that. +How long to cache file structure information (directory listings, file +size, times etc). If all write operations are done through the cache +then you can safely make this value very large as the cache store will +also be updated in real time. - A good balance of all the other settings should make this setting - useless but it is available to set for more special cases. +- Config: info_age +- Env Var: RCLONE_CACHE_INFO_AGE +- Type: Duration +- Default: 6h0m0s +- Examples: + - "1h" + - 1 hour + - "24h" + - 24 hours + - "48h" + - 48 hours - **NOTE**: This will limit the number of requests during streams but - other API calls to the cloud provider like directory listings will - still pass. +--cache-chunk-total-size - - Config: rps - - Env Var: RCLONE_CACHE_RPS - - Type: int - - Default: -1 +The total size that the chunks can take up on the local disk. - #### --cache-writes +If the cache exceeds this value then it will start to delete the oldest +chunks until it goes under this value. - Cache file data on writes through the FS +- Config: chunk_total_size +- Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE +- Type: SizeSuffix +- Default: 10G +- Examples: + - "500M" + - 500 MB + - "1G" + - 1 GB + - "10G" + - 10 GB - If you need to read files immediately after you upload them through - cache you can enable this flag to have their data stored in the - cache store at the same time during upload. +Advanced Options - - Config: writes - - Env Var: RCLONE_CACHE_WRITES - - Type: bool - - Default: false +Here are the advanced options specific to cache (Cache a remote). - #### --cache-tmp-upload-path +--cache-plex-token - Directory to keep temporary files until they are uploaded. +The plex token for authentication - auto set normally - This is the path where cache will use as a temporary storage for new - files that need to be uploaded to the cloud provider. +- Config: plex_token +- Env Var: RCLONE_CACHE_PLEX_TOKEN +- Type: string +- Default: "" - Specifying a value will enable this feature. Without it, it is - completely disabled and files will be uploaded directly to the cloud - provider +--cache-plex-insecure - - Config: tmp_upload_path - - Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH - - Type: string - - Default: "" +Skip all certificate verification when connecting to the Plex server - #### --cache-tmp-wait-time +- Config: plex_insecure +- Env Var: RCLONE_CACHE_PLEX_INSECURE +- Type: string +- Default: "" - How long should files be stored in local cache before being uploaded +--cache-db-path - This is the duration that a file must wait in the temporary location - _cache-tmp-upload-path_ before it is selected for upload. +Directory to store file structure metadata DB. The remote name is used +as the DB file name. - Note that only one file is uploaded at a time and it can take longer - to start the upload if a queue formed for this purpose. +- Config: db_path +- Env Var: RCLONE_CACHE_DB_PATH +- Type: string +- Default: "$HOME/.cache/rclone/cache-backend" - - Config: tmp_wait_time - - Env Var: RCLONE_CACHE_TMP_WAIT_TIME - - Type: Duration - - Default: 15s +--cache-chunk-path - #### --cache-db-wait-time +Directory to cache chunk files. - How long to wait for the DB to be available - 0 is unlimited +Path to where partial file data (chunks) are stored locally. The remote +name is appended to the final path. - Only one process can have the DB open at any one time, so rclone waits - for this duration for the DB to become available before it gives an - error. +This config follows the "--cache-db-path". If you specify a custom +location for "--cache-db-path" and don't specify one for +"--cache-chunk-path" then "--cache-chunk-path" will use the same path as +"--cache-db-path". - If you set it to 0 then it will wait forever. +- Config: chunk_path +- Env Var: RCLONE_CACHE_CHUNK_PATH +- Type: string +- Default: "$HOME/.cache/rclone/cache-backend" - - Config: db_wait_time - - Env Var: RCLONE_CACHE_DB_WAIT_TIME - - Type: Duration - - Default: 1s +--cache-db-purge - ### Backend commands +Clear all the cached data for this remote on start. - Here are the commands specific to the cache backend. +- Config: db_purge +- Env Var: RCLONE_CACHE_DB_PURGE +- Type: bool +- Default: false - Run them with +--cache-chunk-clean-interval - rclone backend COMMAND remote: +How often should the cache perform cleanups of the chunk storage. The +default value should be ok for most people. If you find that the cache +goes over "cache-chunk-total-size" too often then try to lower this +value to force it to perform cleanups more often. - The help below will explain what arguments each command takes. +- Config: chunk_clean_interval +- Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL +- Type: Duration +- Default: 1m0s - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. +--cache-read-retries - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). +How many times to retry a read from a cache storage. - #### stats +Since reading from a cache stream is independent from downloading file +data, readers can get to a point where there's no more data in the +cache. Most of the times this can indicate a connectivity issue if cache +isn't able to provide file data anymore. - Print stats on the cache backend in JSON format. +For really slow connections, increase this to a point where the stream +is able to provide data but your experience will be very stuttering. - rclone backend stats remote: [options] [+] +- Config: read_retries +- Env Var: RCLONE_CACHE_READ_RETRIES +- Type: int +- Default: 10 +--cache-workers +How many workers should run in parallel to download chunks. - Chunker (BETA) - ---------------------------------------- +Higher values will mean more parallel processing (better CPU needed) and +more concurrent requests on the cloud provider. This impacts several +aspects like the cloud provider API limits, more stress on the hardware +that rclone runs on but it also means that streams will be more fluid +and data will be available much more faster to readers. - The `chunker` overlay transparently splits large files into smaller chunks - during upload to wrapped remote and transparently assembles them back - when the file is downloaded. This allows to effectively overcome size limits - imposed by storage providers. +NOTE: If the optional Plex integration is enabled then this setting will +adapt to the type of reading performed and the value specified here will +be used as a maximum number of workers to use. - To use it, first set up the underlying remote following the configuration - instructions for that remote. You can also use a local pathname instead of - a remote. +- Config: workers +- Env Var: RCLONE_CACHE_WORKERS +- Type: int +- Default: 4 - First check your chosen remote is working - we'll call it `remote:path` here. - Note that anything inside `remote:path` will be chunked and anything outside - won't. This means that if you are using a bucket based remote (eg S3, B2, swift) - then you should probably put the bucket in the remote `s3:bucket`. +--cache-chunk-no-memory - Now configure `chunker` using `rclone config`. We will call this one `overlay` - to separate it from the `remote` itself. +Disable the in-memory cache for storing chunks during streaming. -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> overlay Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Transparently chunk/split large files  "chunker" [snip] Storage> -chunker Remote to chunk/unchunk. Normally should contain a ':' and a -path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" -(not recommended). Enter a string value. Press Enter for the default -(""). remote> remote:path Files larger than chunk size will be split in -chunks. Enter a size with suffix k,M,G,T. Press Enter for the default -("2G"). chunk_size> 100M Choose how chunker handles hash sums. All modes -but "none" require metadata. Enter a string value. Press Enter for the -default ("md5"). Choose a number from below, or type in your own value 1 -/ Pass any hash supported by wrapped remote for non-chunked files, -return nothing otherwise  "none" 2 / MD5 for composite files  "md5" 3 / -SHA1 for composite files  "sha1" 4 / MD5 for all files  "md5all" 5 / -SHA1 for all files  "sha1all" 6 / Copying a file to chunker will request -MD5 from the source falling back to SHA1 if unsupported  "md5quick" 7 / -Similar to "md5quick" but prefers SHA1 over MD5  "sha1quick" hash_type> -md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config --------------------- [overlay] type = chunker remote = remote:bucket -chunk_size = 100M hash_type = md5 -------------------- y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y +By default, cache will keep file data during streaming in RAM as well to +provide it to readers as fast as possible. +This transient data is evicted as soon as it is read and the number of +chunks stored doesn't exceed the number of workers. However, depending +on other settings like "cache-chunk-size" and "cache-workers" this +footprint can increase if there are parallel streams too (multiple files +being read at the same time). - ### Specifying the remote +If the hardware permits it, use this feature to provide an overall +better performance during streaming but it can also be disabled if RAM +is not available on the local machine. - In normal use, make sure the remote has a `:` in. If you specify the remote - without a `:` then rclone will use a local directory of that name. - So if you use a remote of `/path/to/secret/files` then rclone will - chunk stuff in that directory. If you use a remote of `name` then rclone - will put files in a directory called `name` in the current directory. +- Config: chunk_no_memory +- Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY +- Type: bool +- Default: false +--cache-rps - ### Chunking +Limits the number of requests per second to the source FS (-1 to +disable) - When rclone starts a file upload, chunker checks the file size. If it - doesn't exceed the configured chunk size, chunker will just pass the file - to the wrapped remote. If a file is large, chunker will transparently cut - data in pieces with temporary names and stream them one by one, on the fly. - Each data chunk will contain the specified number of bytes, except for the - last one which may have less data. If file size is unknown in advance - (this is called a streaming upload), chunker will internally create - a temporary copy, record its size and repeat the above process. +This setting places a hard limit on the number of requests per second +that cache will be doing to the cloud provider remote and try to respect +that value by setting waits between reads. - When upload completes, temporary chunk files are finally renamed. - This scheme guarantees that operations can be run in parallel and look - from outside as atomic. - A similar method with hidden temporary chunks is used for other operations - (copy/move/rename etc). If an operation fails, hidden chunks are normally - destroyed, and the target composite file stays intact. - - When a composite file download is requested, chunker transparently - assembles it by concatenating data chunks in order. As the split is trivial - one could even manually concatenate data chunks together to obtain the - original content. - - When the `list` rclone command scans a directory on wrapped remote, - the potential chunk files are accounted for, grouped and assembled into - composite directory entries. Any temporary chunks are hidden. - - List and other commands can sometimes come across composite files with - missing or invalid chunks, eg. shadowed by like-named directory or - another file. This usually means that wrapped file system has been directly - tampered with or damaged. If chunker detects a missing chunk it will - by default print warning, skip the whole incomplete group of chunks but - proceed with current command. - You can set the `--chunker-fail-hard` flag to have commands abort with - error message in such cases. - - - #### Chunk names - - The default chunk name format is `*.rclone_chunk.###`, hence by default - chunk names are `BIG_FILE_NAME.rclone_chunk.001`, - `BIG_FILE_NAME.rclone_chunk.002` etc. You can configure another name format - using the `name_format` configuration file option. The format uses asterisk - `*` as a placeholder for the base file name and one or more consecutive - hash characters `#` as a placeholder for sequential chunk number. - There must be one and only one asterisk. The number of consecutive hash - characters defines the minimum length of a string representing a chunk number. - If decimal chunk number has less digits than the number of hashes, it is - left-padded by zeros. If the decimal string is longer, it is left intact. - By default numbering starts from 1 but there is another option that allows - user to start from 0, eg. for compatibility with legacy software. - - For example, if name format is `big_*-##.part` and original file name is - `data.txt` and numbering starts from 0, then the first chunk will be named - `big_data.txt-00.part`, the 99th chunk will be `big_data.txt-98.part` - and the 302nd chunk will become `big_data.txt-301.part`. - - Note that `list` assembles composite directory entries only when chunk names - match the configured format and treats non-conforming file names as normal - non-chunked files. - - - ### Metadata - - Besides data chunks chunker will by default create metadata object for - a composite file. The object is named after the original file. - Chunker allows user to disable metadata completely (the `none` format). - Note that metadata is normally not created for files smaller than the - configured chunk size. This may change in future rclone releases. - - #### Simple JSON metadata format - - This is the default format. It supports hash sums and chunk validation - for composite files. Meta objects carry the following fields: - - - `ver` - version of format, currently `1` - - `size` - total size of composite file - - `nchunks` - number of data chunks in file - - `md5` - MD5 hashsum of composite file (if present) - - `sha1` - SHA1 hashsum (if present) - - There is no field for composite file name as it's simply equal to the name - of meta object on the wrapped remote. Please refer to respective sections - for details on hashsums and modified time handling. - - #### No metadata - - You can disable meta objects by setting the meta format option to `none`. - In this mode chunker will scan directory for all files that follow - configured chunk name format, group them by detecting chunks with the same - base name and show group names as virtual composite files. - This method is more prone to missing chunk errors (especially missing - last chunk) than format with metadata enabled. - - - ### Hashsums - - Chunker supports hashsums only when a compatible metadata is present. - Hence, if you choose metadata format of `none`, chunker will report hashsum - as `UNSUPPORTED`. - - Please note that by default metadata is stored only for composite files. - If a file is smaller than configured chunk size, chunker will transparently - redirect hash requests to wrapped remote, so support depends on that. - You will see the empty string as a hashsum of requested type for small - files if the wrapped remote doesn't support it. - - Many storage backends support MD5 and SHA1 hash types, so does chunker. - With chunker you can choose one or another but not both. - MD5 is set by default as the most supported type. - Since chunker keeps hashes for composite files and falls back to the - wrapped remote hash for non-chunked ones, we advise you to choose the same - hash type as supported by wrapped remote so that your file listings - look coherent. - - If your storage backend does not support MD5 or SHA1 but you need consistent - file hashing, configure chunker with `md5all` or `sha1all`. These two modes - guarantee given hash for all files. If wrapped remote doesn't support it, - chunker will then add metadata to all files, even small. However, this can - double the amount of small files in storage and incur additional service charges. - You can even use chunker to force md5/sha1 support in any other remote - at expense of sidecar meta objects by setting eg. `chunk_type=sha1all` - to force hashsums and `chunk_size=1P` to effectively disable chunking. - - Normally, when a file is copied to chunker controlled remote, chunker - will ask the file source for compatible file hash and revert to on-the-fly - calculation if none is found. This involves some CPU overhead but provides - a guarantee that given hashsum is available. Also, chunker will reject - a server-side copy or move operation if source and destination hashsum - types are different resulting in the extra network bandwidth, too. - In some rare cases this may be undesired, so chunker provides two optional - choices: `sha1quick` and `md5quick`. If the source does not support primary - hash type and the quick mode is enabled, chunker will try to fall back to - the secondary type. This will save CPU and bandwidth but can result in empty - hashsums at destination. Beware of consequences: the `sync` command will - revert (sometimes silently) to time/size comparison if compatible hashsums - between source and target are not found. - - - ### Modified time - - Chunker stores modification times using the wrapped remote so support - depends on that. For a small non-chunked file the chunker overlay simply - manipulates modification time of the wrapped remote file. - For a composite file with metadata chunker will get and set - modification time of the metadata object on the wrapped remote. - If file is chunked but metadata format is `none` then chunker will - use modification time of the first data chunk. - - - ### Migrations - - The idiomatic way to migrate to a different chunk size, hash type or - chunk naming scheme is to: - - - Collect all your chunked files under a directory and have your - chunker remote point to it. - - Create another directory (most probably on the same cloud storage) - and configure a new remote with desired metadata format, - hash type, chunk naming etc. - - Now run `rclone sync -i oldchunks: newchunks:` and all your data - will be transparently converted in transfer. - This may take some time, yet chunker will try server-side - copy if possible. - - After checking data integrity you may remove configuration section - of the old remote. - - If rclone gets killed during a long operation on a big composite file, - hidden temporary chunks may stay in the directory. They will not be - shown by the `list` command but will eat up your account quota. - Please note that the `deletefile` command deletes only active - chunks of a file. As a workaround, you can use remote of the wrapped - file system to see them. - An easy way to get rid of hidden garbage is to copy littered directory - somewhere using the chunker remote and purge the original directory. - The `copy` command will copy only active chunks while the `purge` will - remove everything including garbage. - - - ### Caveats and Limitations - - Chunker requires wrapped remote to support server side `move` (or `copy` + - `delete`) operations, otherwise it will explicitly refuse to start. - This is because it internally renames temporary chunk files to their final - names when an operation completes successfully. - - Chunker encodes chunk number in file name, so with default `name_format` - setting it adds 17 characters. Also chunker adds 7 characters of temporary - suffix during operations. Many file systems limit base file name without path - by 255 characters. Using rclone's crypt remote as a base file system limits - file name by 143 characters. Thus, maximum name length is 231 for most files - and 119 for chunker-over-crypt. A user in need can change name format to - eg. `*.rcc##` and save 10 characters (provided at most 99 chunks per file). - - Note that a move implemented using the copy-and-delete method may incur - double charging with some cloud storage providers. - - Chunker will not automatically rename existing chunks when you run - `rclone config` on a live remote and change the chunk name format. - Beware that in result of this some files which have been treated as chunks - before the change can pop up in directory listings as normal files - and vice versa. The same warning holds for the chunk size. - If you desperately need to change critical chunking settings, you should - run data migration as described above. - - If wrapped remote is case insensitive, the chunker overlay will inherit - that property (so you can't have a file called "Hello.doc" and "hello.doc" - in the same directory). - - - - ### Standard Options - - Here are the standard options specific to chunker (Transparently chunk/split large files). - - #### --chunker-remote +If you find that you're getting banned or limited on the cloud provider +through cache and know that a smaller number of requests per second will +allow you to work with it then you can use this setting for that. +A good balance of all the other settings should make this setting +useless but it is available to set for more special cases. + +NOTE: This will limit the number of requests during streams but other +API calls to the cloud provider like directory listings will still pass. + +- Config: rps +- Env Var: RCLONE_CACHE_RPS +- Type: int +- Default: -1 + +--cache-writes + +Cache file data on writes through the FS + +If you need to read files immediately after you upload them through +cache you can enable this flag to have their data stored in the cache +store at the same time during upload. + +- Config: writes +- Env Var: RCLONE_CACHE_WRITES +- Type: bool +- Default: false + +--cache-tmp-upload-path + +Directory to keep temporary files until they are uploaded. + +This is the path where cache will use as a temporary storage for new +files that need to be uploaded to the cloud provider. + +Specifying a value will enable this feature. Without it, it is +completely disabled and files will be uploaded directly to the cloud +provider + +- Config: tmp_upload_path +- Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH +- Type: string +- Default: "" + +--cache-tmp-wait-time + +How long should files be stored in local cache before being uploaded + +This is the duration that a file must wait in the temporary location +_cache-tmp-upload-path_ before it is selected for upload. + +Note that only one file is uploaded at a time and it can take longer to +start the upload if a queue formed for this purpose. + +- Config: tmp_wait_time +- Env Var: RCLONE_CACHE_TMP_WAIT_TIME +- Type: Duration +- Default: 15s + +--cache-db-wait-time + +How long to wait for the DB to be available - 0 is unlimited + +Only one process can have the DB open at any one time, so rclone waits +for this duration for the DB to become available before it gives an +error. + +If you set it to 0 then it will wait forever. + +- Config: db_wait_time +- Env Var: RCLONE_CACHE_DB_WAIT_TIME +- Type: Duration +- Default: 1s + +Backend commands + +Here are the commands specific to the cache backend. + +Run them with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See the "rclone backend" command for more info on how to pass options +and arguments. + +These can be run on a running backend using the rc command +backend/command. + +stats + +Print stats on the cache backend in JSON format. + + rclone backend stats remote: [options] [+] + + +Chunker (BETA) + +The chunker overlay transparently splits large files into smaller chunks +during upload to wrapped remote and transparently assembles them back +when the file is downloaded. This allows to effectively overcome size +limits imposed by storage providers. + +To use it, first set up the underlying remote following the +configuration instructions for that remote. You can also use a local +pathname instead of a remote. + +First check your chosen remote is working - we'll call it remote:path +here. Note that anything inside remote:path will be chunked and anything +outside won't. This means that if you are using a bucket based remote +(eg S3, B2, swift) then you should probably put the bucket in the remote +s3:bucket. + +Now configure chunker using rclone config. We will call this one overlay +to separate it from the remote itself. + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> overlay + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Transparently chunk/split large files + \ "chunker" + [snip] + Storage> chunker Remote to chunk/unchunk. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - - - Config: remote - - Env Var: RCLONE_CHUNKER_REMOTE - - Type: string - - Default: "" - - #### --chunker-chunk-size - + Enter a string value. Press Enter for the default (""). + remote> remote:path Files larger than chunk size will be split in chunks. - - - Config: chunk_size - - Env Var: RCLONE_CHUNKER_CHUNK_SIZE - - Type: SizeSuffix - - Default: 2G - - #### --chunker-hash-type - + Enter a size with suffix k,M,G,T. Press Enter for the default ("2G"). + chunk_size> 100M Choose how chunker handles hash sums. All modes but "none" require metadata. + Enter a string value. Press Enter for the default ("md5"). + Choose a number from below, or type in your own value + 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise + \ "none" + 2 / MD5 for composite files + \ "md5" + 3 / SHA1 for composite files + \ "sha1" + 4 / MD5 for all files + \ "md5all" + 5 / SHA1 for all files + \ "sha1all" + 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported + \ "md5quick" + 7 / Similar to "md5quick" but prefers SHA1 over MD5 + \ "sha1quick" + hash_type> md5 + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + -------------------- + [overlay] + type = chunker + remote = remote:bucket + chunk_size = 100M + hash_type = md5 + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: hash_type - - Env Var: RCLONE_CHUNKER_HASH_TYPE - - Type: string - - Default: "md5" - - Examples: - - "none" - - Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise - - "md5" - - MD5 for composite files - - "sha1" - - SHA1 for composite files - - "md5all" - - MD5 for all files - - "sha1all" - - SHA1 for all files - - "md5quick" - - Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported - - "sha1quick" - - Similar to "md5quick" but prefers SHA1 over MD5 +Specifying the remote - ### Advanced Options +In normal use, make sure the remote has a : in. If you specify the +remote without a : then rclone will use a local directory of that name. +So if you use a remote of /path/to/secret/files then rclone will chunk +stuff in that directory. If you use a remote of name then rclone will +put files in a directory called name in the current directory. - Here are the advanced options specific to chunker (Transparently chunk/split large files). +Chunking - #### --chunker-name-format +When rclone starts a file upload, chunker checks the file size. If it +doesn't exceed the configured chunk size, chunker will just pass the +file to the wrapped remote. If a file is large, chunker will +transparently cut data in pieces with temporary names and stream them +one by one, on the fly. Each data chunk will contain the specified +number of bytes, except for the last one which may have less data. If +file size is unknown in advance (this is called a streaming upload), +chunker will internally create a temporary copy, record its size and +repeat the above process. - String format of chunk file names. - The two placeholders are: base file name (*) and chunk number (#...). - There must be one and only one asterisk and one or more consecutive hash characters. - If chunk number has less digits than the number of hashes, it is left-padded by zeros. - If there are more digits in the number, they are left as is. - Possible chunk files are ignored if their name does not match given format. +When upload completes, temporary chunk files are finally renamed. This +scheme guarantees that operations can be run in parallel and look from +outside as atomic. A similar method with hidden temporary chunks is used +for other operations (copy/move/rename etc). If an operation fails, +hidden chunks are normally destroyed, and the target composite file +stays intact. - - Config: name_format - - Env Var: RCLONE_CHUNKER_NAME_FORMAT - - Type: string - - Default: "*.rclone_chunk.###" +When a composite file download is requested, chunker transparently +assembles it by concatenating data chunks in order. As the split is +trivial one could even manually concatenate data chunks together to +obtain the original content. - #### --chunker-start-from +When the list rclone command scans a directory on wrapped remote, the +potential chunk files are accounted for, grouped and assembled into +composite directory entries. Any temporary chunks are hidden. - Minimum valid chunk number. Usually 0 or 1. - By default chunk numbers start from 1. +List and other commands can sometimes come across composite files with +missing or invalid chunks, eg. shadowed by like-named directory or +another file. This usually means that wrapped file system has been +directly tampered with or damaged. If chunker detects a missing chunk it +will by default print warning, skip the whole incomplete group of chunks +but proceed with current command. You can set the --chunker-fail-hard +flag to have commands abort with error message in such cases. - - Config: start_from - - Env Var: RCLONE_CHUNKER_START_FROM - - Type: int - - Default: 1 +Chunk names - #### --chunker-meta-format +The default chunk name format is *.rclone_chunk.###, hence by default +chunk names are BIG_FILE_NAME.rclone_chunk.001, +BIG_FILE_NAME.rclone_chunk.002 etc. You can configure another name +format using the name_format configuration file option. The format uses +asterisk * as a placeholder for the base file name and one or more +consecutive hash characters # as a placeholder for sequential chunk +number. There must be one and only one asterisk. The number of +consecutive hash characters defines the minimum length of a string +representing a chunk number. If decimal chunk number has less digits +than the number of hashes, it is left-padded by zeros. If the decimal +string is longer, it is left intact. By default numbering starts from 1 +but there is another option that allows user to start from 0, eg. for +compatibility with legacy software. - Format of the metadata object or "none". By default "simplejson". - Metadata is a small JSON file named after the composite file. +For example, if name format is big_*-##.part and original file name is +data.txt and numbering starts from 0, then the first chunk will be named +big_data.txt-00.part, the 99th chunk will be big_data.txt-98.part and +the 302nd chunk will become big_data.txt-301.part. - - Config: meta_format - - Env Var: RCLONE_CHUNKER_META_FORMAT - - Type: string - - Default: "simplejson" - - Examples: - - "none" - - Do not use metadata files at all. Requires hash type "none". - - "simplejson" - - Simple JSON supports hash sums and chunk validation. - - It has the following fields: ver, size, nchunks, md5, sha1. +Note that list assembles composite directory entries only when chunk +names match the configured format and treats non-conforming file names +as normal non-chunked files. - #### --chunker-fail-hard +Metadata - Choose how chunker should handle files with missing or invalid chunks. +Besides data chunks chunker will by default create metadata object for a +composite file. The object is named after the original file. Chunker +allows user to disable metadata completely (the none format). Note that +metadata is normally not created for files smaller than the configured +chunk size. This may change in future rclone releases. - - Config: fail_hard - - Env Var: RCLONE_CHUNKER_FAIL_HARD - - Type: bool - - Default: false - - Examples: - - "true" - - Report errors and abort current command. - - "false" - - Warn user, skip incomplete file and proceed. +Simple JSON metadata format + +This is the default format. It supports hash sums and chunk validation +for composite files. Meta objects carry the following fields: + +- ver - version of format, currently 1 +- size - total size of composite file +- nchunks - number of data chunks in file +- md5 - MD5 hashsum of composite file (if present) +- sha1 - SHA1 hashsum (if present) + +There is no field for composite file name as it's simply equal to the +name of meta object on the wrapped remote. Please refer to respective +sections for details on hashsums and modified time handling. + +No metadata + +You can disable meta objects by setting the meta format option to none. +In this mode chunker will scan directory for all files that follow +configured chunk name format, group them by detecting chunks with the +same base name and show group names as virtual composite files. This +method is more prone to missing chunk errors (especially missing last +chunk) than format with metadata enabled. + +Hashsums + +Chunker supports hashsums only when a compatible metadata is present. +Hence, if you choose metadata format of none, chunker will report +hashsum as UNSUPPORTED. + +Please note that by default metadata is stored only for composite files. +If a file is smaller than configured chunk size, chunker will +transparently redirect hash requests to wrapped remote, so support +depends on that. You will see the empty string as a hashsum of requested +type for small files if the wrapped remote doesn't support it. + +Many storage backends support MD5 and SHA1 hash types, so does chunker. +With chunker you can choose one or another but not both. MD5 is set by +default as the most supported type. Since chunker keeps hashes for +composite files and falls back to the wrapped remote hash for +non-chunked ones, we advise you to choose the same hash type as +supported by wrapped remote so that your file listings look coherent. + +If your storage backend does not support MD5 or SHA1 but you need +consistent file hashing, configure chunker with md5all or sha1all. These +two modes guarantee given hash for all files. If wrapped remote doesn't +support it, chunker will then add metadata to all files, even small. +However, this can double the amount of small files in storage and incur +additional service charges. You can even use chunker to force md5/sha1 +support in any other remote at expense of sidecar meta objects by +setting eg. chunk_type=sha1all to force hashsums and chunk_size=1P to +effectively disable chunking. + +Normally, when a file is copied to chunker controlled remote, chunker +will ask the file source for compatible file hash and revert to +on-the-fly calculation if none is found. This involves some CPU overhead +but provides a guarantee that given hashsum is available. Also, chunker +will reject a server-side copy or move operation if source and +destination hashsum types are different resulting in the extra network +bandwidth, too. In some rare cases this may be undesired, so chunker +provides two optional choices: sha1quick and md5quick. If the source +does not support primary hash type and the quick mode is enabled, +chunker will try to fall back to the secondary type. This will save CPU +and bandwidth but can result in empty hashsums at destination. Beware of +consequences: the sync command will revert (sometimes silently) to +time/size comparison if compatible hashsums between source and target +are not found. + +Modified time + +Chunker stores modification times using the wrapped remote so support +depends on that. For a small non-chunked file the chunker overlay simply +manipulates modification time of the wrapped remote file. For a +composite file with metadata chunker will get and set modification time +of the metadata object on the wrapped remote. If file is chunked but +metadata format is none then chunker will use modification time of the +first data chunk. + +Migrations + +The idiomatic way to migrate to a different chunk size, hash type or +chunk naming scheme is to: + +- Collect all your chunked files under a directory and have your + chunker remote point to it. +- Create another directory (most probably on the same cloud storage) + and configure a new remote with desired metadata format, hash type, + chunk naming etc. +- Now run rclone sync -i oldchunks: newchunks: and all your data will + be transparently converted in transfer. This may take some time, yet + chunker will try server-side copy if possible. +- After checking data integrity you may remove configuration section + of the old remote. + +If rclone gets killed during a long operation on a big composite file, +hidden temporary chunks may stay in the directory. They will not be +shown by the list command but will eat up your account quota. Please +note that the deletefile command deletes only active chunks of a file. +As a workaround, you can use remote of the wrapped file system to see +them. An easy way to get rid of hidden garbage is to copy littered +directory somewhere using the chunker remote and purge the original +directory. The copy command will copy only active chunks while the purge +will remove everything including garbage. + +Caveats and Limitations + +Chunker requires wrapped remote to support server side move (or copy + +delete) operations, otherwise it will explicitly refuse to start. This +is because it internally renames temporary chunk files to their final +names when an operation completes successfully. + +Chunker encodes chunk number in file name, so with default name_format +setting it adds 17 characters. Also chunker adds 7 characters of +temporary suffix during operations. Many file systems limit base file +name without path by 255 characters. Using rclone's crypt remote as a +base file system limits file name by 143 characters. Thus, maximum name +length is 231 for most files and 119 for chunker-over-crypt. A user in +need can change name format to eg. *.rcc## and save 10 characters +(provided at most 99 chunks per file). + +Note that a move implemented using the copy-and-delete method may incur +double charging with some cloud storage providers. + +Chunker will not automatically rename existing chunks when you run +rclone config on a live remote and change the chunk name format. Beware +that in result of this some files which have been treated as chunks +before the change can pop up in directory listings as normal files and +vice versa. The same warning holds for the chunk size. If you +desperately need to change critical chunking settings, you should run +data migration as described above. + +If wrapped remote is case insensitive, the chunker overlay will inherit +that property (so you can't have a file called "Hello.doc" and +"hello.doc" in the same directory). + +Standard Options + +Here are the standard options specific to chunker (Transparently +chunk/split large files). + +--chunker-remote + +Remote to chunk/unchunk. Normally should contain a ':' and a path, eg +"myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not +recommended). + +- Config: remote +- Env Var: RCLONE_CHUNKER_REMOTE +- Type: string +- Default: "" + +--chunker-chunk-size + +Files larger than chunk size will be split in chunks. + +- Config: chunk_size +- Env Var: RCLONE_CHUNKER_CHUNK_SIZE +- Type: SizeSuffix +- Default: 2G + +--chunker-hash-type + +Choose how chunker handles hash sums. All modes but "none" require +metadata. + +- Config: hash_type +- Env Var: RCLONE_CHUNKER_HASH_TYPE +- Type: string +- Default: "md5" +- Examples: + - "none" + - Pass any hash supported by wrapped remote for non-chunked + files, return nothing otherwise + - "md5" + - MD5 for composite files + - "sha1" + - SHA1 for composite files + - "md5all" + - MD5 for all files + - "sha1all" + - SHA1 for all files + - "md5quick" + - Copying a file to chunker will request MD5 from the source + falling back to SHA1 if unsupported + - "sha1quick" + - Similar to "md5quick" but prefers SHA1 over MD5 + +Advanced Options + +Here are the advanced options specific to chunker (Transparently +chunk/split large files). + +--chunker-name-format + +String format of chunk file names. The two placeholders are: base file +name (*) and chunk number (#...). There must be one and only one +asterisk and one or more consecutive hash characters. If chunk number +has less digits than the number of hashes, it is left-padded by zeros. +If there are more digits in the number, they are left as is. Possible +chunk files are ignored if their name does not match given format. + +- Config: name_format +- Env Var: RCLONE_CHUNKER_NAME_FORMAT +- Type: string +- Default: "*.rclone_chunk.###" + +--chunker-start-from + +Minimum valid chunk number. Usually 0 or 1. By default chunk numbers +start from 1. + +- Config: start_from +- Env Var: RCLONE_CHUNKER_START_FROM +- Type: int +- Default: 1 + +--chunker-meta-format + +Format of the metadata object or "none". By default "simplejson". +Metadata is a small JSON file named after the composite file. + +- Config: meta_format +- Env Var: RCLONE_CHUNKER_META_FORMAT +- Type: string +- Default: "simplejson" +- Examples: + - "none" + - Do not use metadata files at all. Requires hash type "none". + - "simplejson" + - Simple JSON supports hash sums and chunk validation. + - It has the following fields: ver, size, nchunks, md5, sha1. + +--chunker-fail-hard + +Choose how chunker should handle files with missing or invalid chunks. + +- Config: fail_hard +- Env Var: RCLONE_CHUNKER_FAIL_HARD +- Type: bool +- Default: false +- Examples: + - "true" + - Report errors and abort current command. + - "false" + - Warn user, skip incomplete file and proceed. +Citrix ShareFile - ## Citrix ShareFile +Citrix ShareFile is a secure file sharing and transfer service aimed as +business. - [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. +The initial setup for Citrix ShareFile involves getting a token from +Citrix ShareFile which you can in your browser. rclone config walks you +through it. - The initial setup for Citrix ShareFile involves getting a token from - Citrix ShareFile which you can in your browser. `rclone config` walks you - through it. +Here is an example of how to make a remote called remote. First run: - Here is an example of how to make a remote called `remote`. First run: + rclone config - rclone config +This will guide you through an interactive setup process: - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value XX / Citrix -Sharefile  "sharefile" Storage> sharefile ** See help for sharefile -backend at: https://rclone.org/sharefile/ ** - -ID of the root folder - -Leave blank to access "Personal Folders". You can use one of the -standard values here or any folder ID (long hex number ID). Enter a -string value. Press Enter for the default (""). Choose a number from -below, or type in your own value 1 / Access the Personal Folders. -(Default)  "" 2 / Access the Favorites folder.  "favorites" 3 / Access -all the shared folders.  "allshared" 4 / Access all the individual -connectors.  "connectors" 5 / Access the home, favorites, and shared -folders as well as the connectors.  "top" root_folder_id> Edit advanced -config? (y/n) y) Yes n) No y/n> n Remote config Use auto config? * Say Y -if not sure * Say N if you are working on a remote or headless machine -y) Yes n) No y/n> y If your browser doesn't open automatically go to the -following link: http://127.0.0.1:53682/auth?state=XXX Log in and -authorize rclone for access Waiting for code... Got code --------------------- [remote] type = sharefile endpoint = -https://XXX.sharefile.com token = -{"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet 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 code. This - is on `http://127.0.0.1:53682/` and this it may require you to unblock - it temporarily if you are running a host firewall. - - Once configured you can then use `rclone` like this, - - List directories in top level of your ShareFile - - rclone lsd remote: - - List all the files in your ShareFile - - rclone ls remote: - - To copy a local directory to an ShareFile directory called backup - - rclone copy /home/source remote:backup - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - ### Modified time and hashes ### - - ShareFile allows modification times to be set on objects accurate to 1 - second. These will be used to detect whether objects need syncing or - not. - - ShareFile supports MD5 type hashes, so you can use the `--checksum` - flag. - - ### Transfers ### - - For files above 128MB rclone will use a chunked transfer. Rclone will - upload up to `--transfers` chunks at the same time (shared among all - the multipart uploads). Chunks are buffered in memory and are - normally 64MB so increasing `--transfers` will increase memory use. - - ### Limitations ### - - Note that ShareFile is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". - - ShareFile only supports filenames up to 256 characters in length. - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \\ | 0x5C | ＼ | - | * | 0x2A | ＊ | - | < | 0x3C | ＜ | - | > | 0x3E | ＞ | - | ? | 0x3F | ？ | - | : | 0x3A | ： | - | \| | 0x7C | ｜ | - | " | 0x22 | ＂ | - - File names can also not start or end with the following characters. - These only get replaced if they are the first or last character in the - name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - | . | 0x2E | ． | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to sharefile (Citrix Sharefile). - - #### --sharefile-root-folder-id + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + XX / Citrix Sharefile + \ "sharefile" + Storage> sharefile + ** See help for sharefile backend at: https://rclone.org/sharefile/ ** ID of the root folder Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID). + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Access the Personal Folders. (Default) + \ "" + 2 / Access the Favorites folder. + \ "favorites" + 3 / Access all the shared folders. + \ "allshared" + 4 / Access all the individual connectors. + \ "connectors" + 5 / Access the home, favorites, and shared folders as well as the connectors. + \ "top" + root_folder_id> + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = sharefile + endpoint = https://XXX.sharefile.com + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs for how to set it up on a machine with no +Internet 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 code. +This is on http://127.0.0.1:53682/ and this it may require you to +unblock it temporarily if you are running a host firewall. + +Once configured you can then use rclone like this, + +List directories in top level of your ShareFile + + rclone lsd remote: + +List all the files in your ShareFile + + rclone ls remote: + +To copy a local directory to an ShareFile directory called backup + + rclone copy /home/source remote:backup + +Paths may be as deep as required, eg remote:directory/subdirectory. + +Modified time and hashes + +ShareFile allows modification times to be set on objects accurate to 1 +second. These will be used to detect whether objects need syncing or +not. + +ShareFile supports MD5 type hashes, so you can use the --checksum flag. + +Transfers - - Config: root_folder_id - - Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID - - Type: string - - Default: "" - - Examples: - - "" - - Access the Personal Folders. (Default) - - "favorites" - - Access the Favorites folder. - - "allshared" - - Access all the shared folders. - - "connectors" - - Access all the individual connectors. - - "top" - - Access the home, favorites, and shared folders as well as the connectors. - - ### Advanced Options +For files above 128MB rclone will use a chunked transfer. Rclone will +upload up to --transfers chunks at the same time (shared among all the +multipart uploads). Chunks are buffered in memory and are normally 64MB +so increasing --transfers will increase memory use. - Here are the advanced options specific to sharefile (Citrix Sharefile). +Limitations - #### --sharefile-upload-cutoff +Note that ShareFile is case insensitive so you can't have a file called +"Hello.doc" and one called "hello.doc". - Cutoff for switching to multipart upload. +ShareFile only supports filenames up to 256 characters in length. - - Config: upload_cutoff - - Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 128M +Restricted filename characters - #### --sharefile-chunk-size +In addition to the default restricted characters set the following +characters are also replaced: - Upload chunk size. Must a power of 2 >= 256k. + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + * 0x2A ＊ + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + : 0x3A ： + | 0x7C ｜ + " 0x22 ＂ - Making this larger will improve performance, but note that each chunk - is buffered in memory one per transfer. +File names can also not start or end with the following characters. +These only get replaced if they are the first or last character in the +name: - Reducing this will reduce memory usage but decrease performance. + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + . 0x2E ． - - Config: chunk_size - - Env Var: RCLONE_SHAREFILE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 64M +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - #### --sharefile-endpoint +Standard Options - Endpoint for API calls. +Here are the standard options specific to sharefile (Citrix Sharefile). - This is usually auto discovered as part of the oauth process, but can - be set manually to something like: https://XXX.sharefile.com +--sharefile-root-folder-id +ID of the root folder - - Config: endpoint - - Env Var: RCLONE_SHAREFILE_ENDPOINT - - Type: string - - Default: "" +Leave blank to access "Personal Folders". You can use one of the +standard values here or any folder ID (long hex number ID). - #### --sharefile-encoding +- Config: root_folder_id +- Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID +- Type: string +- Default: "" +- Examples: + - "" + - Access the Personal Folders. (Default) + - "favorites" + - Access the Favorites folder. + - "allshared" + - Access all the shared folders. + - "connectors" + - Access all the individual connectors. + - "top" + - Access the home, favorites, and shared folders as well as + the connectors. - This sets the encoding for the backend. +Advanced Options - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Here are the advanced options specific to sharefile (Citrix Sharefile). - - Config: encoding - - Env Var: RCLONE_SHAREFILE_ENCODING - - Type: MultiEncoder - - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot +--sharefile-upload-cutoff +Cutoff for switching to multipart upload. +- Config: upload_cutoff +- Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 128M - Crypt - ---------------------------------------- +--sharefile-chunk-size - The `crypt` remote encrypts and decrypts another remote. +Upload chunk size. Must a power of 2 >= 256k. - To use it first set up the underlying remote following the config - instructions for that remote. You can also use a local pathname - instead of a remote which will encrypt and decrypt from that directory - which might be useful for encrypting onto a USB stick for example. +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. - First check your chosen remote is working - we'll call it - `remote:path` in these docs. Note that anything inside `remote:path` - will be encrypted and anything outside won't. This means that if you - are using a bucket based remote (eg S3, B2, swift) then you should - probably put the bucket in the remote `s3:bucket`. If you just use - `s3:` then rclone will make encrypted bucket names too (if using file - name encryption) which may or may not be what you want. +Reducing this will reduce memory usage but decrease performance. - Now configure `crypt` using `rclone config`. We will call this one - `secret` to differentiate it from the `remote`. +- Config: chunk_size +- Env Var: RCLONE_SHAREFILE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 64M -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n -name> secret Type of storage to configure. Choose a number from below, -or type in your own value [snip] XX / Encrypt/Decrypt a remote  "crypt" -[snip] Storage> crypt Remote to encrypt/decrypt. Normally should contain -a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe -"myremote:" (not recommended). remote> remote:path How to encrypt the -filenames. Choose a number from below, or type in your own value 1 / -Don't encrypt the file names. Adds a ".bin" extension only.  "off" 2 / -Encrypt the filenames see the docs for the details.  "standard" 3 / Very -simple filename obfuscation.  "obfuscate" filename_encryption> 2 Option -to either encrypt directory names or leave them intact. Choose a number -from below, or type in your own value 1 / Encrypt directory names. - "true" 2 / Don't encrypt directory names, leave them intact.  "false" -filename_encryption> 1 Password or pass phrase for encryption. y) Yes -type in my own password g) Generate random password y/g> y Enter the -password: password: Confirm the password: password: Password or pass -phrase for salt. Optional but recommended. Should be different to the -previous password. y) Yes type in my own password g) Generate random -password n) No leave this optional password blank y/g/n> g Password -strength in bits. 64 is just about memorable 128 is secure 1024 is the -maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ Use this -password? y) Yes n) No y/n> y Remote config -------------------- -[secret] remote = remote:path filename_encryption = standard password = -*** ENCRYPTED _ PASSWORD2 = _ ENCRYPTED *** -------------------- y) Yes -this is OK e) Edit this remote d) Delete this remote y/e/d> y +--sharefile-endpoint +Endpoint for API calls. - **Important** The password is stored in the config file is lightly - obscured so it isn't immediately obvious what it is. It is in no way - secure unless you use config file encryption. +This is usually auto discovered as part of the oauth process, but can be +set manually to something like: https://XXX.sharefile.com - A long passphrase is recommended, or you can use a random one. +- Config: endpoint +- Env Var: RCLONE_SHAREFILE_ENDPOINT +- Type: string +- Default: "" - The obscured password is created by using AES-CTR with a static key, with - the salt stored verbatim at the beginning of the obscured password. This - static key is shared by between all versions of rclone. +--sharefile-encoding - If you reconfigure rclone with the same passwords/passphrases - elsewhere it will be compatible, but the obscured version will be different - due to the different salt. +This sets the encoding for the backend. - Note that rclone does not encrypt +See: the encoding section in the overview for more info. - * file length - this can be calculated within 16 bytes - * modification time - used for syncing +- Config: encoding +- Env Var: RCLONE_SHAREFILE_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot - ## Specifying the remote ## - In normal use, make sure the remote has a `:` in. If you specify the - remote without a `:` then rclone will use a local directory of that - name. So if you use a remote of `/path/to/secret/files` then rclone - will encrypt stuff to that directory. If you use a remote of `name` - then rclone will put files in a directory called `name` in the current - directory. +Crypt - If you specify the remote as `remote:path/to/dir` then rclone will - store encrypted files in `path/to/dir` on the remote. If you are using - file name encryption, then when you save files to - `secret:subdir/subfile` this will store them in the unencrypted path - `path/to/dir` but the `subdir/subpath` bit will be encrypted. +The crypt remote encrypts and decrypts another remote. - Note that unless you want encrypted bucket names (which are difficult - to manage because you won't know what directory they represent in web - interfaces etc), you should probably specify a bucket, eg - `remote:secretbucket` when using bucket based remotes such as S3, - Swift, Hubic, B2, GCS. +To use it first set up the underlying remote following the config +instructions for that remote. You can also use a local pathname instead +of a remote which will encrypt and decrypt from that directory which +might be useful for encrypting onto a USB stick for example. - ## Example ## +First check your chosen remote is working - we'll call it remote:path in +these docs. Note that anything inside remote:path will be encrypted and +anything outside won't. This means that if you are using a bucket based +remote (eg S3, B2, swift) then you should probably put the bucket in the +remote s3:bucket. If you just use s3: then rclone will make encrypted +bucket names too (if using file name encryption) which may or may not be +what you want. - To test I made a little directory of files using "standard" file name - encryption. - -plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── -file3.txt └── subsubdir └── file4.txt - - - Copy these to the remote and list them back - -$ rclone -q copy plaintext secret: $ rclone -q ls secret: 7 file1.txt 6 -file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 -subdir/file3.txt - - - Now see what that looked like when encrypted - -$ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 -v05749mltvv1tf4onltun46gls 57 -86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 -86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc -56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps - - - Note that this retains the directory structure which means you can do this - -$ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 -subsubdir/file4.txt - - - If don't use file name encryption then the remote will look like this - - note the `.bin` extensions added to prevent the cloud provider - attempting to interpret the data. - -$ rclone -q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 -subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin - - - ### File name encryption modes ### - - Here are some of the features of the file name encryption modes - - Off - - * doesn't hide file names or directory structure - * allows for longer file names (~246 characters) - * can use sub paths and copy single files - - Standard - - * file names encrypted - * file names can't be as long (~143 characters) - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - * can use shortcuts to shorten the directory recursion - - Obfuscation - - This is a simple "rotate" of the filename, with each file having a rot - distance based on the filename. We store the distance at the beginning - of the filename. So a file called "hello" may become "53.jgnnq". - - This is not a strong encryption of filenames, but it may stop automated - scanning tools from picking up on filename patterns. As such it's an - intermediate between "off" and "standard". The advantage is that it - allows for longer path segment names. - - There is a possibility with some unicode based filenames that the - obfuscation is weak and may map lower case characters to upper case - equivalents. You can not rely on this for strong protection. - - * file names very lightly obfuscated - * file names can be longer than standard encryption - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - - Cloud storage systems have various limits on file name length and - total path length which you are more likely to hit using "Standard" - file name encryption. If you keep your file names to below 156 - characters in length then you should be OK on all providers. - - There may be an even more secure file name encryption mode in the - future which will address the long file name problem. - - ### Directory name encryption ### - Crypt offers the option of encrypting dir names or leaving them intact. - There are two options: - - True - - Encrypts the whole file path including directory names - Example: - `1/12/123.txt` is encrypted to - `p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0` - - False - - Only encrypts file names, skips directory names - Example: - `1/12/123.txt` is encrypted to - `1/12/qgm4avr35m5loi1th53ato71v0` - - - ### Modified time and hashes ### - - Crypt stores modification times using the underlying remote so support - depends on that. - - Hashes are not stored for crypt. However the data integrity is - protected by an extremely strong crypto authenticator. - - Note that you should use the `rclone cryptcheck` command to check the - integrity of a crypted remote instead of `rclone check` which can't - check the checksums properly. - - - ### Standard Options - - Here are the standard options specific to crypt (Encrypt/Decrypt a remote). - - #### --crypt-remote +Now configure crypt using rclone config. We will call this one secret to +differentiate it from the remote. + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> secret + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Encrypt/Decrypt a remote + \ "crypt" + [snip] + Storage> crypt Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - - - Config: remote - - Env Var: RCLONE_CRYPT_REMOTE - - Type: string - - Default: "" - - #### --crypt-filename-encryption - + remote> remote:path How to encrypt the filenames. - - - Config: filename_encryption - - Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION - - Type: string - - Default: "standard" - - Examples: - - "standard" - - Encrypt the filenames see the docs for the details. - - "obfuscate" - - Very simple filename obfuscation. - - "off" - - Don't encrypt the file names. Adds a ".bin" extension only. - - #### --crypt-directory-name-encryption - + Choose a number from below, or type in your own value + 1 / Don't encrypt the file names. Adds a ".bin" extension only. + \ "off" + 2 / Encrypt the filenames see the docs for the details. + \ "standard" + 3 / Very simple filename obfuscation. + \ "obfuscate" + filename_encryption> 2 Option to either encrypt directory names or leave them intact. - - NB If filename_encryption is "off" then this option will do nothing. - - - Config: directory_name_encryption - - Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION - - Type: bool - - Default: true - - Examples: - - "true" - - Encrypt directory names. - - "false" - - Don't encrypt directory names, leave them intact. - - #### --crypt-password - + Choose a number from below, or type in your own value + 1 / Encrypt directory names. + \ "true" + 2 / Don't encrypt directory names, leave them intact. + \ "false" + filename_encryption> 1 Password or pass phrase for encryption. - - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - - - Config: password - - Env Var: RCLONE_CRYPT_PASSWORD - - Type: string - - Default: "" - - #### --crypt-password2 - + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. + y) Yes type in my own password + g) Generate random password + n) No leave this optional password blank + y/g/n> g + Password strength in bits. + 64 is just about memorable + 128 is secure + 1024 is the maximum + Bits> 128 + Your password is: JAsJvRcgR-_veXNfy_sGmQ + Use this password? + y) Yes + n) No + y/n> y + Remote config + -------------------- + [secret] + remote = remote:path + filename_encryption = standard + password = *** ENCRYPTED *** + password2 = *** ENCRYPTED *** + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +IMPORTANT The password is stored in the config file is lightly obscured +so it isn't immediately obvious what it is. It is in no way secure +unless you use config file encryption. + +A long passphrase is recommended, or you can use a random one. + +The obscured password is created by using AES-CTR with a static key, +with the salt stored verbatim at the beginning of the obscured password. +This static key is shared by between all versions of rclone. + +If you reconfigure rclone with the same passwords/passphrases elsewhere +it will be compatible, but the obscured version will be different due to +the different salt. + +Note that rclone does not encrypt + +- file length - this can be calculated within 16 bytes +- modification time - used for syncing + + +Specifying the remote + +In normal use, make sure the remote has a : in. If you specify the +remote without a : then rclone will use a local directory of that name. +So if you use a remote of /path/to/secret/files then rclone will encrypt +stuff to that directory. If you use a remote of name then rclone will +put files in a directory called name in the current directory. + +If you specify the remote as remote:path/to/dir then rclone will store +encrypted files in path/to/dir on the remote. If you are using file name +encryption, then when you save files to secret:subdir/subfile this will +store them in the unencrypted path path/to/dir but the subdir/subpath +bit will be encrypted. + +Note that unless you want encrypted bucket names (which are difficult to +manage because you won't know what directory they represent in web +interfaces etc), you should probably specify a bucket, eg +remote:secretbucket when using bucket based remotes such as S3, Swift, +Hubic, B2, GCS. + + +Example + +To test I made a little directory of files using "standard" file name +encryption. + + plaintext/ + ├── file0.txt + ├── file1.txt + └── subdir + ├── file2.txt + ├── file3.txt + └── subsubdir + └── file4.txt + +Copy these to the remote and list them back + + $ rclone -q copy plaintext secret: + $ rclone -q ls secret: + 7 file1.txt + 6 file0.txt + 8 subdir/file2.txt + 10 subdir/subsubdir/file4.txt + 9 subdir/file3.txt + +Now see what that looked like when encrypted + + $ rclone -q ls remote:path + 55 hagjclgavj2mbiqm6u6cnjjqcg + 54 v05749mltvv1tf4onltun46gls + 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo + 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc + 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps + +Note that this retains the directory structure which means you can do +this - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). + $ rclone -q ls secret:subdir + 8 file2.txt + 9 file3.txt + 10 subsubdir/file4.txt - - Config: password2 - - Env Var: RCLONE_CRYPT_PASSWORD2 - - Type: string - - Default: "" +If don't use file name encryption then the remote will look like this - +note the .bin extensions added to prevent the cloud provider attempting +to interpret the data. - ### Advanced Options + $ rclone -q ls remote:path + 54 file0.txt.bin + 57 subdir/file3.txt.bin + 56 subdir/file2.txt.bin + 58 subdir/subsubdir/file4.txt.bin + 55 file1.txt.bin - Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). +File name encryption modes - #### --crypt-server-side-across-configs +Here are some of the features of the file name encryption modes - Allow server side operations (eg copy) to work across different crypt configs. +Off - Normally this option is not what you want, but if you have two crypts - pointing to the same backend you can use it. +- doesn't hide file names or directory structure +- allows for longer file names (~246 characters) +- can use sub paths and copy single files - This can be used, for example, to change file name encryption type - without re-uploading all the data. Just make two crypt backends - pointing to two different directories with the single changed - parameter and use rclone move to move the files between the crypt - remotes. +Standard - - Config: server_side_across_configs - - Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS - - Type: bool - - Default: false +- file names encrypted +- file names can't be as long (~143 characters) +- can use sub paths and copy single files +- directory structure visible +- identical files names will have identical uploaded names +- can use shortcuts to shorten the directory recursion - #### --crypt-show-mapping +Obfuscation - For all files listed show how the names encrypt. +This is a simple "rotate" of the filename, with each file having a rot +distance based on the filename. We store the distance at the beginning +of the filename. So a file called "hello" may become "53.jgnnq". - If this flag is set then for each file that the remote is asked to - list, it will log (at level INFO) a line stating the decrypted file - name and the encrypted file name. +This is not a strong encryption of filenames, but it may stop automated +scanning tools from picking up on filename patterns. As such it's an +intermediate between "off" and "standard". The advantage is that it +allows for longer path segment names. - This is so you can work out which encrypted names are which decrypted - names just in case you need to do something with the encrypted file - names, or for debugging purposes. +There is a possibility with some unicode based filenames that the +obfuscation is weak and may map lower case characters to upper case +equivalents. You can not rely on this for strong protection. - - Config: show_mapping - - Env Var: RCLONE_CRYPT_SHOW_MAPPING - - Type: bool - - Default: false +- file names very lightly obfuscated +- file names can be longer than standard encryption +- can use sub paths and copy single files +- directory structure visible +- identical files names will have identical uploaded names - ### Backend commands +Cloud storage systems have various limits on file name length and total +path length which you are more likely to hit using "Standard" file name +encryption. If you keep your file names to below 156 characters in +length then you should be OK on all providers. - Here are the commands specific to the crypt backend. +There may be an even more secure file name encryption mode in the future +which will address the long file name problem. - Run them with +Directory name encryption - rclone backend COMMAND remote: +Crypt offers the option of encrypting dir names or leaving them intact. +There are two options: - The help below will explain what arguments each command takes. +True - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. +Encrypts the whole file path including directory names Example: +1/12/123.txt is encrypted to +p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0 - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). +False - #### encode +Only encrypts file names, skips directory names Example: 1/12/123.txt is +encrypted to 1/12/qgm4avr35m5loi1th53ato71v0 - Encode the given filename(s) +Modified time and hashes - rclone backend encode remote: [options] [+] +Crypt stores modification times using the underlying remote so support +depends on that. - This encodes the filenames given as arguments returning a list of - strings of the encoded results. +Hashes are not stored for crypt. However the data integrity is protected +by an extremely strong crypto authenticator. - Usage Example: +Note that you should use the rclone cryptcheck command to check the +integrity of a crypted remote instead of rclone check which can't check +the checksums properly. - rclone backend encode crypt: file1 [file2...] - rclone rc backend/command command=encode fs=crypt: file1 [file2...] +Standard Options +Here are the standard options specific to crypt (Encrypt/Decrypt a +remote). - #### decode +--crypt-remote - Decode the given filename(s) +Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg +"myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not +recommended). - rclone backend decode remote: [options] [+] +- Config: remote +- Env Var: RCLONE_CRYPT_REMOTE +- Type: string +- Default: "" - This decodes the filenames given as arguments returning a list of - strings of the decoded results. It will return an error if any of the - inputs are invalid. +--crypt-filename-encryption - Usage Example: +How to encrypt the filenames. - rclone backend decode crypt: encryptedfile1 [encryptedfile2...] - rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] +- Config: filename_encryption +- Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION +- Type: string +- Default: "standard" +- Examples: + - "standard" + - Encrypt the filenames see the docs for the details. + - "obfuscate" + - Very simple filename obfuscation. + - "off" + - Don't encrypt the file names. Adds a ".bin" extension only. +--crypt-directory-name-encryption +Option to either encrypt directory names or leave them intact. +NB If filename_encryption is "off" then this option will do nothing. - ## Backing up a crypted remote ## +- Config: directory_name_encryption +- Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION +- Type: bool +- Default: true +- Examples: + - "true" + - Encrypt directory names. + - "false" + - Don't encrypt directory names, leave them intact. - If you wish to backup a crypted remote, it is recommended that you use - `rclone sync` on the encrypted files, and make sure the passwords are - the same in the new encrypted remote. +--crypt-password - This will have the following advantages +Password or pass phrase for encryption. - * `rclone sync` will check the checksums while copying - * you can use `rclone check` between the encrypted remotes - * you don't decrypt and encrypt unnecessarily +NB Input to this must be obscured - see rclone obscure. - For example, let's say you have your original remote at `remote:` with - the encrypted version at `eremote:` with path `remote:crypt`. You - would then set up the new remote `remote2:` and then the encrypted - version `eremote2:` with path `remote2:crypt` using the same passwords - as `eremote:`. +- Config: password +- Env Var: RCLONE_CRYPT_PASSWORD +- Type: string +- Default: "" - To sync the two remotes you would do +--crypt-password2 - rclone sync -i remote:crypt remote2:crypt +Password or pass phrase for salt. Optional but recommended. Should be +different to the previous password. - And to check the integrity you would do +NB Input to this must be obscured - see rclone obscure. - rclone check remote:crypt remote2:crypt +- Config: password2 +- Env Var: RCLONE_CRYPT_PASSWORD2 +- Type: string +- Default: "" - ## File formats ## +Advanced Options - ### File encryption ### +Here are the advanced options specific to crypt (Encrypt/Decrypt a +remote). - Files are encrypted 1:1 source file to destination object. The file - has a header and is divided into chunks. +--crypt-server-side-across-configs - #### Header #### +Allow server side operations (eg copy) to work across different crypt +configs. - * 8 bytes magic string `RCLONE\x00\x00` - * 24 bytes Nonce (IV) +Normally this option is not what you want, but if you have two crypts +pointing to the same backend you can use it. - The initial nonce is generated from the operating systems crypto - strong random number generator. The nonce is incremented for each - chunk read making sure each nonce is unique for each block written. - The chance of a nonce being re-used is minuscule. If you wrote an - exabyte of data (10¹⁸ bytes) you would have a probability of - approximately 2×10⁻³² of re-using a nonce. +This can be used, for example, to change file name encryption type +without re-uploading all the data. Just make two crypt backends pointing +to two different directories with the single changed parameter and use +rclone move to move the files between the crypt remotes. - #### Chunk #### +- Config: server_side_across_configs +- Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false - Each chunk will contain 64kB of data, except for the last one which - may have less data. The data chunk is in standard NACL secretbox - format. Secretbox uses XSalsa20 and Poly1305 to encrypt and - authenticate messages. +--crypt-show-mapping - Each chunk contains: +For all files listed show how the names encrypt. - * 16 Bytes of Poly1305 authenticator - * 1 - 65536 bytes XSalsa20 encrypted data +If this flag is set then for each file that the remote is asked to list, +it will log (at level INFO) a line stating the decrypted file name and +the encrypted file name. - 64k chunk size was chosen as the best performing chunk size (the - authenticator takes too much time below this and the performance drops - off due to cache effects above this). Note that these chunks are - buffered in memory so they can't be too big. +This is so you can work out which encrypted names are which decrypted +names just in case you need to do something with the encrypted file +names, or for debugging purposes. - This uses a 32 byte (256 bit key) key derived from the user password. +- Config: show_mapping +- Env Var: RCLONE_CRYPT_SHOW_MAPPING +- Type: bool +- Default: false - #### Examples #### +Backend commands - 1 byte file will encrypt to +Here are the commands specific to the crypt backend. - * 32 bytes header - * 17 bytes data chunk +Run them with - 49 bytes total + rclone backend COMMAND remote: - 1MB (1048576 bytes) file will encrypt to +The help below will explain what arguments each command takes. - * 32 bytes header - * 16 chunks of 65568 bytes +See the "rclone backend" command for more info on how to pass options +and arguments. - 1049120 bytes total (a 0.05% overhead). This is the overhead for big - files. +These can be run on a running backend using the rc command +backend/command. - ### Name encryption ### +encode - File names are encrypted segment by segment - the path is broken up - into `/` separated strings and these are encrypted individually. +Encode the given filename(s) - File segments are padded using PKCS#7 to a multiple of 16 bytes - before encryption. + rclone backend encode remote: [options] [+] - They are then encrypted with EME using AES with 256 bit key. EME - (ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 - paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway. +This encodes the filenames given as arguments returning a list of +strings of the encoded results. - This makes for deterministic encryption which is what we want - the - same filename must encrypt to the same thing otherwise we can't find - it on the cloud storage system. +Usage Example: - This means that + rclone backend encode crypt: file1 [file2...] + rclone rc backend/command command=encode fs=crypt: file1 [file2...] - * filenames with the same name will encrypt the same - * filenames which start the same won't have a common prefix +decode - This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of - which are derived from the user password. +Decode the given filename(s) - After encryption they are written out using a modified version of - standard `base32` encoding as described in RFC4648. The standard - encoding is modified in two ways: + rclone backend decode remote: [options] [+] - * it becomes lower case (no-one likes upper case filenames!) - * we strip the padding character `=` +This decodes the filenames given as arguments returning a list of +strings of the decoded results. It will return an error if any of the +inputs are invalid. - `base32` is used rather than the more efficient `base64` so rclone can be - used on case insensitive remotes (eg Windows, Amazon Drive). +Usage Example: - ### Key derivation ### + rclone backend decode crypt: encryptedfile1 [encryptedfile2...] + rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] - Rclone uses `scrypt` with parameters `N=16384, r=8, p=1` with an - optional user supplied salt (password2) to derive the 32+32+16 = 80 - bytes of key material required. If the user doesn't supply a salt - then rclone uses an internal one. - `scrypt` makes it impractical to mount a dictionary attack on rclone - encrypted data. For full protection against this you should always use - a salt. +Backing up a crypted remote - Dropbox - --------------------------------- +If you wish to backup a crypted remote, it is recommended that you use +rclone sync on the encrypted files, and make sure the passwords are the +same in the new encrypted remote. - Paths are specified as `remote:path` +This will have the following advantages - Dropbox paths may be as deep as required, eg - `remote:directory/subdirectory`. +- rclone sync will check the checksums while copying +- you can use rclone check between the encrypted remotes +- you don't decrypt and encrypt unnecessarily - The initial setup for dropbox involves getting a token from Dropbox - which you need to do in your browser. `rclone config` walks you - through it. +For example, let's say you have your original remote at remote: with the +encrypted version at eremote: with path remote:crypt. You would then set +up the new remote remote2: and then the encrypted version eremote2: with +path remote2:crypt using the same passwords as eremote:. - Here is an example of how to make a remote called `remote`. First run: +To sync the two remotes you would do - rclone config + rclone sync -i remote:crypt remote2:crypt - This will guide you through an interactive setup process: +And to check the integrity you would do -n) New remote -o) Delete remote -p) Quit config e/n/d/q> n name> remote Type of storage to configure. - Choose a number from below, or type in your own value [snip] XX / - Dropbox  "dropbox" [snip] Storage> dropbox Dropbox App Key - leave - blank normally. app_key> Dropbox App Secret - leave blank normally. - app_secret> Remote config Please visit: + rclone check remote:crypt remote2:crypt + + +File formats + +File encryption + +Files are encrypted 1:1 source file to destination object. The file has +a header and is divided into chunks. + +Header + +- 8 bytes magic string RCLONE\x00\x00 +- 24 bytes Nonce (IV) + +The initial nonce is generated from the operating systems crypto strong +random number generator. The nonce is incremented for each chunk read +making sure each nonce is unique for each block written. The chance of a +nonce being re-used is minuscule. If you wrote an exabyte of data (10¹⁸ +bytes) you would have a probability of approximately 2×10⁻³² of re-using +a nonce. + +Chunk + +Each chunk will contain 64kB of data, except for the last one which may +have less data. The data chunk is in standard NACL secretbox format. +Secretbox uses XSalsa20 and Poly1305 to encrypt and authenticate +messages. + +Each chunk contains: + +- 16 Bytes of Poly1305 authenticator +- 1 - 65536 bytes XSalsa20 encrypted data + +64k chunk size was chosen as the best performing chunk size (the +authenticator takes too much time below this and the performance drops +off due to cache effects above this). Note that these chunks are +buffered in memory so they can't be too big. + +This uses a 32 byte (256 bit key) key derived from the user password. + +Examples + +1 byte file will encrypt to + +- 32 bytes header +- 17 bytes data chunk + +49 bytes total + +1MB (1048576 bytes) file will encrypt to + +- 32 bytes header +- 16 chunks of 65568 bytes + +1049120 bytes total (a 0.05% overhead). This is the overhead for big +files. + +Name encryption + +File names are encrypted segment by segment - the path is broken up into +/ separated strings and these are encrypted individually. + +File segments are padded using PKCS#7 to a multiple of 16 bytes before +encryption. + +They are then encrypted with EME using AES with 256 bit key. EME +(ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 +paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway. + +This makes for deterministic encryption which is what we want - the same +filename must encrypt to the same thing otherwise we can't find it on +the cloud storage system. + +This means that + +- filenames with the same name will encrypt the same +- filenames which start the same won't have a common prefix + +This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of +which are derived from the user password. + +After encryption they are written out using a modified version of +standard base32 encoding as described in RFC4648. The standard encoding +is modified in two ways: + +- it becomes lower case (no-one likes upper case filenames!) +- we strip the padding character = + +base32 is used rather than the more efficient base64 so rclone can be +used on case insensitive remotes (eg Windows, Amazon Drive). + +Key derivation + +Rclone uses scrypt with parameters N=16384, r=8, p=1 with an optional +user supplied salt (password2) to derive the 32+32+16 = 80 bytes of key +material required. If the user doesn't supply a salt then rclone uses an +internal one. + +scrypt makes it impractical to mount a dictionary attack on rclone +encrypted data. For full protection against this you should always use a +salt. + + +Dropbox + +Paths are specified as remote:path + +Dropbox paths may be as deep as required, eg +remote:directory/subdirectory. + +The initial setup for dropbox involves getting a token from Dropbox +which you need to do in your browser. rclone config walks you through +it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + n) New remote + d) Delete remote + q) Quit config + e/n/d/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Dropbox + \ "dropbox" + [snip] + Storage> dropbox + Dropbox App Key - leave blank normally. + app_key> + Dropbox App Secret - leave blank normally. + app_secret> + Remote config + Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX - -------------------- [remote] app_key = app_secret = token = - XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX -------------------- -q) Yes this is OK -r) Edit this remote -s) Delete this remote y/e/d> y + [remote] + app_key = + app_secret = + token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y +You can then use it like this, - You can then use it like this, +List directories in top level of your dropbox - List directories in top level of your dropbox + rclone lsd remote: - rclone lsd remote: +List all the files in your dropbox - List all the files in your dropbox + rclone ls remote: - rclone ls remote: +To copy a local directory to a dropbox directory called backup - To copy a local directory to a dropbox directory called backup + rclone copy /home/source remote:backup - rclone copy /home/source remote:backup +Dropbox for business - ### Dropbox for business ### +Rclone supports Dropbox for business and Team Folders. - Rclone supports Dropbox for business and Team Folders. +When using Dropbox for business remote: and remote:path/to/file will +refer to your personal folder. - When using Dropbox for business `remote:` and `remote:path/to/file` - will refer to your personal folder. +If you wish to see Team Folders you must use a leading / in the path, so +rclone lsd remote:/ will refer to the root and show you all Team Folders +and your User Folder. - If you wish to see Team Folders you must use a leading `/` in the - path, so `rclone lsd remote:/` will refer to the root and show you all - Team Folders and your User Folder. +You can then use team folders like this remote:/TeamFolder and +remote:/TeamFolder/path/to/file. - You can then use team folders like this `remote:/TeamFolder` and - `remote:/TeamFolder/path/to/file`. +A leading / for a Dropbox personal account will do nothing, but it will +take an extra HTTP transaction so it should be avoided. - A leading `/` for a Dropbox personal account will do nothing, but it - will take an extra HTTP transaction so it should be avoided. +Modified time and Hashes - ### Modified time and Hashes ### +Dropbox supports modified times, but the only way to set a modification +time is to re-upload the file. - Dropbox supports modified times, but the only way to set a - modification time is to re-upload the file. +This means that if you uploaded your data with an older version of +rclone which didn't support the v2 API and modified times, rclone will +decide to upload all your old data to fix the modification times. If you +don't want this to happen use --size-only or --checksum flag to stop it. - This means that if you uploaded your data with an older version of - rclone which didn't support the v2 API and modified times, rclone will - decide to upload all your old data to fix the modification times. If - you don't want this to happen use `--size-only` or `--checksum` flag - to stop it. +Dropbox supports its own hash type which is checked for all transfers. - Dropbox supports [its own hash - type](https://www.dropbox.com/developers/reference/content-hash) which - is checked for all transfers. +Restricted filename characters - #### Restricted filename characters + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + DEL 0x7F ␡ + \ 0x5C ＼ - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - | DEL | 0x7F | ␡ | - | \ | 0x5C | ＼ | +File names can also not end with the following characters. These only +get replaced if they are the last character in the name: - File names can also not end with the following characters. - These only get replaced if they are the last character in the name: + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. +Standard Options +Here are the standard options specific to dropbox (Dropbox). - ### Standard Options +--dropbox-client-id - Here are the standard options specific to dropbox (Dropbox). +OAuth Client Id Leave blank normally. - #### --dropbox-client-id +- Config: client_id +- Env Var: RCLONE_DROPBOX_CLIENT_ID +- Type: string +- Default: "" - OAuth Client Id - Leave blank normally. +--dropbox-client-secret - - Config: client_id - - Env Var: RCLONE_DROPBOX_CLIENT_ID - - Type: string - - Default: "" +OAuth Client Secret Leave blank normally. - #### --dropbox-client-secret +- Config: client_secret +- Env Var: RCLONE_DROPBOX_CLIENT_SECRET +- Type: string +- Default: "" - OAuth Client Secret - Leave blank normally. +Advanced Options - - Config: client_secret - - Env Var: RCLONE_DROPBOX_CLIENT_SECRET - - Type: string - - Default: "" +Here are the advanced options specific to dropbox (Dropbox). - ### Advanced Options +--dropbox-token - Here are the advanced options specific to dropbox (Dropbox). +OAuth Access Token as a JSON blob. - #### --dropbox-token +- Config: token +- Env Var: RCLONE_DROPBOX_TOKEN +- Type: string +- Default: "" - OAuth Access Token as a JSON blob. +--dropbox-auth-url - - Config: token - - Env Var: RCLONE_DROPBOX_TOKEN - - Type: string - - Default: "" +Auth server URL. Leave blank to use the provider defaults. - #### --dropbox-auth-url +- Config: auth_url +- Env Var: RCLONE_DROPBOX_AUTH_URL +- Type: string +- Default: "" - Auth server URL. - Leave blank to use the provider defaults. +--dropbox-token-url - - Config: auth_url - - Env Var: RCLONE_DROPBOX_AUTH_URL - - Type: string - - Default: "" +Token server url. Leave blank to use the provider defaults. - #### --dropbox-token-url +- Config: token_url +- Env Var: RCLONE_DROPBOX_TOKEN_URL +- Type: string +- Default: "" - Token server url. - Leave blank to use the provider defaults. +--dropbox-chunk-size - - Config: token_url - - Env Var: RCLONE_DROPBOX_TOKEN_URL - - Type: string - - Default: "" +Upload chunk size. (< 150M). - #### --dropbox-chunk-size +Any files larger than this will be uploaded in chunks of this size. - Upload chunk size. (< 150M). +Note that chunks are buffered in memory (one at a time) so rclone can +deal with retries. Setting this larger will increase the speed slightly +(at most 10% for 128MB in tests) at the cost of using more memory. It +can be set smaller if you are tight on memory. - Any files larger than this will be uploaded in chunks of this size. +- Config: chunk_size +- Env Var: RCLONE_DROPBOX_CHUNK_SIZE +- Type: SizeSuffix +- Default: 48M - Note that chunks are buffered in memory (one at a time) so rclone can - deal with retries. Setting this larger will increase the speed - slightly (at most 10% for 128MB in tests) at the cost of using more - memory. It can be set smaller if you are tight on memory. +--dropbox-impersonate - - Config: chunk_size - - Env Var: RCLONE_DROPBOX_CHUNK_SIZE - - Type: SizeSuffix - - Default: 48M +Impersonate this user when using a business account. - #### --dropbox-impersonate +- Config: impersonate +- Env Var: RCLONE_DROPBOX_IMPERSONATE +- Type: string +- Default: "" - Impersonate this user when using a business account. +--dropbox-encoding - - Config: impersonate - - Env Var: RCLONE_DROPBOX_IMPERSONATE - - Type: string - - Default: "" +This sets the encoding for the backend. - #### --dropbox-encoding +See: the encoding section in the overview for more info. - This sets the encoding for the backend. +- Config: encoding +- Env Var: RCLONE_DROPBOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Limitations - - Config: encoding - - Env Var: RCLONE_DROPBOX_ENCODING - - Type: MultiEncoder - - Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot +Note that Dropbox is case insensitive so you can't have a file called +"Hello.doc" and one called "hello.doc". +There are some file names such as thumbs.db which Dropbox can't store. +There is a full list of them in the "Ignored Files" section of this +document. Rclone will issue an error message +File name disallowed - not uploading if it attempts to upload one of +those file names, but the sync won't fail. +Some errors may occur if you try to sync copyright-protected files +because Dropbox has its own copyright detector that prevents this sort +of file being downloaded. This will return the error +ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/. - ### Limitations ### +If you have more than 10,000 files in a directory then +rclone purge dropbox:dir will return the error +Failed to purge: There are too many files involved in this operation. As +a work-around do an rclone delete dropbox:dir followed by an +rclone rmdir dropbox:dir. - Note that Dropbox is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". +Get your own Dropbox App ID - There are some file names such as `thumbs.db` which Dropbox can't - store. There is a full list of them in the ["Ignored Files" section - of this document](https://www.dropbox.com/en/help/145). Rclone will - issue an error message `File name disallowed - not uploading` if it - attempts to upload one of those file names, but the sync won't fail. +When you use rclone with Dropbox in its default configuration you are +using rclone's App ID. This is shared between all the rclone users. - Some errors may occur if you try to sync copyright-protected files - because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that - prevents this sort of file being downloaded. This will return the error `ERROR : - /path/to/your/file: Failed to copy: failed to open source object: - path/restricted_content/.` +Here is how to create your own Dropbox App ID for rclone: - If you have more than 10,000 files in a directory then `rclone purge - dropbox:dir` will return the error `Failed to purge: There are too - many files involved in this operation`. As a work-around do an - `rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir`. +1. Log into the Dropbox App console with your Dropbox Account (It need + not to be the same account as the Dropbox you want to access) - ### Get your own Dropbox App ID ### +2. Choose an API => Usually this should be Dropbox API - When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users. +3. Choose the type of access you want to use => Full Dropbox or + App Folder - Here is how to create your own Dropbox App ID for rclone: +4. Name your App. The app name is global, so you can't use rclone for + example - 1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not - to be the same account as the Dropbox you want to access) +5. Click the button Create App - 2. Choose an API => Usually this should be `Dropbox API` +6. Fill Redirect URIs as http://localhost:53682/ - 3. Choose the type of access you want to use => `Full Dropbox` or `App Folder` +7. Find the App key and App secret Use these values in rclone config to + add a new remote or edit an existing remote. - 4. Name your App. The app name is global, so you can't use `rclone` for example - 5. Click the button `Create App` +FTP - 5. Fill `Redirect URIs` as `http://localhost:53682/` +FTP is the File Transfer Protocol. FTP support is provided using the +github.com/jlaffaye/ftp package. - 6. Find the `App key` and `App secret` Use these values in rclone config to add a new remote or edit an existing remote. +Paths are specified as remote:path. If the path does not begin with a / +it is relative to the home directory of the user. An empty path remote: +refers to the user's home directory. - FTP - ------------------------------ +Here is an example of making an FTP configuration. First run - FTP is the File Transfer Protocol. FTP support is provided using the - [github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) - package. + rclone config - Paths are specified as `remote:path`. If the path does not begin with - a `/` it is relative to the home directory of the user. An empty path - `remote:` refers to the user's home directory. +This will guide you through an interactive setup process. An FTP remote +only needs a host together with and a username and a password. With +anonymous FTP server, you will need to use anonymous as username and +your email address as the password. - Here is an example of making an FTP configuration. First run - - rclone config - - This will guide you through an interactive setup process. An FTP remote only - needs a host together with and a username and a password. With anonymous FTP - server, you will need to use `anonymous` as username and your email address as - the password. - -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Enter a string value. Press Enter -for the default (""). Choose a number from below, or type in your own -value [snip] XX / FTP Connection  "ftp" [snip] Storage> ftp ** See help -for ftp backend at: https://rclone.org/ftp/ ** - -FTP host to connect to Enter a string value. Press Enter for the default -(""). Choose a number from below, or type in your own value 1 / Connect -to ftp.example.com  "ftp.example.com" host> ftp.example.com FTP -username, leave blank for current username, ncw Enter a string value. -Press Enter for the default (""). user> FTP port, leave blank to use -default (21) Enter a string value. Press Enter for the default (""). -port> FTP password y) Yes type in my own password g) Generate random -password y/g> y Enter the password: password: Confirm the password: -password: Use FTP over TLS (Implicit) Enter a boolean value (true or -false). Press Enter for the default ("false"). tls> Use FTP over TLS -(Explicit) Enter a boolean value (true or false). Press Enter for the -default ("false"). explicit_tls> Remote config -------------------- -[remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - This remote is called `remote` and can now be used like this - - See all directories in the home directory - - rclone lsd remote: - - Make a new directory - - rclone mkdir remote:path/to/directory - - List the contents of a directory - - rclone ls remote:path/to/directory - - Sync `/home/local/directory` to the remote directory, deleting any - excess files in the directory. - - rclone sync -i /home/local/directory remote:directory - - ### Modified time ### - - FTP does not support modified times. Any times you see on the server - will be time of upload. - - ### Checksums ### - - FTP does not support any checksums. - - ### Usage without a config file ### - - An example how to use the ftp remote without a config file: - - rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy` - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - File names can also not end with the following characters. - These only get replaced if they are the last character in the name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - - Note that not all FTP servers can have all characters in file names, for example: - - | FTP Server| Forbidden characters | - | --------- |:--------------------:| - | proftpd | `*` | - | pureftpd | `\ [ ]` | - - ### Implicit TLS ### - - FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled - in the config for the remote. The default FTPS port is `990` so the - port will likely have to be explicitly set in the config for the remote. - - - ### Standard Options - - Here are the standard options specific to ftp (FTP Connection). - - #### --ftp-host + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / FTP Connection + \ "ftp" + [snip] + Storage> ftp + ** See help for ftp backend at: https://rclone.org/ftp/ ** FTP host to connect to - - - Config: host - - Env Var: RCLONE_FTP_HOST - - Type: string - - Default: "" - - Examples: - - "ftp.example.com" - - Connect to ftp.example.com - - #### --ftp-user - - FTP username, leave blank for current username, $USER - - - Config: user - - Env Var: RCLONE_FTP_USER - - Type: string - - Default: "" - - #### --ftp-port - + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Connect to ftp.example.com + \ "ftp.example.com" + host> ftp.example.com + FTP username, leave blank for current username, ncw + Enter a string value. Press Enter for the default (""). + user> FTP port, leave blank to use default (21) - - - Config: port - - Env Var: RCLONE_FTP_PORT - - Type: string - - Default: "" - - #### --ftp-pass - + Enter a string value. Press Enter for the default (""). + port> FTP password - - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - - - Config: pass - - Env Var: RCLONE_FTP_PASS - - Type: string - - Default: "" - - #### --ftp-tls - - Use FTPS over TLS (Implicit) - When using implicit FTP over TLS the client will connect using TLS - right from the start, which in turn breaks the compatibility with - non-TLS-aware servers. This is usually served over port 990 rather - than port 21. Cannot be used in combination with explicit FTP. - - - Config: tls - - Env Var: RCLONE_FTP_TLS - - Type: bool - - Default: false - - #### --ftp-explicit-tls - + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: + Use FTP over TLS (Implicit) + Enter a boolean value (true or false). Press Enter for the default ("false"). + tls> Use FTP over TLS (Explicit) - When using explicit FTP over TLS the client explicitly request - security from the server in order to upgrade a plain text connection - to an encrypted one. Cannot be used in combination with implicit FTP. - - - Config: explicit_tls - - Env Var: RCLONE_FTP_EXPLICIT_TLS - - Type: bool - - Default: false - - ### Advanced Options - - Here are the advanced options specific to ftp (FTP Connection). - - #### --ftp-concurrency - - Maximum number of FTP simultaneous connections, 0 for unlimited - - - Config: concurrency - - Env Var: RCLONE_FTP_CONCURRENCY - - Type: int - - Default: 0 - - #### --ftp-no-check-certificate - - Do not verify the TLS certificate of the server - - - Config: no_check_certificate - - Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE - - Type: bool - - Default: false - - #### --ftp-disable-epsv - - Disable using EPSV even if server advertises support - - - Config: disable_epsv - - Env Var: RCLONE_FTP_DISABLE_EPSV - - Type: bool - - Default: false - - #### --ftp-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_FTP_ENCODING - - Type: MultiEncoder - - Default: Slash,Del,Ctl,RightSpace,Dot - - - - ### Limitations ### - - Note that FTP does have its own implementation of : `--dump headers`, - `--dump bodies`, `--dump auth` for debugging which isn't the same as - the HTTP based backends - it has less fine grained control. - - Note that `--timeout` isn't supported (but `--contimeout` is). - - Note that `--bind` isn't supported. - - FTP could support server side move but doesn't yet. - - Note that the ftp backend does not support the `ftp_proxy` environment - variable yet. - - Google Cloud Storage - ------------------------------------------------- - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - The initial setup for google cloud storage involves getting a token from Google Cloud Storage - which you need to do in your browser. `rclone config` walks you - through it. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -n) New remote -o) Delete remote -p) Quit config e/n/d/q> n name> remote Type of storage to configure. - Choose a number from below, or type in your own value [snip] XX / - Google Cloud Storage (this is not Google Drive)  "google cloud - storage" [snip] Storage> google cloud storage Google Application - Client Id - leave blank normally. client_id> Google Application - Client Secret - leave blank normally. client_secret> Project number - optional - needed only for list/create/delete buckets - see your - developer console. project_number> 12345678 Service Account - Credentials JSON file path - needed only if you want use SA instead - of interactive login. service_account_file> Access Control List for - new objects. Choose a number from below, or type in your own value 1 - / Object owner gets OWNER access, and all Authenticated Users get - READER access.  "authenticatedRead" 2 / Object owner gets OWNER - access, and project team owners get OWNER access. -  "bucketOwnerFullControl" 3 / Object owner gets OWNER access, and - project team owners get READER access.  "bucketOwnerRead" 4 / Object - owner gets OWNER access [default if left blank].  "private" 5 / - Object owner gets OWNER access, and project team members get access - according to their roles.  "projectPrivate" 6 / Object owner gets - OWNER access, and all Users get READER access.  "publicRead" - object_acl> 4 Access Control List for new buckets. Choose a number - from below, or type in your own value 1 / Project team owners get - OWNER access, and all Authenticated Users get READER access. -  "authenticatedRead" 2 / Project team owners get OWNER access - [default if left blank].  "private" 3 / Project team members get - access according to their roles.  "projectPrivate" 4 / Project team - owners get OWNER access, and all Users get READER access. -  "publicRead" 5 / Project team owners get OWNER access, and all - Users get WRITER access.  "publicReadWrite" bucket_acl> 2 Location - for the newly created buckets. Choose a number from below, or type - in your own value 1 / Empty for default location (US).  "" 2 / - Multi-regional location for Asia.  "asia" 3 / Multi-regional - location for Europe.  "eu" 4 / Multi-regional location for United - States.  "us" 5 / Taiwan.  "asia-east1" 6 / Tokyo. -  "asia-northeast1" 7 / Singapore.  "asia-southeast1" 8 / Sydney. -  "australia-southeast1" 9 / Belgium.  "europe-west1" 10 / London. -  "europe-west2" 11 / Iowa.  "us-central1" 12 / South Carolina. -  "us-east1" 13 / Northern Virginia.  "us-east4" 14 / Oregon. -  "us-west1" location> 12 The storage class to use when storing - objects in Google Cloud Storage. Choose a number from below, or type - in your own value 1 / Default  "" 2 / Multi-regional storage class -  "MULTI_REGIONAL" 3 / Regional storage class  "REGIONAL" 4 / - Nearline storage class  "NEARLINE" 5 / Coldline storage class -  "COLDLINE" 6 / Durable reduced availability storage class -  "DURABLE_REDUCED_AVAILABILITY" storage_class> 5 Remote config Use - auto config? - -- Say Y if not sure -- Say N if you are working on a remote or headless machine or Y didn't - work - -y) Yes -z) No y/n> y If your browser doesn't open automatically go to the - following link: http://127.0.0.1:53682/auth Log in and authorize - rclone for access Waiting for code... Got code -------------------- - [remote] type = google cloud storage client_id = client_secret = - token = - {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} - project_number = 12345678 object_acl = private bucket_acl = private + Enter a boolean value (true or false). Press Enter for the default ("false"). + explicit_tls> + Remote config -------------------- -a) Yes this is OK -b) Edit this remote -c) Delete this remote y/e/d> y + [remote] + type = ftp + host = ftp.example.com + pass = *** ENCRYPTED *** + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +This remote is called remote and can now be used like this + +See all directories in the home directory + + rclone lsd remote: + +Make a new directory + + rclone mkdir remote:path/to/directory + +List the contents of a directory + + rclone ls remote:path/to/directory + +Sync /home/local/directory to the remote directory, deleting any excess +files in the directory. + + rclone sync -i /home/local/directory remote:directory + +Modified time + +FTP does not support modified times. Any times you see on the server +will be time of upload. + +Checksums + +FTP does not support any checksums. + +Usage without a config file + +An example how to use the ftp remote without a config file: + + rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy` + +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + +File names can also not end with the following characters. These only +get replaced if they are the last character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Note that not all FTP servers can have all characters in file names, for +example: + + FTP Server Forbidden characters + ------------ ---------------------- + proftpd * + pureftpd \ [ ] + +Implicit TLS + +FTP supports implicit FTP over TLS servers (FTPS). This has to be +enabled in the config for the remote. The default FTPS port is 990 so +the port will likely have to be explicitly set in the config for the +remote. + +Standard Options + +Here are the standard options specific to ftp (FTP Connection). + +--ftp-host + +FTP host to connect to + +- Config: host +- Env Var: RCLONE_FTP_HOST +- Type: string +- Default: "" +- Examples: + - "ftp.example.com" + - Connect to ftp.example.com + +--ftp-user + +FTP username, leave blank for current username, $USER + +- Config: user +- Env Var: RCLONE_FTP_USER +- Type: string +- Default: "" + +--ftp-port + +FTP port, leave blank to use default (21) + +- Config: port +- Env Var: RCLONE_FTP_PORT +- Type: string +- Default: "" + +--ftp-pass + +FTP password + +NB Input to this must be obscured - see rclone obscure. + +- Config: pass +- Env Var: RCLONE_FTP_PASS +- Type: string +- Default: "" + +--ftp-tls + +Use FTPS over TLS (Implicit) When using implicit FTP over TLS the client +will connect using TLS right from the start, which in turn breaks the +compatibility with non-TLS-aware servers. This is usually served over +port 990 rather than port 21. Cannot be used in combination with +explicit FTP. + +- Config: tls +- Env Var: RCLONE_FTP_TLS +- Type: bool +- Default: false + +--ftp-explicit-tls + +Use FTP over TLS (Explicit) When using explicit FTP over TLS the client +explicitly request security from the server in order to upgrade a plain +text connection to an encrypted one. Cannot be used in combination with +implicit FTP. + +- Config: explicit_tls +- Env Var: RCLONE_FTP_EXPLICIT_TLS +- Type: bool +- Default: false + +Advanced Options + +Here are the advanced options specific to ftp (FTP Connection). + +--ftp-concurrency + +Maximum number of FTP simultaneous connections, 0 for unlimited + +- Config: concurrency +- Env Var: RCLONE_FTP_CONCURRENCY +- Type: int +- Default: 0 + +--ftp-no-check-certificate + +Do not verify the TLS certificate of the server + +- Config: no_check_certificate +- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +- Type: bool +- Default: false + +--ftp-disable-epsv + +Disable using EPSV even if server advertises support + +- Config: disable_epsv +- Env Var: RCLONE_FTP_DISABLE_EPSV +- Type: bool +- Default: false + +--ftp-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_FTP_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,RightSpace,Dot + +Limitations + +Note that FTP does have its own implementation of : --dump headers, +--dump bodies, --dump auth for debugging which isn't the same as the +HTTP based backends - it has less fine grained control. + +Note that --timeout isn't supported (but --contimeout is). + +Note that --bind isn't supported. + +FTP could support server side move but doesn't yet. + +Note that the ftp backend does not support the ftp_proxy environment +variable yet. - Note that rclone runs a webserver on your local machine to collect the - token as returned from Google if you use auto config mode. This only - runs from the moment it opens your browser to the moment you get back - the verification code. This is on `http://127.0.0.1:53682/` and this - it may require you to unblock it temporarily if you are running a host - firewall, or use manual mode. +Google Cloud Storage - This remote is called `remote` and can now be used like this +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, eg remote:bucket/path/to/dir. - See all the buckets in your project +The initial setup for google cloud storage involves getting a token from +Google Cloud Storage which you need to do in your browser. rclone config +walks you through it. - rclone lsd remote: +Here is an example of how to make a remote called remote. First run: - Make a new bucket + rclone config - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any excess - files in the bucket. - - rclone sync -i /home/local/directory remote:bucket - - ### Service Account support ### - - You can set up rclone with Google Cloud Storage in an unattended mode, - i.e. not tied to a specific end-user Google account. This is useful - when you want to synchronise files onto machines that don't have - actively logged-in users, for example build machines. - - To get credentials for Google Cloud Platform - [IAM Service Accounts](https://cloud.google.com/iam/docs/service-accounts), - please head to the - [Service Account](https://console.cloud.google.com/permissions/serviceaccounts) - section of the Google Developer Console. Service Accounts behave just - like normal `User` permissions in - [Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access-control), - so you can limit their access (e.g. make them read only). After - creating an account, a JSON file containing the Service Account's - credentials will be downloaded onto your machines. These credentials - are what rclone will use for authentication. - - To use a Service Account instead of OAuth2 token flow, enter the path - to your Service Account credentials at the `service_account_file` - prompt and rclone won't use the browser based authentication - flow. If you'd rather stuff the contents of the credentials file into - the rclone config file, you can set `service_account_credentials` with - the actual contents of the file instead, or set the equivalent - environment variable. - - ### Anonymous Access ### - - For downloads of objects that permit public access you can configure rclone - to use anonymous access by setting `anonymous` to `true`. - With unauthorized access you can't write or create files but only read or list - those buckets and objects that have public read access. - - ### Application Default Credentials ### - - If no other source of credentials is provided, rclone will fall back - to - [Application Default Credentials](https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) - this is useful both when you already have configured authentication - for your developer account, or in production when running on a google - compute host. Note that if running in docker, you may need to run - additional commands on your google compute machine - - [see this page](https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). - - Note that in the case application default credentials are used, there - is no need to explicitly configure a project number. - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - ### Custom upload headers ### - - You can set custom upload headers with the `--header-upload` - flag. Google Cloud Storage supports the headers as described in the - [working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) - - - Cache-Control - - Content-Disposition - - Content-Encoding - - Content-Language - - Content-Type - - X-Goog-Meta- - - Eg `--header-upload "Content-Type text/potato"` - - Note that the last of these is for setting custom metadata in the form - `--header-upload "x-goog-meta-key: value"` - - ### Modified time ### - - Google google cloud storage stores md5sums natively and rclone stores - modification times as metadata on the object, under the "mtime" key in - RFC3339 format accurate to 1ns. - - #### Restricted filename characters - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | LF | 0x0A | ␊ | - | CR | 0x0D | ␍ | - | / | 0x2F | ／ | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - - #### --gcs-client-id - - OAuth Client Id - Leave blank normally. - - - Config: client_id - - Env Var: RCLONE_GCS_CLIENT_ID - - Type: string - - Default: "" - - #### --gcs-client-secret - - OAuth Client Secret - Leave blank normally. - - - Config: client_secret - - Env Var: RCLONE_GCS_CLIENT_SECRET - - Type: string - - Default: "" - - #### --gcs-project-number - - Project number. - Optional - needed only for list/create/delete buckets - see your developer console. - - - Config: project_number - - Env Var: RCLONE_GCS_PROJECT_NUMBER - - Type: string - - Default: "" - - #### --gcs-service-account-file - - Service Account Credentials JSON file path - Leave blank normally. - Needed only if you want use SA instead of interactive login. - - Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. - - - - Config: service_account_file - - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE - - Type: string - - Default: "" - - #### --gcs-service-account-credentials - - Service Account Credentials JSON blob - Leave blank normally. - Needed only if you want use SA instead of interactive login. - - - Config: service_account_credentials - - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS - - Type: string - - Default: "" - - #### --gcs-anonymous - - Access public buckets and objects without credentials - Set to 'true' if you just want to download files and don't configure credentials. - - - Config: anonymous - - Env Var: RCLONE_GCS_ANONYMOUS - - Type: bool - - Default: false - - #### --gcs-object-acl +This will guide you through an interactive setup process: + n) New remote + d) Delete remote + q) Quit config + e/n/d/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + [snip] + Storage> google cloud storage + Google Application Client Id - leave blank normally. + client_id> + Google Application Client Secret - leave blank normally. + client_secret> + Project number optional - needed only for list/create/delete buckets - see your developer console. + project_number> 12345678 + Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. + service_account_file> Access Control List for new objects. - - - Config: object_acl - - Env Var: RCLONE_GCS_OBJECT_ACL - - Type: string - - Default: "" - - Examples: - - "authenticatedRead" - - Object owner gets OWNER access, and all Authenticated Users get READER access. - - "bucketOwnerFullControl" - - Object owner gets OWNER access, and project team owners get OWNER access. - - "bucketOwnerRead" - - Object owner gets OWNER access, and project team owners get READER access. - - "private" - - Object owner gets OWNER access [default if left blank]. - - "projectPrivate" - - Object owner gets OWNER access, and project team members get access according to their roles. - - "publicRead" - - Object owner gets OWNER access, and all Users get READER access. - - #### --gcs-bucket-acl - + Choose a number from below, or type in your own value + 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. + \ "authenticatedRead" + 2 / Object owner gets OWNER access, and project team owners get OWNER access. + \ "bucketOwnerFullControl" + 3 / Object owner gets OWNER access, and project team owners get READER access. + \ "bucketOwnerRead" + 4 / Object owner gets OWNER access [default if left blank]. + \ "private" + 5 / Object owner gets OWNER access, and project team members get access according to their roles. + \ "projectPrivate" + 6 / Object owner gets OWNER access, and all Users get READER access. + \ "publicRead" + object_acl> 4 Access Control List for new buckets. - - - Config: bucket_acl - - Env Var: RCLONE_GCS_BUCKET_ACL - - Type: string - - Default: "" - - Examples: - - "authenticatedRead" - - Project team owners get OWNER access, and all Authenticated Users get READER access. - - "private" - - Project team owners get OWNER access [default if left blank]. - - "projectPrivate" - - Project team members get access according to their roles. - - "publicRead" - - Project team owners get OWNER access, and all Users get READER access. - - "publicReadWrite" - - Project team owners get OWNER access, and all Users get WRITER access. - - #### --gcs-bucket-policy-only - - Access checks should use bucket-level IAM policies. - - If you want to upload objects to a bucket with Bucket Policy Only set - then you will need to set this. - - When it is set, rclone: - - - ignores ACLs set on buckets - - ignores ACLs set on objects - - creates buckets with Bucket Policy Only set - - Docs: https://cloud.google.com/storage/docs/bucket-policy-only - - - - Config: bucket_policy_only - - Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY - - Type: bool - - Default: false - - #### --gcs-location - + Choose a number from below, or type in your own value + 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. + \ "authenticatedRead" + 2 / Project team owners get OWNER access [default if left blank]. + \ "private" + 3 / Project team members get access according to their roles. + \ "projectPrivate" + 4 / Project team owners get OWNER access, and all Users get READER access. + \ "publicRead" + 5 / Project team owners get OWNER access, and all Users get WRITER access. + \ "publicReadWrite" + bucket_acl> 2 Location for the newly created buckets. - - - Config: location - - Env Var: RCLONE_GCS_LOCATION - - Type: string - - Default: "" - - Examples: - - "" - - Empty for default location (US). - - "asia" - - Multi-regional location for Asia. - - "eu" - - Multi-regional location for Europe. - - "us" - - Multi-regional location for United States. - - "asia-east1" - - Taiwan. - - "asia-east2" - - Hong Kong. - - "asia-northeast1" - - Tokyo. - - "asia-south1" - - Mumbai. - - "asia-southeast1" - - Singapore. - - "australia-southeast1" - - Sydney. - - "europe-north1" - - Finland. - - "europe-west1" - - Belgium. - - "europe-west2" - - London. - - "europe-west3" - - Frankfurt. - - "europe-west4" - - Netherlands. - - "us-central1" - - Iowa. - - "us-east1" - - South Carolina. - - "us-east4" - - Northern Virginia. - - "us-west1" - - Oregon. - - "us-west2" - - California. - - #### --gcs-storage-class - + Choose a number from below, or type in your own value + 1 / Empty for default location (US). + \ "" + 2 / Multi-regional location for Asia. + \ "asia" + 3 / Multi-regional location for Europe. + \ "eu" + 4 / Multi-regional location for United States. + \ "us" + 5 / Taiwan. + \ "asia-east1" + 6 / Tokyo. + \ "asia-northeast1" + 7 / Singapore. + \ "asia-southeast1" + 8 / Sydney. + \ "australia-southeast1" + 9 / Belgium. + \ "europe-west1" + 10 / London. + \ "europe-west2" + 11 / Iowa. + \ "us-central1" + 12 / South Carolina. + \ "us-east1" + 13 / Northern Virginia. + \ "us-east4" + 14 / Oregon. + \ "us-west1" + location> 12 The storage class to use when storing objects in Google Cloud Storage. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Multi-regional storage class + \ "MULTI_REGIONAL" + 3 / Regional storage class + \ "REGIONAL" + 4 / Nearline storage class + \ "NEARLINE" + 5 / Coldline storage class + \ "COLDLINE" + 6 / Durable reduced availability storage class + \ "DURABLE_REDUCED_AVAILABILITY" + storage_class> 5 + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn't work + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = google cloud storage + client_id = + client_secret = + token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} + project_number = 12345678 + object_acl = private + bucket_acl = private + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this it +may require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +This remote is called remote and can now be used like this + +See all the buckets in your project + + rclone lsd remote: + +Make a new bucket + + rclone mkdir remote:bucket + +List the contents of a bucket + + rclone ls remote:bucket + +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. + + rclone sync -i /home/local/directory remote:bucket + +Service Account support + +You can set up rclone with Google Cloud Storage in an unattended mode, +i.e. not tied to a specific end-user Google account. This is useful when +you want to synchronise files onto machines that don't have actively +logged-in users, for example build machines. + +To get credentials for Google Cloud Platform IAM Service Accounts, +please head to the Service Account section of the Google Developer +Console. Service Accounts behave just like normal User permissions in +Google Cloud Storage ACLs, so you can limit their access (e.g. make them +read only). After creating an account, a JSON file containing the +Service Account's credentials will be downloaded onto your machines. +These credentials are what rclone will use for authentication. + +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the service_account_file prompt and +rclone won't use the browser based authentication flow. If you'd rather +stuff the contents of the credentials file into the rclone config file, +you can set service_account_credentials with the actual contents of the +file instead, or set the equivalent environment variable. + +Anonymous Access + +For downloads of objects that permit public access you can configure +rclone to use anonymous access by setting anonymous to true. With +unauthorized access you can't write or create files but only read or +list those buckets and objects that have public read access. + +Application Default Credentials + +If no other source of credentials is provided, rclone will fall back to +Application Default Credentials this is useful both when you already +have configured authentication for your developer account, or in +production when running on a google compute host. Note that if running +in docker, you may need to run additional commands on your google +compute machine - see this page. + +Note that in the case application default credentials are used, there is +no need to explicitly configure a project number. - - Config: storage_class - - Env Var: RCLONE_GCS_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "MULTI_REGIONAL" - - Multi-regional storage class - - "REGIONAL" - - Regional storage class - - "NEARLINE" - - Nearline storage class - - "COLDLINE" - - Coldline storage class - - "ARCHIVE" - - Archive storage class - - "DURABLE_REDUCED_AVAILABILITY" - - Durable reduced availability storage class - - ### Advanced Options - - Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - - #### --gcs-token +--fast-list - OAuth Access Token as a JSON blob. +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. - - Config: token - - Env Var: RCLONE_GCS_TOKEN - - Type: string - - Default: "" +Custom upload headers - #### --gcs-auth-url +You can set custom upload headers with the --header-upload flag. Google +Cloud Storage supports the headers as described in the working with +metadata documentation - Auth server URL. - Leave blank to use the provider defaults. +- Cache-Control +- Content-Disposition +- Content-Encoding +- Content-Language +- Content-Type +- X-Goog-Meta- - - Config: auth_url - - Env Var: RCLONE_GCS_AUTH_URL - - Type: string - - Default: "" +Eg --header-upload "Content-Type text/potato" - #### --gcs-token-url +Note that the last of these is for setting custom metadata in the form +--header-upload "x-goog-meta-key: value" - Token server url. - Leave blank to use the provider defaults. +Modified time - - Config: token_url - - Env Var: RCLONE_GCS_TOKEN_URL - - Type: string - - Default: "" +Google google cloud storage stores md5sums natively and rclone stores +modification times as metadata on the object, under the "mtime" key in +RFC3339 format accurate to 1ns. - #### --gcs-encoding +Restricted filename characters - This sets the encoding for the backend. + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + LF 0x0A ␊ + CR 0x0D ␍ + / 0x2F ／ - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - - Config: encoding - - Env Var: RCLONE_GCS_ENCODING - - Type: MultiEncoder - - Default: Slash,CrLf,InvalidUtf8,Dot +Standard Options +Here are the standard options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). +--gcs-client-id - Google Drive - ----------------------------------------- +OAuth Client Id Leave blank normally. - Paths are specified as `drive:path` +- Config: client_id +- Env Var: RCLONE_GCS_CLIENT_ID +- Type: string +- Default: "" + +--gcs-client-secret + +OAuth Client Secret Leave blank normally. + +- Config: client_secret +- Env Var: RCLONE_GCS_CLIENT_SECRET +- Type: string +- Default: "" + +--gcs-project-number + +Project number. Optional - needed only for list/create/delete buckets - +see your developer console. - Drive paths may be as deep as required, eg `drive:directory/subdirectory`. +- Config: project_number +- Env Var: RCLONE_GCS_PROJECT_NUMBER +- Type: string +- Default: "" - The initial setup for drive involves getting a token from Google drive - which you need to do in your browser. `rclone config` walks you - through it. +--gcs-service-account-file - Here is an example of how to make a remote called `remote`. First run: +Service Account Credentials JSON file path Leave blank normally. Needed +only if you want use SA instead of interactive login. - rclone config +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. - This will guide you through an interactive setup process: +- Config: service_account_file +- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE +- Type: string +- Default: "" -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Choose a number from below, or type -in your own value [snip] XX / Google Drive  "drive" [snip] Storage> -drive Google Application Client Id - leave blank normally. client_id> -Google Application Client Secret - leave blank normally. client_secret> -Scope that rclone should use when requesting access from drive. Choose a -number from below, or type in your own value 1 / Full access all files, -excluding Application Data Folder.  "drive" 2 / Read-only access to file -metadata and file contents.  "drive.readonly" / Access to files created -by rclone only. 3 | These are visible in the drive website. | File -authorization is revoked when the user deauthorizes the app. - "drive.file" / Allows read and write access to the Application Data -folder. 4 | This is not visible in the drive website.  "drive.appfolder" -/ Allows read-only access to file metadata but 5 | does not allow any -access to read or download file content.  "drive.metadata.readonly" -scope> 1 ID of the root folder - leave blank normally. Fill in to access -"Computers" folders. (see docs). root_folder_id> Service Account -Credentials JSON file path - needed only if you want use SA instead of -interactive login. service_account_file> Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine or Y didn't work y) Yes n) No y/n> y If your browser doesn't -open automatically go to the following link: http://127.0.0.1:53682/auth -Log in and authorize rclone for access Waiting for code... Got code -Configure this as a team drive? y) Yes n) No y/n> n -------------------- -[remote] client_id = client_secret = scope = drive root_folder_id = -service_account_file = token = -{"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y +--gcs-service-account-credentials +Service Account Credentials JSON blob Leave blank normally. Needed only +if you want use SA instead of interactive login. - Note that rclone runs a webserver on your local machine to collect the - token as returned from Google if you use auto config mode. This only - runs from the moment it opens your browser to the moment you get back - the verification code. This is on `http://127.0.0.1:53682/` and this - it may require you to unblock it temporarily if you are running a host - firewall, or use manual mode. - - You can then use it like this, - - List directories in top level of your drive - - rclone lsd remote: - - List all the files in your drive - - rclone ls remote: - - To copy a local directory to a drive directory called backup - - rclone copy /home/source remote:backup - - ### Scopes ### - - Rclone allows you to select which scope you would like for rclone to - use. This changes what type of token is granted to rclone. [The - scopes are defined - here](https://developers.google.com/drive/v3/web/about-auth). - - The scope are - - #### drive #### - - This is the default scope and allows full access to all files, except - for the Application Data Folder (see below). - - Choose this one if you aren't sure. - - #### drive.readonly #### - - This allows read only access to all files. Files may be listed and - downloaded but not uploaded, renamed or deleted. - - #### drive.file #### - - With this scope rclone can read/view/modify only those files and - folders it creates. - - So if you uploaded files to drive via the web interface (or any other - means) they will not be visible to rclone. - - This can be useful if you are using rclone to backup data and you want - to be sure confidential data on your drive is not visible to rclone. - - Files created with this scope are visible in the web interface. - - #### drive.appfolder #### - - This gives rclone its own private area to store files. Rclone will - not be able to see any other files on your drive and you won't be able - to see rclone's files from the web interface either. - - #### drive.metadata.readonly #### - - This allows read only access to file names only. It does not allow - rclone to download or upload data, or rename or delete files or - directories. - - ### Root folder ID ### - - You can set the `root_folder_id` for rclone. This is the directory - (identified by its `Folder ID`) that rclone considers to be the root - of your drive. - - Normally you will leave this blank and rclone will determine the - correct root to use itself. - - However you can set this to restrict rclone to a specific folder - hierarchy or to access data within the "Computers" tab on the drive - web interface (where files from Google's Backup and Sync desktop - program go). - - In order to do this you will have to find the `Folder ID` of the - directory you wish rclone to display. This will be the last segment - of the URL when you open the relevant folder in the drive web - interface. - - So if the folder you want rclone to use has a URL which looks like - `https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` - in the browser, then you use `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` as - the `root_folder_id` in the config. - - **NB** folders under the "Computers" tab seem to be read only (drive - gives a 500 error) when using rclone. - - There doesn't appear to be an API to discover the folder IDs of the - "Computers" tab - please contact us if you know otherwise! - - Note also that rclone can't access any data under the "Backups" tab on - the google drive web interface yet. - - ### Service Account support ### - - You can set up rclone with Google Drive in an unattended mode, - i.e. not tied to a specific end-user Google account. This is useful - when you want to synchronise files onto machines that don't have - actively logged-in users, for example build machines. - - To use a Service Account instead of OAuth2 token flow, enter the path - to your Service Account credentials at the `service_account_file` - prompt during `rclone config` and rclone won't use the browser based - authentication flow. If you'd rather stuff the contents of the - credentials file into the rclone config file, you can set - `service_account_credentials` with the actual contents of the file - instead, or set the equivalent environment variable. - - #### Use case - Google Apps/G-suite account and individual Drive #### - - Let's say that you are the administrator of a Google Apps (old) or - G-suite account. - The goal is to store data on an individual's Drive account, who IS - a member of the domain. - We'll call the domain **example.com**, and the user - **foo@example.com**. - - There's a few steps we need to go through to accomplish this: - - ##### 1. Create a service account for example.com ##### - - To create a service account and obtain its credentials, go to the - [Google Developer Console](https://console.developers.google.com). - - You must have a project - create one if you don't. - - Then go to "IAM & admin" -> "Service Accounts". - - Use the "Create Credentials" button. Fill in "Service account name" - with something that identifies your client. "Role" can be empty. - - Tick "Furnish a new private key" - select "Key type JSON". - - Tick "Enable G Suite Domain-wide Delegation". This option makes - "impersonation" possible, as documented here: - [Delegating domain-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) - - These credentials are what rclone will use for authentication. - If you ever need to remove access, press the "Delete service - account key" button. - - ##### 2. Allowing API access to example.com Google Drive ##### - - Go to example.com's admin console - - Go into "Security" (or use the search bar) - - Select "Show more" and then "Advanced settings" - - Select "Manage API client access" in the "Authentication" section - - In the "Client Name" field enter the service account's - "Client ID" - this can be found in the Developer Console under - "IAM & Admin" -> "Service Accounts", then "View Client ID" for - the newly created service account. - It is a ~21 character numerical string. - - In the next field, "One or More API Scopes", enter - `https://www.googleapis.com/auth/drive` - to grant access to Google Drive specifically. - - ##### 3. Configure rclone, assuming a new install ##### - -rclone config - -n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select -the number shown for Google Drive client_id> # Can be left blank -client_secret> # Can be left blank scope> # Select your scope, 1 for -example root_folder_id> # Can be left blank service_account_file> -/home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # -Auto config, y - - - ##### 4. Verify that it's working ##### - - `rclone -v --drive-impersonate foo@example.com lsf gdrive:backup` - - The arguments do: - - `-v` - verbose logging - - `--drive-impersonate foo@example.com` - this is what does - the magic, pretending to be user foo. - - `lsf` - list files in a parsing friendly way - - `gdrive:backup` - use the remote called gdrive, work in - the folder named backup. - - Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using `--drive-impersonate`, do this instead: - - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 - - use rclone without specifying the `--drive-impersonate` option, like this: - `rclone -v foo@example.com lsf gdrive:backup` - - - ### Team drives ### - - If you want to configure the remote to point to a Google Team Drive - then answer `y` to the question `Configure this as a team drive?`. - - This will fetch the list of Team Drives from google and allow you to - configure which one you want to use. You can also type in a team - drive ID if you prefer. - - For example: - -Configure this as a team drive? y) Yes n) No y/n> y Fetching team drive -list... Choose a number from below, or type in your own value 1 / Rclone -Test  "xxxxxxxxxxxxxxxxxxxx" 2 / Rclone Test 2  "yyyyyyyyyyyyyyyyyyyy" 3 -/ Rclone Test 3  "zzzzzzzzzzzzzzzzzzzz" Enter a Team Drive ID> 1 --------------------- [remote] client_id = client_secret = token = -{"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} -team_drive = xxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y - - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - It does this by combining multiple `list` calls into a single API request. - - This works by combining many `'%s' in parents` filters into one expression. - To list the contents of directories a, b and c, the following requests will be send by the regular `List` function: - -trashed=false and 'a' in parents trashed=false and 'b' in parents -trashed=false and 'c' in parents - - These can now be combined into a single request: - -trashed=false and ('a' in parents or 'b' in parents or 'c' in parents) - - - The implementation of `ListR` will put up to 50 `parents` filters into one request. - It will use the `--checkers` value to specify the number of requests to run in parallel. - - In tests, these batch requests were up to 20x faster than the regular method. - Running the following command against different sized folders gives: - -rclone lsjson -vv -R --checkers=6 gdrive:folder - - - small folder (220 directories, 700 files): - - - without `--fast-list`: 38s - - with `--fast-list`: 10s - - large folder (10600 directories, 39000 files): - - - without `--fast-list`: 22:05 min - - with `--fast-list`: 58s - - ### Modified time ### - - Google drive stores modification times accurate to 1 ms. - - #### Restricted filename characters - - Only Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - In contrast to other backends, `/` can also be used in names and `.` - or `..` are valid names. - - ### Revisions ### - - Google drive stores revisions of files. When you upload a change to - an existing file to google drive using rclone it will create a new - revision of that file. - - Revisions follow the standard google policy which at time of writing - was - - * They are deleted after 30 days or 100 revisions (whatever comes first). - * They do not count towards a user storage quota. - - ### Deleting files ### - - By default rclone will send all files to the trash when deleting - files. If deleting them permanently is required then use the - `--drive-use-trash=false` flag, or set the equivalent environment - variable. - - ### Shortcuts ### - - In March 2020 Google introduced a new feature in Google Drive called - [drive shortcuts](https://support.google.com/drive/answer/9700156) - ([API](https://developers.google.com/drive/api/v3/shortcuts)). These - will (by September 2020) [replace the ability for files or folders to - be in multiple folders at once](https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models). - - Shortcuts are files that link to other files on Google Drive somewhat - like a symlink in unix, except they point to the underlying file data - (eg the inode in unix terms) so they don't break if the source is - renamed or moved about. - - Be default rclone treats these as follows. - - For shortcuts pointing to files: - - - When listing a file shortcut appears as the destination file. - - When downloading the contents of the destination file is downloaded. - - When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. - - When server side moving (renaming) the shortcut is renamed, not the destination file. - - When server side copying the shortcut is copied, not the contents of the shortcut. - - When deleting the shortcut is deleted not the linked file. - - When setting the modification time, the modification time of the linked file will be set. - - For shortcuts pointing to folders: - - - When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) - - When downloading the contents of the linked folder and sub contents are downloaded - - When uploading to a shortcut folder the file will be placed in the linked folder - - When server side moving (renaming) the shortcut is renamed, not the destination folder - - When server side copying the contents of the linked folder is copied, not the shortcut. - - When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder. - - **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted. - - The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts. - - Shortcuts can be completely ignored with the `--drive-skip-shortcuts` flag - or the corresponding `skip_shortcuts` configuration setting. - - ### Emptying trash ### - - If you wish to empty your trash you can use the `rclone cleanup remote:` - command which will permanently delete all your trashed files. This command - does not take any path arguments. - - Note that Google Drive takes some time (minutes to days) to empty the - trash even though the command returns within a few seconds. No output - is echoed, so there will be no confirmation even using -v or -vv. - - ### Quota information ### - - To view your current quota you can use the `rclone about remote:` - command which will display your usage limit (quota), the usage in Google - Drive, the size of all files in the Trash and the space used by other - Google services such as Gmail. This command does not take any path - arguments. - - #### Import/Export of google documents #### - - Google documents can be exported from and uploaded to Google Drive. - - When rclone downloads a Google doc it chooses a format to download - depending upon the `--drive-export-formats` setting. - By default the export formats are `docx,xlsx,pptx,svg` which are a - sensible default for an editable document. - - When choosing a format, rclone runs down the list provided in order - and chooses the first file format the doc can be exported as from the - list. If the file can't be exported to a format on the formats list, - then rclone will choose a format from the default list. - - If you prefer an archive copy then you might use `--drive-export-formats - pdf`, or if you prefer openoffice/libreoffice formats you might use - `--drive-export-formats ods,odt,odp`. - - Note that rclone adds the extension to the google doc, so if it is - called `My Spreadsheet` on google docs, it will be exported as `My - Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc. - - When importing files into Google Drive, rclone will convert all - files with an extension in `--drive-import-formats` to their - associated document type. - rclone will not convert any files by default, since the conversion - is lossy process. - - The conversion must result in a file with the same extension when - the `--drive-export-formats` rules are applied to the uploaded document. - - Here are some examples for allowed and prohibited conversions. - - | export-formats | import-formats | Upload Ext | Document Ext | Allowed | - | -------------- | -------------- | ---------- | ------------ | ------- | - | odt | odt | odt | odt | Yes | - | odt | docx,odt | odt | odt | Yes | - | | docx | docx | docx | Yes | - | | odt | odt | docx | No | - | odt,docx | docx,odt | docx | odt | No | - | docx,odt | docx,odt | docx | docx | Yes | - | docx,odt | docx,odt | odt | docx | No | - - This limitation can be disabled by specifying `--drive-allow-import-name-change`. - When using this flag, rclone can convert multiple files types resulting - in the same document type at once, eg with `--drive-import-formats docx,odt,txt`, - all files having these extension would result in a document represented as a docx file. - This brings the additional risk of overwriting a document, if multiple files - have the same stem. Many rclone operations will not handle this name change - in any way. They assume an equal name when copying files and might copy the - file again or delete them when the name changes. - - Here are the possible export extensions with their corresponding mime types. - Most of these can also be used for importing, but there more that are not - listed here. Some of these additional ones might only be available when - the operating system provides the correct MIME type entries. - - This list can be changed by Google Drive at any time and might not - represent the currently available conversions. - - | Extension | Mime Type | Description | - | --------- |-----------| ------------| - | csv | text/csv | Standard CSV format for Spreadsheets | - | docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Office Document | - | epub | application/epub+zip | E-book format | - | html | text/html | An HTML Document | - | jpg | image/jpeg | A JPEG Image File | - | json | application/vnd.google-apps.script+json | JSON Text Format | - | odp | application/vnd.oasis.opendocument.presentation | Openoffice Presentation | - | ods | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | - | ods | application/x-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | - | odt | application/vnd.oasis.opendocument.text | Openoffice Document | - | pdf | application/pdf | Adobe PDF Format | - | png | image/png | PNG Image Format| - | pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation | Microsoft Office Powerpoint | - | rtf | application/rtf | Rich Text Format | - | svg | image/svg+xml | Scalable Vector Graphics Format | - | tsv | text/tab-separated-values | Standard TSV format for spreadsheets | - | txt | text/plain | Plain Text | - | xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | - | zip | application/zip | A ZIP file of HTML, Images CSS | - - Google documents can also be exported as link files. These files will - open a browser window for the Google Docs website of that document - when opened. The link file extension has to be specified as a - `--drive-export-formats` parameter. They will match all available - Google Documents. - - | Extension | Description | OS Support | - | --------- | ----------- | ---------- | - | desktop | freedesktop.org specified desktop entry | Linux | - | link.html | An HTML Document with a redirect | All | - | url | INI style link file | macOS, Windows | - | webloc | macOS specific XML format | macOS | - - - ### Standard Options - - Here are the standard options specific to drive (Google Drive). - - #### --drive-client-id - - OAuth Client Id - Leave blank normally. - - - Config: client_id - - Env Var: RCLONE_DRIVE_CLIENT_ID - - Type: string - - Default: "" - - #### --drive-client-secret - - OAuth Client Secret - Leave blank normally. - - - Config: client_secret - - Env Var: RCLONE_DRIVE_CLIENT_SECRET - - Type: string - - Default: "" - - #### --drive-scope - +- Config: service_account_credentials +- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS +- Type: string +- Default: "" + +--gcs-anonymous + +Access public buckets and objects without credentials Set to 'true' if +you just want to download files and don't configure credentials. + +- Config: anonymous +- Env Var: RCLONE_GCS_ANONYMOUS +- Type: bool +- Default: false + +--gcs-object-acl + +Access Control List for new objects. + +- Config: object_acl +- Env Var: RCLONE_GCS_OBJECT_ACL +- Type: string +- Default: "" +- Examples: + - "authenticatedRead" + - Object owner gets OWNER access, and all Authenticated Users + get READER access. + - "bucketOwnerFullControl" + - Object owner gets OWNER access, and project team owners get + OWNER access. + - "bucketOwnerRead" + - Object owner gets OWNER access, and project team owners get + READER access. + - "private" + - Object owner gets OWNER access [default if left blank]. + - "projectPrivate" + - Object owner gets OWNER access, and project team members get + access according to their roles. + - "publicRead" + - Object owner gets OWNER access, and all Users get READER + access. + +--gcs-bucket-acl + +Access Control List for new buckets. + +- Config: bucket_acl +- Env Var: RCLONE_GCS_BUCKET_ACL +- Type: string +- Default: "" +- Examples: + - "authenticatedRead" + - Project team owners get OWNER access, and all Authenticated + Users get READER access. + - "private" + - Project team owners get OWNER access [default if left + blank]. + - "projectPrivate" + - Project team members get access according to their roles. + - "publicRead" + - Project team owners get OWNER access, and all Users get + READER access. + - "publicReadWrite" + - Project team owners get OWNER access, and all Users get + WRITER access. + +--gcs-bucket-policy-only + +Access checks should use bucket-level IAM policies. + +If you want to upload objects to a bucket with Bucket Policy Only set +then you will need to set this. + +When it is set, rclone: + +- ignores ACLs set on buckets +- ignores ACLs set on objects +- creates buckets with Bucket Policy Only set + +Docs: https://cloud.google.com/storage/docs/bucket-policy-only + +- Config: bucket_policy_only +- Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY +- Type: bool +- Default: false + +--gcs-location + +Location for the newly created buckets. + +- Config: location +- Env Var: RCLONE_GCS_LOCATION +- Type: string +- Default: "" +- Examples: + - "" + - Empty for default location (US). + - "asia" + - Multi-regional location for Asia. + - "eu" + - Multi-regional location for Europe. + - "us" + - Multi-regional location for United States. + - "asia-east1" + - Taiwan. + - "asia-east2" + - Hong Kong. + - "asia-northeast1" + - Tokyo. + - "asia-south1" + - Mumbai. + - "asia-southeast1" + - Singapore. + - "australia-southeast1" + - Sydney. + - "europe-north1" + - Finland. + - "europe-west1" + - Belgium. + - "europe-west2" + - London. + - "europe-west3" + - Frankfurt. + - "europe-west4" + - Netherlands. + - "us-central1" + - Iowa. + - "us-east1" + - South Carolina. + - "us-east4" + - Northern Virginia. + - "us-west1" + - Oregon. + - "us-west2" + - California. + +--gcs-storage-class + +The storage class to use when storing objects in Google Cloud Storage. + +- Config: storage_class +- Env Var: RCLONE_GCS_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "MULTI_REGIONAL" + - Multi-regional storage class + - "REGIONAL" + - Regional storage class + - "NEARLINE" + - Nearline storage class + - "COLDLINE" + - Coldline storage class + - "ARCHIVE" + - Archive storage class + - "DURABLE_REDUCED_AVAILABILITY" + - Durable reduced availability storage class + +Advanced Options + +Here are the advanced options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). + +--gcs-token + +OAuth Access Token as a JSON blob. + +- Config: token +- Env Var: RCLONE_GCS_TOKEN +- Type: string +- Default: "" + +--gcs-auth-url + +Auth server URL. Leave blank to use the provider defaults. + +- Config: auth_url +- Env Var: RCLONE_GCS_AUTH_URL +- Type: string +- Default: "" + +--gcs-token-url + +Token server url. Leave blank to use the provider defaults. + +- Config: token_url +- Env Var: RCLONE_GCS_TOKEN_URL +- Type: string +- Default: "" + +--gcs-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_GCS_ENCODING +- Type: MultiEncoder +- Default: Slash,CrLf,InvalidUtf8,Dot + + +Google Drive + +Paths are specified as drive:path + +Drive paths may be as deep as required, eg drive:directory/subdirectory. + +The initial setup for drive involves getting a token from Google drive +which you need to do in your browser. rclone config walks you through +it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Google Drive + \ "drive" + [snip] + Storage> drive + Google Application Client Id - leave blank normally. + client_id> + Google Application Client Secret - leave blank normally. + client_secret> Scope that rclone should use when requesting access from drive. + Choose a number from below, or type in your own value + 1 / Full access all files, excluding Application Data Folder. + \ "drive" + 2 / Read-only access to file metadata and file contents. + \ "drive.readonly" + / Access to files created by rclone only. + 3 | These are visible in the drive website. + | File authorization is revoked when the user deauthorizes the app. + \ "drive.file" + / Allows read and write access to the Application Data folder. + 4 | This is not visible in the drive website. + \ "drive.appfolder" + / Allows read-only access to file metadata but + 5 | does not allow any access to read or download file content. + \ "drive.metadata.readonly" + scope> 1 + ID of the root folder - leave blank normally. Fill in to access "Computers" folders. (see docs). + root_folder_id> + Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. + service_account_file> + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn't work + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + Configure this as a team drive? + y) Yes + n) No + y/n> n + -------------------- + [remote] + client_id = + client_secret = + scope = drive + root_folder_id = + service_account_file = + token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this it +may require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +You can then use it like this, + +List directories in top level of your drive + + rclone lsd remote: + +List all the files in your drive + + rclone ls remote: + +To copy a local directory to a drive directory called backup + + rclone copy /home/source remote:backup + +Scopes + +Rclone allows you to select which scope you would like for rclone to +use. This changes what type of token is granted to rclone. The scopes +are defined here. + +The scope are + +drive + +This is the default scope and allows full access to all files, except +for the Application Data Folder (see below). + +Choose this one if you aren't sure. + +drive.readonly + +This allows read only access to all files. Files may be listed and +downloaded but not uploaded, renamed or deleted. + +drive.file + +With this scope rclone can read/view/modify only those files and folders +it creates. + +So if you uploaded files to drive via the web interface (or any other +means) they will not be visible to rclone. + +This can be useful if you are using rclone to backup data and you want +to be sure confidential data on your drive is not visible to rclone. + +Files created with this scope are visible in the web interface. + +drive.appfolder + +This gives rclone its own private area to store files. Rclone will not +be able to see any other files on your drive and you won't be able to +see rclone's files from the web interface either. + +drive.metadata.readonly + +This allows read only access to file names only. It does not allow +rclone to download or upload data, or rename or delete files or +directories. + +Root folder ID + +You can set the root_folder_id for rclone. This is the directory +(identified by its Folder ID) that rclone considers to be the root of +your drive. + +Normally you will leave this blank and rclone will determine the correct +root to use itself. + +However you can set this to restrict rclone to a specific folder +hierarchy or to access data within the "Computers" tab on the drive web +interface (where files from Google's Backup and Sync desktop program +go). - - Config: scope - - Env Var: RCLONE_DRIVE_SCOPE - - Type: string - - Default: "" - - Examples: - - "drive" - - Full access all files, excluding Application Data Folder. - - "drive.readonly" - - Read-only access to file metadata and file contents. - - "drive.file" - - Access to files created by rclone only. - - These are visible in the drive website. - - File authorization is revoked when the user deauthorizes the app. - - "drive.appfolder" - - Allows read and write access to the Application Data folder. - - This is not visible in the drive website. - - "drive.metadata.readonly" - - Allows read-only access to file metadata but - - does not allow any access to read or download file content. +In order to do this you will have to find the Folder ID of the directory +you wish rclone to display. This will be the last segment of the URL +when you open the relevant folder in the drive web interface. - #### --drive-root-folder-id +So if the folder you want rclone to use has a URL which looks like +https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh +in the browser, then you use 1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh as the +root_folder_id in the config. - ID of the root folder - Leave blank normally. +NB folders under the "Computers" tab seem to be read only (drive gives a +500 error) when using rclone. - Fill in to access "Computers" folders (see docs), or for rclone to use - a non root folder as its starting point. +There doesn't appear to be an API to discover the folder IDs of the +"Computers" tab - please contact us if you know otherwise! +Note also that rclone can't access any data under the "Backups" tab on +the google drive web interface yet. - - Config: root_folder_id - - Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID - - Type: string - - Default: "" +Service Account support - #### --drive-service-account-file +You can set up rclone with Google Drive in an unattended mode, i.e. not +tied to a specific end-user Google account. This is useful when you want +to synchronise files onto machines that don't have actively logged-in +users, for example build machines. - Service Account Credentials JSON file path - Leave blank normally. - Needed only if you want use SA instead of interactive login. +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the service_account_file prompt +during rclone config and rclone won't use the browser based +authentication flow. If you'd rather stuff the contents of the +credentials file into the rclone config file, you can set +service_account_credentials with the actual contents of the file +instead, or set the equivalent environment variable. - Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. +Use case - Google Apps/G-suite account and individual Drive +Let's say that you are the administrator of a Google Apps (old) or +G-suite account. The goal is to store data on an individual's Drive +account, who IS a member of the domain. We'll call the domain +EXAMPLE.COM, and the user FOO@EXAMPLE.COM. + +There's a few steps we need to go through to accomplish this: + +1. Create a service account for example.com + +- To create a service account and obtain its credentials, go to the + Google Developer Console. +- You must have a project - create one if you don't. +- Then go to "IAM & admin" -> "Service Accounts". +- Use the "Create Credentials" button. Fill in "Service account name" + with something that identifies your client. "Role" can be empty. +- Tick "Furnish a new private key" - select "Key type JSON". +- Tick "Enable G Suite Domain-wide Delegation". This option makes + "impersonation" possible, as documented here: Delegating domain-wide + authority to the service account +- These credentials are what rclone will use for authentication. If + you ever need to remove access, press the "Delete service account + key" button. + +2. Allowing API access to example.com Google Drive + +- Go to example.com's admin console +- Go into "Security" (or use the search bar) +- Select "Show more" and then "Advanced settings" +- Select "Manage API client access" in the "Authentication" section +- In the "Client Name" field enter the service account's "Client ID" - + this can be found in the Developer Console under "IAM & Admin" -> + "Service Accounts", then "View Client ID" for the newly created + service account. It is a ~21 character numerical string. +- In the next field, "One or More API Scopes", enter + https://www.googleapis.com/auth/drive to grant access to Google + Drive specifically. + +3. Configure rclone, assuming a new install + + rclone config + + n/s/q> n # New + name>gdrive # Gdrive is an example name + Storage> # Select the number shown for Google Drive + client_id> # Can be left blank + client_secret> # Can be left blank + scope> # Select your scope, 1 for example + root_folder_id> # Can be left blank + service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! + y/n> # Auto config, y + +4. Verify that it's working + +- rclone -v --drive-impersonate foo@example.com lsf gdrive:backup +- The arguments do: + - -v - verbose logging + - --drive-impersonate foo@example.com - this is what does the + magic, pretending to be user foo. + - lsf - list files in a parsing friendly way + - gdrive:backup - use the remote called gdrive, work in the folder + named backup. + +Note: in case you configured a specific root folder on gdrive and rclone +is unable to access the contents of that folder when using +--drive-impersonate, do this instead: - in the gdrive web interface, +share your root folder with the user/email of the new Service Account +you created/selected at step #1 - use rclone without specifying the +--drive-impersonate option, like this: +rclone -v foo@example.com lsf gdrive:backup + +Team drives + +If you want to configure the remote to point to a Google Team Drive then +answer y to the question Configure this as a team drive?. + +This will fetch the list of Team Drives from google and allow you to +configure which one you want to use. You can also type in a team drive +ID if you prefer. + +For example: + + Configure this as a team drive? + y) Yes + n) No + y/n> y + Fetching team drive list... + Choose a number from below, or type in your own value + 1 / Rclone Test + \ "xxxxxxxxxxxxxxxxxxxx" + 2 / Rclone Test 2 + \ "yyyyyyyyyyyyyyyyyyyy" + 3 / Rclone Test 3 + \ "zzzzzzzzzzzzzzzzzzzz" + Enter a Team Drive ID> 1 + -------------------- + [remote] + client_id = + client_secret = + token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} + team_drive = xxxxxxxxxxxxxxxxxxxx + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +--fast-list + +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. + +It does this by combining multiple list calls into a single API request. + +This works by combining many '%s' in parents filters into one +expression. To list the contents of directories a, b and c, the +following requests will be send by the regular List function: + + trashed=false and 'a' in parents + trashed=false and 'b' in parents + trashed=false and 'c' in parents + +These can now be combined into a single request: + + trashed=false and ('a' in parents or 'b' in parents or 'c' in parents) + +The implementation of ListR will put up to 50 parents filters into one +request. It will use the --checkers value to specify the number of +requests to run in parallel. + +In tests, these batch requests were up to 20x faster than the regular +method. Running the following command against different sized folders +gives: + + rclone lsjson -vv -R --checkers=6 gdrive:folder + +small folder (220 directories, 700 files): + +- without --fast-list: 38s +- with --fast-list: 10s + +large folder (10600 directories, 39000 files): + +- without --fast-list: 22:05 min +- with --fast-list: 58s - - Config: service_account_file - - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE - - Type: string - - Default: "" +Modified time - #### --drive-alternate-export +Google drive stores modification times accurate to 1 ms. - Deprecated: no longer needed +Restricted filename characters - - Config: alternate_export - - Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT - - Type: bool - - Default: false +Only Invalid UTF-8 bytes will be replaced, as they can't be used in JSON +strings. - ### Advanced Options +In contrast to other backends, / can also be used in names and . or .. +are valid names. - Here are the advanced options specific to drive (Google Drive). +Revisions - #### --drive-token +Google drive stores revisions of files. When you upload a change to an +existing file to google drive using rclone it will create a new revision +of that file. - OAuth Access Token as a JSON blob. +Revisions follow the standard google policy which at time of writing was - - Config: token - - Env Var: RCLONE_DRIVE_TOKEN - - Type: string - - Default: "" +- They are deleted after 30 days or 100 revisions (whatever comes + first). +- They do not count towards a user storage quota. - #### --drive-auth-url +Deleting files - Auth server URL. - Leave blank to use the provider defaults. +By default rclone will send all files to the trash when deleting files. +If deleting them permanently is required then use the +--drive-use-trash=false flag, or set the equivalent environment +variable. - - Config: auth_url - - Env Var: RCLONE_DRIVE_AUTH_URL - - Type: string - - Default: "" +Shortcuts - #### --drive-token-url +In March 2020 Google introduced a new feature in Google Drive called +drive shortcuts (API). These will (by September 2020) replace the +ability for files or folders to be in multiple folders at once. - Token server url. - Leave blank to use the provider defaults. +Shortcuts are files that link to other files on Google Drive somewhat +like a symlink in unix, except they point to the underlying file data +(eg the inode in unix terms) so they don't break if the source is +renamed or moved about. - - Config: token_url - - Env Var: RCLONE_DRIVE_TOKEN_URL - - Type: string - - Default: "" +Be default rclone treats these as follows. - #### --drive-service-account-credentials +For shortcuts pointing to files: - Service Account Credentials JSON blob - Leave blank normally. - Needed only if you want use SA instead of interactive login. +- When listing a file shortcut appears as the destination file. +- When downloading the contents of the destination file is downloaded. +- When updating shortcut file with a non shortcut file, the shortcut + is removed then a new file is uploaded in place of the shortcut. +- When server side moving (renaming) the shortcut is renamed, not the + destination file. +- When server side copying the shortcut is copied, not the contents of + the shortcut. +- When deleting the shortcut is deleted not the linked file. +- When setting the modification time, the modification time of the + linked file will be set. - - Config: service_account_credentials - - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS - - Type: string - - Default: "" +For shortcuts pointing to folders: - #### --drive-team-drive +- When listing the shortcut appears as a folder and that folder will + contain the contents of the linked folder appear (including any sub + folders) +- When downloading the contents of the linked folder and sub contents + are downloaded +- When uploading to a shortcut folder the file will be placed in the + linked folder +- When server side moving (renaming) the shortcut is renamed, not the + destination folder +- When server side copying the contents of the linked folder is + copied, not the shortcut. +- When deleting with rclone rmdir or rclone purge the shortcut is + deleted not the linked folder. +- NB When deleting with rclone remove or rclone mount the contents of + the linked folder will be deleted. - ID of the Team Drive +The rclone backend command can be used to create shortcuts. - - Config: team_drive - - Env Var: RCLONE_DRIVE_TEAM_DRIVE - - Type: string - - Default: "" +Shortcuts can be completely ignored with the --drive-skip-shortcuts flag +or the corresponding skip_shortcuts configuration setting. - #### --drive-auth-owner-only +Emptying trash - Only consider files owned by the authenticated user. +If you wish to empty your trash you can use the rclone cleanup remote: +command which will permanently delete all your trashed files. This +command does not take any path arguments. - - Config: auth_owner_only - - Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY - - Type: bool - - Default: false +Note that Google Drive takes some time (minutes to days) to empty the +trash even though the command returns within a few seconds. No output is +echoed, so there will be no confirmation even using -v or -vv. - #### --drive-use-trash +Quota information - Send files to the trash instead of deleting permanently. - Defaults to true, namely sending files to the trash. - Use `--drive-use-trash=false` to delete files permanently instead. +To view your current quota you can use the rclone about remote: command +which will display your usage limit (quota), the usage in Google Drive, +the size of all files in the Trash and the space used by other Google +services such as Gmail. This command does not take any path arguments. - - Config: use_trash - - Env Var: RCLONE_DRIVE_USE_TRASH - - Type: bool - - Default: true +Import/Export of google documents - #### --drive-skip-gdocs +Google documents can be exported from and uploaded to Google Drive. - Skip google documents in all listings. - If given, gdocs practically become invisible to rclone. +When rclone downloads a Google doc it chooses a format to download +depending upon the --drive-export-formats setting. By default the export +formats are docx,xlsx,pptx,svg which are a sensible default for an +editable document. - - Config: skip_gdocs - - Env Var: RCLONE_DRIVE_SKIP_GDOCS - - Type: bool - - Default: false +When choosing a format, rclone runs down the list provided in order and +chooses the first file format the doc can be exported as from the list. +If the file can't be exported to a format on the formats list, then +rclone will choose a format from the default list. - #### --drive-skip-checksum-gphotos +If you prefer an archive copy then you might use +--drive-export-formats pdf, or if you prefer openoffice/libreoffice +formats you might use --drive-export-formats ods,odt,odp. - Skip MD5 checksum on Google photos and videos only. +Note that rclone adds the extension to the google doc, so if it is +called My Spreadsheet on google docs, it will be exported as +My Spreadsheet.xlsx or My Spreadsheet.pdf etc. - Use this if you get checksum errors when transferring Google photos or - videos. +When importing files into Google Drive, rclone will convert all files +with an extension in --drive-import-formats to their associated document +type. rclone will not convert any files by default, since the conversion +is lossy process. - Setting this flag will cause Google photos and videos to return a - blank MD5 checksum. +The conversion must result in a file with the same extension when the +--drive-export-formats rules are applied to the uploaded document. - Google photos are identified by being in the "photos" space. +Here are some examples for allowed and prohibited conversions. - Corrupted checksums are caused by Google modifying the image/video but - not updating the checksum. + export-formats import-formats Upload Ext Document Ext Allowed + ---------------- ---------------- ------------ -------------- --------- + odt odt odt odt Yes + odt docx,odt odt odt Yes + docx docx docx Yes + odt odt docx No + odt,docx docx,odt docx odt No + docx,odt docx,odt docx docx Yes + docx,odt docx,odt odt docx No - - Config: skip_checksum_gphotos - - Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS - - Type: bool - - Default: false +This limitation can be disabled by specifying +--drive-allow-import-name-change. When using this flag, rclone can +convert multiple files types resulting in the same document type at +once, eg with --drive-import-formats docx,odt,txt, all files having +these extension would result in a document represented as a docx file. +This brings the additional risk of overwriting a document, if multiple +files have the same stem. Many rclone operations will not handle this +name change in any way. They assume an equal name when copying files and +might copy the file again or delete them when the name changes. - #### --drive-shared-with-me +Here are the possible export extensions with their corresponding mime +types. Most of these can also be used for importing, but there more that +are not listed here. Some of these additional ones might only be +available when the operating system provides the correct MIME type +entries. - Only show files that are shared with me. +This list can be changed by Google Drive at any time and might not +represent the currently available conversions. - Instructs rclone to operate on your "Shared with me" folder (where - Google Drive lets you access the files and folders others have shared - with you). + -------------------------------------------------------------------------------------------------------------------------- + Extension Mime Type Description + ------------------- --------------------------------------------------------------------------- -------------------------- + csv text/csv Standard CSV format for + Spreadsheets - This works both with the "list" (lsd, lsl, etc) and the "copy" - commands (copy, sync, etc), and with all other commands too. + docx application/vnd.openxmlformats-officedocument.wordprocessingml.document Microsoft Office Document - - Config: shared_with_me - - Env Var: RCLONE_DRIVE_SHARED_WITH_ME - - Type: bool - - Default: false + epub application/epub+zip E-book format - #### --drive-trashed-only + html text/html An HTML Document - Only show files that are in the trash. - This will show trashed files in their original directory structure. + jpg image/jpeg A JPEG Image File - - Config: trashed_only - - Env Var: RCLONE_DRIVE_TRASHED_ONLY - - Type: bool - - Default: false + json application/vnd.google-apps.script+json JSON Text Format - #### --drive-starred-only + odp application/vnd.oasis.opendocument.presentation Openoffice Presentation - Only show files that are starred. + ods application/vnd.oasis.opendocument.spreadsheet Openoffice Spreadsheet - - Config: starred_only - - Env Var: RCLONE_DRIVE_STARRED_ONLY - - Type: bool - - Default: false + ods application/x-vnd.oasis.opendocument.spreadsheet Openoffice Spreadsheet - #### --drive-formats + odt application/vnd.oasis.opendocument.text Openoffice Document - Deprecated: see export_formats + pdf application/pdf Adobe PDF Format - - Config: formats - - Env Var: RCLONE_DRIVE_FORMATS - - Type: string - - Default: "" + png image/png PNG Image Format - #### --drive-export-formats + pptx application/vnd.openxmlformats-officedocument.presentationml.presentation Microsoft Office + Powerpoint - Comma separated list of preferred formats for downloading Google docs. + rtf application/rtf Rich Text Format - - Config: export_formats - - Env Var: RCLONE_DRIVE_EXPORT_FORMATS - - Type: string - - Default: "docx,xlsx,pptx,svg" + svg image/svg+xml Scalable Vector Graphics + Format - #### --drive-import-formats + tsv text/tab-separated-values Standard TSV format for + spreadsheets - Comma separated list of preferred formats for uploading Google docs. + txt text/plain Plain Text - - Config: import_formats - - Env Var: RCLONE_DRIVE_IMPORT_FORMATS - - Type: string - - Default: "" + xlsx application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Microsoft Office + Spreadsheet - #### --drive-allow-import-name-change + zip application/zip A ZIP file of HTML, Images + CSS + -------------------------------------------------------------------------------------------------------------------------- - Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. +Google documents can also be exported as link files. These files will +open a browser window for the Google Docs website of that document when +opened. The link file extension has to be specified as a +--drive-export-formats parameter. They will match all available Google +Documents. - - Config: allow_import_name_change - - Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE - - Type: bool - - Default: false + Extension Description OS Support + ----------- ----------------------------------------- ---------------- + desktop freedesktop.org specified desktop entry Linux + link.html An HTML Document with a redirect All + url INI style link file macOS, Windows + webloc macOS specific XML format macOS - #### --drive-use-created-date +Standard Options - Use file created date instead of modified date., +Here are the standard options specific to drive (Google Drive). - Useful when downloading data and you want the creation date used in - place of the last modified date. +--drive-client-id - **WARNING**: This flag may have some unexpected consequences. +Google Application Client Id Setting your own is recommended. See +https://rclone.org/drive/#making-your-own-client-id for how to create +your own. If you leave this blank, it will use an internal key which is +low performance. - When uploading to your drive all files will be overwritten unless they - haven't been modified since their creation. And the inverse will occur - while downloading. This side effect can be avoided by using the - "--checksum" flag. +- Config: client_id +- Env Var: RCLONE_DRIVE_CLIENT_ID +- Type: string +- Default: "" - This feature was implemented to retain photos capture date as recorded - by google photos. You will first need to check the "Create a Google - Photos folder" option in your google drive settings. You can then copy - or move the photos locally and use the date the image was taken - (created) set as the modification date. +--drive-client-secret - - Config: use_created_date - - Env Var: RCLONE_DRIVE_USE_CREATED_DATE - - Type: bool - - Default: false +OAuth Client Secret Leave blank normally. - #### --drive-use-shared-date +- Config: client_secret +- Env Var: RCLONE_DRIVE_CLIENT_SECRET +- Type: string +- Default: "" - Use date file was shared instead of modified date. +--drive-scope - Note that, as with "--drive-use-created-date", this flag may have - unexpected consequences when uploading/downloading files. +Scope that rclone should use when requesting access from drive. - If both this flag and "--drive-use-created-date" are set, the created - date is used. +- Config: scope +- Env Var: RCLONE_DRIVE_SCOPE +- Type: string +- Default: "" +- Examples: + - "drive" + - Full access all files, excluding Application Data Folder. + - "drive.readonly" + - Read-only access to file metadata and file contents. + - "drive.file" + - Access to files created by rclone only. + - These are visible in the drive website. + - File authorization is revoked when the user deauthorizes the + app. + - "drive.appfolder" + - Allows read and write access to the Application Data folder. + - This is not visible in the drive website. + - "drive.metadata.readonly" + - Allows read-only access to file metadata but + - does not allow any access to read or download file content. - - Config: use_shared_date - - Env Var: RCLONE_DRIVE_USE_SHARED_DATE - - Type: bool - - Default: false +--drive-root-folder-id - #### --drive-list-chunk +ID of the root folder Leave blank normally. - Size of listing chunk 100-1000. 0 to disable. +Fill in to access "Computers" folders (see docs), or for rclone to use a +non root folder as its starting point. - - Config: list_chunk - - Env Var: RCLONE_DRIVE_LIST_CHUNK - - Type: int - - Default: 1000 +- Config: root_folder_id +- Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID +- Type: string +- Default: "" - #### --drive-impersonate +--drive-service-account-file - Impersonate this user when using a service account. +Service Account Credentials JSON file path Leave blank normally. Needed +only if you want use SA instead of interactive login. - - Config: impersonate - - Env Var: RCLONE_DRIVE_IMPERSONATE - - Type: string - - Default: "" +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. - #### --drive-upload-cutoff +- Config: service_account_file +- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +- Type: string +- Default: "" - Cutoff for switching to chunked upload +--drive-alternate-export - - Config: upload_cutoff - - Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 8M +Deprecated: no longer needed - #### --drive-chunk-size +- Config: alternate_export +- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT +- Type: bool +- Default: false - Upload chunk size. Must a power of 2 >= 256k. +Advanced Options - Making this larger will improve performance, but note that each chunk - is buffered in memory one per transfer. +Here are the advanced options specific to drive (Google Drive). - Reducing this will reduce memory usage but decrease performance. +--drive-token - - Config: chunk_size - - Env Var: RCLONE_DRIVE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 8M +OAuth Access Token as a JSON blob. - #### --drive-acknowledge-abuse +- Config: token +- Env Var: RCLONE_DRIVE_TOKEN +- Type: string +- Default: "" - Set to allow files which return cannotDownloadAbusiveFile to be downloaded. +--drive-auth-url - If downloading a file returns the error "This file has been identified - as malware or spam and cannot be downloaded" with the error code - "cannotDownloadAbusiveFile" then supply this flag to rclone to - indicate you acknowledge the risks of downloading the file and rclone - will download it anyway. +Auth server URL. Leave blank to use the provider defaults. - - Config: acknowledge_abuse - - Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE - - Type: bool - - Default: false +- Config: auth_url +- Env Var: RCLONE_DRIVE_AUTH_URL +- Type: string +- Default: "" - #### --drive-keep-revision-forever +--drive-token-url - Keep new head revision of each file forever. +Token server url. Leave blank to use the provider defaults. - - Config: keep_revision_forever - - Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER - - Type: bool - - Default: false +- Config: token_url +- Env Var: RCLONE_DRIVE_TOKEN_URL +- Type: string +- Default: "" - #### --drive-size-as-quota +--drive-service-account-credentials - Show sizes as storage quota usage, not actual size. +Service Account Credentials JSON blob Leave blank normally. Needed only +if you want use SA instead of interactive login. - Show the size of a file as the storage quota used. This is the - current version plus any older versions that have been set to keep - forever. +- Config: service_account_credentials +- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS +- Type: string +- Default: "" - **WARNING**: This flag may have some unexpected consequences. +--drive-team-drive - It is not recommended to set this flag in your config - the - recommended usage is using the flag form --drive-size-as-quota when - doing rclone ls/lsl/lsf/lsjson/etc only. +ID of the Team Drive - If you do use this flag for syncing (not recommended) then you will - need to use --ignore size also. +- Config: team_drive +- Env Var: RCLONE_DRIVE_TEAM_DRIVE +- Type: string +- Default: "" - - Config: size_as_quota - - Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA - - Type: bool - - Default: false +--drive-auth-owner-only - #### --drive-v2-download-min-size +Only consider files owned by the authenticated user. - If Object's are greater, use drive v2 API to download. +- Config: auth_owner_only +- Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY +- Type: bool +- Default: false - - Config: v2_download_min_size - - Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE - - Type: SizeSuffix - - Default: off +--drive-use-trash - #### --drive-pacer-min-sleep +Send files to the trash instead of deleting permanently. Defaults to +true, namely sending files to the trash. Use --drive-use-trash=false to +delete files permanently instead. - Minimum time to sleep between API calls. +- Config: use_trash +- Env Var: RCLONE_DRIVE_USE_TRASH +- Type: bool +- Default: true - - Config: pacer_min_sleep - - Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP - - Type: Duration - - Default: 100ms +--drive-skip-gdocs - #### --drive-pacer-burst +Skip google documents in all listings. If given, gdocs practically +become invisible to rclone. - Number of API calls to allow without sleeping. +- Config: skip_gdocs +- Env Var: RCLONE_DRIVE_SKIP_GDOCS +- Type: bool +- Default: false - - Config: pacer_burst - - Env Var: RCLONE_DRIVE_PACER_BURST - - Type: int - - Default: 100 +--drive-skip-checksum-gphotos - #### --drive-server-side-across-configs +Skip MD5 checksum on Google photos and videos only. - Allow server side operations (eg copy) to work across different drive configs. +Use this if you get checksum errors when transferring Google photos or +videos. - This can be useful if you wish to do a server side copy between two - different Google drives. Note that this isn't enabled by default - because it isn't easy to tell if it will work between any two - configurations. +Setting this flag will cause Google photos and videos to return a blank +MD5 checksum. - - Config: server_side_across_configs - - Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS - - Type: bool - - Default: false +Google photos are identified by being in the "photos" space. - #### --drive-disable-http2 +Corrupted checksums are caused by Google modifying the image/video but +not updating the checksum. - Disable drive using http2 +- Config: skip_checksum_gphotos +- Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS +- Type: bool +- Default: false - There is currently an unsolved issue with the google drive backend and - HTTP/2. HTTP/2 is therefore disabled by default for the drive backend - but can be re-enabled here. When the issue is solved this flag will - be removed. +--drive-shared-with-me - See: https://github.com/rclone/rclone/issues/3631 +Only show files that are shared with me. +Instructs rclone to operate on your "Shared with me" folder (where +Google Drive lets you access the files and folders others have shared +with you). +This works both with the "list" (lsd, lsl, etc) and the "copy" commands +(copy, sync, etc), and with all other commands too. - - Config: disable_http2 - - Env Var: RCLONE_DRIVE_DISABLE_HTTP2 - - Type: bool - - Default: true +- Config: shared_with_me +- Env Var: RCLONE_DRIVE_SHARED_WITH_ME +- Type: bool +- Default: false - #### --drive-stop-on-upload-limit +--drive-trashed-only - Make upload limit errors be fatal +Only show files that are in the trash. This will show trashed files in +their original directory structure. - At the time of writing it is only possible to upload 750GB of data to - Google Drive a day (this is an undocumented limit). When this limit is - reached Google Drive produces a slightly different error message. When - this flag is set it causes these errors to be fatal. These will stop - the in-progress sync. +- Config: trashed_only +- Env Var: RCLONE_DRIVE_TRASHED_ONLY +- Type: bool +- Default: false - Note that this detection is relying on error message strings which - Google don't document so it may break in the future. +--drive-starred-only - See: https://github.com/rclone/rclone/issues/3857 +Only show files that are starred. +- Config: starred_only +- Env Var: RCLONE_DRIVE_STARRED_ONLY +- Type: bool +- Default: false - - Config: stop_on_upload_limit - - Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT - - Type: bool - - Default: false +--drive-formats - #### --drive-skip-shortcuts +Deprecated: see export_formats - If set skip shortcut files +- Config: formats +- Env Var: RCLONE_DRIVE_FORMATS +- Type: string +- Default: "" - Normally rclone dereferences shortcut files making them appear as if - they are the original file (see [the shortcuts section](#shortcuts)). - If this flag is set then rclone will ignore shortcut files completely. +--drive-export-formats +Comma separated list of preferred formats for downloading Google docs. - - Config: skip_shortcuts - - Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS - - Type: bool - - Default: false +- Config: export_formats +- Env Var: RCLONE_DRIVE_EXPORT_FORMATS +- Type: string +- Default: "docx,xlsx,pptx,svg" - #### --drive-encoding +--drive-import-formats - This sets the encoding for the backend. +Comma separated list of preferred formats for uploading Google docs. - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +- Config: import_formats +- Env Var: RCLONE_DRIVE_IMPORT_FORMATS +- Type: string +- Default: "" - - Config: encoding - - Env Var: RCLONE_DRIVE_ENCODING - - Type: MultiEncoder - - Default: InvalidUtf8 +--drive-allow-import-name-change - ### Backend commands +Allow the filetype to change when uploading Google docs (e.g. file.doc +to file.docx). This will confuse sync and reupload every time. - Here are the commands specific to the drive backend. +- Config: allow_import_name_change +- Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE +- Type: bool +- Default: false - Run them with +--drive-use-created-date - rclone backend COMMAND remote: +Use file created date instead of modified date., - The help below will explain what arguments each command takes. +Useful when downloading data and you want the creation date used in +place of the last modified date. - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. +WARNING: This flag may have some unexpected consequences. - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). +When uploading to your drive all files will be overwritten unless they +haven't been modified since their creation. And the inverse will occur +while downloading. This side effect can be avoided by using the +"--checksum" flag. - #### get +This feature was implemented to retain photos capture date as recorded +by google photos. You will first need to check the "Create a Google +Photos folder" option in your google drive settings. You can then copy +or move the photos locally and use the date the image was taken +(created) set as the modification date. - Get command for fetching the drive config parameters +- Config: use_created_date +- Env Var: RCLONE_DRIVE_USE_CREATED_DATE +- Type: bool +- Default: false - rclone backend get remote: [options] [+] +--drive-use-shared-date - This is a get command which will be used to fetch the various drive config parameters +Use date file was shared instead of modified date. - Usage Examples: +Note that, as with "--drive-use-created-date", this flag may have +unexpected consequences when uploading/downloading files. - rclone backend get drive: [-o service_account_file] [-o chunk_size] - rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] +If both this flag and "--drive-use-created-date" are set, the created +date is used. +- Config: use_shared_date +- Env Var: RCLONE_DRIVE_USE_SHARED_DATE +- Type: bool +- Default: false - Options: +--drive-list-chunk - - "chunk_size": show the current upload chunk size - - "service_account_file": show the current service account file +Size of listing chunk 100-1000. 0 to disable. - #### set +- Config: list_chunk +- Env Var: RCLONE_DRIVE_LIST_CHUNK +- Type: int +- Default: 1000 - Set command for updating the drive config parameters +--drive-impersonate - rclone backend set remote: [options] [+] +Impersonate this user when using a service account. - This is a set command which will be used to update the various drive config parameters +- Config: impersonate +- Env Var: RCLONE_DRIVE_IMPERSONATE +- Type: string +- Default: "" - Usage Examples: +--drive-upload-cutoff - rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] - rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] +Cutoff for switching to chunked upload +- Config: upload_cutoff +- Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 8M - Options: +--drive-chunk-size - - "chunk_size": update the current upload chunk size - - "service_account_file": update the current service account file +Upload chunk size. Must a power of 2 >= 256k. - #### shortcut +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. - Create shortcuts from files or directories +Reducing this will reduce memory usage but decrease performance. - rclone backend shortcut remote: [options] [+] +- Config: chunk_size +- Env Var: RCLONE_DRIVE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 8M - This command creates shortcuts from files or directories. +--drive-acknowledge-abuse - Usage: +Set to allow files which return cannotDownloadAbusiveFile to be +downloaded. - rclone backend shortcut drive: source_item destination_shortcut - rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut +If downloading a file returns the error "This file has been identified +as malware or spam and cannot be downloaded" with the error code +"cannotDownloadAbusiveFile" then supply this flag to rclone to indicate +you acknowledge the risks of downloading the file and rclone will +download it anyway. - In the first example this creates a shortcut from the "source_item" - which can be a file or a directory to the "destination_shortcut". The - "source_item" and the "destination_shortcut" should be relative paths - from "drive:" +- Config: acknowledge_abuse +- Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE +- Type: bool +- Default: false - In the second example this creates a shortcut from the "source_item" - relative to "drive:" to the "destination_shortcut" relative to - "drive2:". This may fail with a permission error if the user - authenticated with "drive2:" can't read files from "drive:". +--drive-keep-revision-forever +Keep new head revision of each file forever. - Options: +- Config: keep_revision_forever +- Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER +- Type: bool +- Default: false - - "target": optional target remote for the shortcut destination +--drive-size-as-quota - #### drives +Show sizes as storage quota usage, not actual size. - List the shared drives available to this account +Show the size of a file as the storage quota used. This is the current +version plus any older versions that have been set to keep forever. - rclone backend drives remote: [options] [+] +WARNING: This flag may have some unexpected consequences. - This command lists the shared drives (teamdrives) available to this - account. +It is not recommended to set this flag in your config - the recommended +usage is using the flag form --drive-size-as-quota when doing rclone +ls/lsl/lsf/lsjson/etc only. - Usage: +If you do use this flag for syncing (not recommended) then you will need +to use --ignore size also. - rclone backend drives drive: +- Config: size_as_quota +- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +- Type: bool +- Default: false - This will return a JSON list of objects like this +--drive-v2-download-min-size - [ - { - "id": "0ABCDEF-01234567890", - "kind": "drive#teamDrive", - "name": "My Drive" - }, - { - "id": "0ABCDEFabcdefghijkl", - "kind": "drive#teamDrive", - "name": "Test Drive" - } - ] +If Object's are greater, use drive v2 API to download. +- Config: v2_download_min_size +- Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE +- Type: SizeSuffix +- Default: off +--drive-pacer-min-sleep - #### untrash +Minimum time to sleep between API calls. - Untrash files and directories +- Config: pacer_min_sleep +- Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP +- Type: Duration +- Default: 100ms - rclone backend untrash remote: [options] [+] +--drive-pacer-burst - This command untrashes all the files and directories in the directory - passed in recursively. +Number of API calls to allow without sleeping. - Usage: +- Config: pacer_burst +- Env Var: RCLONE_DRIVE_PACER_BURST +- Type: int +- Default: 100 - This takes an optional directory to trash which make this easier to - use via the API. +--drive-server-side-across-configs - rclone backend untrash drive:directory - rclone backend -i untrash drive:directory subdir +Allow server side operations (eg copy) to work across different drive +configs. - Use the -i flag to see what would be restored before restoring it. +This can be useful if you wish to do a server side copy between two +different Google drives. Note that this isn't enabled by default because +it isn't easy to tell if it will work between any two configurations. - Result: +- Config: server_side_across_configs +- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false +--drive-disable-http2 + +Disable drive using http2 + +There is currently an unsolved issue with the google drive backend and +HTTP/2. HTTP/2 is therefore disabled by default for the drive backend +but can be re-enabled here. When the issue is solved this flag will be +removed. + +See: https://github.com/rclone/rclone/issues/3631 + +- Config: disable_http2 +- Env Var: RCLONE_DRIVE_DISABLE_HTTP2 +- Type: bool +- Default: true + +--drive-stop-on-upload-limit + +Make upload limit errors be fatal + +At the time of writing it is only possible to upload 750GB of data to +Google Drive a day (this is an undocumented limit). When this limit is +reached Google Drive produces a slightly different error message. When +this flag is set it causes these errors to be fatal. These will stop the +in-progress sync. + +Note that this detection is relying on error message strings which +Google don't document so it may break in the future. + +See: https://github.com/rclone/rclone/issues/3857 + +- Config: stop_on_upload_limit +- Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT +- Type: bool +- Default: false + +--drive-skip-shortcuts + +If set skip shortcut files + +Normally rclone dereferences shortcut files making them appear as if +they are the original file (see the shortcuts section). If this flag is +set then rclone will ignore shortcut files completely. + +- Config: skip_shortcuts +- Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS +- Type: bool +- Default: false + +--drive-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_DRIVE_ENCODING +- Type: MultiEncoder +- Default: InvalidUtf8 + +Backend commands + +Here are the commands specific to the drive backend. + +Run them with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See the "rclone backend" command for more info on how to pass options +and arguments. + +These can be run on a running backend using the rc command +backend/command. + +get + +Get command for fetching the drive config parameters + + rclone backend get remote: [options] [+] + +This is a get command which will be used to fetch the various drive +config parameters + +Usage Examples: + + rclone backend get drive: [-o service_account_file] [-o chunk_size] + rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] + +Options: + +- "chunk_size": show the current upload chunk size +- "service_account_file": show the current service account file + +set + +Set command for updating the drive config parameters + + rclone backend set remote: [options] [+] + +This is a set command which will be used to update the various drive +config parameters + +Usage Examples: + + rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] + rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] + +Options: + +- "chunk_size": update the current upload chunk size +- "service_account_file": update the current service account file + +shortcut + +Create shortcuts from files or directories + + rclone backend shortcut remote: [options] [+] + +This command creates shortcuts from files or directories. + +Usage: + + rclone backend shortcut drive: source_item destination_shortcut + rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut + +In the first example this creates a shortcut from the "source_item" +which can be a file or a directory to the "destination_shortcut". The +"source_item" and the "destination_shortcut" should be relative paths +from "drive:" + +In the second example this creates a shortcut from the "source_item" +relative to "drive:" to the "destination_shortcut" relative to +"drive2:". This may fail with a permission error if the user +authenticated with "drive2:" can't read files from "drive:". + +Options: + +- "target": optional target remote for the shortcut destination + +drives + +List the shared drives available to this account + + rclone backend drives remote: [options] [+] + +This command lists the shared drives (teamdrives) available to this +account. + +Usage: + + rclone backend drives drive: + +This will return a JSON list of objects like this + + [ { - "Untrashed": 17, - "Errors": 0 + "id": "0ABCDEF-01234567890", + "kind": "drive#teamDrive", + "name": "My Drive" + }, + { + "id": "0ABCDEFabcdefghijkl", + "kind": "drive#teamDrive", + "name": "Test Drive" } + ] +untrash +Untrash files and directories + rclone backend untrash remote: [options] [+] - ### Limitations ### +This command untrashes all the files and directories in the directory +passed in recursively. - Drive has quite a lot of rate limiting. This causes rclone to be - limited to transferring about 2 files per second only. Individual - files may be transferred much faster at 100s of MBytes/s but lots of - small files can take a long time. +Usage: - Server side copies are also subject to a separate rate limit. If you - see User rate limit exceeded errors, wait at least 24 hours and retry. - You can disable server side copies with `--disable copy` to download - and upload the files if you prefer. +This takes an optional directory to trash which make this easier to use +via the API. - #### Limitations of Google Docs #### + rclone backend untrash drive:directory + rclone backend -i untrash drive:directory subdir - Google docs will appear as size -1 in `rclone ls` and as size 0 in - anything which uses the VFS layer, eg `rclone mount`, `rclone serve`. +Use the -i flag to see what would be restored before restoring it. - This is because rclone can't find out the size of the Google docs - without downloading them. +Result: - Google docs will transfer correctly with `rclone sync`, `rclone copy` - etc as rclone knows to ignore the size when doing the transfer. + { + "Untrashed": 17, + "Errors": 0 + } - However an unfortunate consequence of this is that you may not be able - to download Google docs using `rclone mount`. If it doesn't work you - will get a 0 sized file. If you try again the doc may gain its - correct size and be downloadable. Whether it will work on not depends - on the application accessing the mount and the OS you are running - - experiment to find out if it does work for you! +Limitations - ### Duplicated files ### +Drive has quite a lot of rate limiting. This causes rclone to be limited +to transferring about 2 files per second only. Individual files may be +transferred much faster at 100s of MBytes/s but lots of small files can +take a long time. - Sometimes, for no reason I've been able to track down, drive will - duplicate a file that rclone uploads. Drive unlike all the other - remotes can have duplicated files. +Server side copies are also subject to a separate rate limit. If you see +User rate limit exceeded errors, wait at least 24 hours and retry. You +can disable server side copies with --disable copy to download and +upload the files if you prefer. - Duplicated files cause problems with the syncing and you will see - messages in the log about duplicates. +Limitations of Google Docs - Use `rclone dedupe` to fix duplicated files. +Google docs will appear as size -1 in rclone ls and as size 0 in +anything which uses the VFS layer, eg rclone mount, rclone serve. - Note that this isn't just a problem with rclone, even Google Photos on - Android duplicates files on drive sometimes. +This is because rclone can't find out the size of the Google docs +without downloading them. - ### Rclone appears to be re-copying files it shouldn't ### +Google docs will transfer correctly with rclone sync, rclone copy etc as +rclone knows to ignore the size when doing the transfer. - The most likely cause of this is the duplicated file issue above - run - `rclone dedupe` and check your logs for duplicate object or directory - messages. +However an unfortunate consequence of this is that you may not be able +to download Google docs using rclone mount. If it doesn't work you will +get a 0 sized file. If you try again the doc may gain its correct size +and be downloadable. Whether it will work on not depends on the +application accessing the mount and the OS you are running - experiment +to find out if it does work for you! - This can also be caused by a delay/caching on google drive's end when - comparing directory listings. Specifically with team drives used in - combination with --fast-list. Files that were uploaded recently may - not appear on the directory list sent to rclone when using --fast-list. +Duplicated files - Waiting a moderate period of time between attempts (estimated to be - approximately 1 hour) and/or not using --fast-list both seem to be - effective in preventing the problem. +Sometimes, for no reason I've been able to track down, drive will +duplicate a file that rclone uploads. Drive unlike all the other remotes +can have duplicated files. - ### Making your own client_id ### +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. - When you use rclone with Google drive in its default configuration you - are using rclone's client_id. This is shared between all the rclone - users. There is a global rate limit on the number of queries per - second that each client_id can do set by Google. rclone already has a - high quota and I will continue to make sure it is high enough by - contacting Google. +Use rclone dedupe to fix duplicated files. - It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower. +Note that this isn't just a problem with rclone, even Google Photos on +Android duplicates files on drive sometimes. - Here is how to create your own Google Drive client ID for rclone: +Rclone appears to be re-copying files it shouldn't - 1. Log into the [Google API - Console](https://console.developers.google.com/) with your Google - account. It doesn't matter what Google account you use. (It need not - be the same account as the Google Drive you want to access) +The most likely cause of this is the duplicated file issue above - run +rclone dedupe and check your logs for duplicate object or directory +messages. - 2. Select a project or create a new project. +This can also be caused by a delay/caching on google drive's end when +comparing directory listings. Specifically with team drives used in +combination with --fast-list. Files that were uploaded recently may not +appear on the directory list sent to rclone when using --fast-list. - 3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the +Waiting a moderate period of time between attempts (estimated to be +approximately 1 hour) and/or not using --fast-list both seem to be +effective in preventing the problem. + +Making your own client_id + +When you use rclone with Google drive in its default configuration you +are using rclone's client_id. This is shared between all the rclone +users. There is a global rate limit on the number of queries per second +that each client_id can do set by Google. rclone already has a high +quota and I will continue to make sure it is high enough by contacting +Google. + +It is strongly recommended to use your own client ID as the default +rclone ID is heavily used. If you have multiple services running, it is +recommended to use an API key for each service. The default Google quota +is 10 transactions per second so it is recommended to stay under that +number as if you use more than that, it will cause rclone to rate limit +and make things slower. + +Here is how to create your own Google Drive client ID for rclone: + +1. Log into the Google API Console with your Google account. It doesn't + matter what Google account you use. (It need not be the same account + as the Google Drive you want to access) + +2. Select a project or create a new project. + +3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API". - 4. Click "Credentials" in the left-side panel (not "Create +4. Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials" - 5. If you already configured an "Oauth Consent Screen", then skip - to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button - (near the top right corner of the right panel), then select "External" - and click on "CREATE"; on the next screen, enter an "Application name" - ("rclone" is OK) then click on "Save" (all other data is optional). - Click again on "Credentials" on the left panel to go back to the - "Credentials" screen. +5. If you already configured an "Oauth Consent Screen", then skip to + the next step; if not, click on "CONFIGURE CONSENT SCREEN" button + (near the top right corner of the right panel), then select + "External" and click on "CREATE"; on the next screen, enter an + "Application name" ("rclone" is OK) then click on "Save" (all other + data is optional). Click again on "Credentials" on the left panel to + go back to the "Credentials" screen. - (PS: if you are a GSuite user, you could also select "Internal" instead - of "External" above, but this has not been tested/documented so far). +(PS: if you are a GSuite user, you could also select "Internal" instead +of "External" above, but this has not been tested/documented so far). - 6. Click on the "+ CREATE CREDENTIALS" button at the top of the screen, +6. Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID". - 7. Choose an application type of "Desktop app" if you using a Google account or "Other" if - you using a GSuite account and click "Create". (the default name is fine) +7. Choose an application type of "Desktop app" if you using a Google + account or "Other" if you using a GSuite account and click "Create". + (the default name is fine) - 8. It will show you a client ID and client secret. Use these values - in rclone config to add a new remote or edit an existing remote. +8. It will show you a client ID and client secret. Use these values in + rclone config to add a new remote or edit an existing remote. - Be aware that, due to the "enhanced security" recently introduced by - Google, you are theoretically expected to "submit your app for verification" - and then wait a few weeks(!) for their response; in practice, you can go right - ahead and use the client ID and client secret with rclone, the only issue will - be a very scary confirmation screen shown when you connect via your browser - for rclone to be able to get its token-id (but as this only happens during - the remote configuration, it's not such a big deal). +Be aware that, due to the "enhanced security" recently introduced by +Google, you are theoretically expected to "submit your app for +verification" and then wait a few weeks(!) for their response; in +practice, you can go right ahead and use the client ID and client secret +with rclone, the only issue will be a very scary confirmation screen +shown when you connect via your browser for rclone to be able to get its +token-id (but as this only happens during the remote configuration, it's +not such a big deal). - (Thanks to @balazer on github for these instructions.) +(Thanks to @balazer on github for these instructions.) - Sometimes, creation of an OAuth consent in Google API Console fails due to an error message - “The request failed because changes to one of the field of the resource is not supported”. - As a convenient workaround, the necessary Google Drive API key can be created on the - [Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page. - Just push the Enable the Drive API button to receive the Client ID and Secret. - Note that it will automatically create a new project in the API Console. +Sometimes, creation of an OAuth consent in Google API Console fails due +to an error message “The request failed because changes to one of the +field of the resource is not supported”. As a convenient workaround, the +necessary Google Drive API key can be created on the Python Quickstart +page. Just push the Enable the Drive API button to receive the Client ID +and Secret. Note that it will automatically create a new project in the +API Console. - Google Photos - ------------------------------------------------- - The rclone backend for [Google Photos](https://www.google.com/photos/about/) is - a specialized backend for transferring photos and videos to and from - Google Photos. +Google Photos - **NB** The Google Photos API which rclone uses has quite a few - limitations, so please read the [limitations section](#limitations) - carefully to make sure it is suitable for your use. +The rclone backend for Google Photos is a specialized backend for +transferring photos and videos to and from Google Photos. - ## Configuring Google Photos +NB The Google Photos API which rclone uses has quite a few limitations, +so please read the limitations section carefully to make sure it is +suitable for your use. - The initial setup for google cloud storage involves getting a token from Google Photos - which you need to do in your browser. `rclone config` walks you - through it. - Here is an example of how to make a remote called `remote`. First run: +Configuring Google Photos - rclone config +The initial setup for google cloud storage involves getting a token from +Google Photos which you need to do in your browser. rclone config walks +you through it. - This will guide you through an interactive setup process: +Here is an example of how to make a remote called remote. First run: -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value [snip] XX / Google -Photos  "google photos" [snip] Storage> google photos ** See help for -google photos backend at: https://rclone.org/googlephotos/ ** + rclone config -Google Application Client Id Leave blank normally. Enter a string value. -Press Enter for the default (""). client_id> Google Application Client -Secret Leave blank normally. Enter a string value. Press Enter for the -default (""). client_secret> Set to make the Google Photos backend read -only. +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / Google Photos + \ "google photos" + [snip] + Storage> google photos + ** See help for google photos backend at: https://rclone.org/googlephotos/ ** + + Google Application Client Id + Leave blank normally. + Enter a string value. Press Enter for the default (""). + client_id> + Google Application Client Secret + Leave blank normally. + Enter a string value. Press Enter for the default (""). + client_secret> + Set to make the Google Photos backend read only. + + If you choose read only then rclone will only request read only access + to your photos, otherwise rclone will request full access. + Enter a boolean value (true or false). Press Enter for the default ("false"). + read_only> + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + + *** IMPORTANT: All media items uploaded to Google Photos with rclone + *** are stored in full resolution at original quality. These uploads + *** will count towards storage in your Google Account. + + -------------------- + [remote] + type = google photos + token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this may +require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +This remote is called remote and can now be used like this + +See all the albums in your photos + + rclone lsd remote:album + +Make a new album + + rclone mkdir remote:album/newAlbum + +List the contents of an album + + rclone ls remote:album/newAlbum + +Sync /home/local/images to the Google Photos, removing any excess files +in the album. + + rclone sync -i /home/local/image remote:album/newAlbum + + +Layout + +As Google Photos is not a general purpose cloud storage system the +backend is laid out to help you navigate it. + +The directories under media show different ways of categorizing the +media. Each file will appear multiple times. So if you want to make a +backup of your google photos you might choose to backup +remote:media/by-month. (NB remote:media/by-day is rather slow at the +moment so avoid for syncing.) + +Note that all your photos and videos will appear somewhere under media, +but they may not appear under album unless you've put them into albums. + + / + - upload + - file1.jpg + - file2.jpg + - ... + - media + - all + - file1.jpg + - file2.jpg + - ... + - by-year + - 2000 + - file1.jpg + - ... + - 2001 + - file2.jpg + - ... + - ... + - by-month + - 2000 + - 2000-01 + - file1.jpg + - ... + - 2000-02 + - file2.jpg + - ... + - ... + - by-day + - 2000 + - 2000-01-01 + - file1.jpg + - ... + - 2000-01-02 + - file2.jpg + - ... + - ... + - album + - album name + - album name/sub + - shared-album + - album name + - album name/sub + - feature + - favorites + - file1.jpg + - file2.jpg + +There are two writable parts of the tree, the upload directory and sub +directories of the album directory. + +The upload directory is for uploading files you don't want to put into +albums. This will be empty to start with and will contain the files +you've uploaded for one rclone session only, becoming empty again when +you restart rclone. The use case for this would be if you have a load of +files you just want to once off dump into Google Photos. For repeated +syncing, uploading to album will work better. + +Directories within the album directory are also writeable and you may +create new directories (albums) under album. If you copy files with a +directory hierarchy in there then rclone will create albums with the / +character in them. For example if you do + + rclone copy /path/to/images remote:album/images + +and the images directory contains + + images + - file1.jpg + dir + file2.jpg + dir2 + dir3 + file3.jpg + +Then rclone will create the following albums with the following files in + +- images + - file1.jpg +- images/dir + - file2.jpg +- images/dir2/dir3 + - file3.jpg + +This means that you can use the album path pretty much like a normal +filesystem and it is a good target for repeated syncing. + +The shared-album directory shows albums shared with you or by you. This +is similar to the Sharing tab in the Google Photos web interface. + + +Limitations + +Only images and videos can be uploaded. If you attempt to upload non +videos or images or formats that Google Photos doesn't understand, +rclone will upload the file, then Google Photos will give an error when +it is put turned into a media item. + +Note that all media items uploaded to Google Photos through the API are +stored in full resolution at "original quality" and WILL count towards +your storage quota in your Google Account. The API does NOT offer a way +to upload in "high quality" mode.. + +Downloading Images + +When Images are downloaded this strips EXIF location (according to the +docs and my tests). This is a limitation of the Google Photos API and is +covered by bug #112096115. + +THE CURRENT GOOGLE API DOES NOT ALLOW PHOTOS TO BE DOWNLOADED AT +ORIGINAL RESOLUTION. THIS IS VERY IMPORTANT IF YOU ARE, FOR EXAMPLE, +RELYING ON "GOOGLE PHOTOS" AS A BACKUP OF YOUR PHOTOS. YOU WILL NOT BE +ABLE TO USE RCLONE TO REDOWNLOAD ORIGINAL IMAGES. YOU COULD USE 'GOOGLE +TAKEOUT' TO RECOVER THE ORIGINAL PHOTOS AS A LAST RESORT + +Downloading Videos + +When videos are downloaded they are downloaded in a really compressed +version of the video compared to downloading it via the Google Photos +web interface. This is covered by bug #113672044. + +Duplicates + +If a file name is duplicated in a directory then rclone will add the +file ID into its name. So two files called file.jpg would then appear as +file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer +alas!). + +If you upload the same image (with the same binary data) twice then +Google Photos will deduplicate it. However it will retain the filename +from the first upload which may confuse rclone. For example if you +uploaded an image to upload then uploaded the same image to +album/my_album the filename of the image in album/my_album will be what +it was uploaded with initially, not what you uploaded it with to album. +In practise this shouldn't cause too many problems. + +Modified time + +The date shown of media in Google Photos is the creation date as +determined by the EXIF information, or the upload date if that is not +known. + +This is not changeable by rclone and is not the modification date of the +media on local disk. This means that rclone cannot use the dates from +Google Photos for syncing purposes. + +Size + +The Google Photos API does not return the size of media. This means that +when syncing to Google Photos, rclone can only do a file existence +check. + +It is possible to read the size of the media, but this needs an extra +HTTP HEAD request per media item so is VERY SLOW and uses up a lot of +transactions. This can be enabled with the --gphotos-read-size option or +the read_size = true config parameter. + +If you want to use the backend with rclone mount you may need to enable +this flag (depending on your OS and application using the photos) +otherwise you may not be able to read media off the mount. You'll need +to experiment to see if it works for you without the flag. + +Albums + +Rclone can only upload files to albums it created. This is a limitation +of the Google Photos API. + +Rclone can remove files it uploaded from albums it created only. + +Deleting files + +Rclone can remove files from albums it created, but note that the Google +Photos API does not allow media to be deleted permanently so this media +will still remain. See bug #109759781. + +Rclone cannot delete files anywhere except under album. + +Deleting albums + +The Google Photos API does not support deleting albums - see bug +#135714733. + +Standard Options + +Here are the standard options specific to google photos (Google Photos). + +--gphotos-client-id + +OAuth Client Id Leave blank normally. + +- Config: client_id +- Env Var: RCLONE_GPHOTOS_CLIENT_ID +- Type: string +- Default: "" + +--gphotos-client-secret + +OAuth Client Secret Leave blank normally. + +- Config: client_secret +- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET +- Type: string +- Default: "" + +--gphotos-read-only + +Set to make the Google Photos backend read only. If you choose read only then rclone will only request read only access -to your photos, otherwise rclone will request full access. Enter a -boolean value (true or false). Press Enter for the default ("false"). -read_only> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -Use auto config? * Say Y if not sure * Say N if you are working on a -remote or headless machine y) Yes n) No y/n> y If your browser doesn't -open automatically go to the following link: http://127.0.0.1:53682/auth -Log in and authorize rclone for access Waiting for code... Got code +to your photos, otherwise rclone will request full access. -*** IMPORTANT: All media items uploaded to Google Photos with rclone *** -are stored in full resolution at original quality. These uploads *** -will count towards storage in your Google Account. +- Config: read_only +- Env Var: RCLONE_GPHOTOS_READ_ONLY +- Type: bool +- Default: false - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - [remote] type = google photos token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"} - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` +Advanced Options - Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode. +Here are the advanced options specific to google photos (Google Photos). - This remote is called remote and can now be used like this +--gphotos-token - See all the albums in your photos +OAuth Access Token as a JSON blob. - rclone lsd remote:album +- Config: token +- Env Var: RCLONE_GPHOTOS_TOKEN +- Type: string +- Default: "" - Make a new album +--gphotos-auth-url - rclone mkdir remote:album/newAlbum +Auth server URL. Leave blank to use the provider defaults. - List the contents of an album +- Config: auth_url +- Env Var: RCLONE_GPHOTOS_AUTH_URL +- Type: string +- Default: "" - rclone ls remote:album/newAlbum +--gphotos-token-url - Sync /home/local/images to the Google Photos, removing any excess files in the album. +Token server url. Leave blank to use the provider defaults. - rclone sync -i /home/local/image remote:album/newAlbum +- Config: token_url +- Env Var: RCLONE_GPHOTOS_TOKEN_URL +- Type: string +- Default: "" - ## Layout +--gphotos-read-size - As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it. +Set to read the size of media items. - The directories under media show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup remote:media/by-month. (NB remote:media/by-day is rather slow at the moment so avoid for syncing.) +Normally rclone does not read the size of media items since this takes +another transaction. This isn't necessary for syncing. However rclone +mount needs to know the size of files in advance of reading them, so +setting this flag when using rclone mount is recommended if you want to +read the media. - Note that all your photos and videos will appear somewhere under media, but they may not appear under album unless you've put them into albums. +- Config: read_size +- Env Var: RCLONE_GPHOTOS_READ_SIZE +- Type: bool +- Default: false - / - upload - file1.jpg - file2.jpg - ... - media - all - file1.jpg - file2.jpg - ... - by-year - 2000 - file1.jpg - ... - 2001 - file2.jpg - ... - ... - by-month - 2000 - 2000-01 - file1.jpg - ... - 2000-02 - file2.jpg - ... - ... - by-day - 2000 - 2000-01-01 - file1.jpg - ... - 2000-01-02 - file2.jpg - ... - ... - album - album name - album name/sub - shared-album - album name - album name/sub - feature - favorites - file1.jpg - file2.jpg +--gphotos-start-year - There are two writable parts of the tree, the upload directory and sub directories of the album directory. +Year limits the photos to be downloaded to those which are uploaded +after the given year - The upload directory is for uploading files you don't want to put into albums. This will be empty to start with and will contain the files you've uploaded for one rclone session only, becoming empty again when you restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to album will work better. +- Config: start_year +- Env Var: RCLONE_GPHOTOS_START_YEAR +- Type: int +- Default: 2000 - Directories within the album directory are also writeable and you may create new directories (albums) under album. If you copy files with a directory hierarchy in there then rclone will create albums with the / character in them. For example if you do - rclone copy /path/to/images remote:album/images - - and the images directory contains - - images - file1.jpg dir file2.jpg dir2 dir3 file3.jpg - - Then rclone will create the following albums with the following files in - - - images - file1.jpg - images/dir - file2.jpg - images/dir2/dir3 - file3.jpg - - This means that you can use the album path pretty much like a normal filesystem and it is a good target for repeated syncing. - - The shared-album directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface. - - ## Limitations - - Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn't understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item. - - Note that all media items uploaded to Google Photos through the API are stored in full resolution at "original quality" and WILL count towards your storage quota in your Google Account. The API does NOT offer a way to upload in "high quality" mode.. - - ### Downloading Images - - When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115. - - THE CURRENT GOOGLE API DOES NOT ALLOW PHOTOS TO BE DOWNLOADED AT ORIGINAL RESOLUTION. THIS IS VERY IMPORTANT IF YOU ARE, FOR EXAMPLE, RELYING ON "GOOGLE PHOTOS" AS A BACKUP OF YOUR PHOTOS. YOU WILL NOT BE ABLE TO USE RCLONE TO REDOWNLOAD ORIGINAL IMAGES. YOU COULD USE 'GOOGLE TAKEOUT' TO RECOVER THE ORIGINAL PHOTOS AS A LAST RESORT - - ### Downloading Videos - - When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044. - - ### Duplicates - - If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called file.jpg would then appear as file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer alas!). - - If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may confuse rclone. For example if you uploaded an image to upload then uploaded the same image to album/my_album the filename of the image in album/my_album will be what it was uploaded with initially, not what you uploaded it with to album. In practise this shouldn't cause - too many problems. - - ### Modified time - - The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known. - - This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes. - - ### Size - - The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check. - - It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is VERY SLOW and uses up a lot of transactions. This can be enabled with the --gphotos-read-size option or the read_size = true config parameter. - - If you want to use the backend with rclone mount you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You'll need to experiment to see if it works for you without the flag. - - ### Albums - - Rclone can only upload files to albums it created. This is a limitation of the Google Photos API. - - Rclone can remove files it uploaded from albums it created only. - - ### Deleting files - - Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781. - - Rclone cannot delete files anywhere except under album. - - ### Deleting albums - - The Google Photos API does not support deleting albums - see bug #135714733. - - ### Standard Options - - Here are the standard options specific to google photos (Google Photos). - - #### --gphotos-client-id - - OAuth Client Id Leave blank normally. - - - Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Default: "" - - #### --gphotos-client-secret - - OAuth Client Secret Leave blank normally. - - - Config: client_secret - Env Var: RCLONE_GPHOTOS_CLIENT_SECRET - Type: string - Default: "" - - #### --gphotos-read-only - - Set to make the Google Photos backend read only. - - If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. - - - Config: read_only - Env Var: RCLONE_GPHOTOS_READ_ONLY - Type: bool - Default: false - - ### Advanced Options - - Here are the advanced options specific to google photos (Google Photos). - - #### --gphotos-token - - OAuth Access Token as a JSON blob. - - - Config: token - Env Var: RCLONE_GPHOTOS_TOKEN - Type: string - Default: "" - - #### --gphotos-auth-url - - Auth server URL. Leave blank to use the provider defaults. - - - Config: auth_url - Env Var: RCLONE_GPHOTOS_AUTH_URL - Type: string - Default: "" - - #### --gphotos-token-url - - Token server url. Leave blank to use the provider defaults. - - - Config: token_url - Env Var: RCLONE_GPHOTOS_TOKEN_URL - Type: string - Default: "" - - #### --gphotos-read-size - - Set to read the size of media items. - - Normally rclone does not read the size of media items since this takes another transaction. This isn't necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media. - - - Config: read_size - Env Var: RCLONE_GPHOTOS_READ_SIZE - Type: bool - Default: false - - #### --gphotos-start-year - - Year limits the photos to be downloaded to those which are uploaded after the given year - - - Config: start_year - Env Var: RCLONE_GPHOTOS_START_YEAR - Type: int - Default: 2000 - - HTTP - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +HTTP The HTTP remote is a read only remote for reading files of a webserver. The webserver should provide file listings which rclone will read and @@ -18728,7 +19925,11 @@ Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (wherever the TMPDIR environment variable points to) before it is uploaded. Small files will be cached in memory - see the ---jottacloud-md5-memory-limit flag. +--jottacloud-md5-memory-limit flag. When uploading from local disk the +source checksum is always available, so this does not apply. Starting +with rclone version 1.52 the same is true for crypted remotes (in older +versions the crypt backend would not calculate hashes for uploads from +local disk, so the Jottacloud backend had to do it as described above). Restricted filename characters @@ -24457,6 +25658,45 @@ Options: CHANGELOG +v1.53.1 - 2020-09-13 + +See commits + +- Bug Fixes + - accounting: Remove new line from end of --stats-one-line display + (Nick Craig-Wood) + - check + - Add back missing --download flag (Nick Craig-Wood) + - Fix docs (Nick Craig-Wood) + - docs + - Note --log-file does append (Nick Craig-Wood) + - Add full stops for consistency in rclone --help (edwardxml) + - Add Tencent COS to s3 provider list (wjielai) + - Updated mount command to reflect that it requires Go 1.13 or + newer (Evan Harris) + - jottacloud: Mention that uploads from local disk will not + need to cache files to disk for md5 calculation (albertony) + - Fix formatting of rc docs page (Nick Craig-Wood) + - build + - Include vendor tar ball in release and fix startdev (Nick + Craig-Wood) + - Fix "Illegal instruction" error for ARMv6 builds (Nick + Craig-Wood) + - Fix architecture name in ARMv7 build (Nick Craig-Wood) +- VFS + - Fix spurious error "vfs cache: failed to _ensure cache EOF" + (Nick Craig-Wood) + - Log an ERROR if we fail to set the file to be sparse (Nick + Craig-Wood) +- Local + - Log an ERROR if we fail to set the file to be sparse (Nick + Craig-Wood) +- Drive + - Re-adds special oauth help text (Tim Gallant) +- Opendrive + - Do not retry 400 errors (Evan Harris) + + v1.53.0 - 2020-09-02 See commits diff --git a/docs/content/changelog.md b/docs/content/changelog.md index 79b9f8482..c6cfb823f 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -5,6 +5,36 @@ description: "Rclone Changelog" # Changelog +## v1.53.1 - 2020-09-13 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1) + +* Bug Fixes + * accounting: Remove new line from end of --stats-one-line display (Nick Craig-Wood) + * check + * Add back missing --download flag (Nick Craig-Wood) + * Fix docs (Nick Craig-Wood) + * docs + * Note --log-file does append (Nick Craig-Wood) + * Add full stops for consistency in rclone --help (edwardxml) + * Add Tencent COS to s3 provider list (wjielai) + * Updated mount command to reflect that it requires Go 1.13 or newer (Evan Harris) + * jottacloud: Mention that uploads from local disk will not need to cache files to disk for md5 calculation (albertony) + * Fix formatting of rc docs page (Nick Craig-Wood) + * build + * Include vendor tar ball in release and fix startdev (Nick Craig-Wood) + * Fix "Illegal instruction" error for ARMv6 builds (Nick Craig-Wood) + * Fix architecture name in ARMv7 build (Nick Craig-Wood) +* VFS + * Fix spurious error "vfs cache: failed to _ensure cache EOF" (Nick Craig-Wood) + * Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood) +* Local + * Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood) +* Drive + * Re-adds special oauth help text (Tim Gallant) +* Opendrive + * Do not retry 400 errors (Evan Harris) + ## v1.53.0 - 2020-09-02 [See commits](https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0) diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index 2025bbeb0..d93cb6594 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -39,10 +39,10 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone backend](/commands/rclone_backend/) - Run a backend specific command. * [rclone cat](/commands/rclone_cat/) - Concatenates any files and sends them to stdout. * [rclone check](/commands/rclone_check/) - Checks the files in the source and destination match. -* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible +* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied -* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied +* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied. +* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied. * [rclone copyurl](/commands/rclone_copyurl/) - Copy url content to dest. * [rclone cryptcheck](/commands/rclone_cryptcheck/) - Cryptcheck checks the integrity of a crypted remote. * [rclone cryptdecode](/commands/rclone_cryptdecode/) - Cryptdecode returns unencrypted file names. @@ -56,7 +56,7 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file. * [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path. * [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path. -* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing +* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing. * [rclone lsjson](/commands/rclone_lsjson/) - List directories and objects in the path in JSON format. * [rclone lsl](/commands/rclone_lsl/) - List the objects in path with modification time, size and path. * [rclone md5sum](/commands/rclone_md5sum/) - Produces an md5sum file for all the objects in the path. @@ -65,7 +65,7 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone move](/commands/rclone_move/) - Move files from source to dest. * [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest. * [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface. -* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file +* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file. * [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents. * [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone. * [rclone rcat](/commands/rclone_rcat/) - Copies standard input to file on remote. diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index c91d5c196..7a37bbb95 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -29,7 +29,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are @@ -55,6 +55,7 @@ rclone check source:path dest:path [flags] ``` --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file + --download Check by downloading rather than with hash. --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index 0e8dcf58b..680b4f981 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,13 +1,13 @@ --- title: "rclone cleanup" -description: "Clean up the remote if possible" +description: "Clean up the remote if possible." slug: rclone_cleanup url: /commands/rclone_cleanup/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cleanup/ and as part of making a release run "make commanddocs" --- # rclone cleanup -Clean up the remote if possible +Clean up the remote if possible. ## Synopsis diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index 16b25d04e..2032a883a 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,13 +1,13 @@ --- title: "rclone copy" -description: "Copy files from source to dest, skipping already copied" +description: "Copy files from source to dest, skipping already copied." slug: rclone_copy url: /commands/rclone_copy/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copy/ and as part of making a release run "make commanddocs" --- # rclone copy -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index 17567ee01..e571c8c75 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,13 +1,13 @@ --- title: "rclone copyto" -description: "Copy files from source to dest, skipping already copied" +description: "Copy files from source to dest, skipping already copied." slug: rclone_copyto url: /commands/rclone_copyto/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyto/ and as part of making a release run "make commanddocs" --- # rclone copyto -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index 47cbf716b..cf4d701ad 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -40,7 +40,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index 26bb1b9de..7901ebfc3 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,13 +1,13 @@ --- title: "rclone lsf" -description: "List directories and objects in remote:path formatted for parsing" +description: "List directories and objects in remote:path formatted for parsing." slug: rclone_lsf url: /commands/rclone_lsf/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsf/ and as part of making a release run "make commanddocs" --- # rclone lsf -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. ## Synopsis diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index fbf78b11d..eec62f0f5 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -49,6 +49,9 @@ Stopping the mount manually: # OS X umount /path/to/local/mount +**Note**: As of `rclone` 1.52.2, `rclone mount` now requires Go version 1.13 +or newer on some platforms depending on the underlying FUSE library in use. + ## Installing on Windows To run rclone mount on Windows, you will need to @@ -357,6 +360,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for diff --git a/docs/content/commands/rclone_obscure.md b/docs/content/commands/rclone_obscure.md index bbc5f7bfc..aee053a50 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,13 +1,13 @@ --- title: "rclone obscure" -description: "Obscure password for use in the rclone config file" +description: "Obscure password for use in the rclone config file." slug: rclone_obscure url: /commands/rclone_obscure/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/obscure/ and as part of making a release run "make commanddocs" --- # rclone obscure -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. ## Synopsis diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index 9f7b27932..b39d5ec01 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -196,6 +196,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index fadbf2b9f..2cd509b32 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -195,6 +195,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 39ca31f90..30c261147 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -267,6 +267,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index 3f750f9f7..d5d37f96b 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -206,6 +206,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index 0f29adcec..96b893245 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -275,6 +275,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for diff --git a/docs/content/drive.md b/docs/content/drive.md index ddbef261e..ab8af675d 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -547,8 +547,10 @@ Here are the standard options specific to drive (Google Drive). #### --drive-client-id -OAuth Client Id -Leave blank normally. +Google Application Client Id +Setting your own is recommended. +See https://rclone.org/drive/#making-your-own-client-id for how to create your own. +If you leave this blank, it will use an internal key which is low performance. - Config: client_id - Env Var: RCLONE_DRIVE_CLIENT_ID diff --git a/docs/content/flags.md b/docs/content/flags.md index d710580ef..c736e099b 100755 --- a/docs/content/flags.md +++ b/docs/content/flags.md @@ -147,7 +147,7 @@ These flags are available for every command. --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata - --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.1") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -246,7 +246,7 @@ and may be set in the config file. --drive-auth-owner-only Only consider files owned by the authenticated user. --drive-auth-url string Auth server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) - --drive-client-id string OAuth Client Id + --drive-client-id string Google Application Client Id --drive-client-secret string OAuth Client Secret --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) diff --git a/docs/content/s3.md b/docs/content/s3.md index 877093d41..f9e14e91b 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -456,7 +456,7 @@ Vault API, so rclone cannot directly access Glacier Vaults. {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/s3/s3.go then run make backenddocs" >}} ### Standard Options -Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). +Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc)). #### --s3-provider @@ -487,10 +487,10 @@ Choose your S3 provider. - Scaleway Object Storage - "StackPath" - StackPath Object Storage - - "Wasabi" - - Wasabi Object Storage - "TencentCOS" - Tencent Cloud Object Storage (COS) + - "Wasabi" + - Wasabi Object Storage - "Other" - Any other S3 compatible provider @@ -842,6 +842,54 @@ Endpoint for StackPath Object Storage. #### --s3-endpoint +Endpoint for Tencent COS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "cos.ap-beijing.myqcloud.com" + - Beijing Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-shanghai.myqcloud.com" + - Shanghai Region. + - "cos.ap-guangzhou.myqcloud.com" + - Guangzhou Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-chengdu.myqcloud.com" + - Chengdu Region. + - "cos.ap-chongqing.myqcloud.com" + - Chongqing Region. + - "cos.ap-hongkong.myqcloud.com" + - Hong Kong (China) Region. + - "cos.ap-singapore.myqcloud.com" + - Singapore Region. + - "cos.ap-mumbai.myqcloud.com" + - Mumbai Region. + - "cos.ap-seoul.myqcloud.com" + - Seoul Region. + - "cos.ap-bangkok.myqcloud.com" + - Bangkok Region. + - "cos.ap-tokyo.myqcloud.com" + - Tokyo Region. + - "cos.na-siliconvalley.myqcloud.com" + - Silicon Valley Region. + - "cos.na-ashburn.myqcloud.com" + - Virginia Region. + - "cos.na-toronto.myqcloud.com" + - Toronto Region. + - "cos.eu-frankfurt.myqcloud.com" + - Frankfurt Region. + - "cos.eu-moscow.myqcloud.com" + - Moscow Region. + - "cos.accelerate.myqcloud.com" + - Use Tencent COS Accelerate Endpoint. + +#### --s3-endpoint + Endpoint for S3 API. Required when using an S3 clone. @@ -1009,6 +1057,8 @@ doesn't copy the ACL from the source but rather writes a fresh one. - Type: string - Default: "" - Examples: + - "default" + - Owner gets Full_CONTROL. No one else has access rights (default). - "private" - Owner gets FULL_CONTROL. No one else has access rights (default). - "public-read" @@ -1109,6 +1159,24 @@ The storage class to use when storing new objects in OSS. #### --s3-storage-class +The storage class to use when storing new objects in Tencent COS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "ARCHIVE" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +#### --s3-storage-class + The storage class to use when storing new objects in S3. - Config: storage_class @@ -1346,7 +1414,7 @@ if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. -Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to +Some providers (eg AWS, Aliyun OSS, Netease COS or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting. diff --git a/rclone.1 b/rclone.1 index a7aae105f..ef9cd43fd 100644 --- a/rclone.1 +++ b/rclone.1 @@ -1,7 +1,7 @@ .\"t .\" Automatically generated by Pandoc 2.5 .\" -.TH "rclone" "1" "Sep 02, 2020" "User Manual" "" +.TH "rclone" "1" "Sep 13, 2020" "User Manual" "" .hy .SH Rclone syncs your files to cloud storage .PP @@ -231,6 +231,8 @@ SugarSync .IP \[bu] 2 Tardigrade .IP \[bu] 2 +Tencent Cloud Object Storage (COS) +.IP \[bu] 2 Wasabi .IP \[bu] 2 WebDAV @@ -766,7 +768,7 @@ userinfo (https://rclone.org/commands/rclone_config_userinfo/) \- Prints info about logged in user of remote. .SH rclone copy .PP -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. .SS Synopsis .PP Copy the source to the destination. @@ -1150,7 +1152,7 @@ This means that extra files in the destination that are not in the source will not be detected. .PP The \f[C]\-\-differ\f[R], \f[C]\-\-missing\-on\-dst\f[R], -\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-src\-only\f[R] and +\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-match\f[R] and \f[C]\-\-error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]\-\f[R]) supplied. What they write is described in the help below. @@ -1188,6 +1190,7 @@ rclone check source:path dest:path [flags] \f[C] \-\-combined string Make a combined report of changes to this file \-\-differ string Report all non\-matching files to this file + \-\-download Check by downloading rather than with hash. \-\-error string Report all files with errors (hashing or reading) to this file \-h, \-\-help help for check \-\-match string Report all matching files to this file @@ -1572,7 +1575,7 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone cleanup .PP -Clean up the remote if possible +Clean up the remote if possible. .SS Synopsis .PP Clean up the remote if possible. @@ -2421,7 +2424,7 @@ rclone config (https://rclone.org/commands/rclone_config/) \- Enter an interactive configuration session. .SH rclone copyto .PP -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. .SS Synopsis .PP If source:path is a file or directory then it copies it to a file or @@ -2562,7 +2565,7 @@ This means that extra files in the destination that are not in the source will not be detected. .PP The \f[C]\-\-differ\f[R], \f[C]\-\-missing\-on\-dst\f[R], -\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-src\-only\f[R] and +\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-match\f[R] and \f[C]\-\-error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]\-\f[R]) supplied. What they write is described in the help below. @@ -3022,7 +3025,7 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone lsf .PP -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. .SS Synopsis .PP List the contents of the source path (directories and objects) to @@ -3393,6 +3396,10 @@ fusermount \-u /path/to/local/mount umount /path/to/local/mount \f[R] .fi +.PP +\f[B]Note\f[R]: As of \f[C]rclone\f[R] 1.52.2, \f[C]rclone mount\f[R] +now requires Go version 1.13 or newer on some platforms depending on the +underlying FUSE library in use. .SS Installing on Windows .PP To run rclone mount on Windows, you will need to download and install @@ -3739,6 +3746,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -4014,7 +4027,7 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone obscure .PP -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. .SS Synopsis .PP In the rclone config file, human readable passwords are obscured. @@ -4565,6 +4578,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -4919,6 +4938,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -5523,6 +5548,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -6191,6 +6222,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -6799,6 +6836,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -7980,6 +8023,8 @@ This can be useful for tracking down problems with syncs in combination with the \f[C]\-v\f[R] flag. See the Logging section for more info. .PP +If FILE exists then rclone will append to it. +.PP Note that if you are using the \f[C]logrotate\f[R] program to manage rclone\[aq]s logs, then you should use the \f[C]copytruncate\f[R] option as rclone doesn\[aq]t have a signal to rotate logs. @@ -10752,4382 +10797,8192 @@ OR \[dq]error\[dq]: true, \[dq]result\[dq]: \[dq]\[dq] } - -**Authentication is required for this call.** - -### core/gc: Runs a garbage collection. {#core\-gc} - -This tells the go runtime to do a garbage collection run. It isn\[aq]t -necessary to call this normally, but it can be useful for debugging -memory problems. - -### core/group\-list: Returns list of stats. {#core\-group\-list} - -This returns list of stats groups currently in memory. - -Returns the following values: \f[R] .fi .PP -{ \[dq]groups\[dq]: an array of group names: [ \[dq]group1\[dq], -\[dq]group2\[dq], ... -] } +\f[B]Authentication is required for this call.\f[R] +.SS core/gc: Runs a garbage collection. +.PP +This tells the go runtime to do a garbage collection run. +It isn\[aq]t necessary to call this normally, but it can be useful for +debugging memory problems. +.SS core/group\-list: Returns list of stats. +.PP +This returns list of stats groups currently in memory. +.PP +Returns the following values: .IP .nf \f[C] - -### core/memstats: Returns the memory statistics {#core\-memstats} - -This returns the memory statistics of the running program. What the values mean -are explained in the go docs: https://golang.org/pkg/runtime/#MemStats - +{ + \[dq]groups\[dq]: an array of group names: + [ + \[dq]group1\[dq], + \[dq]group2\[dq], + ... + ] +} +\f[R] +.fi +.SS core/memstats: Returns the memory statistics +.PP +This returns the memory statistics of the running program. +What the values mean are explained in the go docs: +https://golang.org/pkg/runtime/#MemStats +.PP The most interesting values for most people are: - -* HeapAlloc: This is the amount of memory rclone is actually using -* HeapSys: This is the amount of memory rclone has obtained from the OS -* Sys: this is the total amount of memory requested from the OS - * It is virtual memory so may include unused memory - -### core/obscure: Obscures a string passed in. {#core\-obscure} - -Pass a clear string and rclone will obscure it for the config file: -\- clear \- string - -Returns -\- obscured \- string - -### core/pid: Return PID of current process {#core\-pid} - +.IP \[bu] 2 +HeapAlloc: This is the amount of memory rclone is actually using +.IP \[bu] 2 +HeapSys: This is the amount of memory rclone has obtained from the OS +.IP \[bu] 2 +Sys: this is the total amount of memory requested from the OS +.RS 2 +.IP \[bu] 2 +It is virtual memory so may include unused memory +.RE +.SS core/obscure: Obscures a string passed in. +.PP +Pass a clear string and rclone will obscure it for the config file: \- +clear \- string +.PP +Returns \- obscured \- string +.SS core/pid: Return PID of current process +.PP This returns PID of current process. Useful for stopping rclone process. - -### core/quit: Terminates the app. {#core\-quit} - -(optional) Pass an exit code to be used for terminating the app: -\- exitCode \- int - -### core/stats: Returns stats about current transfers. {#core\-stats} - +.SS core/quit: Terminates the app. +.PP +(optional) Pass an exit code to be used for terminating the app: \- +exitCode \- int +.SS core/stats: Returns stats about current transfers. +.PP This returns all available stats: - - rclone rc core/stats - +.IP +.nf +\f[C] +rclone rc core/stats +\f[R] +.fi +.PP If group is not provided then summed up stats for all groups will be returned. - -Parameters - -\- group \- name of the stats group (string) - -Returns the following values: -\f[R] -.fi .PP -{ \[dq]speed\[dq]: average speed in bytes/sec since start of the -process, \[dq]bytes\[dq]: total transferred bytes since the start of the -process, \[dq]errors\[dq]: number of errors, \[dq]fatalError\[dq]: -whether there has been at least one FatalError, \[dq]retryError\[dq]: -whether there has been at least one non\-NoRetryError, \[dq]checks\[dq]: -number of checked files, \[dq]transfers\[dq]: number of transferred -files, \[dq]deletes\[dq] : number of deleted files, \[dq]renames\[dq] : -number of renamed files, \[dq]transferTime\[dq] : total time spent on -running jobs, \[dq]elapsedTime\[dq]: time in seconds since the start of -the process, \[dq]lastError\[dq]: last occurred error, -\[dq]transferring\[dq]: an array of currently active file transfers: [ { -\[dq]bytes\[dq]: total transferred bytes for this file, \[dq]eta\[dq]: -estimated time in seconds until file transfer completion \[dq]name\[dq]: -name of the file, \[dq]percentage\[dq]: progress of the file transfer in -percent, \[dq]speed\[dq]: average speed over the whole transfer in -bytes/sec, \[dq]speedAvg\[dq]: current speed in bytes/sec as an -exponentially weighted moving average, \[dq]size\[dq]: size of the file -in bytes } ], \[dq]checking\[dq]: an array of names of currently active -file checks [] } +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) +.PP +Returns the following values: .IP .nf \f[C] -Values for \[dq]transferring\[dq], \[dq]checking\[dq] and \[dq]lastError\[dq] are only assigned if data is available. +{ + \[dq]speed\[dq]: average speed in bytes/sec since start of the process, + \[dq]bytes\[dq]: total transferred bytes since the start of the process, + \[dq]errors\[dq]: number of errors, + \[dq]fatalError\[dq]: whether there has been at least one FatalError, + \[dq]retryError\[dq]: whether there has been at least one non\-NoRetryError, + \[dq]checks\[dq]: number of checked files, + \[dq]transfers\[dq]: number of transferred files, + \[dq]deletes\[dq] : number of deleted files, + \[dq]renames\[dq] : number of renamed files, + \[dq]transferTime\[dq] : total time spent on running jobs, + \[dq]elapsedTime\[dq]: time in seconds since the start of the process, + \[dq]lastError\[dq]: last occurred error, + \[dq]transferring\[dq]: an array of currently active file transfers: + [ + { + \[dq]bytes\[dq]: total transferred bytes for this file, + \[dq]eta\[dq]: estimated time in seconds until file transfer completion + \[dq]name\[dq]: name of the file, + \[dq]percentage\[dq]: progress of the file transfer in percent, + \[dq]speed\[dq]: average speed over the whole transfer in bytes/sec, + \[dq]speedAvg\[dq]: current speed in bytes/sec as an exponentially weighted moving average, + \[dq]size\[dq]: size of the file in bytes + } + ], + \[dq]checking\[dq]: an array of names of currently active file checks + [] +} +\f[R] +.fi +.PP +Values for \[dq]transferring\[dq], \[dq]checking\[dq] and +\[dq]lastError\[dq] are only assigned if data is available. The value for \[dq]eta\[dq] is null if an eta cannot be determined. - -### core/stats\-delete: Delete stats group. {#core\-stats\-delete} - +.SS core/stats\-delete: Delete stats group. +.PP This deletes entire stats group - +.PP Parameters - -\- group \- name of the stats group (string) - -### core/stats\-reset: Reset stats. {#core\-stats\-reset} - -This clears counters, errors and finished transfers for all stats or specific -stats group if group is provided. - +.IP \[bu] 2 +group \- name of the stats group (string) +.SS core/stats\-reset: Reset stats. +.PP +This clears counters, errors and finished transfers for all stats or +specific stats group if group is provided. +.PP Parameters - -\- group \- name of the stats group (string) - -### core/transferred: Returns stats about completed transfers. {#core\-transferred} - +.IP \[bu] 2 +group \- name of the stats group (string) +.SS core/transferred: Returns stats about completed transfers. +.PP This returns stats about completed transfers: - - rclone rc core/transferred - +.IP +.nf +\f[C] +rclone rc core/transferred +\f[R] +.fi +.PP If group is not provided then completed transfers for all groups will be returned. - -Note only the last 100 completed transfers are returned. - -Parameters - -\- group \- name of the stats group (string) - -Returns the following values: -\f[R] -.fi .PP -{ \[dq]transferred\[dq]: an array of completed transfers (including -failed ones): [ { \[dq]name\[dq]: name of the file, \[dq]size\[dq]: size -of the file in bytes, \[dq]bytes\[dq]: total transferred bytes for this -file, \[dq]checked\[dq]: if the transfer is only checked (skipped, -deleted), \[dq]timestamp\[dq]: integer representing millisecond unix -epoch, \[dq]error\[dq]: string description of the error (empty if -successful), \[dq]jobid\[dq]: id of the job that this transfer belongs -to } ] } +Note only the last 100 completed transfers are returned. +.PP +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) +.PP +Returns the following values: .IP .nf \f[C] - -### core/version: Shows the current version of rclone and the go runtime. {#core\-version} - +{ + \[dq]transferred\[dq]: an array of completed transfers (including failed ones): + [ + { + \[dq]name\[dq]: name of the file, + \[dq]size\[dq]: size of the file in bytes, + \[dq]bytes\[dq]: total transferred bytes for this file, + \[dq]checked\[dq]: if the transfer is only checked (skipped, deleted), + \[dq]timestamp\[dq]: integer representing millisecond unix epoch, + \[dq]error\[dq]: string description of the error (empty if successful), + \[dq]jobid\[dq]: id of the job that this transfer belongs to + } + ] +} +\f[R] +.fi +.SS core/version: Shows the current version of rclone and the go runtime. +.PP This shows the current version of go and the go runtime - -\- version \- rclone version, eg \[dq]v1.53.0\[dq] -\- decomposed \- version number as [major, minor, patch] -\- isGit \- boolean \- true if this was compiled from the git version -\- isBeta \- boolean \- true if this is a beta version -\- os \- OS in use as according to Go -\- arch \- cpu architecture in use according to Go -\- goVersion \- version of Go runtime in use - -### debug/set\-block\-profile\-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug\-set\-block\-profile\-rate} - +.IP \[bu] 2 +version \- rclone version, eg \[dq]v1.53.0\[dq] +.IP \[bu] 2 +decomposed \- version number as [major, minor, patch] +.IP \[bu] 2 +isGit \- boolean \- true if this was compiled from the git version +.IP \[bu] 2 +isBeta \- boolean \- true if this is a beta version +.IP \[bu] 2 +os \- OS in use as according to Go +.IP \[bu] 2 +arch \- cpu architecture in use according to Go +.IP \[bu] 2 +goVersion \- version of Go runtime in use +.SS debug/set\-block\-profile\-rate: Set runtime.SetBlockProfileRate for blocking profiling. +.PP SetBlockProfileRate controls the fraction of goroutine blocking events -that are reported in the blocking profile. The profiler aims to sample -an average of one blocking event per rate nanoseconds spent blocked. - -To include every blocking event in the profile, pass rate = 1. To turn -off profiling entirely, pass rate <= 0. - +that are reported in the blocking profile. +The profiler aims to sample an average of one blocking event per rate +nanoseconds spent blocked. +.PP +To include every blocking event in the profile, pass rate = 1. +To turn off profiling entirely, pass rate <= 0. +.PP After calling this you can use this to see the blocking profile: - - go tool pprof http://localhost:5572/debug/pprof/block - +.IP +.nf +\f[C] +go tool pprof http://localhost:5572/debug/pprof/block +\f[R] +.fi +.PP Parameters - -\- rate \- int - -### debug/set\-mutex\-profile\-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug\-set\-mutex\-profile\-fraction} - -SetMutexProfileFraction controls the fraction of mutex contention -events that are reported in the mutex profile. On average 1/rate -events are reported. The previous rate is returned. - -To turn off profiling entirely, pass rate 0. To just read the current -rate, pass rate < 0. (For n>1 the details of sampling may change.) - +.IP \[bu] 2 +rate \- int +.SS debug/set\-mutex\-profile\-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. +.PP +SetMutexProfileFraction controls the fraction of mutex contention events +that are reported in the mutex profile. +On average 1/rate events are reported. +The previous rate is returned. +.PP +To turn off profiling entirely, pass rate 0. +To just read the current rate, pass rate < 0. +(For n>1 the details of sampling may change.) +.PP Once this is set you can look use this to profile the mutex contention: - - go tool pprof http://localhost:5572/debug/pprof/mutex - +.IP +.nf +\f[C] +go tool pprof http://localhost:5572/debug/pprof/mutex +\f[R] +.fi +.PP Parameters - -\- rate \- int - +.IP \[bu] 2 +rate \- int +.PP Results - -\- previousRate \- int - -### job/list: Lists the IDs of the running jobs {#job\-list} - +.IP \[bu] 2 +previousRate \- int +.SS job/list: Lists the IDs of the running jobs +.PP Parameters \- None - +.PP Results - -\- jobids \- array of integer job ids - -### job/status: Reads the status of the job ID {#job\-status} - +.IP \[bu] 2 +jobids \- array of integer job ids +.SS job/status: Reads the status of the job ID +.PP Parameters - -\- jobid \- id of the job (integer) - +.IP \[bu] 2 +jobid \- id of the job (integer) +.PP Results - -\- finished \- boolean -\- duration \- time in seconds that the job ran for -\- endTime \- time the job finished (eg \[dq]2018\-10\-26T18:50:20.528746884+01:00\[dq]) -\- error \- error from the job or empty string for no error -\- finished \- boolean whether the job has finished or not -\- id \- as passed in above -\- startTime \- time the job started (eg \[dq]2018\-10\-26T18:50:20.528336039+01:00\[dq]) -\- success \- boolean \- true for success false otherwise -\- output \- output of the job as would have been returned if called synchronously -\- progress \- output of the progress related to the underlying job - -### job/stop: Stop the running job {#job\-stop} - +.IP \[bu] 2 +finished \- boolean +.IP \[bu] 2 +duration \- time in seconds that the job ran for +.IP \[bu] 2 +endTime \- time the job finished (eg +\[dq]2018\-10\-26T18:50:20.528746884+01:00\[dq]) +.IP \[bu] 2 +error \- error from the job or empty string for no error +.IP \[bu] 2 +finished \- boolean whether the job has finished or not +.IP \[bu] 2 +id \- as passed in above +.IP \[bu] 2 +startTime \- time the job started (eg +\[dq]2018\-10\-26T18:50:20.528336039+01:00\[dq]) +.IP \[bu] 2 +success \- boolean \- true for success false otherwise +.IP \[bu] 2 +output \- output of the job as would have been returned if called +synchronously +.IP \[bu] 2 +progress \- output of the progress related to the underlying job +.SS job/stop: Stop the running job +.PP Parameters - -\- jobid \- id of the job (integer) - -### mount/listmounts: Show current mount points {#mount\-listmounts} - -This shows currently mounted points, which can be used for performing an unmount - +.IP \[bu] 2 +jobid \- id of the job (integer) +.SS mount/listmounts: Show current mount points +.PP +This shows currently mounted points, which can be used for performing an +unmount +.PP This takes no parameters and returns - -\- mountPoints: list of current mount points - +.IP \[bu] 2 +mountPoints: list of current mount points +.PP Eg - - rclone rc mount/listmounts - -**Authentication is required for this call.** - -### mount/mount: Create a new mount point {#mount\-mount} - +.IP +.nf +\f[C] +rclone rc mount/listmounts +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/mount: Create a new mount point +.PP rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. - -If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2 - -This takes the following parameters - -\- fs \- a remote path to be mounted (required) -\- mountPoint: valid path on the local machine (required) -\- mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use -\- mountOpt: a JSON object with Mount options in. -\- vfsOpt: a JSON object with VFS options in. - -Eg - - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount - rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=\[aq]{\[dq]CacheMode\[dq]: 2}\[aq] mountOpt=\[aq]{\[dq]AllowOther\[dq]: true}\[aq] - -The vfsOpt are as described in options/get and can be seen in the the -\[dq]vfs\[dq] section when running and the mountOpt can be seen in the \[dq]mount\[dq] section. - - rclone rc options/get - -**Authentication is required for this call.** - -### mount/types: Show all possible mount types {#mount\-types} - -This shows all possible mount types and returns them as a list. - -This takes no parameters and returns - -\- mountTypes: list of mount types - -The mount types are strings like \[dq]mount\[dq], \[dq]mount2\[dq], \[dq]cmount\[dq] and can -be passed to mount/mount as the mountType parameter. - -Eg - - rclone rc mount/types - -**Authentication is required for this call.** - -### mount/unmount: Unmount selected active mount {#mount\-unmount} - -rclone allows Linux, FreeBSD, macOS and Windows to -mount any of Rclone\[aq]s cloud storage systems as a file system with -FUSE. - -This takes the following parameters - -\- mountPoint: valid path on the local machine where the mount was created (required) - -Eg - - rclone rc mount/unmount mountPoint=/home//mountPoint - -**Authentication is required for this call.** - -### mount/unmountall: Show current mount points {#mount\-unmountall} - -This shows currently mounted points, which can be used for performing an unmount - -This takes no parameters and returns error if unmount does not succeed. - -Eg - - rclone rc mount/unmountall - -**Authentication is required for this call.** - -### operations/about: Return the space used on the remote {#operations\-about} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -The result is as returned from rclone about \-\-json - -See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/cleanup: Remove trashed files in the remote or path {#operations\-cleanup} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/copyfile: Copy a file from source remote to destination remote {#operations\-copyfile} - -This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:\[dq] for the source -\- srcRemote \- a path within that remote eg \[dq]file.txt\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive2:\[dq] for the destination -\- dstRemote \- a path within that remote eg \[dq]file2.txt\[dq] for the destination - -**Authentication is required for this call.** - -### operations/copyurl: Copy the URL to the object {#operations\-copyurl} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- url \- string, URL to read from - \- autoFilename \- boolean, set to true to retrieve destination file name from url -See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/delete: Remove files in the path {#operations\-delete} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/deletefile: Remove the single file pointed to {#operations\-deletefile} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/fsinfo: Return information about the remote {#operations\-fsinfo} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -This returns info about the remote passed in; -\f[R] -.fi .PP -{ // optional features and whether they are available or not -\[dq]Features\[dq]: { \[dq]About\[dq]: true, \[dq]BucketBased\[dq]: -false, \[dq]CanHaveEmptyDirectories\[dq]: true, -\[dq]CaseInsensitive\[dq]: false, \[dq]ChangeNotify\[dq]: false, -\[dq]CleanUp\[dq]: false, \[dq]Copy\[dq]: false, -\[dq]DirCacheFlush\[dq]: false, \[dq]DirMove\[dq]: true, -\[dq]DuplicateFiles\[dq]: false, \[dq]GetTier\[dq]: false, -\[dq]ListR\[dq]: false, \[dq]MergeDirs\[dq]: false, \[dq]Move\[dq]: -true, \[dq]OpenWriterAt\[dq]: true, \[dq]PublicLink\[dq]: false, -\[dq]Purge\[dq]: true, \[dq]PutStream\[dq]: true, -\[dq]PutUnchecked\[dq]: false, \[dq]ReadMimeType\[dq]: false, -\[dq]ServerSideAcrossConfigs\[dq]: false, \[dq]SetTier\[dq]: false, -\[dq]SetWrapper\[dq]: false, \[dq]UnWrap\[dq]: false, \[dq]WrapFs\[dq]: -false, \[dq]WriteMimeType\[dq]: false }, // Names of hashes available -\[dq]Hashes\[dq]: [ \[dq]MD5\[dq], \[dq]SHA\-1\[dq], -\[dq]DropboxHash\[dq], \[dq]QuickXorHash\[dq] ], \[dq]Name\[dq]: -\[dq]local\[dq], // Name as created \[dq]Precision\[dq]: 1, // Precision -of timestamps in ns \[dq]Root\[dq]: \[dq]/\[dq], // Path as created -\[dq]String\[dq]: \[dq]Local file system at /\[dq] // how the remote -will appear in logs } +If no mountType is provided, the priority is given as follows: 1. +mount 2.cmount 3.mount2 +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote path to be mounted (required) +.IP \[bu] 2 +mountPoint: valid path on the local machine (required) +.IP \[bu] 2 +mountType: One of the values (mount, cmount, mount2) specifies the mount +implementation to use +.IP \[bu] 2 +mountOpt: a JSON object with Mount options in. +.IP \[bu] 2 +vfsOpt: a JSON object with VFS options in. +.PP +Eg .IP .nf \f[C] - -This command does not have a command line equivalent so use this instead: - - rclone rc \-\-loopback operations/fsinfo fs=remote: - -### operations/list: List the given remote and path in JSON format {#operations\-list} - +rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint +rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount +rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=\[aq]{\[dq]CacheMode\[dq]: 2}\[aq] mountOpt=\[aq]{\[dq]AllowOther\[dq]: true}\[aq] +\f[R] +.fi +.PP +The vfsOpt are as described in options/get and can be seen in the the +\[dq]vfs\[dq] section when running and the mountOpt can be seen in the +\[dq]mount\[dq] section. +.IP +.nf +\f[C] +rclone rc options/get +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/types: Show all possible mount types +.PP +This shows all possible mount types and returns them as a list. +.PP +This takes no parameters and returns +.IP \[bu] 2 +mountTypes: list of mount types +.PP +The mount types are strings like \[dq]mount\[dq], \[dq]mount2\[dq], +\[dq]cmount\[dq] and can be passed to mount/mount as the mountType +parameter. +.PP +Eg +.IP +.nf +\f[C] +rclone rc mount/types +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/unmount: Unmount selected active mount +.PP +rclone allows Linux, FreeBSD, macOS and Windows to mount any of +Rclone\[aq]s cloud storage systems as a file system with FUSE. +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- opt \- a dictionary of options to control the listing (optional) - \- recurse \- If set recurse directories - \- noModTime \- If set return modification time - \- showEncrypted \- If set show decrypted names - \- showOrigIDs \- If set show the IDs for each item if known - \- showHash \- If set return a dictionary of hashes - +.IP \[bu] 2 +mountPoint: valid path on the local machine where the mount was created +(required) +.PP +Eg +.IP +.nf +\f[C] +rclone rc mount/unmount mountPoint=/home//mountPoint +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/unmountall: Show current mount points +.PP +This shows currently mounted points, which can be used for performing an +unmount +.PP +This takes no parameters and returns error if unmount does not succeed. +.PP +Eg +.IP +.nf +\f[C] +rclone rc mount/unmountall +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/about: Return the space used on the remote +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.PP +The result is as returned from rclone about \-\-json +.PP +See the about command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/cleanup: Remove trashed files in the remote or path +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.PP +See the cleanup command (https://rclone.org/commands/rclone_cleanup/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/copyfile: Copy a file from source remote to destination remote +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string eg \[dq]drive:\[dq] for the source +.IP \[bu] 2 +srcRemote \- a path within that remote eg \[dq]file.txt\[dq] for the +source +.IP \[bu] 2 +dstFs \- a remote name string eg \[dq]drive2:\[dq] for the destination +.IP \[bu] 2 +dstRemote \- a path within that remote eg \[dq]file2.txt\[dq] for the +destination +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/copyurl: Copy the URL to the object +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.IP \[bu] 2 +url \- string, URL to read from +.IP \[bu] 2 +autoFilename \- boolean, set to true to retrieve destination file name +from url See the copyurl +command (https://rclone.org/commands/rclone_copyurl/) command for more +information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/delete: Remove files in the path +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.PP +See the delete command (https://rclone.org/commands/rclone_delete/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/deletefile: Remove the single file pointed to +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.PP +See the deletefile +command (https://rclone.org/commands/rclone_deletefile/) command for +more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/fsinfo: Return information about the remote +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.PP +This returns info about the remote passed in; +.IP +.nf +\f[C] +{ + // optional features and whether they are available or not + \[dq]Features\[dq]: { + \[dq]About\[dq]: true, + \[dq]BucketBased\[dq]: false, + \[dq]CanHaveEmptyDirectories\[dq]: true, + \[dq]CaseInsensitive\[dq]: false, + \[dq]ChangeNotify\[dq]: false, + \[dq]CleanUp\[dq]: false, + \[dq]Copy\[dq]: false, + \[dq]DirCacheFlush\[dq]: false, + \[dq]DirMove\[dq]: true, + \[dq]DuplicateFiles\[dq]: false, + \[dq]GetTier\[dq]: false, + \[dq]ListR\[dq]: false, + \[dq]MergeDirs\[dq]: false, + \[dq]Move\[dq]: true, + \[dq]OpenWriterAt\[dq]: true, + \[dq]PublicLink\[dq]: false, + \[dq]Purge\[dq]: true, + \[dq]PutStream\[dq]: true, + \[dq]PutUnchecked\[dq]: false, + \[dq]ReadMimeType\[dq]: false, + \[dq]ServerSideAcrossConfigs\[dq]: false, + \[dq]SetTier\[dq]: false, + \[dq]SetWrapper\[dq]: false, + \[dq]UnWrap\[dq]: false, + \[dq]WrapFs\[dq]: false, + \[dq]WriteMimeType\[dq]: false + }, + // Names of hashes available + \[dq]Hashes\[dq]: [ + \[dq]MD5\[dq], + \[dq]SHA\-1\[dq], + \[dq]DropboxHash\[dq], + \[dq]QuickXorHash\[dq] + ], + \[dq]Name\[dq]: \[dq]local\[dq], // Name as created + \[dq]Precision\[dq]: 1, // Precision of timestamps in ns + \[dq]Root\[dq]: \[dq]/\[dq], // Path as created + \[dq]String\[dq]: \[dq]Local file system at /\[dq] // how the remote will appear in logs +} +\f[R] +.fi +.PP +This command does not have a command line equivalent so use this +instead: +.IP +.nf +\f[C] +rclone rc \-\-loopback operations/fsinfo fs=remote: +\f[R] +.fi +.SS operations/list: List the given remote and path in JSON format +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.IP \[bu] 2 +opt \- a dictionary of options to control the listing (optional) +.RS 2 +.IP \[bu] 2 +recurse \- If set recurse directories +.IP \[bu] 2 +noModTime \- If set return modification time +.IP \[bu] 2 +showEncrypted \- If set show decrypted names +.IP \[bu] 2 +showOrigIDs \- If set show the IDs for each item if known +.IP \[bu] 2 +showHash \- If set return a dictionary of hashes +.RE +.PP The result is - -\- list - \- This is an array of objects as described in the lsjson command - -See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. - -**Authentication is required for this call.** - -### operations/mkdir: Make a destination directory or container {#operations\-mkdir} - +.IP \[bu] 2 +list +.RS 2 +.IP \[bu] 2 +This is an array of objects as described in the lsjson command +.RE +.PP +See the lsjson command (https://rclone.org/commands/rclone_lsjson/) for +more information on the above and examples. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/mkdir: Make a destination directory or container +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/movefile: Move a file from source remote to destination remote {#operations\-movefile} - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.PP +See the mkdir command (https://rclone.org/commands/rclone_mkdir/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/movefile: Move a file from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:\[dq] for the source -\- srcRemote \- a path within that remote eg \[dq]file.txt\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive2:\[dq] for the destination -\- dstRemote \- a path within that remote eg \[dq]file2.txt\[dq] for the destination - -**Authentication is required for this call.** - -### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations\-publiclink} - +.IP \[bu] 2 +srcFs \- a remote name string eg \[dq]drive:\[dq] for the source +.IP \[bu] 2 +srcRemote \- a path within that remote eg \[dq]file.txt\[dq] for the +source +.IP \[bu] 2 +dstFs \- a remote name string eg \[dq]drive2:\[dq] for the destination +.IP \[bu] 2 +dstRemote \- a path within that remote eg \[dq]file2.txt\[dq] for the +destination +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/publiclink: Create or retrieve a public link to the given file or folder. +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- unlink \- boolean \- if set removes the link rather than adding it (optional) -\- expire \- string \- the expiry time of the link eg \[dq]1d\[dq] (optional) - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.IP \[bu] 2 +unlink \- boolean \- if set removes the link rather than adding it +(optional) +.IP \[bu] 2 +expire \- string \- the expiry time of the link eg \[dq]1d\[dq] +(optional) +.PP Returns - -\- url \- URL of the resource - -See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/purge: Remove a directory or container and all of its contents {#operations\-purge} - +.IP \[bu] 2 +url \- URL of the resource +.PP +See the link command (https://rclone.org/commands/rclone_link/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/purge: Remove a directory or container and all of its contents +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/rmdir: Remove an empty directory or container {#operations\-rmdir} - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.PP +See the purge command (https://rclone.org/commands/rclone_purge/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/rmdir: Remove an empty directory or container +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/rmdirs: Remove all the empty directories in the path {#operations\-rmdirs} - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.PP +See the rmdir command (https://rclone.org/commands/rclone_rmdir/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/rmdirs: Remove all the empty directories in the path +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- leaveRoot \- boolean, set to true not to delete the root - -See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/size: Count the number of bytes and files in remote {#operations\-size} - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.IP \[bu] 2 +leaveRoot \- boolean, set to true not to delete the root +.PP +See the rmdirs command (https://rclone.org/commands/rclone_rmdirs/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/size: Count the number of bytes and files in remote +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:path/to/dir\[dq] - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:path/to/dir\[dq] +.PP Returns - -\- count \- number of files -\- bytes \- number of bytes in those files - -See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/uploadfile: Upload file using multiform/form\-data {#operations\-uploadfile} - +.IP \[bu] 2 +count \- number of files +.IP \[bu] 2 +bytes \- number of bytes in those files +.PP +See the size command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/uploadfile: Upload file using multiform/form\-data +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- each part in body represents a file to be uploaded -See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above. - -**Authentication is required for this call.** - -### options/blocks: List all the option blocks {#options\-blocks} - -Returns -\- options \- a list of the options block names - -### options/get: Get all the options {#options\-get} - +.IP \[bu] 2 +fs \- a remote name string eg \[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote eg \[dq]dir\[dq] +.IP \[bu] 2 +each part in body represents a file to be uploaded See the uploadfile +command (https://rclone.org/commands/rclone_uploadfile/) command for +more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS options/blocks: List all the option blocks +.PP +Returns \- options \- a list of the options block names +.SS options/get: Get all the options +.PP Returns an object where keys are option block names and values are an object with the current option values in. - +.PP This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions. - -### options/set: Set an option {#options\-set} - +.SS options/set: Set an option +.PP Parameters - -\- option block name containing an object with - \- key: value - +.IP \[bu] 2 +option block name containing an object with +.RS 2 +.IP \[bu] 2 +key: value +.RE +.PP Repeated as often as required. - -Only supply the options you wish to change. If an option is unknown -it will be silently ignored. Not all options will have an effect when -changed like this. - +.PP +Only supply the options you wish to change. +If an option is unknown it will be silently ignored. +Not all options will have an effect when changed like this. +.PP For example: - +.PP This sets DEBUG level logs (\-vv) - - rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 8}}\[aq] - +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 8}}\[aq] +\f[R] +.fi +.PP And this sets INFO level logs (\-v) - - rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 7}}\[aq] - +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 7}}\[aq] +\f[R] +.fi +.PP And this sets NOTICE level logs (normal without \-v) - - rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 6}}\[aq] - -### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl\-addPlugin} - +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 6}}\[aq] +\f[R] +.fi +.SS pluginsctl/addPlugin: Add a plugin using url +.PP used for adding a plugin to the webgui - +.PP This takes the following parameters - -\- url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone\-webui\-react) - +.IP \[bu] 2 +url: http url of the github repo where the plugin is hosted +(http://github.com/rclone/rclone\-webui\-react) +.PP Eg - - rclone rc pluginsctl/addPlugin - -**Authentication is required for this call.** - -### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl\-getPluginsForType} - +.PP +rclone rc pluginsctl/addPlugin +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/getPluginsForType: Get plugins with type criteria +.PP This shows all possible plugins by a mime type - +.PP This takes the following parameters - -\- type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3) -\- pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) - +.IP \[bu] 2 +type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3) +.IP \[bu] 2 +pluginType: filter plugins based on their type eg (DASHBOARD, +FILE_HANDLER, TERMINAL) +.PP and returns - -\- loadedPlugins: list of current production plugins -\- testPlugins: list of temporarily loaded development plugins, usually running on a different server. - +.IP \[bu] 2 +loadedPlugins: list of current production plugins +.IP \[bu] 2 +testPlugins: list of temporarily loaded development plugins, usually +running on a different server. +.PP Eg - - rclone rc pluginsctl/getPluginsForType type=video/mp4 - -**Authentication is required for this call.** - -### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl\-listPlugins} - +.PP +rclone rc pluginsctl/getPluginsForType type=video/mp4 +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/listPlugins: Get the list of currently loaded plugins +.PP This allows you to get the currently enabled plugins and their details. - +.PP This takes no parameters and returns - -\- loadedPlugins: list of current production plugins -\- testPlugins: list of temporarily loaded development plugins, usually running on a different server. - +.IP \[bu] 2 +loadedPlugins: list of current production plugins +.IP \[bu] 2 +testPlugins: list of temporarily loaded development plugins, usually +running on a different server. +.PP Eg - - rclone rc pluginsctl/listPlugins - -**Authentication is required for this call.** - -### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl\-listTestPlugins} - -allows listing of test plugins with the rclone.test set to true in package.json of the plugin - +.PP +rclone rc pluginsctl/listPlugins +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/listTestPlugins: Show currently loaded test plugins +.PP +allows listing of test plugins with the rclone.test set to true in +package.json of the plugin +.PP This takes no parameters and returns - -\- loadedTestPlugins: list of currently available test plugins - +.IP \[bu] 2 +loadedTestPlugins: list of currently available test plugins +.PP Eg - - rclone rc pluginsctl/listTestPlugins - -**Authentication is required for this call.** - -### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl\-removePlugin} - +.IP +.nf +\f[C] +rclone rc pluginsctl/listTestPlugins +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/removePlugin: Remove a loaded plugin +.PP This allows you to remove a plugin using it\[aq]s name - +.PP This takes parameters - -\- name: name of the plugin in the format / - +.IP \[bu] 2 +name: name of the plugin in the format +\f[C]author\f[R]/\f[C]plugin_name\f[R] +.PP Eg - - rclone rc pluginsctl/removePlugin name=rclone/video\-plugin - -**Authentication is required for this call.** - -### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl\-removeTestPlugin} - +.PP +rclone rc pluginsctl/removePlugin name=rclone/video\-plugin +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/removeTestPlugin: Remove a test plugin +.PP This allows you to remove a plugin using it\[aq]s name - +.PP This takes the following parameters - -\- name: name of the plugin in the format / - +.IP \[bu] 2 +name: name of the plugin in the format +\f[C]author\f[R]/\f[C]plugin_name\f[R] +.PP Eg - - rclone rc pluginsctl/removeTestPlugin name=rclone/rclone\-webui\-react - -**Authentication is required for this call.** - -### rc/error: This returns an error {#rc\-error} - +.IP +.nf +\f[C] +rclone rc pluginsctl/removeTestPlugin name=rclone/rclone\-webui\-react +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS rc/error: This returns an error +.PP This returns an error with the input as part of its error string. Useful for testing error handling. - -### rc/list: List all the registered remote control commands {#rc\-list} - +.SS rc/list: List all the registered remote control commands +.PP This lists all the registered remote control commands as a JSON map in the commands response. - -### rc/noop: Echo the input to the output parameters {#rc\-noop} - +.SS rc/noop: Echo the input to the output parameters +.PP This echoes the input parameters to the output parameters for testing -purposes. It can be used to check that rclone is still alive and to -check that parameter passing is working properly. - -### rc/noopauth: Echo the input to the output parameters requiring auth {#rc\-noopauth} - +purposes. +It can be used to check that rclone is still alive and to check that +parameter passing is working properly. +.SS rc/noopauth: Echo the input to the output parameters requiring auth +.PP This echoes the input parameters to the output parameters for testing -purposes. It can be used to check that rclone is still alive and to -check that parameter passing is working properly. - -**Authentication is required for this call.** - -### sync/copy: copy a directory from source remote to destination remote {#sync\-copy} - +purposes. +It can be used to check that rclone is still alive and to check that +parameter passing is working properly. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS sync/copy: copy a directory from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination - - -See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above. - -**Authentication is required for this call.** - -### sync/move: move a directory from source remote to destination remote {#sync\-move} - +.IP \[bu] 2 +srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination +.PP +See the copy command (https://rclone.org/commands/rclone_copy/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS sync/move: move a directory from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination -\- deleteEmptySrcDirs \- delete empty src directories if set - - -See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above. - -**Authentication is required for this call.** - -### sync/sync: sync a directory from source remote to destination remote {#sync\-sync} - +.IP \[bu] 2 +srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination +.IP \[bu] 2 +deleteEmptySrcDirs \- delete empty src directories if set +.PP +See the move command (https://rclone.org/commands/rclone_move/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS sync/sync: sync a directory from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination - - -See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. - -**Authentication is required for this call.** - -### vfs/forget: Forget files or directories in the directory cache. {#vfs\-forget} - +.IP \[bu] 2 +srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination +.PP +See the sync command (https://rclone.org/commands/rclone_sync/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS vfs/forget: Forget files or directories in the directory cache. +.PP This forgets the paths in the directory cache causing them to be re\-read from the remote when needed. - +.PP If no paths are passed in then it will forget all the paths in the directory cache. - - rclone rc vfs/forget - -Otherwise pass files or dirs in as file=path or dir=path. Any -parameter key starting with file will forget that file and any +.IP +.nf +\f[C] +rclone rc vfs/forget +\f[R] +.fi +.PP +Otherwise pass files or dirs in as file=path or dir=path. +Any parameter key starting with file will forget that file and any starting with dir will forget that dir, eg - - rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - -This command takes an \[dq]fs\[dq] parameter. If this parameter is not -supplied and if there is only one VFS in use then that VFS will be -used. If there is more than one VFS in use then the \[dq]fs\[dq] parameter +.IP +.nf +\f[C] +rclone rc vfs/forget file=hello file2=goodbye dir=home/junk +\f[R] +.fi +.PP +This command takes an \[dq]fs\[dq] parameter. +If this parameter is not supplied and if there is only one VFS in use +then that VFS will be used. +If there is more than one VFS in use then the \[dq]fs\[dq] parameter must be supplied. - -### vfs/list: List active VFSes. {#vfs\-list} - +.SS vfs/list: List active VFSes. +.PP This lists the active VFSes. - -It returns a list under the key \[dq]vfses\[dq] where the values are the VFS -names that could be passed to the other VFS commands in the \[dq]fs\[dq] -parameter. - -### vfs/poll\-interval: Get the status or update the value of the poll\-interval option. {#vfs\-poll\-interval} - +.PP +It returns a list under the key \[dq]vfses\[dq] where the values are the +VFS names that could be passed to the other VFS commands in the +\[dq]fs\[dq] parameter. +.SS vfs/poll\-interval: Get the status or update the value of the poll\-interval option. +.PP Without any parameter given this returns the current status of the poll\-interval setting. - -When the interval=duration parameter is set, the poll\-interval value -is updated and the polling function is notified. +.PP +When the interval=duration parameter is set, the poll\-interval value is +updated and the polling function is notified. Setting interval=0 disables poll\-interval. - - rclone rc vfs/poll\-interval interval=5m - -The timeout=duration parameter can be used to specify a time to wait -for the current poll function to apply the new value. +.IP +.nf +\f[C] +rclone rc vfs/poll\-interval interval=5m +\f[R] +.fi +.PP +The timeout=duration parameter can be used to specify a time to wait for +the current poll function to apply the new value. If timeout is less or equal 0, which is the default, wait indefinitely. - -The new poll\-interval value will only be active when the timeout is -not reached. - -If poll\-interval is updated or disabled temporarily, some changes -might not get picked up by the polling function, depending on the -used remote. - -This command takes an \[dq]fs\[dq] parameter. If this parameter is not -supplied and if there is only one VFS in use then that VFS will be -used. If there is more than one VFS in use then the \[dq]fs\[dq] parameter +.PP +The new poll\-interval value will only be active when the timeout is not +reached. +.PP +If poll\-interval is updated or disabled temporarily, some changes might +not get picked up by the polling function, depending on the used remote. +.PP +This command takes an \[dq]fs\[dq] parameter. +If this parameter is not supplied and if there is only one VFS in use +then that VFS will be used. +If there is more than one VFS in use then the \[dq]fs\[dq] parameter must be supplied. - -### vfs/refresh: Refresh the directory cache. {#vfs\-refresh} - +.SS vfs/refresh: Refresh the directory cache. +.PP This reads the directories for the specified paths and freshens the directory cache. - +.PP If no paths are passed in then it will refresh the root directory. - - rclone rc vfs/refresh - -Otherwise pass directories in as dir=path. Any parameter key -starting with dir will refresh that directory, eg - - rclone rc vfs/refresh dir=home/junk dir2=data/misc - -If the parameter recursive=true is given the whole directory tree -will get refreshed. This refresh will use \-\-fast\-list if enabled. - -This command takes an \[dq]fs\[dq] parameter. If this parameter is not -supplied and if there is only one VFS in use then that VFS will be -used. If there is more than one VFS in use then the \[dq]fs\[dq] parameter +.IP +.nf +\f[C] +rclone rc vfs/refresh +\f[R] +.fi +.PP +Otherwise pass directories in as dir=path. +Any parameter key starting with dir will refresh that directory, eg +.IP +.nf +\f[C] +rclone rc vfs/refresh dir=home/junk dir2=data/misc +\f[R] +.fi +.PP +If the parameter recursive=true is given the whole directory tree will +get refreshed. +This refresh will use \-\-fast\-list if enabled. +.PP +This command takes an \[dq]fs\[dq] parameter. +If this parameter is not supplied and if there is only one VFS in use +then that VFS will be used. +If there is more than one VFS in use then the \[dq]fs\[dq] parameter must be supplied. - - - -## Accessing the remote control via HTTP - +.SS Accessing the remote control via HTTP +.PP Rclone implements a simple HTTP based protocol. - +.PP Each endpoint takes an JSON object and returns a JSON object or an -error. The JSON objects are essentially a map of string names to -values. - +error. +The JSON objects are essentially a map of string names to values. +.PP All calls must made using POST. - -The input objects can be supplied using URL parameters, POST -parameters or by supplying \[dq]Content\-Type: application/json\[dq] and a JSON -blob in the body. There are examples of these below using \[ga]curl\[ga]. - -The response will be a JSON blob in the body of the response. This is -formatted to be reasonably human readable. - -### Error returns - -If an error occurs then there will be an HTTP error status (eg 500) -and the body of the response will contain a JSON encoded error object, -eg -\f[R] -.fi .PP -{ \[dq]error\[dq]: \[dq]Expecting string value for key \[dq]remote\[dq] -(was float64)\[dq], \[dq]input\[dq]: { \[dq]fs\[dq]: \[dq]/tmp\[dq], -\[dq]remote\[dq]: 3 }, \[dq]status\[dq]: 400 \[dq]path\[dq]: -\[dq]operations/rmdir\[dq], } +The input objects can be supplied using URL parameters, POST parameters +or by supplying \[dq]Content\-Type: application/json\[dq] and a JSON +blob in the body. +There are examples of these below using \f[C]curl\f[R]. +.PP +The response will be a JSON blob in the body of the response. +This is formatted to be reasonably human readable. +.SS Error returns +.PP +If an error occurs then there will be an HTTP error status (eg 500) and +the body of the response will contain a JSON encoded error object, eg .IP .nf \f[C] - -The keys in the error response are -\- error \- error string -\- input \- the input parameters to the call -\- status \- the HTTP status code -\- path \- the path of the call - -### CORS - +{ + \[dq]error\[dq]: \[dq]Expecting string value for key \[rs]\[dq]remote\[rs]\[dq] (was float64)\[dq], + \[dq]input\[dq]: { + \[dq]fs\[dq]: \[dq]/tmp\[dq], + \[dq]remote\[dq]: 3 + }, + \[dq]status\[dq]: 400 + \[dq]path\[dq]: \[dq]operations/rmdir\[dq], +} +\f[R] +.fi +.PP +The keys in the error response are \- error \- error string \- input \- +the input parameters to the call \- status \- the HTTP status code \- +path \- the path of the call +.SS CORS +.PP The sever implements basic CORS support and allows all origins for that. -The response to a preflight OPTIONS request will echo the requested \[dq]Access\-Control\-Request\-Headers\[dq] back. - -### Using POST with URL parameters only -\f[R] -.fi -.PP +The response to a preflight OPTIONS request will echo the requested +\[dq]Access\-Control\-Request\-Headers\[dq] back. +.SS Using POST with URL parameters only +.IP +.nf +\f[C] curl \-X POST \[aq]http://localhost:5572/rc/noop?potato=1&sausage=2\[aq] -.IP -.nf -\f[C] - -Response \f[R] .fi .PP -{ \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } +Response .IP .nf \f[C] - +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] +} +\f[R] +.fi +.PP Here is what an error response looks like: -\f[R] -.fi -.PP -curl \-X POST -\[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] .IP .nf \f[C] +curl \-X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] \f[R] .fi -.PP -{ \[dq]error\[dq]: \[dq]arbitrary error on input map[potato:1 -sausage:2]\[dq], \[dq]input\[dq]: { \[dq]potato\[dq]: \[dq]1\[dq], -\[dq]sausage\[dq]: \[dq]2\[dq] } } .IP .nf \f[C] - -Note that curl doesn\[aq]t return errors to the shell unless you use the \[ga]\-f\[ga] option +{ + \[dq]error\[dq]: \[dq]arbitrary error on input map[potato:1 sausage:2]\[dq], + \[dq]input\[dq]: { + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] + } +} \f[R] .fi .PP -$ curl \-f \-X POST -\[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] curl: (22) -The requested URL returned error: 400 Bad Request $ echo $? +Note that curl doesn\[aq]t return errors to the shell unless you use the +\f[C]\-f\f[R] option +.IP +.nf +\f[C] +$ curl \-f \-X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] +curl: (22) The requested URL returned error: 400 Bad Request +$ echo $? 22 +\f[R] +.fi +.SS Using POST with a form .IP .nf \f[C] - -### Using POST with a form +curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] http://localhost:5572/rc/noop \f[R] .fi .PP -curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] -http://localhost:5572/rc/noop -.IP -.nf -\f[C] - Response -\f[R] -.fi -.PP -{ \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } .IP .nf \f[C] - +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] +} +\f[R] +.fi +.PP Note that you can combine these with URL parameters too with the POST parameters taking precedence. -\f[R] -.fi -.PP -curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] -\[dq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[dq] .IP .nf \f[C] - +curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] \[dq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[dq] +\f[R] +.fi +.PP Response -\f[R] -.fi -.PP -{ \[dq]potato\[dq]: \[dq]1\[dq], \[dq]rutabaga\[dq]: \[dq]3\[dq], -\[dq]sausage\[dq]: \[dq]4\[dq] } .IP .nf \f[C] - -### Using POST with a JSON blob +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]rutabaga\[dq]: \[dq]3\[dq], + \[dq]sausage\[dq]: \[dq]4\[dq] +} \f[R] .fi -.PP -curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d -\[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] -http://localhost:5572/rc/noop +.SS Using POST with a JSON blob .IP .nf \f[C] - +curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d \[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] http://localhost:5572/rc/noop +\f[R] +.fi +.PP response -\f[R] -.fi -.PP -{ \[dq]password\[dq]: \[dq]xyz\[dq], \[dq]username\[dq]: \[dq]xyz\[dq] } .IP .nf \f[C] - -This can be combined with URL parameters too if required. The JSON -blob takes precedence. +{ + \[dq]password\[dq]: \[dq]xyz\[dq], + \[dq]username\[dq]: \[dq]xyz\[dq] +} \f[R] .fi .PP -curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d -\[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] -\[aq]http://localhost:5572/rc/noop?rutabaga=3&potato=4\[aq] +This can be combined with URL parameters too if required. +The JSON blob takes precedence. .IP .nf \f[C] +curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d \[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] \[aq]http://localhost:5572/rc/noop?rutabaga=3&potato=4\[aq] \f[R] .fi -.PP -{ \[dq]potato\[dq]: 2, \[dq]rutabaga\[dq]: \[dq]3\[dq], -\[dq]sausage\[dq]: 1 } .IP .nf \f[C] - -## Debugging rclone with pprof ## - -If you use the \[ga]\-\-rc\[ga] flag this will also enable the use of the go -profiling tools on the same port. - -To use these, first [install go](https://golang.org/doc/install). - -### Debugging memory use - +{ + \[dq]potato\[dq]: 2, + \[dq]rutabaga\[dq]: \[dq]3\[dq], + \[dq]sausage\[dq]: 1 +} +\f[R] +.fi +.SS Debugging rclone with pprof +.PP +If you use the \f[C]\-\-rc\f[R] flag this will also enable the use of +the go profiling tools on the same port. +.PP +To use these, first install go (https://golang.org/doc/install). +.SS Debugging memory use +.PP To profile rclone\[aq]s memory use you can run: - - go tool pprof \-web http://localhost:5572/debug/pprof/heap - +.IP +.nf +\f[C] +go tool pprof \-web http://localhost:5572/debug/pprof/heap +\f[R] +.fi +.PP This should open a page in your browser showing what is using what memory. - -You can also use the \[ga]\-text\[ga] flag to produce a textual summary -\f[R] -.fi .PP -$ go tool pprof \-text http://localhost:5572/debug/pprof/heap Showing -nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% -cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode -513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% -1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% -100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% -net/http.(\f[I]conn).readRequest 0 0% 100% 513kB 33.38% -net/http.(\f[R]conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main +You can also use the \f[C]\-text\f[R] flag to produce a textual summary .IP .nf \f[C] - -### Debugging go routine leaks - +$ go tool pprof \-text http://localhost:5572/debug/pprof/heap +Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total + flat flat% sum% cum cum% + 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode + 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 + 0 0% 100% 1024.03kB 66.62% main.init + 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest + 0 0% 100% 513kB 33.38% net/http.(*conn).serve + 0 0% 100% 1024.03kB 66.62% runtime.main +\f[R] +.fi +.SS Debugging go routine leaks +.PP Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected. - +.PP See all active go routines using - - curl http://localhost:5572/debug/pprof/goroutine?debug=1 - -Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. - -### Other profiles to look at - -You can see a summary of profiles available at http://localhost:5572/debug/pprof/ - +.IP +.nf +\f[C] +curl http://localhost:5572/debug/pprof/goroutine?debug=1 +\f[R] +.fi +.PP +Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your +browser. +.SS Other profiles to look at +.PP +You can see a summary of profiles available at +http://localhost:5572/debug/pprof/ +.PP Here is how to use some of them: - -\- Memory: \[ga]go tool pprof http://localhost:5572/debug/pprof/heap\[ga] -\- Go routines: \[ga]curl http://localhost:5572/debug/pprof/goroutine?debug=1\[ga] -\- 30\-second CPU profile: \[ga]go tool pprof http://localhost:5572/debug/pprof/profile\[ga] -\- 5\-second execution trace: \[ga]wget http://localhost:5572/debug/pprof/trace?seconds=5\[ga] -\- Goroutine blocking profile - \- Enable first with: \[ga]rclone rc debug/set\-block\-profile\-rate rate=1\[ga] ([docs](#debug/set\-block\-profile\-rate)) - \- \[ga]go tool pprof http://localhost:5572/debug/pprof/block\[ga] -\- Contended mutexes: - \- Enable first with: \[ga]rclone rc debug/set\-mutex\-profile\-fraction rate=1\[ga] ([docs](#debug/set\-mutex\-profile\-fraction)) - \- \[ga]go tool pprof http://localhost:5572/debug/pprof/mutex\[ga] - -See the [net/http/pprof docs](https://golang.org/pkg/net/http/pprof/) -for more info on how to use the profiling and for a general overview -see [the Go team\[aq]s blog post on profiling go programs](https://blog.golang.org/profiling\-go\-programs). - -The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). - -# Overview of cloud storage systems # - -Each cloud storage system is slightly different. Rclone attempts to -provide a unified interface to them, but some underlying differences -show through. - -## Features ## - +.IP \[bu] 2 +Memory: \f[C]go tool pprof http://localhost:5572/debug/pprof/heap\f[R] +.IP \[bu] 2 +Go routines: +\f[C]curl http://localhost:5572/debug/pprof/goroutine?debug=1\f[R] +.IP \[bu] 2 +30\-second CPU profile: +\f[C]go tool pprof http://localhost:5572/debug/pprof/profile\f[R] +.IP \[bu] 2 +5\-second execution trace: +\f[C]wget http://localhost:5572/debug/pprof/trace?seconds=5\f[R] +.IP \[bu] 2 +Goroutine blocking profile +.RS 2 +.IP \[bu] 2 +Enable first with: +\f[C]rclone rc debug/set\-block\-profile\-rate rate=1\f[R] (docs) +.IP \[bu] 2 +\f[C]go tool pprof http://localhost:5572/debug/pprof/block\f[R] +.RE +.IP \[bu] 2 +Contended mutexes: +.RS 2 +.IP \[bu] 2 +Enable first with: +\f[C]rclone rc debug/set\-mutex\-profile\-fraction rate=1\f[R] (docs) +.IP \[bu] 2 +\f[C]go tool pprof http://localhost:5572/debug/pprof/mutex\f[R] +.RE +.PP +See the net/http/pprof docs (https://golang.org/pkg/net/http/pprof/) for +more info on how to use the profiling and for a general overview see the +Go team\[aq]s blog post on profiling go +programs (https://blog.golang.org/profiling-go-programs). +.PP +The profiling hook is zero overhead unless it is +used (https://stackoverflow.com/q/26545159/164234). +.SH Overview of cloud storage systems +.PP +Each cloud storage system is slightly different. +Rclone attempts to provide a unified interface to them, but some +underlying differences show through. +.SS Features +.PP Here is an overview of the major features of each cloud storage system. - -| Name | Hash | ModTime | Case Insensitive | Duplicate Files | MIME Type | -| \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-:| -| 1Fichier | Whirlpool | No | No | Yes | R | -| Amazon Drive | MD5 | No | Yes | No | R | -| Amazon S3 | MD5 | Yes | No | No | R/W | -| Backblaze B2 | SHA1 | Yes | No | No | R/W | -| Box | SHA1 | Yes | Yes | No | \- | -| Citrix ShareFile | MD5 | Yes | Yes | No | \- | -| Dropbox | DBHASH \[dg] | Yes | Yes | No | \- | -| FTP | \- | No | No | No | \- | -| Google Cloud Storage | MD5 | Yes | No | No | R/W | -| Google Drive | MD5 | Yes | No | Yes | R/W | -| Google Photos | \- | No | No | Yes | R | -| HTTP | \- | No | No | No | R | -| Hubic | MD5 | Yes | No | No | R/W | -| Jottacloud | MD5 | Yes | Yes | No | R/W | -| Koofr | MD5 | No | Yes | No | \- | -| Mail.ru Cloud | Mailru \[dd]\[dd]\[dd] | Yes | Yes | No | \- | -| Mega | \- | No | No | Yes | \- | -| Memory | MD5 | Yes | No | No | \- | -| Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | -| Microsoft OneDrive | SHA1 \[dd]\[dd] | Yes | Yes | No | R | -| OpenDrive | MD5 | Yes | Yes | Partial \[rs]* | \- | -| OpenStack Swift | MD5 | Yes | No | No | R/W | -| pCloud | MD5, SHA1 | Yes | No | No | W | -| premiumize.me | \- | No | Yes | No | R | -| put.io | CRC\-32 | Yes | No | Yes | R | -| QingStor | MD5 | No | No | No | R/W | -| Seafile | \- | No | No | No | \- | -| SFTP | MD5, SHA1 \[dd] | Yes | Depends | No | \- | -| SugarSync | \- | No | No | No | \- | -| Tardigrade | \- | Yes | No | No | \- | -| WebDAV | MD5, SHA1 \[dg]\[dg]| Yes \[dg]\[dg]\[dg] | Depends | No | \- | -| Yandex Disk | MD5 | Yes | No | No | R/W | -| The local filesystem | All | Yes | Depends | No | \- | - -### Hash ### - +.PP +.TS +tab(@); +l c c c c c. +T{ +Name +T}@T{ +Hash +T}@T{ +ModTime +T}@T{ +Case Insensitive +T}@T{ +Duplicate Files +T}@T{ +MIME Type +T} +_ +T{ +1Fichier +T}@T{ +Whirlpool +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +Amazon Drive +T}@T{ +MD5 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +Amazon S3 +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Backblaze B2 +T}@T{ +SHA1 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Box +T}@T{ +SHA1 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Citrix ShareFile +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Dropbox +T}@T{ +DBHASH \[dg] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +FTP +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Google Cloud Storage +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Google Drive +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +R/W +T} +T{ +Google Photos +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +HTTP +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +R +T} +T{ +Hubic +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Jottacloud +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +R/W +T} +T{ +Koofr +T}@T{ +MD5 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Mail.ru Cloud +T}@T{ +Mailru \[dd]\[dd]\[dd] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Mega +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +\- +T} +T{ +Memory +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Microsoft Azure Blob Storage +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Microsoft OneDrive +T}@T{ +SHA1 \[dd]\[dd] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +OpenDrive +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Partial * +T}@T{ +\- +T} +T{ +OpenStack Swift +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +pCloud +T}@T{ +MD5, SHA1 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +W +T} +T{ +premiumize.me +T}@T{ +\- +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +put.io +T}@T{ +CRC\-32 +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +QingStor +T}@T{ +MD5 +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Seafile +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +SFTP +T}@T{ +MD5, SHA1 \[dd] +T}@T{ +Yes +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +T{ +SugarSync +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Tardigrade +T}@T{ +\- +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +WebDAV +T}@T{ +MD5, SHA1 \[dg]\[dg] +T}@T{ +Yes \[dg]\[dg]\[dg] +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +T{ +Yandex Disk +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +The local filesystem +T}@T{ +All +T}@T{ +Yes +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +.TE +.SS Hash +.PP The cloud storage system supports various hash types of the objects. -The hashes are used when transferring data as an integrity check and -can be specifically used with the \[ga]\-\-checksum\[ga] flag in syncs and in -the \[ga]check\[ga] command. - +The hashes are used when transferring data as an integrity check and can +be specifically used with the \f[C]\-\-checksum\f[R] flag in syncs and +in the \f[C]check\f[R] command. +.PP To use the verify checksums when transferring between cloud storage systems they must support a common hash type. - -\[dg] Note that Dropbox supports [its own custom -hash](https://www.dropbox.com/developers/reference/content\-hash). +.PP +\[dg] Note that Dropbox supports its own custom +hash (https://www.dropbox.com/developers/reference/content-hash). This is an SHA256 sum of all the 4MB block SHA256s. - -\[dd] SFTP supports checksums if the same login has shell access and \[ga]md5sum\[ga] -or \[ga]sha1sum\[ga] as well as \[ga]echo\[ga] are in the remote\[aq]s PATH. - -\[dg]\[dg] WebDAV supports hashes when used with Owncloud and Nextcloud only. - -\[dg]\[dg]\[dg] WebDAV supports modtimes when used with Owncloud and Nextcloud only. - -\[dd]\[dd] Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive -for business and SharePoint server support Microsoft\[aq]s own -[QuickXorHash](https://docs.microsoft.com/en\-us/onedrive/developer/code\-snippets/quickxorhash). - +.PP +\[dd] SFTP supports checksums if the same login has shell access and +\f[C]md5sum\f[R] or \f[C]sha1sum\f[R] as well as \f[C]echo\f[R] are in +the remote\[aq]s PATH. +.PP +\[dg]\[dg] WebDAV supports hashes when used with Owncloud and Nextcloud +only. +.PP +\[dg]\[dg]\[dg] WebDAV supports modtimes when used with Owncloud and +Nextcloud only. +.PP +\[dd]\[dd] Microsoft OneDrive Personal supports SHA1 hashes, whereas +OneDrive for business and SharePoint server support Microsoft\[aq]s own +QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). +.PP \[dd]\[dd]\[dd] Mail.ru uses its own modified SHA1 hash - -### ModTime ### - -The cloud storage system supports setting modification times on -objects. If it does then this enables a using the modification times -as part of the sync. If not then only the size will be checked by -default, though the MD5SUM can be checked with the \[ga]\-\-checksum\[ga] flag. - +.SS ModTime +.PP +The cloud storage system supports setting modification times on objects. +If it does then this enables a using the modification times as part of +the sync. +If not then only the size will be checked by default, though the MD5SUM +can be checked with the \f[C]\-\-checksum\f[R] flag. +.PP All cloud storage systems support some kind of date on the object and these will be set when transferring from the cloud storage system. - -### Case Insensitive ### - -If a cloud storage systems is case sensitive then it is possible to -have two files which differ only in case, eg \[ga]file.txt\[ga] and -\[ga]FILE.txt\[ga]. If a cloud storage system is case insensitive then that -isn\[aq]t possible. - -This can cause problems when syncing between a case insensitive -system and a case sensitive system. The symptom of this is that no -matter how many times you run the sync it never completes fully. - -The local filesystem and SFTP may or may not be case sensitive -depending on OS. - - * Windows \- usually case insensitive, though case is preserved - * OSX \- usually case insensitive, though it is possible to format case sensitive - * Linux \- usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys) - +.SS Case Insensitive +.PP +If a cloud storage systems is case sensitive then it is possible to have +two files which differ only in case, eg \f[C]file.txt\f[R] and +\f[C]FILE.txt\f[R]. +If a cloud storage system is case insensitive then that isn\[aq]t +possible. +.PP +This can cause problems when syncing between a case insensitive system +and a case sensitive system. +The symptom of this is that no matter how many times you run the sync it +never completes fully. +.PP +The local filesystem and SFTP may or may not be case sensitive depending +on OS. +.IP \[bu] 2 +Windows \- usually case insensitive, though case is preserved +.IP \[bu] 2 +OSX \- usually case insensitive, though it is possible to format case +sensitive +.IP \[bu] 2 +Linux \- usually case sensitive, but there are case insensitive file +systems (eg FAT formatted USB keys) +.PP Most of the time this doesn\[aq]t cause any problems as people tend to avoid files whose name differs only by case even on case sensitive systems. - -### Duplicate files ### - +.SS Duplicate files +.PP If a cloud storage system allows duplicate files then it can have two objects with the same name. - -This confuses rclone greatly when syncing \- use the \[ga]rclone dedupe\[ga] -command to rename or remove duplicates. - -\[rs]* Opendrive does not support creation of duplicate files using -their web client interface or other stock clients, but the underlying -storage platform has been determined to allow duplicate files, and it -is possible to create them with \[ga]rclone\[ga]. It may be that this is a -mistake or an unsupported feature. - -### Restricted filenames ### - +.PP +This confuses rclone greatly when syncing \- use the +\f[C]rclone dedupe\f[R] command to rename or remove duplicates. +.PP +* Opendrive does not support creation of duplicate files using their web +client interface or other stock clients, but the underlying storage +platform has been determined to allow duplicate files, and it is +possible to create them with \f[C]rclone\f[R]. +It may be that this is a mistake or an unsupported feature. +.SS Restricted filenames +.PP Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. -When \[ga]rclone\[ga] detects such a name during a file upload, it will +When \f[C]rclone\f[R] detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters. - +.PP This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently. - -The name shown by \[ga]rclone\[ga] to the user or during log output will only -contain a minimal set of [replaced characters](#restricted\-characters) -to ensure correct formatting and not necessarily the actual name used -on the cloud storage. - +.PP +The name shown by \f[C]rclone\f[R] to the user or during log output will +only contain a minimal set of replaced characters to ensure correct +formatting and not necessarily the actual name used on the cloud +storage. +.PP This transformation is reversed when downloading a file or parsing -\[ga]rclone\[ga] arguments. -For example, when uploading a file named \[ga]my file?.txt\[ga] to Onedrive -will be displayed as \[ga]my file?.txt\[ga] on the console, but stored as -\[ga]my file\[uFF1F].txt\[ga] (the \[ga]?\[ga] gets replaced by the similar looking \[ga]\[uFF1F]\[ga] -character) to Onedrive. -The reverse transformation allows to read a file\[ga]unusual/name.txt\[ga] -from Google Drive, by passing the name \[ga]unusual\[uFF0F]name.txt\[ga] (the \[ga]/\[ga] needs -to be replaced by the similar looking \[ga]\[uFF0F]\[ga] character) on the command line. - -#### Default restricted characters {#restricted\-characters} - +\f[C]rclone\f[R] arguments. +For example, when uploading a file named \f[C]my file?.txt\f[R] to +Onedrive will be displayed as \f[C]my file?.txt\f[R] on the console, but +stored as \f[C]my file\[uFF1F].txt\f[R] (the \f[C]?\f[R] gets replaced +by the similar looking \f[C]\[uFF1F]\f[R] character) to Onedrive. +The reverse transformation allows to read a +file\f[C]unusual/name.txt\f[R] from Google Drive, by passing the name +\f[C]unusual\[uFF0F]name.txt\f[R] (the \f[C]/\f[R] needs to be replaced +by the similar looking \f[C]\[uFF0F]\f[R] character) on the command +line. +.SS Default restricted characters +.PP The table below shows the characters that are replaced by default. - -When a replacement character is found in a filename, this character -will be escaped with the \[ga]\[u201B]\[ga] character to avoid ambiguous file names. -(e.g. a file named \[ga]\[u2400].txt\[ga] would shown as \[ga]\[u201B]\[u2400].txt\[ga]) - -Each cloud storage backend can use a different set of characters, -which will be specified in the documentation for each backend. - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| SOH | 0x01 | \[u2401] | -| STX | 0x02 | \[u2402] | -| ETX | 0x03 | \[u2403] | -| EOT | 0x04 | \[u2404] | -| ENQ | 0x05 | \[u2405] | -| ACK | 0x06 | \[u2406] | -| BEL | 0x07 | \[u2407] | -| BS | 0x08 | \[u2408] | -| HT | 0x09 | \[u2409] | -| LF | 0x0A | \[u240A] | -| VT | 0x0B | \[u240B] | -| FF | 0x0C | \[u240C] | -| CR | 0x0D | \[u240D] | -| SO | 0x0E | \[u240E] | -| SI | 0x0F | \[u240F] | -| DLE | 0x10 | \[u2410] | -| DC1 | 0x11 | \[u2411] | -| DC2 | 0x12 | \[u2412] | -| DC3 | 0x13 | \[u2413] | -| DC4 | 0x14 | \[u2414] | -| NAK | 0x15 | \[u2415] | -| SYN | 0x16 | \[u2416] | -| ETB | 0x17 | \[u2417] | -| CAN | 0x18 | \[u2418] | -| EM | 0x19 | \[u2419] | -| SUB | 0x1A | \[u241A] | -| ESC | 0x1B | \[u241B] | -| FS | 0x1C | \[u241C] | -| GS | 0x1D | \[u241D] | -| RS | 0x1E | \[u241E] | -| US | 0x1F | \[u241F] | -| / | 0x2F | \[uFF0F] | -| DEL | 0x7F | \[u2421] | - +.PP +When a replacement character is found in a filename, this character will +be escaped with the \f[C]\[u201B]\f[R] character to avoid ambiguous file +names. +(e.g. +a file named \f[C]\[u2400].txt\f[R] would shown as +\f[C]\[u201B]\[u2400].txt\f[R]) +.PP +Each cloud storage backend can use a different set of characters, which +will be specified in the documentation for each backend. +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +SOH +T}@T{ +0x01 +T}@T{ +\[u2401] +T} +T{ +STX +T}@T{ +0x02 +T}@T{ +\[u2402] +T} +T{ +ETX +T}@T{ +0x03 +T}@T{ +\[u2403] +T} +T{ +EOT +T}@T{ +0x04 +T}@T{ +\[u2404] +T} +T{ +ENQ +T}@T{ +0x05 +T}@T{ +\[u2405] +T} +T{ +ACK +T}@T{ +0x06 +T}@T{ +\[u2406] +T} +T{ +BEL +T}@T{ +0x07 +T}@T{ +\[u2407] +T} +T{ +BS +T}@T{ +0x08 +T}@T{ +\[u2408] +T} +T{ +HT +T}@T{ +0x09 +T}@T{ +\[u2409] +T} +T{ +LF +T}@T{ +0x0A +T}@T{ +\[u240A] +T} +T{ +VT +T}@T{ +0x0B +T}@T{ +\[u240B] +T} +T{ +FF +T}@T{ +0x0C +T}@T{ +\[u240C] +T} +T{ +CR +T}@T{ +0x0D +T}@T{ +\[u240D] +T} +T{ +SO +T}@T{ +0x0E +T}@T{ +\[u240E] +T} +T{ +SI +T}@T{ +0x0F +T}@T{ +\[u240F] +T} +T{ +DLE +T}@T{ +0x10 +T}@T{ +\[u2410] +T} +T{ +DC1 +T}@T{ +0x11 +T}@T{ +\[u2411] +T} +T{ +DC2 +T}@T{ +0x12 +T}@T{ +\[u2412] +T} +T{ +DC3 +T}@T{ +0x13 +T}@T{ +\[u2413] +T} +T{ +DC4 +T}@T{ +0x14 +T}@T{ +\[u2414] +T} +T{ +NAK +T}@T{ +0x15 +T}@T{ +\[u2415] +T} +T{ +SYN +T}@T{ +0x16 +T}@T{ +\[u2416] +T} +T{ +ETB +T}@T{ +0x17 +T}@T{ +\[u2417] +T} +T{ +CAN +T}@T{ +0x18 +T}@T{ +\[u2418] +T} +T{ +EM +T}@T{ +0x19 +T}@T{ +\[u2419] +T} +T{ +SUB +T}@T{ +0x1A +T}@T{ +\[u241A] +T} +T{ +ESC +T}@T{ +0x1B +T}@T{ +\[u241B] +T} +T{ +FS +T}@T{ +0x1C +T}@T{ +\[u241C] +T} +T{ +GS +T}@T{ +0x1D +T}@T{ +\[u241D] +T} +T{ +RS +T}@T{ +0x1E +T}@T{ +\[u241E] +T} +T{ +US +T}@T{ +0x1F +T}@T{ +\[u241F] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +T{ +DEL +T}@T{ +0x7F +T}@T{ +\[u2421] +T} +.TE +.PP The default encoding will also encode these file names as they are problematic with many cloud storage systems. - -| File name | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-:| -| . | \[uFF0E] | -| .. | \[uFF0E]\[uFF0E] | - -#### Invalid UTF\-8 bytes {#invalid\-utf8} - -Some backends only support a sequence of well formed UTF\-8 bytes -as file or directory names. - +.PP +.TS +tab(@); +l c. +T{ +File name +T}@T{ +Replacement +T} +_ +T{ +\&. +T}@T{ +\[uFF0E] +T} +T{ +\&.. +T}@T{ +\[uFF0E]\[uFF0E] +T} +.TE +.SS Invalid UTF\-8 bytes +.PP +Some backends only support a sequence of well formed UTF\-8 bytes as +file or directory names. +.PP In this case all invalid UTF\-8 bytes will be replaced with a quoted representation of the byte value to allow uploading a file to such a -backend. For example, the invalid byte \[ga]0xFE\[ga] will be encoded as \[ga]\[u201B]FE\[ga]. - -A common source of invalid UTF\-8 bytes are local filesystems, that store -names in a different encoding than UTF\-8 or UTF\-16, like latin1. See the -[local filenames](https://rclone.org/local/#filenames) section for details. - -#### Encoding option {#encoding} - +backend. +For example, the invalid byte \f[C]0xFE\f[R] will be encoded as +\f[C]\[u201B]FE\f[R]. +.PP +A common source of invalid UTF\-8 bytes are local filesystems, that +store names in a different encoding than UTF\-8 or UTF\-16, like latin1. +See the local filenames (https://rclone.org/local/#filenames) section +for details. +.SS Encoding option +.PP Most backends have an encoding options, specified as a flag -\[ga]\-\-backend\-encoding\[ga] where \[ga]backend\[ga] is the name of the backend, or as -a config parameter \[ga]encoding\[ga] (you\[aq]ll need to select the Advanced -config in \[ga]rclone config\[ga] to see it). - +\f[C]\-\-backend\-encoding\f[R] where \f[C]backend\f[R] is the name of +the backend, or as a config parameter \f[C]encoding\f[R] (you\[aq]ll +need to select the Advanced config in \f[C]rclone config\f[R] to see +it). +.PP This will have default value which encodes and decodes characters in -such a way as to preserve the maximum number of characters (see -above). - -However this can be incorrect in some scenarios, for example if you -have a Windows file system with characters such as \[ga]\[uFF0A]\[ga] and \[ga]\[uFF1F]\[ga] that -you want to remain as those characters on the remote rather than being -translated to \[ga]*\[ga] and \[ga]?\[ga]. - -The \[ga]\-\-backend\-encoding\[ga] flags allow you to change that. You can -disable the encoding completely with \[ga]\-\-backend\-encoding None\[ga] or set -\[ga]encoding = None\[ga] in the config file. - -Encoding takes a comma separated list of encodings. You can see the -list of all available characters by passing an invalid value to this -flag, eg \[ga]\-\-local\-encoding \[dq]help\[dq]\[ga] and \[ga]rclone help flags encoding\[ga] -will show you the defaults for the backends. - -| Encoding | Characters | -| \-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\- | -| Asterisk | \[ga]*\[ga] | -| BackQuote | \[ga]\[ga] \[ga] \[ga]\[ga] | -| BackSlash | \[ga]\[rs]\[ga] | -| Colon | \[ga]:\[ga] | -| CrLf | CR 0x0D, LF 0x0A | -| Ctl | All control characters 0x00\-0x1F | -| Del | DEL 0x7F | -| Dollar | \[ga]$\[ga] | -| Dot | \[ga].\[ga] | -| DoubleQuote | \[ga]\[dq]\[ga] | -| Hash | \[ga]#\[ga] | -| InvalidUtf8 | An invalid UTF\-8 character (eg latin1) | -| LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string | -| LeftPeriod | \[ga].\[ga] on the left of a string | -| LeftSpace | SPACE on the left of a string | -| LeftTilde | \[ga]\[ti]\[ga] on the left of a string | -| LtGt | \[ga]<\[ga], \[ga]>\[ga] | -| None | No characters are encoded | -| Percent | \[ga]%\[ga] | -| Pipe | \[rs]| | -| Question | \[ga]?\[ga] | -| RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string | -| RightPeriod | \[ga].\[ga] on the right of a string | -| RightSpace | SPACE on the right of a string | -| SingleQuote | \[ga]\[aq]\[ga] | -| Slash | \[ga]/\[ga] | - +such a way as to preserve the maximum number of characters (see above). +.PP +However this can be incorrect in some scenarios, for example if you have +a Windows file system with characters such as \f[C]\[uFF0A]\f[R] and +\f[C]\[uFF1F]\f[R] that you want to remain as those characters on the +remote rather than being translated to \f[C]*\f[R] and \f[C]?\f[R]. +.PP +The \f[C]\-\-backend\-encoding\f[R] flags allow you to change that. +You can disable the encoding completely with +\f[C]\-\-backend\-encoding None\f[R] or set \f[C]encoding = None\f[R] in +the config file. +.PP +Encoding takes a comma separated list of encodings. +You can see the list of all available characters by passing an invalid +value to this flag, eg \f[C]\-\-local\-encoding \[dq]help\[dq]\f[R] and +\f[C]rclone help flags encoding\f[R] will show you the defaults for the +backends. +.PP +.TS +tab(@); +l l. +T{ +Encoding +T}@T{ +Characters +T} +_ +T{ +Asterisk +T}@T{ +\f[C]*\f[R] +T} +T{ +BackQuote +T}@T{ +\f[C]\[ga]\f[R] +T} +T{ +BackSlash +T}@T{ +\f[C]\[rs]\f[R] +T} +T{ +Colon +T}@T{ +\f[C]:\f[R] +T} +T{ +CrLf +T}@T{ +CR 0x0D, LF 0x0A +T} +T{ +Ctl +T}@T{ +All control characters 0x00\-0x1F +T} +T{ +Del +T}@T{ +DEL 0x7F +T} +T{ +Dollar +T}@T{ +\f[C]$\f[R] +T} +T{ +Dot +T}@T{ +\f[C].\f[R] +T} +T{ +DoubleQuote +T}@T{ +\f[C]\[dq]\f[R] +T} +T{ +Hash +T}@T{ +\f[C]#\f[R] +T} +T{ +InvalidUtf8 +T}@T{ +An invalid UTF\-8 character (eg latin1) +T} +T{ +LeftCrLfHtVt +T}@T{ +CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string +T} +T{ +LeftPeriod +T}@T{ +\f[C].\f[R] on the left of a string +T} +T{ +LeftSpace +T}@T{ +SPACE on the left of a string +T} +T{ +LeftTilde +T}@T{ +\f[C]\[ti]\f[R] on the left of a string +T} +T{ +LtGt +T}@T{ +\f[C]<\f[R], \f[C]>\f[R] +T} +T{ +None +T}@T{ +No characters are encoded +T} +T{ +Percent +T}@T{ +\f[C]%\f[R] +T} +T{ +Pipe +T}@T{ +| +T} +T{ +Question +T}@T{ +\f[C]?\f[R] +T} +T{ +RightCrLfHtVt +T}@T{ +CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string +T} +T{ +RightPeriod +T}@T{ +\f[C].\f[R] on the right of a string +T} +T{ +RightSpace +T}@T{ +SPACE on the right of a string +T} +T{ +SingleQuote +T}@T{ +\f[C]\[aq]\f[R] +T} +T{ +Slash +T}@T{ +\f[C]/\f[R] +T} +.TE +.PP To take a specific example, the FTP backend\[aq]s default encoding is - - \-\-ftp\-encoding \[dq]Slash,Del,Ctl,RightSpace,Dot\[dq] - -However, let\[aq]s say the FTP server is running on Windows and can\[aq]t have -any of the invalid Windows characters in file names. You are backing -up Linux servers to this FTP server which do have those characters in -file names. So you would add the Windows set which are - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - +.IP +.nf +\f[C] +\-\-ftp\-encoding \[dq]Slash,Del,Ctl,RightSpace,Dot\[dq] +\f[R] +.fi +.PP +However, let\[aq]s say the FTP server is running on Windows and +can\[aq]t have any of the invalid Windows characters in file names. +You are backing up Linux servers to this FTP server which do have those +characters in file names. +So you would add the Windows set which are +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot +\f[R] +.fi +.PP to the existing ones, giving: - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace - -This can be specified using the \[ga]\-\-ftp\-encoding\[ga] flag or using an \[ga]encoding\[ga] parameter in the config file. - -Or let\[aq]s say you have a Windows server but you want to preserve \[ga]\[uFF0A]\[ga] -and \[ga]\[uFF1F]\[ga], you would then have this as the encoding (the Windows -encoding minus \[ga]Asterisk\[ga] and \[ga]Question\[ga]). - - Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - -This can be specified using the \[ga]\-\-local\-encoding\[ga] flag or using an -\[ga]encoding\[ga] parameter in the config file. - -### MIME Type ### - -MIME types (also known as media types) classify types of documents -using a simple text classification, eg \[ga]text/html\[ga] or -\[ga]application/pdf\[ga]. - -Some cloud storage systems support reading (\[ga]R\[ga]) the MIME type of -objects and some support writing (\[ga]W\[ga]) the MIME type of objects. - -The MIME type can be important if you are serving files directly to -HTTP from the storage system. - -If you are copying from a remote which supports reading (\[ga]R\[ga]) to a -remote which supports writing (\[ga]W\[ga]) then rclone will preserve the MIME -types. Otherwise they will be guessed from the extension, or the -remote itself may assign the MIME type. - -## Optional Features ## - +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace +\f[R] +.fi +.PP +This can be specified using the \f[C]\-\-ftp\-encoding\f[R] flag or +using an \f[C]encoding\f[R] parameter in the config file. +.PP +Or let\[aq]s say you have a Windows server but you want to preserve +\f[C]\[uFF0A]\f[R] and \f[C]\[uFF1F]\f[R], you would then have this as +the encoding (the Windows encoding minus \f[C]Asterisk\f[R] and +\f[C]Question\f[R]). +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot +\f[R] +.fi +.PP +This can be specified using the \f[C]\-\-local\-encoding\f[R] flag or +using an \f[C]encoding\f[R] parameter in the config file. +.SS MIME Type +.PP +MIME types (also known as media types) classify types of documents using +a simple text classification, eg \f[C]text/html\f[R] or +\f[C]application/pdf\f[R]. +.PP +Some cloud storage systems support reading (\f[C]R\f[R]) the MIME type +of objects and some support writing (\f[C]W\f[R]) the MIME type of +objects. +.PP +The MIME type can be important if you are serving files directly to HTTP +from the storage system. +.PP +If you are copying from a remote which supports reading (\f[C]R\f[R]) to +a remote which supports writing (\f[C]W\f[R]) then rclone will preserve +the MIME types. +Otherwise they will be guessed from the extension, or the remote itself +may assign the MIME type. +.SS Optional Features +.PP All the remotes support a basic set of features, but there are some -optional features supported by some remotes used to make some -operations more efficient. - -| Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir | -| \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-:|:\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-:| :\-\-\-\-\-\-: | -| 1Fichier | No | No | No | No | No | No | No | No | No | Yes | -| Amazon Drive | Yes | No | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | -| Amazon S3 | No | Yes | No | No | Yes | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | Yes | No | No | -| Box | Yes | Yes | Yes | Yes | Yes \[dd]\[dd] | No | Yes | Yes | No | Yes | -| Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | Yes | No | No | Yes | -| Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | Yes | Yes | -| FTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | -| Google Cloud Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Google Drive | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | -| Google Photos | No | No | No | No | No | No | No | No | No | No | -| HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | -| Hubic | Yes \[dg] | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | -| Jottacloud | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | -| Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| Memory | No | Yes | No | No | No | Yes | Yes | No | No | No | -| Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Microsoft OneDrive | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | -| OpenStack Swift | Yes \[dg] | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | -| pCloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| premiumize.me | Yes | No | Yes | Yes | No | No | No | Yes | Yes | Yes | -| put.io | Yes | No | Yes | Yes | Yes | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| QingStor | No | Yes | No | No | Yes | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Seafile | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | -| SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | -| Tardigrade | Yes \[dg] | No | No | No | No | Yes | Yes | No | No | No | -| WebDAV | Yes | Yes | Yes | Yes | No | No | Yes \[dd] | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | -| The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | - -### Purge ### - -This deletes a directory quicker than just deleting all the files in -the directory. - -\[dg] Note Swift, Hubic, and Tardigrade implement this in order to delete -directory markers but they don\[aq]t actually have a quicker way of deleting -files other than deleting them individually. - +optional features supported by some remotes used to make some operations +more efficient. +.PP +.TS +tab(@); +l c c c c c c c c c c. +T{ +Name +T}@T{ +Purge +T}@T{ +Copy +T}@T{ +Move +T}@T{ +DirMove +T}@T{ +CleanUp +T}@T{ +ListR +T}@T{ +StreamUpload +T}@T{ +LinkSharing +T}@T{ +About +T}@T{ +EmptyDir +T} +_ +T{ +1Fichier +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Amazon Drive +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Amazon S3 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Backblaze B2 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T} +T{ +Box +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes \[dd]\[dd] +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T} +T{ +Citrix ShareFile +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Dropbox +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +FTP +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Google Cloud Storage +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Google Drive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Google Photos +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T} +T{ +HTTP +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Hubic +T}@T{ +Yes \[dg] +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +No +T} +T{ +Jottacloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Mail.ru Cloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Mega +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Memory +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T} +T{ +Microsoft Azure Blob Storage +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Microsoft OneDrive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +OpenDrive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +OpenStack Swift +T}@T{ +Yes \[dg] +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +No +T} +T{ +pCloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +premiumize.me +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +put.io +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +QingStor +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Seafile +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +SFTP +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +SugarSync +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T} +T{ +Tardigrade +T}@T{ +Yes \[dg] +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T} +T{ +WebDAV +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes \[dd] +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Yandex Disk +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +The local filesystem +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T} +.TE +.SS Purge +.PP +This deletes a directory quicker than just deleting all the files in the +directory. +.PP +\[dg] Note Swift, Hubic, and Tardigrade implement this in order to +delete directory markers but they don\[aq]t actually have a quicker way +of deleting files other than deleting them individually. +.PP \[dd] StreamUpload is not supported with Nextcloud - -### Copy ### - -Used when copying an object to and from the same remote. This known -as a server side copy so you can copy a file without downloading it -and uploading it again. It is used if you use \[ga]rclone copy\[ga] or -\[ga]rclone move\[ga] if the remote doesn\[aq]t support \[ga]Move\[ga] directly. - -If the server doesn\[aq]t support \[ga]Copy\[ga] directly then for copy operations -the file is downloaded then re\-uploaded. - -### Move ### - -Used when moving/renaming an object on the same remote. This is known -as a server side move of a file. This is used in \[ga]rclone move\[ga] if the -server doesn\[aq]t support \[ga]DirMove\[ga]. - -If the server isn\[aq]t capable of \[ga]Move\[ga] then rclone simulates it with -\[ga]Copy\[ga] then delete. If the server doesn\[aq]t support \[ga]Copy\[ga] then rclone -will download the file and re\-upload it. - -### DirMove ### - -This is used to implement \[ga]rclone move\[ga] to move a directory if -possible. If it isn\[aq]t then it will use \[ga]Move\[ga] on each file (which -falls back to \[ga]Copy\[ga] then download and upload \- see \[ga]Move\[ga] section). - -### CleanUp ### - -This is used for emptying the trash for a remote by \[ga]rclone cleanup\[ga]. - -If the server can\[aq]t do \[ga]CleanUp\[ga] then \[ga]rclone cleanup\[ga] will return an -error. - -\[dd]\[dd] Note that while Box implements this it has to delete every file -idividually so it will be slower than emptying the trash via the WebUI - -### ListR ### - -The remote supports a recursive list to list all the contents beneath -a directory quickly. This enables the \[ga]\-\-fast\-list\[ga] flag to work. -See the [rclone docs](https://rclone.org/docs/#fast\-list) for more details. - -### StreamUpload ### - -Some remotes allow files to be uploaded without knowing the file size -in advance. This allows certain operations to work without spooling the -file to local disk first, e.g. \[ga]rclone rcat\[ga]. - -### LinkSharing ### - +.SS Copy +.PP +Used when copying an object to and from the same remote. +This known as a server side copy so you can copy a file without +downloading it and uploading it again. +It is used if you use \f[C]rclone copy\f[R] or \f[C]rclone move\f[R] if +the remote doesn\[aq]t support \f[C]Move\f[R] directly. +.PP +If the server doesn\[aq]t support \f[C]Copy\f[R] directly then for copy +operations the file is downloaded then re\-uploaded. +.SS Move +.PP +Used when moving/renaming an object on the same remote. +This is known as a server side move of a file. +This is used in \f[C]rclone move\f[R] if the server doesn\[aq]t support +\f[C]DirMove\f[R]. +.PP +If the server isn\[aq]t capable of \f[C]Move\f[R] then rclone simulates +it with \f[C]Copy\f[R] then delete. +If the server doesn\[aq]t support \f[C]Copy\f[R] then rclone will +download the file and re\-upload it. +.SS DirMove +.PP +This is used to implement \f[C]rclone move\f[R] to move a directory if +possible. +If it isn\[aq]t then it will use \f[C]Move\f[R] on each file (which +falls back to \f[C]Copy\f[R] then download and upload \- see +\f[C]Move\f[R] section). +.SS CleanUp +.PP +This is used for emptying the trash for a remote by +\f[C]rclone cleanup\f[R]. +.PP +If the server can\[aq]t do \f[C]CleanUp\f[R] then +\f[C]rclone cleanup\f[R] will return an error. +.PP +\[dd]\[dd] Note that while Box implements this it has to delete every +file idividually so it will be slower than emptying the trash via the +WebUI +.SS ListR +.PP +The remote supports a recursive list to list all the contents beneath a +directory quickly. +This enables the \f[C]\-\-fast\-list\f[R] flag to work. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS StreamUpload +.PP +Some remotes allow files to be uploaded without knowing the file size in +advance. +This allows certain operations to work without spooling the file to +local disk first, e.g. +\f[C]rclone rcat\f[R]. +.SS LinkSharing +.PP Sets the necessary permissions on a file or folder and prints a link -that allows others to access them, even if they don\[aq]t have an account -on the particular cloud provider. - -### About ### - +that allows others to access them, even if they don\[aq]t have an +account on the particular cloud provider. +.SS About +.PP This is used to fetch quota information from the remote, like bytes used/free/quota and bytes used in the trash. - -This is also used to return the space used, available for \[ga]rclone mount\[ga]. - -If the server can\[aq]t do \[ga]About\[ga] then \[ga]rclone about\[ga] will return an -error. - -### EmptyDir ### - -The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations) - for details. Most Object/Bucket based remotes do not support this. - -# Global Flags - -This describes the global flags available to every rclone command -split into two groups, non backend and backend flags. - -## Non Backend Flags - +.PP +This is also used to return the space used, available for +\f[C]rclone mount\f[R]. +.PP +If the server can\[aq]t do \f[C]About\f[R] then \f[C]rclone about\f[R] +will return an error. +.SS EmptyDir +.PP +The remote supports empty directories. +See Limitations (https://rclone.org/bugs/#limitations) for details. +Most Object/Bucket based remotes do not support this. +.SH Global Flags +.PP +This describes the global flags available to every rclone command split +into two groups, non backend and backend flags. +.SS Non Backend Flags +.PP These flags are available for every command. -\f[R] -.fi .IP .nf \f[C] - \-\-ask\-password Allow prompt for password for encrypted configuration. (default true) - \-\-auto\-confirm If enabled, do not request console confirmation. - \-\-backup\-dir string Make backups into hierarchy based in DIR. - \-\-bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. - \-\-buffer\-size SizeSuffix In memory buffer size when reading files for each \-\-transfer. (default 16M) - \-\-bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. - \-\-bwlimit\-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. - \-\-ca\-cert string CA certificate used to verify servers - \-\-cache\-dir string Directory rclone will use for caching. (default \[dq]$HOME/.cache/rclone\[dq]) - \-\-check\-first Do all the checks before starting transfers. - \-\-checkers int Number of checkers to run in parallel. (default 8) + \-\-ask\-password Allow prompt for password for encrypted configuration. (default true) + \-\-auto\-confirm If enabled, do not request console confirmation. + \-\-backup\-dir string Make backups into hierarchy based in DIR. + \-\-bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + \-\-buffer\-size SizeSuffix In memory buffer size when reading files for each \-\-transfer. (default 16M) + \-\-bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + \-\-bwlimit\-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. + \-\-ca\-cert string CA certificate used to verify servers + \-\-cache\-dir string Directory rclone will use for caching. (default \[dq]$HOME/.cache/rclone\[dq]) + \-\-check\-first Do all the checks before starting transfers. + \-\-checkers int Number of checkers to run in parallel. (default 8) + \-c, \-\-checksum Skip based on checksum (if available) & size, not mod\-time & size + \-\-client\-cert string Client SSL certificate (PEM) for mutual TLS auth + \-\-client\-key string Client SSL private key (PEM) for mutual TLS auth + \-\-compare\-dest string Include additional server\-side path during comparison. + \-\-config string Config file. (default \[dq]$HOME/.config/rclone/rclone.conf\[dq]) + \-\-contimeout duration Connect timeout (default 1m0s) + \-\-copy\-dest string Implies \-\-compare\-dest but also copies files from path into destination. + \-\-cpuprofile string Write cpu profile to file + \-\-cutoff\-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default \[dq]HARD\[dq]) + \-\-delete\-after When synchronizing, delete files on destination after transferring (default) + \-\-delete\-before When synchronizing, delete files on destination before transferring + \-\-delete\-during When synchronizing, delete files during transfer + \-\-delete\-excluded Delete files on dest excluded from sync + \-\-disable string Disable a comma separated list of features. Use help to see a list. + \-n, \-\-dry\-run Do a trial run with no permanent changes + \-\-dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + \-\-dump\-bodies Dump HTTP headers and bodies \- may contain sensitive info + \-\-dump\-headers Dump HTTP headers \- may contain sensitive info + \-\-error\-on\-no\-transfer Sets exit code 9 if no files are transferred, useful in scripts + \-\-exclude stringArray Exclude files matching pattern + \-\-exclude\-from stringArray Read exclude patterns from file (use \- to read from stdin) + \-\-exclude\-if\-present string Exclude directories if filename is present + \-\-expect\-continue\-timeout duration Timeout when using expect / 100\-continue in HTTP (default 1s) + \-\-fast\-list Use recursive list if available. Uses more memory but fewer transactions. + \-\-files\-from stringArray Read list of source\-file names from file (use \- to read from stdin) + \-\-files\-from\-raw stringArray Read list of source\-file names from file without any processing of lines (use \- to read from stdin) + \-f, \-\-filter stringArray Add a file\-filtering rule + \-\-filter\-from stringArray Read filtering patterns from a file (use \- to read from stdin) + \-\-header stringArray Set HTTP header for all transactions + \-\-header\-download stringArray Set HTTP header for download transactions + \-\-header\-upload stringArray Set HTTP header for upload transactions + \-\-ignore\-case Ignore case in filters (case insensitive) + \-\-ignore\-case\-sync Ignore case when synchronizing + \-\-ignore\-checksum Skip post copy check of checksums. + \-\-ignore\-errors delete even if there are I/O errors + \-\-ignore\-existing Skip all files that exist on destination + \-\-ignore\-size Ignore size when skipping use mod\-time or checksum. + \-I, \-\-ignore\-times Don\[aq]t skip files that match size and time \- transfer all files + \-\-immutable Do not modify files. Fail if existing files have been modified. + \-\-include stringArray Include files matching pattern + \-\-include\-from stringArray Read include patterns from file (use \- to read from stdin) + \-i, \-\-interactive Enable interactive mode + \-\-log\-file string Log everything to this file + \-\-log\-format string Comma separated list of log format options (default \[dq]date,time\[dq]) + \-\-log\-level string Log level DEBUG|INFO|NOTICE|ERROR (default \[dq]NOTICE\[dq]) + \-\-low\-level\-retries int Number of low level retries to do. (default 10) + \-\-max\-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) + \-\-max\-backlog int Maximum number of objects in sync or check backlog. (default 10000) + \-\-max\-delete int When synchronizing, limit the number of deletes (default \-1) + \-\-max\-depth int If set limits the recursion depth to this. (default \-1) + \-\-max\-duration duration Maximum duration rclone will transfer data for. + \-\-max\-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) + \-\-max\-stats\-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) + \-\-max\-transfer SizeSuffix Maximum size of data to transfer. (default off) + \-\-memprofile string Write memory profile to file + \-\-min\-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) + \-\-min\-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) + \-\-modify\-window duration Max time diff to be considered the same (default 1ns) + \-\-multi\-thread\-cutoff SizeSuffix Use multi\-thread downloads for files above this size. (default 250M) + \-\-multi\-thread\-streams int Max number of streams to use for multi\-thread downloads. (default 4) + \-\-no\-check\-certificate Do not verify the server SSL certificate. Insecure. + \-\-no\-check\-dest Don\[aq]t check the destination, copy regardless. + \-\-no\-gzip\-encoding Don\[aq]t set Accept\-Encoding: gzip. + \-\-no\-traverse Don\[aq]t traverse destination file system on copy. + \-\-no\-unicode\-normalization Don\[aq]t normalize unicode characters in filenames. + \-\-no\-update\-modtime Don\[aq]t update destination mod\-time if files identical. + \-\-order\-by string Instructions on how to order the transfers, eg \[aq]size,descending\[aq] + \-\-password\-command SpaceSepList Command for supplying password for encrypted configuration. + \-P, \-\-progress Show progress during transfer. + \-q, \-\-quiet Print as little stuff as possible + \-\-rc Enable the remote control server. + \-\-rc\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:5572\[dq]) + \-\-rc\-allow\-origin string Set the allowed origin for CORS. + \-\-rc\-baseurl string Prefix for URLs \- leave blank for root. + \-\-rc\-cert string SSL PEM key (concatenation of certificate and CA certificate) + \-\-rc\-client\-ca string Client certificate authority to verify clients with + \-\-rc\-enable\-metrics Enable prometheus metrics on /metrics + \-\-rc\-files string Path to local files to serve on the HTTP server. + \-\-rc\-htpasswd string htpasswd file \- if not provided no authentication is done + \-\-rc\-job\-expire\-duration duration expire finished async jobs older than this value (default 1m0s) + \-\-rc\-job\-expire\-interval duration interval to check for expired async jobs (default 10s) + \-\-rc\-key string SSL PEM Private key + \-\-rc\-max\-header\-bytes int Maximum size of request header (default 4096) + \-\-rc\-no\-auth Don\[aq]t require auth for certain methods. + \-\-rc\-pass string Password for authentication. + \-\-rc\-realm string realm for authentication (default \[dq]rclone\[dq]) + \-\-rc\-serve Enable the serving of remote objects. + \-\-rc\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) + \-\-rc\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) + \-\-rc\-template string User Specified Template. + \-\-rc\-user string User name for authentication. + \-\-rc\-web\-fetch\-url string URL to fetch the releases for webgui. (default \[dq]https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest\[dq]) + \-\-rc\-web\-gui Launch WebGUI on localhost + \-\-rc\-web\-gui\-force\-update Force update to latest version of web gui + \-\-rc\-web\-gui\-no\-open\-browser Don\[aq]t open the browser automatically + \-\-rc\-web\-gui\-update Check and update to latest version of web gui + \-\-refresh\-times Refresh the modtime of remote files. + \-\-retries int Retry operations this many times if they fail (default 3) + \-\-retries\-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) + \-\-size\-only Skip based on size only, not mod\-time or checksum + \-\-stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) + \-\-stats\-file\-name\-length int Max file name length in stats. 0 for no limit (default 45) + \-\-stats\-log\-level string Log level to show \-\-stats output DEBUG|INFO|NOTICE|ERROR (default \[dq]INFO\[dq]) + \-\-stats\-one\-line Make the stats fit on one line. + \-\-stats\-one\-line\-date Enables \-\-stats\-one\-line and add current date/time prefix. + \-\-stats\-one\-line\-date\-format string Enables \-\-stats\-one\-line\-date and uses custom formatted date. Enclose date string in double quotes (\[dq]). See https://golang.org/pkg/time/#Time.Format + \-\-stats\-unit string Show data rate in stats as either \[aq]bits\[aq] or \[aq]bytes\[aq]/s (default \[dq]bytes\[dq]) + \-\-streaming\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) + \-\-suffix string Suffix to add to changed files. + \-\-suffix\-keep\-extension Preserve the extension when using \-\-suffix. + \-\-syslog Use Syslog for logging + \-\-syslog\-facility string Facility for syslog, eg KERN,USER,... (default \[dq]DAEMON\[dq]) + \-\-timeout duration IO idle timeout (default 5m0s) + \-\-tpslimit float Limit HTTP transactions per second to this. + \-\-tpslimit\-burst int Max burst of transactions for \-\-tpslimit. (default 1) + \-\-track\-renames When synchronizing, track file renames and do a server side move if possible + \-\-track\-renames\-strategy string Strategies to use when synchronizing using track\-renames hash|modtime|leaf (default \[dq]hash\[dq]) + \-\-transfers int Number of file transfers to run in parallel. (default 4) + \-u, \-\-update Skip files that are newer on the destination. + \-\-use\-cookies Enable session cookiejar. + \-\-use\-json\-log Use json log format. + \-\-use\-mmap Use mmap allocator (see docs). + \-\-use\-server\-modtime Use server modified time instead of object metadata + \-\-user\-agent string Set the user\-agent to a specified string. The default is rclone/ version (default \[dq]rclone/v1.53.1\[dq]) + \-v, \-\-verbose count Print lots more stuff (repeat for more) +\f[R] +.fi +.SS Backend Flags +.PP +These flags are available for every command. +They control the backends and may be set in the config file. +.IP +.nf +\f[C] + \-\-acd\-auth\-url string Auth server URL. + \-\-acd\-client\-id string OAuth Client Id + \-\-acd\-client\-secret string OAuth Client Secret + \-\-acd\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + \-\-acd\-templink\-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + \-\-acd\-token string OAuth Access Token as a JSON blob. + \-\-acd\-token\-url string Token server url. + \-\-acd\-upload\-wait\-per\-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) + \-\-alias\-remote string Remote or path to alias. + \-\-azureblob\-access\-tier string Access tier of blob: hot, cool or archive. + \-\-azureblob\-account string Storage Account Name (leave blank to use SAS URL or Emulator) + \-\-azureblob\-chunk\-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) + \-\-azureblob\-disable\-checksum Don\[aq]t store MD5 checksum with object metadata. + \-\-azureblob\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) + \-\-azureblob\-endpoint string Endpoint for the service + \-\-azureblob\-key string Storage Account Key (leave blank to use SAS URL or Emulator) + \-\-azureblob\-list\-chunk int Size of blob list. (default 5000) + \-\-azureblob\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + \-\-azureblob\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. + \-\-azureblob\-sas\-url string SAS URL for container level access only + \-\-azureblob\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) + \-\-azureblob\-use\-emulator Uses local storage emulator if provided as \[aq]true\[aq] (leave blank if using real azure storage endpoint) + \-\-b2\-account string Account ID or Application Key ID + \-\-b2\-chunk\-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + \-\-b2\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) + \-\-b2\-disable\-checksum Disable checksums for large (> upload cutoff) files + \-\-b2\-download\-auth\-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + \-\-b2\-download\-url string Custom endpoint for downloads. + \-\-b2\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-b2\-endpoint string Endpoint for the service. + \-\-b2\-hard\-delete Permanently delete files on remote removal, otherwise hide files. + \-\-b2\-key string Application Key + \-\-b2\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + \-\-b2\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. + \-\-b2\-test\-mode string A flag string for X\-Bz\-Test\-Mode header for debugging. + \-\-b2\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + \-\-b2\-versions Include old versions in directory listings. + \-\-box\-access\-token string Box App Primary Access Token + \-\-box\-auth\-url string Auth server URL. + \-\-box\-box\-config\-file string Box App config.json location + \-\-box\-box\-sub\-type string (default \[dq]user\[dq]) + \-\-box\-client\-id string OAuth Client Id + \-\-box\-client\-secret string OAuth Client Secret + \-\-box\-commit\-retries int Max number of times to try committing a multipart file. (default 100) + \-\-box\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + \-\-box\-root\-folder\-id string Fill in for rclone to use a non root folder as its starting point. + \-\-box\-token string OAuth Access Token as a JSON blob. + \-\-box\-token\-url string Token server url. + \-\-box\-upload\-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + \-\-cache\-chunk\-clean\-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + \-\-cache\-chunk\-no\-memory Disable the in\-memory cache for storing chunks during streaming. + \-\-cache\-chunk\-path string Directory to cache chunk files. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) + \-\-cache\-chunk\-size SizeSuffix The size of a chunk (partial file data). (default 5M) + \-\-cache\-chunk\-total\-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + \-\-cache\-db\-path string Directory to store file structure metadata DB. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) + \-\-cache\-db\-purge Clear all the cached data for this remote on start. + \-\-cache\-db\-wait\-time Duration How long to wait for the DB to be available \- 0 is unlimited (default 1s) + \-\-cache\-info\-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) + \-\-cache\-plex\-insecure string Skip all certificate verification when connecting to the Plex server + \-\-cache\-plex\-password string The password of the Plex user (obscured) + \-\-cache\-plex\-url string The URL of the Plex server + \-\-cache\-plex\-username string The username of the Plex user + \-\-cache\-read\-retries int How many times to retry a read from a cache storage. (default 10) + \-\-cache\-remote string Remote to cache. + \-\-cache\-rps int Limits the number of requests per second to the source FS (\-1 to disable) (default \-1) + \-\-cache\-tmp\-upload\-path string Directory to keep temporary files until they are uploaded. + \-\-cache\-tmp\-wait\-time Duration How long should files be stored in local cache before being uploaded (default 15s) + \-\-cache\-workers int How many workers should run in parallel to download chunks. (default 4) + \-\-cache\-writes Cache file data on writes through the FS + \-\-chunker\-chunk\-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + \-\-chunker\-fail\-hard Choose how chunker should handle files with missing or invalid chunks. + \-\-chunker\-hash\-type string Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. (default \[dq]md5\[dq]) + \-\-chunker\-meta\-format string Format of the metadata object or \[dq]none\[dq]. By default \[dq]simplejson\[dq]. (default \[dq]simplejson\[dq]) + \-\-chunker\-name\-format string String format of chunk file names. (default \[dq]*.rclone_chunk.###\[dq]) + \-\-chunker\-remote string Remote to chunk/unchunk. + \-\-chunker\-start\-from int Minimum valid chunk number. Usually 0 or 1. (default 1) + \-L, \-\-copy\-links Follow symlinks and copy the pointed to item. + \-\-crypt\-directory\-name\-encryption Option to either encrypt directory names or leave them intact. (default true) + \-\-crypt\-filename\-encryption string How to encrypt the filenames. (default \[dq]standard\[dq]) + \-\-crypt\-password string Password or pass phrase for encryption. (obscured) + \-\-crypt\-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) + \-\-crypt\-remote string Remote to encrypt/decrypt. + \-\-crypt\-server\-side\-across\-configs Allow server side operations (eg copy) to work across different crypt configs. + \-\-crypt\-show\-mapping For all files listed show how the names encrypt. + \-\-drive\-acknowledge\-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + \-\-drive\-allow\-import\-name\-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + \-\-drive\-auth\-owner\-only Only consider files owned by the authenticated user. + \-\-drive\-auth\-url string Auth server URL. + \-\-drive\-chunk\-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + \-\-drive\-client\-id string Google Application Client Id + \-\-drive\-client\-secret string OAuth Client Secret + \-\-drive\-disable\-http2 Disable drive using http2 (default true) + \-\-drive\-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) + \-\-drive\-export\-formats string Comma separated list of preferred formats for downloading Google docs. (default \[dq]docx,xlsx,pptx,svg\[dq]) + \-\-drive\-formats string Deprecated: see export_formats + \-\-drive\-impersonate string Impersonate this user when using a service account. + \-\-drive\-import\-formats string Comma separated list of preferred formats for uploading Google docs. + \-\-drive\-keep\-revision\-forever Keep new head revision of each file forever. + \-\-drive\-list\-chunk int Size of listing chunk 100\-1000. 0 to disable. (default 1000) + \-\-drive\-pacer\-burst int Number of API calls to allow without sleeping. (default 100) + \-\-drive\-pacer\-min\-sleep Duration Minimum time to sleep between API calls. (default 100ms) + \-\-drive\-root\-folder\-id string ID of the root folder + \-\-drive\-scope string Scope that rclone should use when requesting access from drive. + \-\-drive\-server\-side\-across\-configs Allow server side operations (eg copy) to work across different drive configs. + \-\-drive\-service\-account\-credentials string Service Account Credentials JSON blob + \-\-drive\-service\-account\-file string Service Account Credentials JSON file path + \-\-drive\-shared\-with\-me Only show files that are shared with me. + \-\-drive\-size\-as\-quota Show sizes as storage quota usage, not actual size. + \-\-drive\-skip\-checksum\-gphotos Skip MD5 checksum on Google photos and videos only. + \-\-drive\-skip\-gdocs Skip google documents in all listings. + \-\-drive\-skip\-shortcuts If set skip shortcut files + \-\-drive\-starred\-only Only show files that are starred. + \-\-drive\-stop\-on\-upload\-limit Make upload limit errors be fatal + \-\-drive\-team\-drive string ID of the Team Drive + \-\-drive\-token string OAuth Access Token as a JSON blob. + \-\-drive\-token\-url string Token server url. + \-\-drive\-trashed\-only Only show files that are in the trash. + \-\-drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + \-\-drive\-use\-created\-date Use file created date instead of modified date., + \-\-drive\-use\-shared\-date Use date file was shared instead of modified date. + \-\-drive\-use\-trash Send files to the trash instead of deleting permanently. (default true) + \-\-drive\-v2\-download\-min\-size SizeSuffix If Object\[aq]s are greater, use drive v2 API to download. (default off) + \-\-dropbox\-auth\-url string Auth server URL. + \-\-dropbox\-chunk\-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + \-\-dropbox\-client\-id string OAuth Client Id + \-\-dropbox\-client\-secret string OAuth Client Secret + \-\-dropbox\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) + \-\-dropbox\-impersonate string Impersonate this user when using a business account. + \-\-dropbox\-token string OAuth Access Token as a JSON blob. + \-\-dropbox\-token\-url string Token server url. + \-\-fichier\-api\-key string Your API Key, get it from https://1fichier.com/console/params.pl + \-\-fichier\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) + \-\-fichier\-shared\-folder string If you want to download a shared folder, add this parameter + \-\-ftp\-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited + \-\-ftp\-disable\-epsv Disable using EPSV even if server advertises support + \-\-ftp\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) + \-\-ftp\-explicit\-tls Use FTP over TLS (Explicit) + \-\-ftp\-host string FTP host to connect to + \-\-ftp\-no\-check\-certificate Do not verify the TLS certificate of the server + \-\-ftp\-pass string FTP password (obscured) + \-\-ftp\-port string FTP port, leave blank to use default (21) + \-\-ftp\-tls Use FTPS over TLS (Implicit) + \-\-ftp\-user string FTP username, leave blank for current username, $USER + \-\-gcs\-anonymous Access public buckets and objects without credentials + \-\-gcs\-auth\-url string Auth server URL. + \-\-gcs\-bucket\-acl string Access Control List for new buckets. + \-\-gcs\-bucket\-policy\-only Access checks should use bucket\-level IAM policies. + \-\-gcs\-client\-id string OAuth Client Id + \-\-gcs\-client\-secret string OAuth Client Secret + \-\-gcs\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) + \-\-gcs\-location string Location for the newly created buckets. + \-\-gcs\-object\-acl string Access Control List for new objects. + \-\-gcs\-project\-number string Project number. + \-\-gcs\-service\-account\-file string Service Account Credentials JSON file path + \-\-gcs\-storage\-class string The storage class to use when storing objects in Google Cloud Storage. + \-\-gcs\-token string OAuth Access Token as a JSON blob. + \-\-gcs\-token\-url string Token server url. + \-\-gphotos\-auth\-url string Auth server URL. + \-\-gphotos\-client\-id string OAuth Client Id + \-\-gphotos\-client\-secret string OAuth Client Secret + \-\-gphotos\-read\-only Set to make the Google Photos backend read only. + \-\-gphotos\-read\-size Set to read the size of media items. + \-\-gphotos\-start\-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) + \-\-gphotos\-token string OAuth Access Token as a JSON blob. + \-\-gphotos\-token\-url string Token server url. + \-\-http\-headers CommaSepList Set HTTP headers for all transactions + \-\-http\-no\-head Don\[aq]t use HEAD requests to find file sizes in dir listing + \-\-http\-no\-slash Set this if the site doesn\[aq]t end directories with / + \-\-http\-url string URL of http host to connect to + \-\-hubic\-auth\-url string Auth server URL. + \-\-hubic\-chunk\-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + \-\-hubic\-client\-id string OAuth Client Id + \-\-hubic\-client\-secret string OAuth Client Secret + \-\-hubic\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + \-\-hubic\-no\-chunk Don\[aq]t chunk files during streaming upload. + \-\-hubic\-token string OAuth Access Token as a JSON blob. + \-\-hubic\-token\-url string Token server url. + \-\-jottacloud\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) + \-\-jottacloud\-hard\-delete Delete files permanently rather than putting them into the trash. + \-\-jottacloud\-md5\-memory\-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) + \-\-jottacloud\-trashed\-only Only show files that are in the trash. + \-\-jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this can be resumed if the upload fail\[aq]s. (default 10M) + \-\-koofr\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-koofr\-endpoint string The Koofr API endpoint to use (default \[dq]https://app.koofr.net\[dq]) + \-\-koofr\-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. + \-\-koofr\-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) + \-\-koofr\-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) + \-\-koofr\-user string Your Koofr user name + \-l, \-\-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension + \-\-local\-case\-insensitive Force the filesystem to report itself as case insensitive + \-\-local\-case\-sensitive Force the filesystem to report itself as case sensitive. + \-\-local\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) + \-\-local\-no\-check\-updated Don\[aq]t check to see if the files change during upload + \-\-local\-no\-set\-modtime Disable setting modtime + \-\-local\-no\-sparse Disable sparse files for multi\-thread downloads + \-\-local\-no\-unicode\-normalization Don\[aq]t apply unicode normalization to paths and filenames (Deprecated) + \-\-local\-nounc string Disable UNC (long path names) conversion on Windows + \-\-mailru\-check\-hash What should copy do if file checksum is mismatched or invalid (default true) + \-\-mailru\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-mailru\-pass string Password (obscured) + \-\-mailru\-speedup\-enable Skip full upload if there is another file with same data hash. (default true) + \-\-mailru\-speedup\-file\-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default \[dq]*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf\[dq]) + \-\-mailru\-speedup\-max\-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) + \-\-mailru\-speedup\-max\-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) + \-\-mailru\-user string User name (usually email) + \-\-mega\-debug Output more debug from Mega. + \-\-mega\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + \-\-mega\-hard\-delete Delete files permanently rather than putting them into the trash. + \-\-mega\-pass string Password. (obscured) + \-\-mega\-user string User name + \-x, \-\-one\-file\-system Don\[aq]t cross filesystem boundaries (unix/macOS only). + \-\-onedrive\-auth\-url string Auth server URL. + \-\-onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- must be multiple of 320k (327,680 bytes). (default 10M) + \-\-onedrive\-client\-id string OAuth Client Id + \-\-onedrive\-client\-secret string OAuth Client Secret + \-\-onedrive\-drive\-id string The ID of the drive to use + \-\-onedrive\-drive\-type string The type of the drive ( personal | business | documentLibrary ) + \-\-onedrive\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + \-\-onedrive\-expose\-onenote\-files Set to make OneNote files show up in directory listings. + \-\-onedrive\-no\-versions Remove all versions on modifying operations + \-\-onedrive\-server\-side\-across\-configs Allow server side operations (eg copy) to work across different onedrive configs. + \-\-onedrive\-token string OAuth Access Token as a JSON blob. + \-\-onedrive\-token\-url string Token server url. + \-\-opendrive\-chunk\-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) + \-\-opendrive\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) + \-\-opendrive\-password string Password. (obscured) + \-\-opendrive\-username string Username + \-\-pcloud\-auth\-url string Auth server URL. + \-\-pcloud\-client\-id string OAuth Client Id + \-\-pcloud\-client\-secret string OAuth Client Secret + \-\-pcloud\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-pcloud\-hostname string Hostname to connect to. (default \[dq]api.pcloud.com\[dq]) + \-\-pcloud\-root\-folder\-id string Fill in for rclone to use a non root folder as its starting point. (default \[dq]d0\[dq]) + \-\-pcloud\-token string OAuth Access Token as a JSON blob. + \-\-pcloud\-token\-url string Token server url. + \-\-premiumizeme\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-putio\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-qingstor\-access\-key\-id string QingStor Access Key ID + \-\-qingstor\-chunk\-size SizeSuffix Chunk size to use for uploading. (default 4M) + \-\-qingstor\-connection\-retries int Number of connection retries. (default 3) + \-\-qingstor\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) + \-\-qingstor\-endpoint string Enter an endpoint URL to connection QingStor API. + \-\-qingstor\-env\-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + \-\-qingstor\-secret\-access\-key string QingStor Secret Access Key (password) + \-\-qingstor\-upload\-concurrency int Concurrency for multipart uploads. (default 1) + \-\-qingstor\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + \-\-qingstor\-zone string Zone to connect to. + \-\-s3\-access\-key\-id string AWS Access Key ID. + \-\-s3\-acl string Canned ACL used when creating buckets and storing or copying objects. + \-\-s3\-bucket\-acl string Canned ACL used when creating buckets. + \-\-s3\-chunk\-size SizeSuffix Chunk size to use for uploading. (default 5M) + \-\-s3\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) + \-\-s3\-disable\-checksum Don\[aq]t store MD5 checksum with object metadata + \-\-s3\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + \-\-s3\-endpoint string Endpoint for S3 API. + \-\-s3\-env\-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + \-\-s3\-force\-path\-style If true use path style access if false use virtual hosted style. (default true) + \-\-s3\-leave\-parts\-on\-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. + \-\-s3\-list\-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) + \-\-s3\-location\-constraint string Location constraint \- must be set to match the Region. + \-\-s3\-max\-upload\-parts int Maximum number of parts in a multipart upload. (default 10000) + \-\-s3\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + \-\-s3\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. + \-\-s3\-no\-check\-bucket If set don\[aq]t attempt to check the bucket exists or create it + \-\-s3\-profile string Profile to use in the shared credentials file + \-\-s3\-provider string Choose your S3 provider. + \-\-s3\-region string Region to connect to. + \-\-s3\-secret\-access\-key string AWS Secret Access Key (password) + \-\-s3\-server\-side\-encryption string The server\-side encryption algorithm used when storing this object in S3. + \-\-s3\-session\-token string An AWS session token + \-\-s3\-shared\-credentials\-file string Path to the shared credentials file + \-\-s3\-sse\-customer\-algorithm string If using SSE\-C, the server\-side encryption algorithm used when storing this object in S3. + \-\-s3\-sse\-customer\-key string If using SSE\-C you must provide the secret encryption key used to encrypt/decrypt your data. + \-\-s3\-sse\-customer\-key\-md5 string If using SSE\-C you must provide the secret encryption key MD5 checksum. + \-\-s3\-sse\-kms\-key\-id string If using KMS ID you must provide the ARN of Key. + \-\-s3\-storage\-class string The storage class to use when storing new objects in S3. + \-\-s3\-upload\-concurrency int Concurrency for multipart uploads. (default 4) + \-\-s3\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + \-\-s3\-use\-accelerate\-endpoint If true use the AWS S3 accelerated endpoint. + \-\-s3\-v2\-auth If true use v2 authentication. + \-\-seafile\-2fa Two\-factor authentication (\[aq]true\[aq] if the account has 2FA enabled) + \-\-seafile\-create\-library Should rclone create a library if it doesn\[aq]t exist + \-\-seafile\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) + \-\-seafile\-library string Name of the library. Leave blank to access all non\-encrypted libraries. + \-\-seafile\-library\-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) + \-\-seafile\-pass string Password (obscured) + \-\-seafile\-url string URL of seafile host to connect to + \-\-seafile\-user string User name (usually email address) + \-\-sftp\-ask\-password Allow asking for SFTP password when needed. + \-\-sftp\-disable\-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + \-\-sftp\-host string SSH host to connect to + \-\-sftp\-key\-file string Path to PEM\-encoded private key file, leave blank or set key\-use\-agent to use ssh\-agent. + \-\-sftp\-key\-file\-pass string The passphrase to decrypt the PEM\-encoded private key file. (obscured) + \-\-sftp\-key\-pem string Raw PEM\-encoded private key, If specified, will override key_file parameter. + \-\-sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. + \-\-sftp\-md5sum\-command string The command used to read md5 hashes. Leave blank for autodetect. + \-\-sftp\-pass string SSH password, leave blank to use ssh\-agent. (obscured) + \-\-sftp\-path\-override string Override path used by SSH connection. + \-\-sftp\-port string SSH port, leave blank to use default (22) + \-\-sftp\-server\-command string Specifies the path or command to run a sftp server on the remote host. + \-\-sftp\-set\-modtime Set the modified time on the remote if set. (default true) + \-\-sftp\-sha1sum\-command string The command used to read sha1 hashes. Leave blank for autodetect. + \-\-sftp\-skip\-links Set to skip any symlinks and any other non regular files. + \-\-sftp\-subsystem string Specifies the SSH2 subsystem on the remote host. (default \[dq]sftp\[dq]) + \-\-sftp\-use\-insecure\-cipher Enable the use of insecure ciphers and key exchange methods. + \-\-sftp\-user string SSH username, leave blank for current username, ncw + \-\-sharefile\-chunk\-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) + \-\-sharefile\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) + \-\-sharefile\-endpoint string Endpoint for API calls. + \-\-sharefile\-root\-folder\-id string ID of the root folder + \-\-sharefile\-upload\-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) + \-\-skip\-links Don\[aq]t warn about skipped symlinks. + \-\-sugarsync\-access\-key\-id string Sugarsync Access Key ID. + \-\-sugarsync\-app\-id string Sugarsync App ID. + \-\-sugarsync\-authorization string Sugarsync authorization + \-\-sugarsync\-authorization\-expiry string Sugarsync authorization expiry + \-\-sugarsync\-deleted\-id string Sugarsync deleted folder id + \-\-sugarsync\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) + \-\-sugarsync\-hard\-delete Permanently delete files if true + \-\-sugarsync\-private\-access\-key string Sugarsync Private Access Key + \-\-sugarsync\-refresh\-token string Sugarsync refresh token + \-\-sugarsync\-root\-id string Sugarsync root id + \-\-sugarsync\-user string Sugarsync user + \-\-swift\-application\-credential\-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) + \-\-swift\-application\-credential\-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) + \-\-swift\-application\-credential\-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) + \-\-swift\-auth string Authentication URL for server (OS_AUTH_URL). + \-\-swift\-auth\-token string Auth Token from alternate authentication \- optional (OS_AUTH_TOKEN) + \-\-swift\-auth\-version int AuthVersion \- optional \- set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) + \-\-swift\-chunk\-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + \-\-swift\-domain string User domain \- optional (v3 auth) (OS_USER_DOMAIN_NAME) + \-\-swift\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + \-\-swift\-endpoint\-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default \[dq]public\[dq]) + \-\-swift\-env\-auth Get swift credentials from environment variables in standard OpenStack form. + \-\-swift\-key string API key or password (OS_PASSWORD). + \-\-swift\-no\-chunk Don\[aq]t chunk files during streaming upload. + \-\-swift\-region string Region name \- optional (OS_REGION_NAME) + \-\-swift\-storage\-policy string The storage policy to use when creating a new container + \-\-swift\-storage\-url string Storage URL \- optional (OS_STORAGE_URL) + \-\-swift\-tenant string Tenant name \- optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) + \-\-swift\-tenant\-domain string Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) + \-\-swift\-tenant\-id string Tenant ID \- optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) + \-\-swift\-user string User name to log in (OS_USERNAME). + \-\-swift\-user\-id string User ID to log in \- optional \- most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). + \-\-tardigrade\-access\-grant string Access Grant. + \-\-tardigrade\-api\-key string API Key. + \-\-tardigrade\-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. + \-\-tardigrade\-provider string Choose an authentication method. (default \[dq]existing\[dq]) + \-\-tardigrade\-satellite\-address \[at]
    : Satellite Address. Custom satellite address should match the format: \[at]
    :. (default \[dq]us\-central\-1.tardigrade.io\[dq]) + \-\-union\-action\-policy string Policy to choose upstream on ACTION category. (default \[dq]epall\[dq]) + \-\-union\-cache\-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) + \-\-union\-create\-policy string Policy to choose upstream on CREATE category. (default \[dq]epmfs\[dq]) + \-\-union\-search\-policy string Policy to choose upstream on SEARCH category. (default \[dq]ff\[dq]) + \-\-union\-upstreams string List of space separated upstreams. + \-\-webdav\-bearer\-token string Bearer token instead of user/pass (eg a Macaroon) + \-\-webdav\-bearer\-token\-command string Command to run to get a bearer token + \-\-webdav\-pass string Password. (obscured) + \-\-webdav\-url string URL of http host to connect to + \-\-webdav\-user string User name + \-\-webdav\-vendor string Name of the Webdav site/service/software you are using + \-\-yandex\-auth\-url string Auth server URL. + \-\-yandex\-client\-id string OAuth Client Id + \-\-yandex\-client\-secret string OAuth Client Secret + \-\-yandex\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + \-\-yandex\-token string OAuth Access Token as a JSON blob. + \-\-yandex\-token\-url string Token server url. +\f[R] +.fi +.SS 1Fichier +.PP +This is a backend for the 1fichier (https://1fichier.com) cloud storage +service. +Note that a Premium subscription is required to use the API. +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.PP +The initial setup for 1Fichier involves getting the API key from the +website which you need to do in your browser. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config \f[R] .fi .PP -\-c, \-\-checksum Skip based on checksum (if available) & size, not -mod\-time & size \-\-client\-cert string Client SSL certificate (PEM) -for mutual TLS auth \-\-client\-key string Client SSL private key (PEM) -for mutual TLS auth \-\-compare\-dest string Include additional -server\-side path during comparison. -\-\-config string Config file. -(default \[dq]$HOME/.config/rclone/rclone.conf\[dq]) \-\-contimeout -duration Connect timeout (default 1m0s) \-\-copy\-dest string Implies -\-\-compare\-dest but also copies files from path into destination. -\-\-cpuprofile string Write cpu profile to file \-\-cutoff\-mode string -Mode to stop transfers when reaching the max transfer limit -HARD|SOFT|CAUTIOUS (default \[dq]HARD\[dq]) \-\-delete\-after When -synchronizing, delete files on destination after transferring (default) -\-\-delete\-before When synchronizing, delete files on destination -before transferring \-\-delete\-during When synchronizing, delete files -during transfer \-\-delete\-excluded Delete files on dest excluded from -sync \-\-disable string Disable a comma separated list of features. -Use help to see a list. -\-n, \-\-dry\-run Do a trial run with no permanent changes \-\-dump -DumpFlags List of items to dump from: -headers,bodies,requests,responses,auth,filters,goroutines,openfiles -\-\-dump\-bodies Dump HTTP headers and bodies \- may contain sensitive -info \-\-dump\-headers Dump HTTP headers \- may contain sensitive info -\-\-error\-on\-no\-transfer Sets exit code 9 if no files are -transferred, useful in scripts \-\-exclude stringArray Exclude files -matching pattern \-\-exclude\-from stringArray Read exclude patterns -from file (use \- to read from stdin) \-\-exclude\-if\-present string -Exclude directories if filename is present \-\-expect\-continue\-timeout -duration Timeout when using expect / 100\-continue in HTTP (default 1s) -\-\-fast\-list Use recursive list if available. -Uses more memory but fewer transactions. -\-\-files\-from stringArray Read list of source\-file names from file -(use \- to read from stdin) \-\-files\-from\-raw stringArray Read list -of source\-file names from file without any processing of lines (use \- -to read from stdin) \-f, \-\-filter stringArray Add a file\-filtering -rule \-\-filter\-from stringArray Read filtering patterns from a file -(use \- to read from stdin) \-\-header stringArray Set HTTP header for -all transactions \-\-header\-download stringArray Set HTTP header for -download transactions \-\-header\-upload stringArray Set HTTP header for -upload transactions \-\-ignore\-case Ignore case in filters (case -insensitive) \-\-ignore\-case\-sync Ignore case when synchronizing -\-\-ignore\-checksum Skip post copy check of checksums. -\-\-ignore\-errors delete even if there are I/O errors -\-\-ignore\-existing Skip all files that exist on destination -\-\-ignore\-size Ignore size when skipping use mod\-time or checksum. -\-I, \-\-ignore\-times Don\[aq]t skip files that match size and time \- -transfer all files \-\-immutable Do not modify files. -Fail if existing files have been modified. -\-\-include stringArray Include files matching pattern \-\-include\-from -stringArray Read include patterns from file (use \- to read from stdin) -\-i, \-\-interactive Enable interactive mode \-\-log\-file string Log -everything to this file \-\-log\-format string Comma separated list of -log format options (default \[dq]date,time\[dq]) \-\-log\-level string -Log level DEBUG|INFO|NOTICE|ERROR (default \[dq]NOTICE\[dq]) -\-\-low\-level\-retries int Number of low level retries to do. -(default 10) \-\-max\-age Duration Only transfer files younger than this -in s or suffix ms|s|m|h|d|w|M|y (default off) \-\-max\-backlog int -Maximum number of objects in sync or check backlog. -(default 10000) \-\-max\-delete int When synchronizing, limit the number -of deletes (default \-1) \-\-max\-depth int If set limits the recursion -depth to this. -(default \-1) \-\-max\-duration duration Maximum duration rclone will -transfer data for. -\-\-max\-size SizeSuffix Only transfer files smaller than this in k or -suffix b|k|M|G (default off) \-\-max\-stats\-groups int Maximum number -of stats groups to keep in memory. -On max oldest is discarded. -(default 1000) \-\-max\-transfer SizeSuffix Maximum size of data to -transfer. -(default off) \-\-memprofile string Write memory profile to file -\-\-min\-age Duration Only transfer files older than this in s or suffix -ms|s|m|h|d|w|M|y (default off) \-\-min\-size SizeSuffix Only transfer -files bigger than this in k or suffix b|k|M|G (default off) -\-\-modify\-window duration Max time diff to be considered the same -(default 1ns) \-\-multi\-thread\-cutoff SizeSuffix Use multi\-thread -downloads for files above this size. -(default 250M) \-\-multi\-thread\-streams int Max number of streams to -use for multi\-thread downloads. -(default 4) \-\-no\-check\-certificate Do not verify the server SSL -certificate. -Insecure. -\-\-no\-check\-dest Don\[aq]t check the destination, copy regardless. -\-\-no\-gzip\-encoding Don\[aq]t set Accept\-Encoding: gzip. -\-\-no\-traverse Don\[aq]t traverse destination file system on copy. -\-\-no\-unicode\-normalization Don\[aq]t normalize unicode characters in -filenames. -\-\-no\-update\-modtime Don\[aq]t update destination mod\-time if files -identical. -\-\-order\-by string Instructions on how to order the transfers, eg -\[aq]size,descending\[aq] \-\-password\-command SpaceSepList Command for -supplying password for encrypted configuration. -\-P, \-\-progress Show progress during transfer. -\-q, \-\-quiet Print as little stuff as possible \-\-rc Enable the -remote control server. -\-\-rc\-addr string IPaddress:Port or :Port to bind server to. -(default \[dq]localhost:5572\[dq]) \-\-rc\-allow\-origin string Set the -allowed origin for CORS. -\-\-rc\-baseurl string Prefix for URLs \- leave blank for root. -\-\-rc\-cert string SSL PEM key (concatenation of certificate and CA -certificate) \-\-rc\-client\-ca string Client certificate authority to -verify clients with \-\-rc\-enable\-metrics Enable prometheus metrics on -/metrics \-\-rc\-files string Path to local files to serve on the HTTP -server. -\-\-rc\-htpasswd string htpasswd file \- if not provided no -authentication is done \-\-rc\-job\-expire\-duration duration expire -finished async jobs older than this value (default 1m0s) -\-\-rc\-job\-expire\-interval duration interval to check for expired -async jobs (default 10s) \-\-rc\-key string SSL PEM Private key -\-\-rc\-max\-header\-bytes int Maximum size of request header (default -4096) \-\-rc\-no\-auth Don\[aq]t require auth for certain methods. -\-\-rc\-pass string Password for authentication. -\-\-rc\-realm string realm for authentication (default \[dq]rclone\[dq]) -\-\-rc\-serve Enable the serving of remote objects. -\-\-rc\-server\-read\-timeout duration Timeout for server reading data -(default 1h0m0s) \-\-rc\-server\-write\-timeout duration Timeout for -server writing data (default 1h0m0s) \-\-rc\-template string User -Specified Template. -\-\-rc\-user string User name for authentication. -\-\-rc\-web\-fetch\-url string URL to fetch the releases for webgui. -(default -\[dq]https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest\[dq]) -\-\-rc\-web\-gui Launch WebGUI on localhost -\-\-rc\-web\-gui\-force\-update Force update to latest version of web -gui \-\-rc\-web\-gui\-no\-open\-browser Don\[aq]t open the browser -automatically \-\-rc\-web\-gui\-update Check and update to latest -version of web gui \-\-refresh\-times Refresh the modtime of remote -files. -\-\-retries int Retry operations this many times if they fail (default -3) \-\-retries\-sleep duration Interval between retrying operations if -they fail, e.g 500ms, 60s, 5m. -(0 to disable) \-\-size\-only Skip based on size only, not mod\-time or -checksum \-\-stats duration Interval between printing stats, e.g 500ms, -60s, 5m. -(0 to disable) (default 1m0s) \-\-stats\-file\-name\-length int Max file -name length in stats. -0 for no limit (default 45) \-\-stats\-log\-level string Log level to -show \-\-stats output DEBUG|INFO|NOTICE|ERROR (default \[dq]INFO\[dq]) -\-\-stats\-one\-line Make the stats fit on one line. -\-\-stats\-one\-line\-date Enables \-\-stats\-one\-line and add current -date/time prefix. -\-\-stats\-one\-line\-date\-format string Enables -\-\-stats\-one\-line\-date and uses custom formatted date. -Enclose date string in double quotes (\[dq]). -See https://golang.org/pkg/time/#Time.Format \-\-stats\-unit string Show -data rate in stats as either \[aq]bits\[aq] or \[aq]bytes\[aq]/s -(default \[dq]bytes\[dq]) \-\-streaming\-upload\-cutoff SizeSuffix -Cutoff for switching to chunked upload if file size is unknown. -Upload starts after reaching cutoff or when file ends. -(default 100k) \-\-suffix string Suffix to add to changed files. -\-\-suffix\-keep\-extension Preserve the extension when using -\-\-suffix. -\-\-syslog Use Syslog for logging \-\-syslog\-facility string Facility -for syslog, eg KERN,USER,... -(default \[dq]DAEMON\[dq]) \-\-timeout duration IO idle timeout (default -5m0s) \-\-tpslimit float Limit HTTP transactions per second to this. -\-\-tpslimit\-burst int Max burst of transactions for \-\-tpslimit. -(default 1) \-\-track\-renames When synchronizing, track file renames -and do a server side move if possible \-\-track\-renames\-strategy -string Strategies to use when synchronizing using track\-renames -hash|modtime|leaf (default \[dq]hash\[dq]) \-\-transfers int Number of -file transfers to run in parallel. -(default 4) \-u, \-\-update Skip files that are newer on the -destination. -\-\-use\-cookies Enable session cookiejar. -\-\-use\-json\-log Use json log format. -\-\-use\-mmap Use mmap allocator (see docs). -\-\-use\-server\-modtime Use server modified time instead of object -metadata \-\-user\-agent string Set the user\-agent to a specified -string. -The default is rclone/ version (default \[dq]rclone/v1.53.0\[dq]) \-v, -\-\-verbose count Print lots more stuff (repeat for more) -.IP -.nf -\f[C] - -## Backend Flags - -These flags are available for every command. They control the backends -and may be set in the config file. -\f[R] -.fi -.IP -.nf -\f[C] - \-\-acd\-auth\-url string Auth server URL. - \-\-acd\-client\-id string OAuth Client Id - \-\-acd\-client\-secret string OAuth Client Secret - \-\-acd\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) - \-\-acd\-templink\-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - \-\-acd\-token string OAuth Access Token as a JSON blob. - \-\-acd\-token\-url string Token server url. - \-\-acd\-upload\-wait\-per\-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) - \-\-alias\-remote string Remote or path to alias. - \-\-azureblob\-access\-tier string Access tier of blob: hot, cool or archive. - \-\-azureblob\-account string Storage Account Name (leave blank to use SAS URL or Emulator) - \-\-azureblob\-chunk\-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) - \-\-azureblob\-disable\-checksum Don\[aq]t store MD5 checksum with object metadata. - \-\-azureblob\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) - \-\-azureblob\-endpoint string Endpoint for the service - \-\-azureblob\-key string Storage Account Key (leave blank to use SAS URL or Emulator) - \-\-azureblob\-list\-chunk int Size of blob list. (default 5000) - \-\-azureblob\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - \-\-azureblob\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. - \-\-azureblob\-sas\-url string SAS URL for container level access only - \-\-azureblob\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) - \-\-azureblob\-use\-emulator Uses local storage emulator if provided as \[aq]true\[aq] (leave blank if using real azure storage endpoint) - \-\-b2\-account string Account ID or Application Key ID - \-\-b2\-chunk\-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) - \-\-b2\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) - \-\-b2\-disable\-checksum Disable checksums for large (> upload cutoff) files - \-\-b2\-download\-auth\-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) - \-\-b2\-download\-url string Custom endpoint for downloads. - \-\-b2\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - \-\-b2\-endpoint string Endpoint for the service. - \-\-b2\-hard\-delete Permanently delete files on remote removal, otherwise hide files. - \-\-b2\-key string Application Key - \-\-b2\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - \-\-b2\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. - \-\-b2\-test\-mode string A flag string for X\-Bz\-Test\-Mode header for debugging. - \-\-b2\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) - \-\-b2\-versions Include old versions in directory listings. - \-\-box\-access\-token string Box App Primary Access Token - \-\-box\-auth\-url string Auth server URL. - \-\-box\-box\-config\-file string Box App config.json location - \-\-box\-box\-sub\-type string (default \[dq]user\[dq]) - \-\-box\-client\-id string OAuth Client Id - \-\-box\-client\-secret string OAuth Client Secret - \-\-box\-commit\-retries int Max number of times to try committing a multipart file. (default 100) - \-\-box\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) - \-\-box\-root\-folder\-id string Fill in for rclone to use a non root folder as its starting point. - \-\-box\-token string OAuth Access Token as a JSON blob. - \-\-box\-token\-url string Token server url. - \-\-box\-upload\-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) - \-\-cache\-chunk\-clean\-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) - \-\-cache\-chunk\-no\-memory Disable the in\-memory cache for storing chunks during streaming. - \-\-cache\-chunk\-path string Directory to cache chunk files. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) - \-\-cache\-chunk\-size SizeSuffix The size of a chunk (partial file data). (default 5M) - \-\-cache\-chunk\-total\-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) - \-\-cache\-db\-path string Directory to store file structure metadata DB. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) - \-\-cache\-db\-purge Clear all the cached data for this remote on start. - \-\-cache\-db\-wait\-time Duration How long to wait for the DB to be available \- 0 is unlimited (default 1s) - \-\-cache\-info\-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) - \-\-cache\-plex\-insecure string Skip all certificate verification when connecting to the Plex server - \-\-cache\-plex\-password string The password of the Plex user (obscured) - \-\-cache\-plex\-url string The URL of the Plex server - \-\-cache\-plex\-username string The username of the Plex user - \-\-cache\-read\-retries int How many times to retry a read from a cache storage. (default 10) - \-\-cache\-remote string Remote to cache. - \-\-cache\-rps int Limits the number of requests per second to the source FS (\-1 to disable) (default \-1) - \-\-cache\-tmp\-upload\-path string Directory to keep temporary files until they are uploaded. - \-\-cache\-tmp\-wait\-time Duration How long should files be stored in local cache before being uploaded (default 15s) - \-\-cache\-workers int How many workers should run in parallel to download chunks. (default 4) - \-\-cache\-writes Cache file data on writes through the FS - \-\-chunker\-chunk\-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) - \-\-chunker\-fail\-hard Choose how chunker should handle files with missing or invalid chunks. - \-\-chunker\-hash\-type string Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. (default \[dq]md5\[dq]) - \-\-chunker\-meta\-format string Format of the metadata object or \[dq]none\[dq]. By default \[dq]simplejson\[dq]. (default \[dq]simplejson\[dq]) - \-\-chunker\-name\-format string String format of chunk file names. (default \[dq]*.rclone_chunk.###\[dq]) - \-\-chunker\-remote string Remote to chunk/unchunk. - \-\-chunker\-start\-from int Minimum valid chunk number. Usually 0 or 1. (default 1) -\f[R] -.fi -\-L, \-\-copy\-links Follow symlinks and copy the pointed to item. -\-\-crypt\-directory\-name\-encryption Option to either encrypt -directory names or leave them intact. -(default true) \-\-crypt\-filename\-encryption string How to encrypt the -filenames. -(default \[dq]standard\[dq]) \-\-crypt\-password string Password or pass -phrase for encryption. -(obscured) \-\-crypt\-password2 string Password or pass phrase for salt. -Optional but recommended. -(obscured) \-\-crypt\-remote string Remote to encrypt/decrypt. -\-\-crypt\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different crypt configs. -\-\-crypt\-show\-mapping For all files listed show how the names -encrypt. -\-\-drive\-acknowledge\-abuse Set to allow files which return -cannotDownloadAbusiveFile to be downloaded. -\-\-drive\-allow\-import\-name\-change Allow the filetype to change when -uploading Google docs (e.g. -file.doc to file.docx). -This will confuse sync and reupload every time. -\-\-drive\-auth\-owner\-only Only consider files owned by the -authenticated user. -\-\-drive\-auth\-url string Auth server URL. -\-\-drive\-chunk\-size SizeSuffix Upload chunk size. -Must a power of 2 >= 256k. -(default 8M) \-\-drive\-client\-id string OAuth Client Id -\-\-drive\-client\-secret string OAuth Client Secret -\-\-drive\-disable\-http2 Disable drive using http2 (default true) -\-\-drive\-encoding MultiEncoder This sets the encoding for the backend. -(default InvalidUtf8) \-\-drive\-export\-formats string Comma separated -list of preferred formats for downloading Google docs. -(default \[dq]docx,xlsx,pptx,svg\[dq]) \-\-drive\-formats string -Deprecated: see export_formats \-\-drive\-impersonate string Impersonate -this user when using a service account. -\-\-drive\-import\-formats string Comma separated list of preferred -formats for uploading Google docs. -\-\-drive\-keep\-revision\-forever Keep new head revision of each file -forever. -\-\-drive\-list\-chunk int Size of listing chunk 100\-1000. -0 to disable. -(default 1000) \-\-drive\-pacer\-burst int Number of API calls to allow -without sleeping. -(default 100) \-\-drive\-pacer\-min\-sleep Duration Minimum time to -sleep between API calls. -(default 100ms) \-\-drive\-root\-folder\-id string ID of the root folder -\-\-drive\-scope string Scope that rclone should use when requesting -access from drive. -\-\-drive\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different drive configs. -\-\-drive\-service\-account\-credentials string Service Account -Credentials JSON blob \-\-drive\-service\-account\-file string Service -Account Credentials JSON file path \-\-drive\-shared\-with\-me Only show -files that are shared with me. -\-\-drive\-size\-as\-quota Show sizes as storage quota usage, not actual -size. -\-\-drive\-skip\-checksum\-gphotos Skip MD5 checksum on Google photos -and videos only. -\-\-drive\-skip\-gdocs Skip google documents in all listings. -\-\-drive\-skip\-shortcuts If set skip shortcut files -\-\-drive\-starred\-only Only show files that are starred. -\-\-drive\-stop\-on\-upload\-limit Make upload limit errors be fatal -\-\-drive\-team\-drive string ID of the Team Drive \-\-drive\-token -string OAuth Access Token as a JSON blob. -\-\-drive\-token\-url string Token server url. -\-\-drive\-trashed\-only Only show files that are in the trash. -\-\-drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked -upload (default 8M) \-\-drive\-use\-created\-date Use file created date -instead of modified date., \-\-drive\-use\-shared\-date Use date file -was shared instead of modified date. -\-\-drive\-use\-trash Send files to the trash instead of deleting -permanently. -(default true) \-\-drive\-v2\-download\-min\-size SizeSuffix If -Object\[aq]s are greater, use drive v2 API to download. -(default off) \-\-dropbox\-auth\-url string Auth server URL. -\-\-dropbox\-chunk\-size SizeSuffix Upload chunk size. -(< 150M). -(default 48M) \-\-dropbox\-client\-id string OAuth Client Id -\-\-dropbox\-client\-secret string OAuth Client Secret -\-\-dropbox\-encoding MultiEncoder This sets the encoding for the -backend. -(default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) -\-\-dropbox\-impersonate string Impersonate this user when using a -business account. -\-\-dropbox\-token string OAuth Access Token as a JSON blob. -\-\-dropbox\-token\-url string Token server url. -\-\-fichier\-api\-key string Your API Key, get it from -https://1fichier.com/console/params.pl \-\-fichier\-encoding -MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) -\-\-fichier\-shared\-folder string If you want to download a shared -folder, add this parameter \-\-ftp\-concurrency int Maximum number of -FTP simultaneous connections, 0 for unlimited \-\-ftp\-disable\-epsv -Disable using EPSV even if server advertises support \-\-ftp\-encoding -MultiEncoder This sets the encoding for the backend. -(default Slash,Del,Ctl,RightSpace,Dot) \-\-ftp\-explicit\-tls Use FTP -over TLS (Explicit) \-\-ftp\-host string FTP host to connect to -\-\-ftp\-no\-check\-certificate Do not verify the TLS certificate of the -server \-\-ftp\-pass string FTP password (obscured) \-\-ftp\-port string -FTP port, leave blank to use default (21) \-\-ftp\-tls Use FTPS over TLS -(Implicit) \-\-ftp\-user string FTP username, leave blank for current -username, $USER \-\-gcs\-anonymous Access public buckets and objects -without credentials \-\-gcs\-auth\-url string Auth server URL. -\-\-gcs\-bucket\-acl string Access Control List for new buckets. -\-\-gcs\-bucket\-policy\-only Access checks should use bucket\-level IAM -policies. -\-\-gcs\-client\-id string OAuth Client Id \-\-gcs\-client\-secret -string OAuth Client Secret \-\-gcs\-encoding MultiEncoder This sets the -encoding for the backend. -(default Slash,CrLf,InvalidUtf8,Dot) \-\-gcs\-location string Location -for the newly created buckets. -\-\-gcs\-object\-acl string Access Control List for new objects. -\-\-gcs\-project\-number string Project number. -\-\-gcs\-service\-account\-file string Service Account Credentials JSON -file path \-\-gcs\-storage\-class string The storage class to use when -storing objects in Google Cloud Storage. -\-\-gcs\-token string OAuth Access Token as a JSON blob. -\-\-gcs\-token\-url string Token server url. -\-\-gphotos\-auth\-url string Auth server URL. -\-\-gphotos\-client\-id string OAuth Client Id -\-\-gphotos\-client\-secret string OAuth Client Secret -\-\-gphotos\-read\-only Set to make the Google Photos backend read only. -\-\-gphotos\-read\-size Set to read the size of media items. -\-\-gphotos\-start\-year int Year limits the photos to be downloaded to -those which are uploaded after the given year (default 2000) -\-\-gphotos\-token string OAuth Access Token as a JSON blob. -\-\-gphotos\-token\-url string Token server url. -\-\-http\-headers CommaSepList Set HTTP headers for all transactions -\-\-http\-no\-head Don\[aq]t use HEAD requests to find file sizes in dir -listing \-\-http\-no\-slash Set this if the site doesn\[aq]t end -directories with / \-\-http\-url string URL of http host to connect to -\-\-hubic\-auth\-url string Auth server URL. -\-\-hubic\-chunk\-size SizeSuffix Above this size files will be chunked -into a _segments container. -(default 5G) \-\-hubic\-client\-id string OAuth Client Id -\-\-hubic\-client\-secret string OAuth Client Secret \-\-hubic\-encoding -MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8) \-\-hubic\-no\-chunk Don\[aq]t chunk files -during streaming upload. -\-\-hubic\-token string OAuth Access Token as a JSON blob. -\-\-hubic\-token\-url string Token server url. -\-\-jottacloud\-encoding MultiEncoder This sets the encoding for the -backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) -\-\-jottacloud\-hard\-delete Delete files permanently rather than -putting them into the trash. -\-\-jottacloud\-md5\-memory\-limit SizeSuffix Files bigger than this -will be cached on disk to calculate the MD5 if required. -(default 10M) \-\-jottacloud\-trashed\-only Only show files that are in -the trash. -\-\-jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this -can be resumed if the upload fail\[aq]s. -(default 10M) \-\-koofr\-encoding MultiEncoder This sets the encoding -for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) \-\-koofr\-endpoint -string The Koofr API endpoint to use (default -\[dq]https://app.koofr.net\[dq]) \-\-koofr\-mountid string Mount ID of -the mount to use. -If omitted, the primary mount is used. -\-\-koofr\-password string Your Koofr password for rclone (generate one -at https://app.koofr.net/app/admin/preferences/password) (obscured) -\-\-koofr\-setmtime Does the backend support setting modification time. -Set this to false if you use a mount ID that points to a Dropbox or -Amazon Drive backend. -(default true) \-\-koofr\-user string Your Koofr user name \-l, -\-\-links Translate symlinks to/from regular files with a -\[aq].rclonelink\[aq] extension \-\-local\-case\-insensitive Force the -filesystem to report itself as case insensitive -\-\-local\-case\-sensitive Force the filesystem to report itself as case -sensitive. -\-\-local\-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,Dot) \-\-local\-no\-check\-updated Don\[aq]t check to see -if the files change during upload \-\-local\-no\-set\-modtime Disable -setting modtime \-\-local\-no\-sparse Disable sparse files for -multi\-thread downloads \-\-local\-no\-unicode\-normalization Don\[aq]t -apply unicode normalization to paths and filenames (Deprecated) -\-\-local\-nounc string Disable UNC (long path names) conversion on -Windows \-\-mailru\-check\-hash What should copy do if file checksum is -mismatched or invalid (default true) \-\-mailru\-encoding MultiEncoder -This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) -\-\-mailru\-pass string Password (obscured) \-\-mailru\-speedup\-enable -Skip full upload if there is another file with same data hash. -(default true) \-\-mailru\-speedup\-file\-patterns string Comma -separated list of file name patterns eligible for speedup (put by hash). -(default -\[dq]\f[I].mkv,\f[R].avi,\f[I].mp4,\f[R].mp3,\f[I].zip,\f[R].gz,\f[I].rar,\f[R].pdf\[dq]) -\-\-mailru\-speedup\-max\-disk SizeSuffix This option allows you to -disable speedup (put by hash) for large files (default 3G) -\-\-mailru\-speedup\-max\-memory SizeSuffix Files larger than the size -given below will always be hashed on disk. -(default 32M) \-\-mailru\-user string User name (usually email) -\-\-mega\-debug Output more debug from Mega. -\-\-mega\-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8,Dot) \-\-mega\-hard\-delete Delete files -permanently rather than putting them into the trash. -\-\-mega\-pass string Password. -(obscured) \-\-mega\-user string User name \-x, \-\-one\-file\-system -Don\[aq]t cross filesystem boundaries (unix/macOS only). -\-\-onedrive\-auth\-url string Auth server URL. -\-\-onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- -must be multiple of 320k (327,680 bytes). -(default 10M) \-\-onedrive\-client\-id string OAuth Client Id -\-\-onedrive\-client\-secret string OAuth Client Secret -\-\-onedrive\-drive\-id string The ID of the drive to use -\-\-onedrive\-drive\-type string The type of the drive ( personal | -business | documentLibrary ) \-\-onedrive\-encoding MultiEncoder This -sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) -\-\-onedrive\-expose\-onenote\-files Set to make OneNote files show up -in directory listings. -\-\-onedrive\-no\-versions Remove all versions on modifying operations -\-\-onedrive\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different onedrive configs. -\-\-onedrive\-token string OAuth Access Token as a JSON blob. -\-\-onedrive\-token\-url string Token server url. -\-\-opendrive\-chunk\-size SizeSuffix Files will be uploaded in chunks -this size. -(default 10M) \-\-opendrive\-encoding MultiEncoder This sets the -encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) -\-\-opendrive\-password string Password. -(obscured) \-\-opendrive\-username string Username \-\-pcloud\-auth\-url -string Auth server URL. -\-\-pcloud\-client\-id string OAuth Client Id \-\-pcloud\-client\-secret -string OAuth Client Secret \-\-pcloud\-encoding MultiEncoder This sets -the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) \-\-pcloud\-hostname -string Hostname to connect to. -(default \[dq]api.pcloud.com\[dq]) \-\-pcloud\-root\-folder\-id string -Fill in for rclone to use a non root folder as its starting point. -(default \[dq]d0\[dq]) \-\-pcloud\-token string OAuth Access Token as a -JSON blob. -\-\-pcloud\-token\-url string Token server url. -\-\-premiumizeme\-encoding MultiEncoder This sets the encoding for the -backend. -(default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) -\-\-putio\-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) -\-\-qingstor\-access\-key\-id string QingStor Access Key ID -\-\-qingstor\-chunk\-size SizeSuffix Chunk size to use for uploading. -(default 4M) \-\-qingstor\-connection\-retries int Number of connection -retries. -(default 3) \-\-qingstor\-encoding MultiEncoder This sets the encoding -for the backend. -(default Slash,Ctl,InvalidUtf8) \-\-qingstor\-endpoint string Enter an -endpoint URL to connection QingStor API. -\-\-qingstor\-env\-auth Get QingStor credentials from runtime. -Only applies if access_key_id and secret_access_key is blank. -\-\-qingstor\-secret\-access\-key string QingStor Secret Access Key -(password) \-\-qingstor\-upload\-concurrency int Concurrency for -multipart uploads. -(default 1) \-\-qingstor\-upload\-cutoff SizeSuffix Cutoff for switching -to chunked upload (default 200M) \-\-qingstor\-zone string Zone to -connect to. -\-\-s3\-access\-key\-id string AWS Access Key ID. -\-\-s3\-acl string Canned ACL used when creating buckets and storing or -copying objects. -\-\-s3\-bucket\-acl string Canned ACL used when creating buckets. -\-\-s3\-chunk\-size SizeSuffix Chunk size to use for uploading. -(default 5M) \-\-s3\-copy\-cutoff SizeSuffix Cutoff for switching to -multipart copy (default 4.656G) \-\-s3\-disable\-checksum Don\[aq]t -store MD5 checksum with object metadata \-\-s3\-encoding MultiEncoder -This sets the encoding for the backend. -(default Slash,InvalidUtf8,Dot) \-\-s3\-endpoint string Endpoint for S3 -API. -\-\-s3\-env\-auth Get AWS credentials from runtime (environment -variables or EC2/ECS meta data if no env vars). -\-\-s3\-force\-path\-style If true use path style access if false use -virtual hosted style. -(default true) \-\-s3\-leave\-parts\-on\-error If true avoid calling -abort upload on a failure, leaving all successfully uploaded parts on S3 -for manual recovery. -\-\-s3\-list\-chunk int Size of listing chunk (response list for each -ListObject S3 request). -(default 1000) \-\-s3\-location\-constraint string Location constraint -\- must be set to match the Region. -\-\-s3\-max\-upload\-parts int Maximum number of parts in a multipart -upload. -(default 10000) \-\-s3\-memory\-pool\-flush\-time Duration How often -internal memory buffer pools will be flushed. -(default 1m0s) \-\-s3\-memory\-pool\-use\-mmap Whether to use mmap -buffers in internal memory pool. -\-\-s3\-no\-check\-bucket If set don\[aq]t attempt to check the bucket -exists or create it \-\-s3\-profile string Profile to use in the shared -credentials file \-\-s3\-provider string Choose your S3 provider. -\-\-s3\-region string Region to connect to. -\-\-s3\-secret\-access\-key string AWS Secret Access Key (password) -\-\-s3\-server\-side\-encryption string The server\-side encryption -algorithm used when storing this object in S3. -\-\-s3\-session\-token string An AWS session token -\-\-s3\-shared\-credentials\-file string Path to the shared credentials -file \-\-s3\-sse\-customer\-algorithm string If using SSE\-C, the -server\-side encryption algorithm used when storing this object in S3. -\-\-s3\-sse\-customer\-key string If using SSE\-C you must provide the -secret encryption key used to encrypt/decrypt your data. -\-\-s3\-sse\-customer\-key\-md5 string If using SSE\-C you must provide -the secret encryption key MD5 checksum. -\-\-s3\-sse\-kms\-key\-id string If using KMS ID you must provide the -ARN of Key. -\-\-s3\-storage\-class string The storage class to use when storing new -objects in S3. -\-\-s3\-upload\-concurrency int Concurrency for multipart uploads. -(default 4) \-\-s3\-upload\-cutoff SizeSuffix Cutoff for switching to -chunked upload (default 200M) \-\-s3\-use\-accelerate\-endpoint If true -use the AWS S3 accelerated endpoint. -\-\-s3\-v2\-auth If true use v2 authentication. -\-\-seafile\-2fa Two\-factor authentication (\[aq]true\[aq] if the -account has 2FA enabled) \-\-seafile\-create\-library Should rclone -create a library if it doesn\[aq]t exist \-\-seafile\-encoding -MultiEncoder This sets the encoding for the backend. -(default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) -\-\-seafile\-library string Name of the library. -Leave blank to access all non\-encrypted libraries. -\-\-seafile\-library\-key string Library password (for encrypted -libraries only). -Leave blank if you pass it through the command line. -(obscured) \-\-seafile\-pass string Password (obscured) \-\-seafile\-url -string URL of seafile host to connect to \-\-seafile\-user string User -name (usually email address) \-\-sftp\-ask\-password Allow asking for -SFTP password when needed. -\-\-sftp\-disable\-hashcheck Disable the execution of SSH commands to -determine if remote file hashing is available. -\-\-sftp\-host string SSH host to connect to \-\-sftp\-key\-file string -Path to PEM\-encoded private key file, leave blank or set -key\-use\-agent to use ssh\-agent. -\-\-sftp\-key\-file\-pass string The passphrase to decrypt the -PEM\-encoded private key file. -(obscured) \-\-sftp\-key\-pem string Raw PEM\-encoded private key, If -specified, will override key_file parameter. -\-\-sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. -\-\-sftp\-md5sum\-command string The command used to read md5 hashes. -Leave blank for autodetect. -\-\-sftp\-pass string SSH password, leave blank to use ssh\-agent. -(obscured) \-\-sftp\-path\-override string Override path used by SSH -connection. -\-\-sftp\-port string SSH port, leave blank to use default (22) -\-\-sftp\-server\-command string Specifies the path or command to run a -sftp server on the remote host. -\-\-sftp\-set\-modtime Set the modified time on the remote if set. -(default true) \-\-sftp\-sha1sum\-command string The command used to -read sha1 hashes. -Leave blank for autodetect. -\-\-sftp\-skip\-links Set to skip any symlinks and any other non regular -files. -\-\-sftp\-subsystem string Specifies the SSH2 subsystem on the remote -host. -(default \[dq]sftp\[dq]) \-\-sftp\-use\-insecure\-cipher Enable the use -of insecure ciphers and key exchange methods. -\-\-sftp\-user string SSH username, leave blank for current username, -ncw \-\-sharefile\-chunk\-size SizeSuffix Upload chunk size. -Must a power of 2 >= 256k. -(default 64M) \-\-sharefile\-encoding MultiEncoder This sets the -encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) -\-\-sharefile\-endpoint string Endpoint for API calls. -\-\-sharefile\-root\-folder\-id string ID of the root folder -\-\-sharefile\-upload\-cutoff SizeSuffix Cutoff for switching to -multipart upload. -(default 128M) \-\-skip\-links Don\[aq]t warn about skipped symlinks. -\-\-sugarsync\-access\-key\-id string Sugarsync Access Key ID. -\-\-sugarsync\-app\-id string Sugarsync App ID. -\-\-sugarsync\-authorization string Sugarsync authorization -\-\-sugarsync\-authorization\-expiry string Sugarsync authorization -expiry \-\-sugarsync\-deleted\-id string Sugarsync deleted folder id -\-\-sugarsync\-encoding MultiEncoder This sets the encoding for the -backend. -(default Slash,Ctl,InvalidUtf8,Dot) \-\-sugarsync\-hard\-delete -Permanently delete files if true \-\-sugarsync\-private\-access\-key -string Sugarsync Private Access Key \-\-sugarsync\-refresh\-token string -Sugarsync refresh token \-\-sugarsync\-root\-id string Sugarsync root id -\-\-sugarsync\-user string Sugarsync user -\-\-swift\-application\-credential\-id string Application Credential ID -(OS_APPLICATION_CREDENTIAL_ID) \-\-swift\-application\-credential\-name -string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) -\-\-swift\-application\-credential\-secret string Application Credential -Secret (OS_APPLICATION_CREDENTIAL_SECRET) \-\-swift\-auth string -Authentication URL for server (OS_AUTH_URL). -\-\-swift\-auth\-token string Auth Token from alternate authentication -\- optional (OS_AUTH_TOKEN) \-\-swift\-auth\-version int AuthVersion \- -optional \- set to (1,2,3) if your auth URL has no version -(ST_AUTH_VERSION) \-\-swift\-chunk\-size SizeSuffix Above this size -files will be chunked into a _segments container. -(default 5G) \-\-swift\-domain string User domain \- optional (v3 auth) -(OS_USER_DOMAIN_NAME) \-\-swift\-encoding MultiEncoder This sets the -encoding for the backend. -(default Slash,InvalidUtf8) \-\-swift\-endpoint\-type string Endpoint -type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default -\[dq]public\[dq]) \-\-swift\-env\-auth Get swift credentials from -environment variables in standard OpenStack form. -\-\-swift\-key string API key or password (OS_PASSWORD). -\-\-swift\-no\-chunk Don\[aq]t chunk files during streaming upload. -\-\-swift\-region string Region name \- optional (OS_REGION_NAME) -\-\-swift\-storage\-policy string The storage policy to use when -creating a new container \-\-swift\-storage\-url string Storage URL \- -optional (OS_STORAGE_URL) \-\-swift\-tenant string Tenant name \- -optional for v1 auth, this or tenant_id required otherwise -(OS_TENANT_NAME or OS_PROJECT_NAME) \-\-swift\-tenant\-domain string -Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) -\-\-swift\-tenant\-id string Tenant ID \- optional for v1 auth, this or -tenant required otherwise (OS_TENANT_ID) \-\-swift\-user string User -name to log in (OS_USERNAME). -\-\-swift\-user\-id string User ID to log in \- optional \- most swift -systems use user and leave this blank (v3 auth) (OS_USER_ID). -\-\-tardigrade\-access\-grant string Access Grant. -\-\-tardigrade\-api\-key string API Key. -\-\-tardigrade\-passphrase string Encryption Passphrase. -To access existing objects enter passphrase used for uploading. -\-\-tardigrade\-provider string Choose an authentication method. -(default \[dq]existing\[dq]) \-\-tardigrade\-satellite\-address \[at] -: Satellite Address. -Custom satellite address should match the format: \[at] -.PP -:. -(default \[dq]us\-central\-1.tardigrade.io\[dq]) -\-\-union\-action\-policy string Policy to choose upstream on ACTION -category. -(default \[dq]epall\[dq]) \-\-union\-cache\-time int Cache time of usage -and free space (in seconds). -This option is only useful when a path preserving policy is used. -(default 120) \-\-union\-create\-policy string Policy to choose upstream -on CREATE category. -(default \[dq]epmfs\[dq]) \-\-union\-search\-policy string Policy to -choose upstream on SEARCH category. -(default \[dq]ff\[dq]) \-\-union\-upstreams string List of space -separated upstreams. -\-\-webdav\-bearer\-token string Bearer token instead of user/pass (eg a -Macaroon) \-\-webdav\-bearer\-token\-command string Command to run to -get a bearer token \-\-webdav\-pass string Password. -(obscured) \-\-webdav\-url string URL of http host to connect to -\-\-webdav\-user string User name \-\-webdav\-vendor string Name of the -Webdav site/service/software you are using \-\-yandex\-auth\-url string -Auth server URL. -\-\-yandex\-client\-id string OAuth Client Id \-\-yandex\-client\-secret -string OAuth Client Secret \-\-yandex\-encoding MultiEncoder This sets -the encoding for the backend. -(default Slash,Del,Ctl,InvalidUtf8,Dot) \-\-yandex\-token string OAuth -Access Token as a JSON blob. -\-\-yandex\-token\-url string Token server url. -.IP -.nf -\f[C] - - 1Fichier -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -This is a backend for the [1fichier](https://1fichier.com) cloud -storage service. Note that a Premium subscription is required to use -the API. - -Paths are specified as \[ga]remote:path\[ga] - -Paths may be as deep as required, eg \[ga]remote:directory/subdirectory\[ga]. - -The initial setup for 1Fichier involves getting the API key from the website which you -need to do in your browser. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] XX / -1Fichier \ \[dq]fichier\[dq] [snip] Storage> fichier ** See help for -fichier backend at: https://rclone.org/fichier/ ** -.PP -Your API Key, get it from https://1fichier.com/console/params.pl Enter a -string value. -Press Enter for the default (\[dq]\[dq]). -api_key> example_key -.PP -Edit advanced config? -(y/n) y) Yes n) No y/n> Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = fichier api_key -= example_key \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y .IP .nf \f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / 1Fichier + \[rs] \[dq]fichier\[dq] +[snip] +Storage> fichier +** See help for fichier backend at: https://rclone.org/fichier/ ** -Once configured you can then use \[ga]rclone\[ga] like this, +Your API Key, get it from https://1fichier.com/console/params.pl +Enter a string value. Press Enter for the default (\[dq]\[dq]). +api_key> example_key +Edit advanced config? (y/n) +y) Yes +n) No +y/n> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = fichier +api_key = example_key +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP List directories in top level of your 1Fichier account - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP List all the files in your 1Fichier account - - rclone ls remote: - +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP To copy a local directory to a 1Fichier directory called backup - - rclone copy /home/source remote:backup - -### Modified time and hashes ### - -1Fichier does not support modification times. It supports the Whirlpool hash algorithm. - -### Duplicated files ### - -1Fichier can have two files with exactly the same name and path (unlike a -normal file system). - +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Modified time and hashes +.PP +1Fichier does not support modification times. +It supports the Whirlpool hash algorithm. +.SS Duplicated files +.PP +1Fichier can have two files with exactly the same name and path (unlike +a normal file system). +.PP Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs] | 0x5C | \[uFF3C] | -| < | 0x3C | \[uFF1C] | -| > | 0x3E | \[uFF1E] | -| \[dq] | 0x22 | \[uFF02] | -| $ | 0x24 | \[uFF04] | -| \[ga] | 0x60 | \[uFF40] | -| \[aq] | 0x27 | \[uFF07] | - +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +T{ +< +T}@T{ +0x3C +T}@T{ +\[uFF1C] +T} +T{ +> +T}@T{ +0x3E +T}@T{ +\[uFF1E] +T} +T{ +\[dq] +T}@T{ +0x22 +T}@T{ +\[uFF02] +T} +T{ +$ +T}@T{ +0x24 +T}@T{ +\[uFF04] +T} +T{ +\[ga] +T}@T{ +0x60 +T}@T{ +\[uFF40] +T} +T{ +\[aq] +T}@T{ +0x27 +T}@T{ +\[uFF07] +T} +.TE +.PP File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP Here are the standard options specific to fichier (1Fichier). - -#### \-\-fichier\-api\-key - +.SS \-\-fichier\-api\-key +.PP Your API Key, get it from https://1fichier.com/console/params.pl - -\- Config: api_key -\- Env Var: RCLONE_FICHIER_API_KEY -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - +.IP \[bu] 2 +Config: api_key +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_API_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP Here are the advanced options specific to fichier (1Fichier). - -#### \-\-fichier\-shared\-folder - +.SS \-\-fichier\-shared\-folder +.PP If you want to download a shared folder, add this parameter - -\- Config: shared_folder -\- Env Var: RCLONE_FICHIER_SHARED_FOLDER -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-fichier\-encoding - +.IP \[bu] 2 +Config: shared_folder +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_SHARED_FOLDER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-fichier\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_FICHIER_ENCODING -\- Type: MultiEncoder -\- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot - - - - Alias -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]alias\[ga] remote provides a new name for another remote. - -Paths may be as deep as required or a local path, -eg \[ga]remote:directory/subdirectory\[ga] or \[ga]/directory/subdirectory\[ga]. - -During the initial setup with \[ga]rclone config\[ga] you will specify the target -remote. The target remote can either be a local path or another remote. - -Subfolders can be used in target remote. Assume an alias remote named \[ga]backup\[ga] -with the target \[ga]mydrive:private/backup\[ga]. Invoking \[ga]rclone mkdir backup:desktop\[ga] -is exactly the same as invoking \[ga]rclone mkdir mydrive:private/backup/desktop\[ga]. - -There will be no special handling of paths containing \[ga]..\[ga] segments. -Invoking \[ga]rclone mkdir backup:../desktop\[ga] is exactly the same as invoking -\[ga]rclone mkdir mydrive:private/backup/../desktop\[ga]. -The empty path is not allowed as a remote. To alias the current directory -use \[ga].\[ga] instead. - -Here is an example of how to make an alias called \[ga]remote\[ga] for local folder. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +.SS Alias +.PP +The \f[C]alias\f[R] remote provides a new name for another remote. +.PP +Paths may be as deep as required or a local path, eg +\f[C]remote:directory/subdirectory\f[R] or +\f[C]/directory/subdirectory\f[R]. +.PP +During the initial setup with \f[C]rclone config\f[R] you will specify +the target remote. +The target remote can either be a local path or another remote. +.PP +Subfolders can be used in target remote. +Assume an alias remote named \f[C]backup\f[R] with the target +\f[C]mydrive:private/backup\f[R]. +Invoking \f[C]rclone mkdir backup:desktop\f[R] is exactly the same as +invoking \f[C]rclone mkdir mydrive:private/backup/desktop\f[R]. +.PP +There will be no special handling of paths containing \f[C]..\f[R] +segments. +Invoking \f[C]rclone mkdir backup:../desktop\f[R] is exactly the same as +invoking \f[C]rclone mkdir mydrive:private/backup/../desktop\f[R]. +The empty path is not allowed as a remote. +To alias the current directory use \f[C].\f[R] instead. +.PP +Here is an example of how to make an alias called \f[C]remote\f[R] for +local folder. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Alias -for an existing remote \ \[dq]alias\[dq] [snip] Storage> alias Remote or -path to alias. -Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], -\[dq]myremote:\[dq] or \[dq]/local/path\[dq]. -remote> /mnt/storage/backup Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] remote = -/mnt/storage/backup \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this -is OK e) Edit this remote d) Delete this remote y/e/d> y Current -remotes: -.PP -Name Type ==== ==== remote alias -.IP "e)" 3 -Edit existing remote -.IP "f)" 3 -New remote -.IP "g)" 3 -Delete remote -.IP "h)" 3 -Rename remote -.IP "i)" 3 -Copy remote -.IP "j)" 3 -Set configuration password -.IP "k)" 3 -Quit config e/n/d/r/c/s/q> q .IP .nf \f[C] - -Once configured you can then use \[ga]rclone\[ga] like this, - -List directories in top level in \[ga]/mnt/storage/backup\[ga] - - rclone lsd remote: - -List all the files in \[ga]/mnt/storage/backup\[ga] - - rclone ls remote: - -Copy another local directory to the alias directory called source - - rclone copy /home/source remote:source - - -### Standard Options - -Here are the standard options specific to alias (Alias for an existing remote). - -#### \-\-alias\-remote - + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Alias for an existing remote + \[rs] \[dq]alias\[dq] +[snip] +Storage> alias Remote or path to alias. Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], \[dq]myremote:\[dq] or \[dq]/local/path\[dq]. +remote> /mnt/storage/backup +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +remote = /mnt/storage/backup +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: -\- Config: remote -\- Env Var: RCLONE_ALIAS_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - - - - Amazon Drive -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +Name Type +==== ==== +remote alias +e) Edit existing remote +n) New remote +d) Delete remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +e/n/d/r/c/s/q> q +\f[R] +.fi +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level in \f[C]/mnt/storage/backup\f[R] +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in \f[C]/mnt/storage/backup\f[R] +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +Copy another local directory to the alias directory called source +.IP +.nf +\f[C] +rclone copy /home/source remote:source +\f[R] +.fi +.SS Standard Options +.PP +Here are the standard options specific to alias (Alias for an existing +remote). +.SS \-\-alias\-remote +.PP +Remote or path to alias. +Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], +\[dq]myremote:\[dq] or \[dq]/local/path\[dq]. +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_ALIAS_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Amazon Drive +.PP Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers. - -## Status - -**Important:** rclone supports Amazon Drive only if you have your own -set of API keys. Unfortunately the [Amazon Drive developer -program](https://developer.amazon.com/amazon\-drive) is now closed to -new entries so if you don\[aq]t already have your own set of keys you will -not be able to use rclone with Amazon Drive. - -For the history on why rclone no longer has a set of Amazon Drive API -keys see [the forum](https://forum.rclone.org/t/rclone\-has\-been\-banned\-from\-amazon\-drive/2314). - -If you happen to know anyone who works at Amazon then please ask them -to re\-instate rclone into the Amazon Drive developer program \- thanks! - -## Setup - -The initial setup for Amazon Drive involves getting a token from -Amazon which you need to do in your browser. \[ga]rclone config\[ga] walks -you through it. - -The configuration process for Amazon Drive may involve using an [oauth -proxy](https://github.com/ncw/oauthproxy). This is used to keep the -Amazon credentials out of the source code. The proxy runs in Google\[aq]s -very secure App Engine environment and doesn\[aq]t store any credentials -which pass through it. - -Since rclone doesn\[aq]t currently have its own Amazon Drive credentials -so you will either need to have your own \[ga]client_id\[ga] and -\[ga]client_secret\[ga] with Amazon Drive, or use a third party oauth proxy -in which case you will need to enter \[ga]client_id\[ga], \[ga]client_secret\[ga], -\[ga]auth_url\[ga] and \[ga]token_url\[ga]. - -Note also if you are not using Amazon\[aq]s \[ga]auth_url\[ga] and \[ga]token_url\[ga], -(ie you filled in something for those) then if setting up on a remote -machine you can only use the [copying the config method of -configuration](https://rclone.org/remote_setup/#configuring\-by\-copying\-the\-config\-file) -\- \[ga]rclone authorize\[ga] will not work. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi +.SS Status .PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -Drive \ \[dq]amazon cloud drive\[dq] [snip] Storage> amazon cloud drive -Amazon Application Client Id \- required. -client_id> your client ID goes here Amazon Application Client Secret \- -required. -client_secret> your client secret goes here Auth server URL \- leave -blank to use Amazon\[aq]s. -auth_url> Optional auth URL Token server url \- leave blank to use -Amazon\[aq]s. -token_url> Optional token URL Remote config Make sure your Redirect URL -is set to \[dq]http://127.0.0.1:53682/\[dq] in your custom config. -Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: http://127.0.0.1:53682/auth Log -in and authorize rclone for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] client_id = -your client ID goes here client_secret = your client secret goes here -auth_url = Optional auth URL token_url = Optional token URL token = -{\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxx\[dq],\[dq]expiry\[dq]:\[dq]2015\-09\-06T16:07:39.658438471+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +\f[B]Important:\f[R] rclone supports Amazon Drive only if you have your +own set of API keys. +Unfortunately the Amazon Drive developer +program (https://developer.amazon.com/amazon-drive) is now closed to new +entries so if you don\[aq]t already have your own set of keys you will +not be able to use rclone with Amazon Drive. +.PP +For the history on why rclone no longer has a set of Amazon Drive API +keys see the +forum (https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314). +.PP +If you happen to know anyone who works at Amazon then please ask them to +re\-instate rclone into the Amazon Drive developer program \- thanks! +.SS Setup +.PP +The initial setup for Amazon Drive involves getting a token from Amazon +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +The configuration process for Amazon Drive may involve using an oauth +proxy (https://github.com/ncw/oauthproxy). +This is used to keep the Amazon credentials out of the source code. +The proxy runs in Google\[aq]s very secure App Engine environment and +doesn\[aq]t store any credentials which pass through it. +.PP +Since rclone doesn\[aq]t currently have its own Amazon Drive credentials +so you will either need to have your own \f[C]client_id\f[R] and +\f[C]client_secret\f[R] with Amazon Drive, or use a third party oauth +proxy in which case you will need to enter \f[C]client_id\f[R], +\f[C]client_secret\f[R], \f[C]auth_url\f[R] and \f[C]token_url\f[R]. +.PP +Note also if you are not using Amazon\[aq]s \f[C]auth_url\f[R] and +\f[C]token_url\f[R], (ie you filled in something for those) then if +setting up on a remote machine you can only use the copying the config +method of +configuration (https://rclone.org/remote_setup/#configuring-by-copying-the-config-file) +\- \f[C]rclone authorize\f[R] will not work. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: .IP .nf \f[C] - -See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a -machine with no Internet browser available. - + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] +[snip] +Storage> amazon cloud drive +Amazon Application Client Id \- required. +client_id> your client ID goes here +Amazon Application Client Secret \- required. +client_secret> your client secret goes here +Auth server URL \- leave blank to use Amazon\[aq]s. +auth_url> Optional auth URL +Token server url \- leave blank to use Amazon\[aq]s. +token_url> Optional token URL +Remote config +Make sure your Redirect URL is set to \[dq]http://127.0.0.1:53682/\[dq] in your custom config. +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = your client ID goes here +client_secret = your client secret goes here +auth_url = Optional auth URL +token_url = Optional token URL +token = {\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxx\[dq],\[dq]expiry\[dq]:\[dq]2015\-09\-06T16:07:39.658438471+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP Note that rclone runs a webserver on your local machine to collect the -token as returned from Amazon. This only runs from the moment it -opens your browser to the moment you get back the verification -code. This is on \[ga]http://127.0.0.1:53682/\[ga] and this it may require -you to unblock it temporarily if you are running a host firewall. - -Once configured you can then use \[ga]rclone\[ga] like this, - +token as returned from Amazon. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP List directories in top level of your Amazon Drive - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP List all the files in your Amazon Drive - - rclone ls remote: - +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP To copy a local directory to an Amazon Drive directory called backup - - rclone copy /home/source remote:backup - -### Modified time and MD5SUMs ### - -Amazon Drive doesn\[aq]t allow modification times to be changed via -the API so these won\[aq]t be accurate or used for syncing. - +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Modified time and MD5SUMs +.PP +Amazon Drive doesn\[aq]t allow modification times to be changed via the +API so these won\[aq]t be accurate or used for syncing. +.PP It does store MD5SUMs so for a more accurate sync, you can use the -\[ga]\-\-checksum\[ga] flag. - -#### Restricted filename characters - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| / | 0x2F | \[uFF0F] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -### Deleting files ### - -Any files you delete with rclone will end up in the trash. Amazon -don\[aq]t provide an API to permanently delete files, nor to empty the -trash, so you will have to do that with one of Amazon\[aq]s apps or via -the Amazon Drive website. As of November 17, 2016, files are -automatically deleted by Amazon from the trash after 30 days. - -### Using with non \[ga].com\[ga] Amazon accounts ### - -Let\[aq]s say you usually use \[ga]amazon.co.uk\[ga]. When you authenticate with -rclone it will take you to an \[ga]amazon.com\[ga] page to log in. Your -\[ga]amazon.co.uk\[ga] email and password should work here just fine. - - -### Standard Options - -Here are the standard options specific to amazon cloud drive (Amazon Drive). - -#### \-\-acd\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_ACD_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_ACD_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - -Here are the advanced options specific to amazon cloud drive (Amazon Drive). - -#### \-\-acd\-token - +\f[C]\-\-checksum\f[R] flag. +.SS Restricted filename characters +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Deleting files +.PP +Any files you delete with rclone will end up in the trash. +Amazon don\[aq]t provide an API to permanently delete files, nor to +empty the trash, so you will have to do that with one of Amazon\[aq]s +apps or via the Amazon Drive website. +As of November 17, 2016, files are automatically deleted by Amazon from +the trash after 30 days. +.SS Using with non \f[C].com\f[R] Amazon accounts +.PP +Let\[aq]s say you usually use \f[C]amazon.co.uk\f[R]. +When you authenticate with rclone it will take you to an +\f[C]amazon.com\f[R] page to log in. +Your \f[C]amazon.co.uk\f[R] email and password should work here just +fine. +.SS Standard Options +.PP +Here are the standard options specific to amazon cloud drive (Amazon +Drive). +.SS \-\-acd\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_ACD_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_ACD_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to amazon cloud drive (Amazon +Drive). +.SS \-\-acd\-token +.PP OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_ACD_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-auth\-url - +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_ACD_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-auth\-url +.PP Auth server URL. Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_ACD_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-token\-url - +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_ACD_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-token\-url +.PP Token server url. Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_ACD_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-checkpoint - +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_ACD_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-checkpoint +.PP Checkpoint for internal polling (debug). - -\- Config: checkpoint -\- Env Var: RCLONE_ACD_CHECKPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-upload\-wait\-per\-gb - -Additional time per GB to wait after a failed complete upload to see if it appears. - +.IP \[bu] 2 +Config: checkpoint +.IP \[bu] 2 +Env Var: RCLONE_ACD_CHECKPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-upload\-wait\-per\-gb +.PP +Additional time per GB to wait after a failed complete upload to see if +it appears. +.PP Sometimes Amazon Drive gives an error when a file has been fully -uploaded but the file appears anyway after a little while. This -happens sometimes for files over 1GB in size and nearly every time for -files bigger than 10GB. This parameter controls the time rclone waits -for the file to appear. - -The default value for this parameter is 3 minutes per GB, so by -default it will wait 3 minutes for every GB uploaded to see if the -file appears. - -You can disable this feature by setting it to 0. This may cause -conflict errors as rclone retries the failed upload but the file will -most likely appear correctly eventually. - -These values were determined empirically by observing lots of uploads -of big files for a range of file sizes. - -Upload with the \[dq]\-v\[dq] flag to see more info about what rclone is doing -in this situation. - -\- Config: upload_wait_per_gb -\- Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB -\- Type: Duration -\- Default: 3m0s - -#### \-\-acd\-templink\-threshold - +uploaded but the file appears anyway after a little while. +This happens sometimes for files over 1GB in size and nearly every time +for files bigger than 10GB. +This parameter controls the time rclone waits for the file to appear. +.PP +The default value for this parameter is 3 minutes per GB, so by default +it will wait 3 minutes for every GB uploaded to see if the file appears. +.PP +You can disable this feature by setting it to 0. +This may cause conflict errors as rclone retries the failed upload but +the file will most likely appear correctly eventually. +.PP +These values were determined empirically by observing lots of uploads of +big files for a range of file sizes. +.PP +Upload with the \[dq]\-v\[dq] flag to see more info about what rclone is +doing in this situation. +.IP \[bu] 2 +Config: upload_wait_per_gb +.IP \[bu] 2 +Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 3m0s +.SS \-\-acd\-templink\-threshold +.PP Files >= this size will be downloaded via their tempLink. - -Files this size or more will be downloaded via their \[dq]tempLink\[dq]. This -is to work around a problem with Amazon Drive which blocks downloads -of files bigger than about 10GB. The default for this is 9GB which -shouldn\[aq]t need to be changed. - -To download files above this threshold, rclone requests a \[dq]tempLink\[dq] -which downloads the file through a temporary URL directly from the -underlying S3 storage. - -\- Config: templink_threshold -\- Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD -\- Type: SizeSuffix -\- Default: 9G - -#### \-\-acd\-encoding - +.PP +Files this size or more will be downloaded via their \[dq]tempLink\[dq]. +This is to work around a problem with Amazon Drive which blocks +downloads of files bigger than about 10GB. +The default for this is 9GB which shouldn\[aq]t need to be changed. +.PP +To download files above this threshold, rclone requests a +\[dq]tempLink\[dq] which downloads the file through a temporary URL +directly from the underlying S3 storage. +.IP \[bu] 2 +Config: templink_threshold +.IP \[bu] 2 +Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 9G +.SS \-\-acd\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_ACD_ENCODING -\- Type: MultiEncoder -\- Default: Slash,InvalidUtf8,Dot - - - -### Limitations ### - -Note that Amazon Drive is case insensitive so you can\[aq]t have a -file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -Amazon Drive has rate limiting so you may notice errors in the -sync (429 errors). rclone will automatically retry the sync up to 3 -times by default (see \[ga]\-\-retries\[ga] flag) which should hopefully work -around this problem. - -Amazon Drive has an internal limit of file sizes that can be uploaded -to the service. This limit is not officially published, but all files -larger than this will fail. - +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_ACD_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8,Dot +.SS Limitations +.PP +Note that Amazon Drive is case insensitive so you can\[aq]t have a file +called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +Amazon Drive has rate limiting so you may notice errors in the sync (429 +errors). +rclone will automatically retry the sync up to 3 times by default (see +\f[C]\-\-retries\f[R] flag) which should hopefully work around this +problem. +.PP +Amazon Drive has an internal limit of file sizes that can be uploaded to +the service. +This limit is not officially published, but all files larger than this +will fail. +.PP At the time of writing (Jan 2016) is in the area of 50GB per file. This means that larger files are likely to fail. - +.PP Unfortunately there is no way for rclone to see that this failure is because of file size, so it will retry the operation, as any other -failure. To avoid this problem, use \[ga]\-\-max\-size 50000M\[ga] option to limit -the maximum size of uploaded files. Note that \[ga]\-\-max\-size\[ga] does not split -files into segments, it only ignores files over this size. - - Amazon S3 Storage Providers -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - +failure. +To avoid this problem, use \f[C]\-\-max\-size 50000M\f[R] option to +limit the maximum size of uploaded files. +Note that \f[C]\-\-max\-size\f[R] does not split files into segments, it +only ignores files over this size. +.SS Amazon S3 Storage Providers +.PP The S3 backend can be used with a number of different providers: - - -\- AWS S3 -\- Alibaba Cloud (Aliyun) Object Storage System (OSS) -\- Ceph -\- DigitalOcean Spaces -\- Dreamhost -\- IBM COS S3 -\- Minio -\- Scaleway -\- StackPath -\- Wasabi - - -Paths are specified as \[ga]remote:bucket\[ga] (or \[ga]remote:\[ga] for the \[ga]lsd\[ga] -command.) You may put subdirectories in too, eg \[ga]remote:bucket/path/to/dir\[ga]. - +.IP \[bu] 2 +AWS S3 +.IP \[bu] 2 +Alibaba Cloud (Aliyun) Object Storage System (OSS) +.IP \[bu] 2 +Ceph +.IP \[bu] 2 +DigitalOcean Spaces +.IP \[bu] 2 +Dreamhost +.IP \[bu] 2 +IBM COS S3 +.IP \[bu] 2 +Minio +.IP \[bu] 2 +Scaleway +.IP \[bu] 2 +StackPath +.IP \[bu] 2 +Tencent Cloud Object Storage (COS) +.IP \[bu] 2 +Wasabi +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. +.PP Once you have made a remote (see the provider specific section above) you can use it like this: - -See all buckets - - rclone lsd remote: - -Make a new bucket - - rclone mkdir remote:bucket - -List the contents of a bucket - - rclone ls remote:bucket - -Sync \[ga]/home/local/directory\[ga] to the remote bucket, deleting any excess -files in the bucket. - - rclone sync \-i /home/local/directory remote:bucket - -## AWS S3 {#amazon\-s3} - -Here is an example of making an s3 configuration. First run - - rclone config - -This will guide you through an interactive setup process. -\f[R] -.fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) -\ \[dq]s3\[dq] [snip] Storage> s3 Choose your S3 provider. -Choose a number from below, or type in your own value 1 / Amazon Web -Services (AWS) S3 \ \[dq]AWS\[dq] 2 / Ceph Object Storage -\ \[dq]Ceph\[dq] 3 / Digital Ocean Spaces \ \[dq]DigitalOcean\[dq] 4 / -Dreamhost DreamObjects \ \[dq]Dreamhost\[dq] 5 / IBM COS S3 -\ \[dq]IBMCOS\[dq] 6 / Minio Object Storage \ \[dq]Minio\[dq] 7 / Wasabi -Object Storage \ \[dq]Wasabi\[dq] 8 / Any other S3 compatible provider -\ \[dq]Other\[dq] provider> 1 Get AWS credentials from runtime -(environment variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[dq]false\[dq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[dq]true\[dq] env_auth> 1 AWS -Access Key ID \- leave blank for anonymous access or runtime -credentials. -access_key_id> XXX AWS Secret Access Key (password) \- leave blank for -anonymous access or runtime credentials. -secret_access_key> YYY Region to connect to. -Choose a number from below, or type in your own value / The default -endpoint \- a good choice if you are unsure. -1 | US Region, Northern Virginia or Pacific Northwest. -| Leave location constraint empty. -\ \[dq]us\-east\-1\[dq] / US East (Ohio) Region 2 | Needs location -constraint us\-east\-2. -\ \[dq]us\-east\-2\[dq] / US West (Oregon) Region 3 | Needs location -constraint us\-west\-2. -\ \[dq]us\-west\-2\[dq] / US West (Northern California) Region 4 | Needs -location constraint us\-west\-1. -\ \[dq]us\-west\-1\[dq] / Canada (Central) Region 5 | Needs location -constraint ca\-central\-1. -\ \[dq]ca\-central\-1\[dq] / EU (Ireland) Region 6 | Needs location -constraint EU or eu\-west\-1. -\ \[dq]eu\-west\-1\[dq] / EU (London) Region 7 | Needs location -constraint eu\-west\-2. -\ \[dq]eu\-west\-2\[dq] / EU (Frankfurt) Region 8 | Needs location -constraint eu\-central\-1. -\ \[dq]eu\-central\-1\[dq] / Asia Pacific (Singapore) Region 9 | Needs -location constraint ap\-southeast\-1. -\ \[dq]ap\-southeast\-1\[dq] / Asia Pacific (Sydney) Region 10 | Needs -location constraint ap\-southeast\-2. -\ \[dq]ap\-southeast\-2\[dq] / Asia Pacific (Tokyo) Region 11 | Needs -location constraint ap\-northeast\-1. -\ \[dq]ap\-northeast\-1\[dq] / Asia Pacific (Seoul) 12 | Needs location -constraint ap\-northeast\-2. -\ \[dq]ap\-northeast\-2\[dq] / Asia Pacific (Mumbai) 13 | Needs location -constraint ap\-south\-1. -\ \[dq]ap\-south\-1\[dq] / Asia Patific (Hong Kong) Region 14 | Needs -location constraint ap\-east\-1. -\ \[dq]ap\-east\-1\[dq] / South America (Sao Paulo) Region 15 | Needs -location constraint sa\-east\-1. -\ \[dq]sa\-east\-1\[dq] region> 1 Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -endpoint> Location constraint \- must be set to match the Region. -Used when creating buckets only. -Choose a number from below, or type in your own value 1 / Empty for US -Region, Northern Virginia or Pacific Northwest. -\ \[dq]\[dq] 2 / US East (Ohio) Region. -\ \[dq]us\-east\-2\[dq] 3 / US West (Oregon) Region. -\ \[dq]us\-west\-2\[dq] 4 / US West (Northern California) Region. -\ \[dq]us\-west\-1\[dq] 5 / Canada (Central) Region. -\ \[dq]ca\-central\-1\[dq] 6 / EU (Ireland) Region. -\ \[dq]eu\-west\-1\[dq] 7 / EU (London) Region. -\ \[dq]eu\-west\-2\[dq] 8 / EU Region. -\ \[dq]EU\[dq] 9 / Asia Pacific (Singapore) Region. -\ \[dq]ap\-southeast\-1\[dq] 10 / Asia Pacific (Sydney) Region. -\ \[dq]ap\-southeast\-2\[dq] 11 / Asia Pacific (Tokyo) Region. -\ \[dq]ap\-northeast\-1\[dq] 12 / Asia Pacific (Seoul) -\ \[dq]ap\-northeast\-2\[dq] 13 / Asia Pacific (Mumbai) -\ \[dq]ap\-south\-1\[dq] 14 / Asia Pacific (Hong Kong) -\ \[dq]ap\-east\-1\[dq] 15 / South America (Sao Paulo) Region. -\ \[dq]sa\-east\-1\[dq] location_constraint> 1 Canned ACL used when -creating buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -\ \[dq]public\-read\[dq] / Owner gets FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -3 | Granting this on a bucket is generally not recommended. -\ \[dq]public\-read\-write\[dq] 4 / Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -\ \[dq]authenticated\-read\[dq] / Object owner gets FULL_CONTROL. -Bucket owner gets READ access. -5 | If you specify this canned ACL when creating a bucket, Amazon S3 -ignores it. -\ \[dq]bucket\-owner\-read\[dq] / Both the object owner and the bucket -owner get FULL_CONTROL over the object. -6 | If you specify this canned ACL when creating a bucket, Amazon S3 -ignores it. -\ \[dq]bucket\-owner\-full\-control\[dq] acl> 1 The server\-side -encryption algorithm used when storing this object in S3. -Choose a number from below, or type in your own value 1 / None -\ \[dq]\[dq] 2 / AES256 \ \[dq]AES256\[dq] server_side_encryption> 1 The -storage class to use when storing objects in S3. -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Standard storage class \ \[dq]STANDARD\[dq] 3 / Reduced -redundancy storage class \ \[dq]REDUCED_REDUNDANCY\[dq] 4 / Standard -Infrequent Access storage class \ \[dq]STANDARD_IA\[dq] 5 / One Zone -Infrequent Access storage class \ \[dq]ONEZONE_IA\[dq] 6 / Glacier -storage class \ \[dq]GLACIER\[dq] 7 / Glacier Deep Archive storage class -\ \[dq]DEEP_ARCHIVE\[dq] 8 / Intelligent\-Tiering storage class -\ \[dq]INTELLIGENT_TIERING\[dq] storage_class> 1 Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = s3 provider = -AWS env_auth = false access_key_id = XXX secret_access_key = YYY region -= us\-east\-1 endpoint = location_constraint = acl = private -server_side_encryption = storage_class = -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> +See all buckets .IP .nf \f[C] - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -### \-\-update and \-\-use\-server\-modtime ### - -As noted below, the modified time is stored on metadata on the object. It is -used by default for all operations that require checking the time a file was -last updated. It allows rclone to treat the remote more like a true filesystem, -but it is inefficient because it requires an extra API call to retrieve the +rclone lsd remote: +\f[R] +.fi +.PP +Make a new bucket +.IP +.nf +\f[C] +rclone mkdir remote:bucket +\f[R] +.fi +.PP +List the contents of a bucket +.IP +.nf +\f[C] +rclone ls remote:bucket +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any +excess files in the bucket. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:bucket +\f[R] +.fi +.SS AWS S3 +.PP +Here is an example of making an s3 configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Choose your S3 provider. +Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] + 2 / Ceph Object Storage + \[rs] \[dq]Ceph\[dq] + 3 / Digital Ocean Spaces + \[rs] \[dq]DigitalOcean\[dq] + 4 / Dreamhost DreamObjects + \[rs] \[dq]Dreamhost\[dq] + 5 / IBM COS S3 + \[rs] \[dq]IBMCOS\[dq] + 6 / Minio Object Storage + \[rs] \[dq]Minio\[dq] + 7 / Wasabi Object Storage + \[rs] \[dq]Wasabi\[dq] + 8 / Any other S3 compatible provider + \[rs] \[dq]Other\[dq] +provider> 1 +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> XXX +AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> YYY +Region to connect to. +Choose a number from below, or type in your own value + / The default endpoint \- a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \[rs] \[dq]us\-east\-1\[dq] + / US East (Ohio) Region + 2 | Needs location constraint us\-east\-2. + \[rs] \[dq]us\-east\-2\[dq] + / US West (Oregon) Region + 3 | Needs location constraint us\-west\-2. + \[rs] \[dq]us\-west\-2\[dq] + / US West (Northern California) Region + 4 | Needs location constraint us\-west\-1. + \[rs] \[dq]us\-west\-1\[dq] + / Canada (Central) Region + 5 | Needs location constraint ca\-central\-1. + \[rs] \[dq]ca\-central\-1\[dq] + / EU (Ireland) Region + 6 | Needs location constraint EU or eu\-west\-1. + \[rs] \[dq]eu\-west\-1\[dq] + / EU (London) Region + 7 | Needs location constraint eu\-west\-2. + \[rs] \[dq]eu\-west\-2\[dq] + / EU (Frankfurt) Region + 8 | Needs location constraint eu\-central\-1. + \[rs] \[dq]eu\-central\-1\[dq] + / Asia Pacific (Singapore) Region + 9 | Needs location constraint ap\-southeast\-1. + \[rs] \[dq]ap\-southeast\-1\[dq] + / Asia Pacific (Sydney) Region +10 | Needs location constraint ap\-southeast\-2. + \[rs] \[dq]ap\-southeast\-2\[dq] + / Asia Pacific (Tokyo) Region +11 | Needs location constraint ap\-northeast\-1. + \[rs] \[dq]ap\-northeast\-1\[dq] + / Asia Pacific (Seoul) +12 | Needs location constraint ap\-northeast\-2. + \[rs] \[dq]ap\-northeast\-2\[dq] + / Asia Pacific (Mumbai) +13 | Needs location constraint ap\-south\-1. + \[rs] \[dq]ap\-south\-1\[dq] + / Asia Patific (Hong Kong) Region +14 | Needs location constraint ap\-east\-1. + \[rs] \[dq]ap\-east\-1\[dq] + / South America (Sao Paulo) Region +15 | Needs location constraint sa\-east\-1. + \[rs] \[dq]sa\-east\-1\[dq] +region> 1 +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +endpoint> +Location constraint \- must be set to match the Region. Used when creating buckets only. +Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \[rs] \[dq]\[dq] + 2 / US East (Ohio) Region. + \[rs] \[dq]us\-east\-2\[dq] + 3 / US West (Oregon) Region. + \[rs] \[dq]us\-west\-2\[dq] + 4 / US West (Northern California) Region. + \[rs] \[dq]us\-west\-1\[dq] + 5 / Canada (Central) Region. + \[rs] \[dq]ca\-central\-1\[dq] + 6 / EU (Ireland) Region. + \[rs] \[dq]eu\-west\-1\[dq] + 7 / EU (London) Region. + \[rs] \[dq]eu\-west\-2\[dq] + 8 / EU Region. + \[rs] \[dq]EU\[dq] + 9 / Asia Pacific (Singapore) Region. + \[rs] \[dq]ap\-southeast\-1\[dq] +10 / Asia Pacific (Sydney) Region. + \[rs] \[dq]ap\-southeast\-2\[dq] +11 / Asia Pacific (Tokyo) Region. + \[rs] \[dq]ap\-northeast\-1\[dq] +12 / Asia Pacific (Seoul) + \[rs] \[dq]ap\-northeast\-2\[dq] +13 / Asia Pacific (Mumbai) + \[rs] \[dq]ap\-south\-1\[dq] +14 / Asia Pacific (Hong Kong) + \[rs] \[dq]ap\-east\-1\[dq] +15 / South America (Sao Paulo) Region. + \[rs] \[dq]sa\-east\-1\[dq] +location_constraint> 1 +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \[rs] \[dq]public\-read\[dq] + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. + 3 | Granting this on a bucket is generally not recommended. + \[rs] \[dq]public\-read\-write\[dq] + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. + \[rs] \[dq]authenticated\-read\[dq] + / Object owner gets FULL_CONTROL. Bucket owner gets READ access. + 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \[rs] \[dq]bucket\-owner\-read\[dq] + / Both the object owner and the bucket owner get FULL_CONTROL over the object. + 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \[rs] \[dq]bucket\-owner\-full\-control\[dq] +acl> 1 +The server\-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value + 1 / None + \[rs] \[dq]\[dq] + 2 / AES256 + \[rs] \[dq]AES256\[dq] +server_side_encryption> 1 +The storage class to use when storing objects in S3. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Reduced redundancy storage class + \[rs] \[dq]REDUCED_REDUNDANCY\[dq] + 4 / Standard Infrequent Access storage class + \[rs] \[dq]STANDARD_IA\[dq] + 5 / One Zone Infrequent Access storage class + \[rs] \[dq]ONEZONE_IA\[dq] + 6 / Glacier storage class + \[rs] \[dq]GLACIER\[dq] + 7 / Glacier Deep Archive storage class + \[rs] \[dq]DEEP_ARCHIVE\[dq] + 8 / Intelligent\-Tiering storage class + \[rs] \[dq]INTELLIGENT_TIERING\[dq] +storage_class> 1 +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = s3 +provider = AWS +env_auth = false +access_key_id = XXX +secret_access_key = YYY +region = us\-east\-1 +endpoint = +location_constraint = +acl = private +server_side_encryption = +storage_class = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> +\f[R] +.fi +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS \-\-update and \-\-use\-server\-modtime +.PP +As noted below, the modified time is stored on metadata on the object. +It is used by default for all operations that require checking the time +a file was last updated. +It allows rclone to treat the remote more like a true filesystem, but it +is inefficient because it requires an extra API call to retrieve the metadata. - -For many operations, the time the object was last uploaded to the remote is -sufficient to determine if it is \[dq]dirty\[dq]. By using \[ga]\-\-update\[ga] along with -\[ga]\-\-use\-server\-modtime\[ga], you can avoid the extra API call and simply upload -files whose local modtime is newer than the time it was last uploaded. - -### Modified time ### - +.PP +For many operations, the time the object was last uploaded to the remote +is sufficient to determine if it is \[dq]dirty\[dq]. +By using \f[C]\-\-update\f[R] along with +\f[C]\-\-use\-server\-modtime\f[R], you can avoid the extra API call and +simply upload files whose local modtime is newer than the time it was +last uploaded. +.SS Modified time +.PP The modified time is stored as metadata on the object as -\[ga]X\-Amz\-Meta\-Mtime\[ga] as floating point since the epoch accurate to 1 ns. - -If the modification time needs to be updated rclone will attempt to perform a server -side copy to update the modification if the object can be copied in a single part. -In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive -storage the object will be uploaded rather than copied. - -### Cleanup ### - -If you run \[ga]rclone cleanup s3:bucket\[ga] then it will remove all pending -multipart uploads older than 24 hours. You can use the \[ga]\-i\[ga] flag to -see exactly what it will do. If you want more control over the expiry -date then run \[ga]rclone backend cleanup s3:bucket \-o max\-age=1h\[ga] to -expire all uploads older than one hour. You can use \[ga]rclone backend -list\-multipart\-uploads s3:bucket\[ga] to see the pending multipart -uploads. - -#### Restricted filename characters - +\f[C]X\-Amz\-Meta\-Mtime\f[R] as floating point since the epoch accurate +to 1 ns. +.PP +If the modification time needs to be updated rclone will attempt to +perform a server side copy to update the modification if the object can +be copied in a single part. +In the case the object is larger than 5Gb or is in Glacier or Glacier +Deep Archive storage the object will be uploaded rather than copied. +.SS Cleanup +.PP +If you run \f[C]rclone cleanup s3:bucket\f[R] then it will remove all +pending multipart uploads older than 24 hours. +You can use the \f[C]\-i\f[R] flag to see exactly what it will do. +If you want more control over the expiry date then run +\f[C]rclone backend cleanup s3:bucket \-o max\-age=1h\f[R] to expire all +uploads older than one hour. +You can use \f[C]rclone backend list\-multipart\-uploads s3:bucket\f[R] +to see the pending multipart uploads. +.SS Restricted filename characters +.PP S3 allows any valid UTF\-8 string as a key. - -Invalid UTF\-8 bytes will be [replaced](https://rclone.org/overview/#invalid\-utf8), as -they can\[aq]t be used in XML. - +.PP +Invalid UTF\-8 bytes will be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in XML. +.PP The following characters are replaced since these are problematic when dealing with the REST API: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| / | 0x2F | \[uFF0F] | - +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +.TE +.PP The encoding will also encode these file names as they don\[aq]t seem to work with the SDK properly: - -| File name | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-:| -| . | \[uFF0E] | -| .. | \[uFF0E]\[uFF0E] | - -### Multipart uploads ### - -rclone supports multipart uploads with S3 which means that it can -upload files bigger than 5GB. - -Note that files uploaded *both* with multipart upload *and* through -crypt remotes do not have MD5 sums. - +.PP +.TS +tab(@); +l c. +T{ +File name +T}@T{ +Replacement +T} +_ +T{ +\&. +T}@T{ +\[uFF0E] +T} +T{ +\&.. +T}@T{ +\[uFF0E]\[uFF0E] +T} +.TE +.SS Multipart uploads +.PP +rclone supports multipart uploads with S3 which means that it can upload +files bigger than 5GB. +.PP +Note that files uploaded \f[I]both\f[R] with multipart upload +\f[I]and\f[R] through crypt remotes do not have MD5 sums. +.PP rclone switches from single part uploads to multipart uploads at the -point specified by \[ga]\-\-s3\-upload\-cutoff\[ga]. This can be a maximum of 5GB -and a minimum of 0 (ie always upload multipart files). - +point specified by \f[C]\-\-s3\-upload\-cutoff\f[R]. +This can be a maximum of 5GB and a minimum of 0 (ie always upload +multipart files). +.PP The chunk sizes used in the multipart upload are specified by -\[ga]\-\-s3\-chunk\-size\[ga] and the number of chunks uploaded concurrently is -specified by \[ga]\-\-s3\-upload\-concurrency\[ga]. - -Multipart uploads will use \[ga]\-\-transfers\[ga] * \[ga]\-\-s3\-upload\-concurrency\[ga] * -\[ga]\-\-s3\-chunk\-size\[ga] extra memory. Single part uploads to not use extra -memory. - +\f[C]\-\-s3\-chunk\-size\f[R] and the number of chunks uploaded +concurrently is specified by \f[C]\-\-s3\-upload\-concurrency\f[R]. +.PP +Multipart uploads will use \f[C]\-\-transfers\f[R] * +\f[C]\-\-s3\-upload\-concurrency\f[R] * \f[C]\-\-s3\-chunk\-size\f[R] +extra memory. +Single part uploads to not use extra memory. +.PP Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 \- the more latency, the more likely single part transfers will be faster. - -Increasing \[ga]\-\-s3\-upload\-concurrency\[ga] will increase throughput (8 would -be a sensible value) and increasing \[ga]\-\-s3\-chunk\-size\[ga] also increases -throughput (16M would be sensible). Increasing either of these will -use more memory. The default values are high enough to gain most of -the possible performance without using too much memory. - - -### Buckets and Regions ### - -With Amazon S3 you can list buckets (\[ga]rclone lsd\[ga]) using any region, -but you can only access the content of a bucket from the region it was -created in. If you attempt to access a bucket from the wrong region, -you will get an error, \[ga]incorrect region, the bucket is not in \[aq]XXX\[aq] -region\[ga]. - -### Authentication ### - -There are a number of ways to supply \[ga]rclone\[ga] with a set of AWS -credentials, with and without using the environment. - -The different authentication methods are tried in this order: - - \- Directly in the rclone configuration file (\[ga]env_auth = false\[ga] in the config file): - \- \[ga]access_key_id\[ga] and \[ga]secret_access_key\[ga] are required. - \- \[ga]session_token\[ga] can be optionally set when using AWS STS. - \- Runtime configuration (\[ga]env_auth = true\[ga] in the config file): - \- Export the following environment variables before running \[ga]rclone\[ga]: - \- Access Key ID: \[ga]AWS_ACCESS_KEY_ID\[ga] or \[ga]AWS_ACCESS_KEY\[ga] - \- Secret Access Key: \[ga]AWS_SECRET_ACCESS_KEY\[ga] or \[ga]AWS_SECRET_KEY\[ga] - \- Session Token: \[ga]AWS_SESSION_TOKEN\[ga] (optional) - \- Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli\-multiple\-profiles.html): - \- Profile files are standard files used by AWS CLI tools - \- By default it will use the profile in your home directory (eg \[ga]\[ti]/.aws/credentials\[ga] on unix based systems) file and the \[dq]default\[dq] profile, to change set these environment variables: - \- \[ga]AWS_SHARED_CREDENTIALS_FILE\[ga] to control which file. - \- \[ga]AWS_PROFILE\[ga] to control which profile to use. - \- Or, run \[ga]rclone\[ga] in an ECS task with an IAM role (AWS only). - \- Or, run \[ga]rclone\[ga] on an EC2 instance with an IAM role (AWS only). - \- Or, run \[ga]rclone\[ga] in an EKS pod with an IAM role that is associated with a service account (AWS only). - -If none of these option actually end up providing \[ga]rclone\[ga] with AWS -credentials then S3 interaction will be non\-authenticated (see below). - -### S3 Permissions ### - -When using the \[ga]sync\[ga] subcommand of \[ga]rclone\[ga] the following minimum -permissions are required to be available on the bucket being written to: - -* \[ga]ListBucket\[ga] -* \[ga]DeleteObject\[ga] -* \[ga]GetObject\[ga] -* \[ga]PutObject\[ga] -* \[ga]PutObjectACL\[ga] - -When using the \[ga]lsd\[ga] subcommand, the \[ga]ListAllMyBuckets\[ga] permission is required. - -Example policy: -\f[R] -.fi .PP -{ \[dq]Version\[dq]: \[dq]2012\-10\-17\[dq], \[dq]Statement\[dq]: [ { -\[dq]Effect\[dq]: \[dq]Allow\[dq], \[dq]Principal\[dq]: { \[dq]AWS\[dq]: -\[dq]arn:aws:iam::USER_SID:user/USER_NAME\[dq] }, \[dq]Action\[dq]: [ -\[dq]s3:ListBucket\[dq], \[dq]s3:DeleteObject\[dq], -\[dq]s3:GetObject\[dq], \[dq]s3:PutObject\[dq], -\[dq]s3:PutObjectAcl\[dq] ], \[dq]Resource\[dq]: [ -\[dq]arn:aws:s3:::BUCKET_NAME/*\[dq], \[dq]arn:aws:s3:::BUCKET_NAME\[dq] -] }, { \[dq]Effect\[dq]: \[dq]Allow\[dq], \[dq]Action\[dq]: -\[dq]s3:ListAllMyBuckets\[dq], \[dq]Resource\[dq]: -\[dq]arn:aws:s3:::*\[dq] } -.PD 0 -.P -.PD -] } +Increasing \f[C]\-\-s3\-upload\-concurrency\f[R] will increase +throughput (8 would be a sensible value) and increasing +\f[C]\-\-s3\-chunk\-size\f[R] also increases throughput (16M would be +sensible). +Increasing either of these will use more memory. +The default values are high enough to gain most of the possible +performance without using too much memory. +.SS Buckets and Regions +.PP +With Amazon S3 you can list buckets (\f[C]rclone lsd\f[R]) using any +region, but you can only access the content of a bucket from the region +it was created in. +If you attempt to access a bucket from the wrong region, you will get an +error, +\f[C]incorrect region, the bucket is not in \[aq]XXX\[aq] region\f[R]. +.SS Authentication +.PP +There are a number of ways to supply \f[C]rclone\f[R] with a set of AWS +credentials, with and without using the environment. +.PP +The different authentication methods are tried in this order: +.IP \[bu] 2 +Directly in the rclone configuration file (\f[C]env_auth = false\f[R] in +the config file): +.RS 2 +.IP \[bu] 2 +\f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R] are required. +.IP \[bu] 2 +\f[C]session_token\f[R] can be optionally set when using AWS STS. +.RE +.IP \[bu] 2 +Runtime configuration (\f[C]env_auth = true\f[R] in the config file): +.RS 2 +.IP \[bu] 2 +Export the following environment variables before running +\f[C]rclone\f[R]: +.RS 2 +.IP \[bu] 2 +Access Key ID: \f[C]AWS_ACCESS_KEY_ID\f[R] or \f[C]AWS_ACCESS_KEY\f[R] +.IP \[bu] 2 +Secret Access Key: \f[C]AWS_SECRET_ACCESS_KEY\f[R] or +\f[C]AWS_SECRET_KEY\f[R] +.IP \[bu] 2 +Session Token: \f[C]AWS_SESSION_TOKEN\f[R] (optional) +.RE +.IP \[bu] 2 +Or, use a named +profile (https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html): +.RS 2 +.IP \[bu] 2 +Profile files are standard files used by AWS CLI tools +.IP \[bu] 2 +By default it will use the profile in your home directory (eg +\f[C]\[ti]/.aws/credentials\f[R] on unix based systems) file and the +\[dq]default\[dq] profile, to change set these environment variables: +.RS 2 +.IP \[bu] 2 +\f[C]AWS_SHARED_CREDENTIALS_FILE\f[R] to control which file. +.IP \[bu] 2 +\f[C]AWS_PROFILE\f[R] to control which profile to use. +.RE +.RE +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] in an ECS task with an IAM role (AWS only). +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] on an EC2 instance with an IAM role (AWS only). +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] in an EKS pod with an IAM role that is +associated with a service account (AWS only). +.RE +.PP +If none of these option actually end up providing \f[C]rclone\f[R] with +AWS credentials then S3 interaction will be non\-authenticated (see +below). +.SS S3 Permissions +.PP +When using the \f[C]sync\f[R] subcommand of \f[C]rclone\f[R] the +following minimum permissions are required to be available on the bucket +being written to: +.IP \[bu] 2 +\f[C]ListBucket\f[R] +.IP \[bu] 2 +\f[C]DeleteObject\f[R] +.IP \[bu] 2 +\f[C]GetObject\f[R] +.IP \[bu] 2 +\f[C]PutObject\f[R] +.IP \[bu] 2 +\f[C]PutObjectACL\f[R] +.PP +When using the \f[C]lsd\f[R] subcommand, the \f[C]ListAllMyBuckets\f[R] +permission is required. +.PP +Example policy: .IP .nf \f[C] - +{ + \[dq]Version\[dq]: \[dq]2012\-10\-17\[dq], + \[dq]Statement\[dq]: [ + { + \[dq]Effect\[dq]: \[dq]Allow\[dq], + \[dq]Principal\[dq]: { + \[dq]AWS\[dq]: \[dq]arn:aws:iam::USER_SID:user/USER_NAME\[dq] + }, + \[dq]Action\[dq]: [ + \[dq]s3:ListBucket\[dq], + \[dq]s3:DeleteObject\[dq], + \[dq]s3:GetObject\[dq], + \[dq]s3:PutObject\[dq], + \[dq]s3:PutObjectAcl\[dq] + ], + \[dq]Resource\[dq]: [ + \[dq]arn:aws:s3:::BUCKET_NAME/*\[dq], + \[dq]arn:aws:s3:::BUCKET_NAME\[dq] + ] + }, + { + \[dq]Effect\[dq]: \[dq]Allow\[dq], + \[dq]Action\[dq]: \[dq]s3:ListAllMyBuckets\[dq], + \[dq]Resource\[dq]: \[dq]arn:aws:s3:::*\[dq] + } + ] +} +\f[R] +.fi +.PP Notes on above: - -1. This is a policy that can be used when creating bucket. It assumes - that \[ga]USER_NAME\[ga] has been created. -2. The Resource entry must include both resource ARNs, as one implies - the bucket and the other implies the bucket\[aq]s objects. - -For reference, [here\[aq]s an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) -that will generate one or more buckets that will work with \[ga]rclone sync\[ga]. - -### Key Management System (KMS) ### - -If you are using server side encryption with KMS then you will find -you can\[aq]t transfer small objects. As a work\-around you can use the -\[ga]\-\-ignore\-checksum\[ga] flag. - -A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824). - -### Glacier and Glacier Deep Archive ### - -You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user\-guide/create\-lifecycle.html). +.IP "1." 3 +This is a policy that can be used when creating bucket. +It assumes that \f[C]USER_NAME\f[R] has been created. +.IP "2." 3 +The Resource entry must include both resource ARNs, as one implies the +bucket and the other implies the bucket\[aq]s objects. +.PP +For reference, here\[aq]s an Ansible +script (https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) +that will generate one or more buckets that will work with +\f[C]rclone sync\f[R]. +.SS Key Management System (KMS) +.PP +If you are using server side encryption with KMS then you will find you +can\[aq]t transfer small objects. +As a work\-around you can use the \f[C]\-\-ignore\-checksum\f[R] flag. +.PP +A proper fix is being worked on in issue +#1824 (https://github.com/rclone/rclone/issues/1824). +.SS Glacier and Glacier Deep Archive +.PP +You can upload objects using the glacier storage class or transition +them to glacier using a lifecycle +policy (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html). The bucket can still be synced or copied into normally, but if rclone -tries to access data from the glacier storage class you will see an error like below. - - 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file - -In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user\-guide/restore\-archived\-objects.html) +tries to access data from the glacier storage class you will see an +error like below. +.IP +.nf +\f[C] +2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file +\f[R] +.fi +.PP +In this case you need to +restore (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) the object(s) in question before using rclone. - +.PP Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults. - - -### Standard Options - -Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - -#### \-\-s3\-provider - +.SS Standard Options +.PP +Here are the standard options specific to s3 (Amazon S3 Compliant +Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, Tencent COS, etc)). +.SS \-\-s3\-provider +.PP Choose your S3 provider. - -\- Config: provider -\- Env Var: RCLONE_S3_PROVIDER -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]AWS\[dq] - \- Amazon Web Services (AWS) S3 - \- \[dq]Alibaba\[dq] - \- Alibaba Cloud Object Storage System (OSS) formerly Aliyun - \- \[dq]Ceph\[dq] - \- Ceph Object Storage - \- \[dq]DigitalOcean\[dq] - \- Digital Ocean Spaces - \- \[dq]Dreamhost\[dq] - \- Dreamhost DreamObjects - \- \[dq]IBMCOS\[dq] - \- IBM COS S3 - \- \[dq]Minio\[dq] - \- Minio Object Storage - \- \[dq]Netease\[dq] - \- Netease Object Storage (NOS) - \- \[dq]Scaleway\[dq] - \- Scaleway Object Storage - \- \[dq]StackPath\[dq] - \- StackPath Object Storage - \- \[dq]Wasabi\[dq] - \- Wasabi Object Storage - \- \[dq]Other\[dq] - \- Any other S3 compatible provider - -#### \-\-s3\-env\-auth - -Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +.IP \[bu] 2 +Config: provider +.IP \[bu] 2 +Env Var: RCLONE_S3_PROVIDER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]AWS\[dq] +.RS 2 +.IP \[bu] 2 +Amazon Web Services (AWS) S3 +.RE +.IP \[bu] 2 +\[dq]Alibaba\[dq] +.RS 2 +.IP \[bu] 2 +Alibaba Cloud Object Storage System (OSS) formerly Aliyun +.RE +.IP \[bu] 2 +\[dq]Ceph\[dq] +.RS 2 +.IP \[bu] 2 +Ceph Object Storage +.RE +.IP \[bu] 2 +\[dq]DigitalOcean\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces +.RE +.IP \[bu] 2 +\[dq]Dreamhost\[dq] +.RS 2 +.IP \[bu] 2 +Dreamhost DreamObjects +.RE +.IP \[bu] 2 +\[dq]IBMCOS\[dq] +.RS 2 +.IP \[bu] 2 +IBM COS S3 +.RE +.IP \[bu] 2 +\[dq]Minio\[dq] +.RS 2 +.IP \[bu] 2 +Minio Object Storage +.RE +.IP \[bu] 2 +\[dq]Netease\[dq] +.RS 2 +.IP \[bu] 2 +Netease Object Storage (NOS) +.RE +.IP \[bu] 2 +\[dq]Scaleway\[dq] +.RS 2 +.IP \[bu] 2 +Scaleway Object Storage +.RE +.IP \[bu] 2 +\[dq]StackPath\[dq] +.RS 2 +.IP \[bu] 2 +StackPath Object Storage +.RE +.IP \[bu] 2 +\[dq]TencentCOS\[dq] +.RS 2 +.IP \[bu] 2 +Tencent Cloud Object Storage (COS) +.RE +.IP \[bu] 2 +\[dq]Wasabi\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi Object Storage +.RE +.IP \[bu] 2 +\[dq]Other\[dq] +.RS 2 +.IP \[bu] 2 +Any other S3 compatible provider +.RE +.RE +.SS \-\-s3\-env\-auth +.PP +Get AWS credentials from runtime (environment variables or EC2/ECS meta +data if no env vars). Only applies if access_key_id and secret_access_key is blank. - -\- Config: env_auth -\- Env Var: RCLONE_S3_ENV_AUTH -\- Type: bool -\- Default: false -\- Examples: - \- \[dq]false\[dq] - \- Enter AWS credentials in the next step - \- \[dq]true\[dq] - \- Get AWS credentials from the environment (env vars or IAM) - -#### \-\-s3\-access\-key\-id - +.IP \[bu] 2 +Config: env_auth +.IP \[bu] 2 +Env Var: RCLONE_S3_ENV_AUTH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]false\[dq] +.RS 2 +.IP \[bu] 2 +Enter AWS credentials in the next step +.RE +.IP \[bu] 2 +\[dq]true\[dq] +.RS 2 +.IP \[bu] 2 +Get AWS credentials from the environment (env vars or IAM) +.RE +.RE +.SS \-\-s3\-access\-key\-id +.PP AWS Access Key ID. Leave blank for anonymous access or runtime credentials. - -\- Config: access_key_id -\- Env Var: RCLONE_S3_ACCESS_KEY_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-secret\-access\-key - -AWS Secret Access Key (password) -Leave blank for anonymous access or runtime credentials. - -\- Config: secret_access_key -\- Env Var: RCLONE_S3_SECRET_ACCESS_KEY -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-region - +.IP \[bu] 2 +Config: access_key_id +.IP \[bu] 2 +Env Var: RCLONE_S3_ACCESS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-secret\-access\-key +.PP +AWS Secret Access Key (password) Leave blank for anonymous access or +runtime credentials. +.IP \[bu] 2 +Config: secret_access_key +.IP \[bu] 2 +Env Var: RCLONE_S3_SECRET_ACCESS_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-region +.PP Region to connect to. - -\- Config: region -\- Env Var: RCLONE_S3_REGION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]us\-east\-1\[dq] - \- The default endpoint \- a good choice if you are unsure. - \- US Region, Northern Virginia or Pacific Northwest. - \- Leave location constraint empty. - \- \[dq]us\-east\-2\[dq] - \- US East (Ohio) Region - \- Needs location constraint us\-east\-2. - \- \[dq]us\-west\-2\[dq] - \- US West (Oregon) Region - \- Needs location constraint us\-west\-2. - \- \[dq]us\-west\-1\[dq] - \- US West (Northern California) Region - \- Needs location constraint us\-west\-1. - \- \[dq]ca\-central\-1\[dq] - \- Canada (Central) Region - \- Needs location constraint ca\-central\-1. - \- \[dq]eu\-west\-1\[dq] - \- EU (Ireland) Region - \- Needs location constraint EU or eu\-west\-1. - \- \[dq]eu\-west\-2\[dq] - \- EU (London) Region - \- Needs location constraint eu\-west\-2. - \- \[dq]eu\-north\-1\[dq] - \- EU (Stockholm) Region - \- Needs location constraint eu\-north\-1. - \- \[dq]eu\-central\-1\[dq] - \- EU (Frankfurt) Region - \- Needs location constraint eu\-central\-1. - \- \[dq]ap\-southeast\-1\[dq] - \- Asia Pacific (Singapore) Region - \- Needs location constraint ap\-southeast\-1. - \- \[dq]ap\-southeast\-2\[dq] - \- Asia Pacific (Sydney) Region - \- Needs location constraint ap\-southeast\-2. - \- \[dq]ap\-northeast\-1\[dq] - \- Asia Pacific (Tokyo) Region - \- Needs location constraint ap\-northeast\-1. - \- \[dq]ap\-northeast\-2\[dq] - \- Asia Pacific (Seoul) - \- Needs location constraint ap\-northeast\-2. - \- \[dq]ap\-south\-1\[dq] - \- Asia Pacific (Mumbai) - \- Needs location constraint ap\-south\-1. - \- \[dq]ap\-east\-1\[dq] - \- Asia Patific (Hong Kong) Region - \- Needs location constraint ap\-east\-1. - \- \[dq]sa\-east\-1\[dq] - \- South America (Sao Paulo) Region - \- Needs location constraint sa\-east\-1. - -#### \-\-s3\-region - +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_S3_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]us\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +The default endpoint \- a good choice if you are unsure. +.IP \[bu] 2 +US Region, Northern Virginia or Pacific Northwest. +.IP \[bu] 2 +Leave location constraint empty. +.RE +.IP \[bu] 2 +\[dq]us\-east\-2\[dq] +.RS 2 +.IP \[bu] 2 +US East (Ohio) Region +.IP \[bu] 2 +Needs location constraint us\-east\-2. +.RE +.IP \[bu] 2 +\[dq]us\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +US West (Oregon) Region +.IP \[bu] 2 +Needs location constraint us\-west\-2. +.RE +.IP \[bu] 2 +\[dq]us\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +US West (Northern California) Region +.IP \[bu] 2 +Needs location constraint us\-west\-1. +.RE +.IP \[bu] 2 +\[dq]ca\-central\-1\[dq] +.RS 2 +.IP \[bu] 2 +Canada (Central) Region +.IP \[bu] 2 +Needs location constraint ca\-central\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Ireland) Region +.IP \[bu] 2 +Needs location constraint EU or eu\-west\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +EU (London) Region +.IP \[bu] 2 +Needs location constraint eu\-west\-2. +.RE +.IP \[bu] 2 +\[dq]eu\-north\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Stockholm) Region +.IP \[bu] 2 +Needs location constraint eu\-north\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-central\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Frankfurt) Region +.IP \[bu] 2 +Needs location constraint eu\-central\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Singapore) Region +.IP \[bu] 2 +Needs location constraint ap\-southeast\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Sydney) Region +.IP \[bu] 2 +Needs location constraint ap\-southeast\-2. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Tokyo) Region +.IP \[bu] 2 +Needs location constraint ap\-northeast\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Seoul) +.IP \[bu] 2 +Needs location constraint ap\-northeast\-2. +.RE +.IP \[bu] 2 +\[dq]ap\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Mumbai) +.IP \[bu] 2 +Needs location constraint ap\-south\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Patific (Hong Kong) Region +.IP \[bu] 2 +Needs location constraint ap\-east\-1. +.RE +.IP \[bu] 2 +\[dq]sa\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +South America (Sao Paulo) Region +.IP \[bu] 2 +Needs location constraint sa\-east\-1. +.RE +.RE +.SS \-\-s3\-region +.PP Region to connect to. - -\- Config: region -\- Env Var: RCLONE_S3_REGION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]nl\-ams\[dq] - \- Amsterdam, The Netherlands - \- \[dq]fr\-par\[dq] - \- Paris, France - -#### \-\-s3\-region - +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_S3_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]nl\-ams\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam, The Netherlands +.RE +.IP \[bu] 2 +\[dq]fr\-par\[dq] +.RS 2 +.IP \[bu] 2 +Paris, France +.RE +.RE +.SS \-\-s3\-region +.PP Region to connect to. -Leave blank if you are using an S3 clone and you don\[aq]t have a region. - -\- Config: region -\- Env Var: RCLONE_S3_REGION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Use this if unsure. Will use v4 signatures and an empty region. - \- \[dq]other\-v2\-signature\[dq] - \- Use this only if v4 signatures don\[aq]t work, eg pre Jewel/v10 CEPH. - -#### \-\-s3\-endpoint - +Leave blank if you are using an S3 clone and you don\[aq]t have a +region. +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_S3_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Use this if unsure. +Will use v4 signatures and an empty region. +.RE +.IP \[bu] 2 +\[dq]other\-v2\-signature\[dq] +.RS 2 +.IP \[bu] 2 +Use this only if v4 signatures don\[aq]t work, eg pre Jewel/v10 CEPH. +.RE +.RE +.SS \-\-s3\-endpoint +.PP Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-endpoint - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-endpoint +.PP Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]s3.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Endpoint - \- \[dq]s3.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Dallas Endpoint - \- \[dq]s3.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Washington DC Endpoint - \- \[dq]s3.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region San Jose Endpoint - \- \[dq]s3.private.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Private Endpoint - \- \[dq]s3.private.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Dallas Private Endpoint - \- \[dq]s3.private.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Washington DC Private Endpoint - \- \[dq]s3.private.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region San Jose Private Endpoint - \- \[dq]s3.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region East Endpoint - \- \[dq]s3.private.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region East Private Endpoint - \- \[dq]s3.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region South Endpoint - \- \[dq]s3.private.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region South Private Endpoint - \- \[dq]s3.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Endpoint - \- \[dq]s3.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Frankfurt Endpoint - \- \[dq]s3.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Milan Endpoint - \- \[dq]s3.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Amsterdam Endpoint - \- \[dq]s3.private.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Private Endpoint - \- \[dq]s3.private.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Frankfurt Private Endpoint - \- \[dq]s3.private.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Milan Private Endpoint - \- \[dq]s3.private.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Amsterdam Private Endpoint - \- \[dq]s3.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] - \- Great Britain Endpoint - \- \[dq]s3.private.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] - \- Great Britain Private Endpoint - \- \[dq]s3.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Region DE Endpoint - \- \[dq]s3.private.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Region DE Private Endpoint - \- \[dq]s3.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Endpoint - \- \[dq]s3.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Tokyo Endpoint - \- \[dq]s3.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional HongKong Endpoint - \- \[dq]s3.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Seoul Endpoint - \- \[dq]s3.private.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Private Endpoint - \- \[dq]s3.private.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Tokyo Private Endpoint - \- \[dq]s3.private.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional HongKong Private Endpoint - \- \[dq]s3.private.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Seoul Private Endpoint - \- \[dq]s3.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Japan Endpoint - \- \[dq]s3.private.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Japan Private Endpoint - \- \[dq]s3.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Australia Endpoint - \- \[dq]s3.private.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Australia Private Endpoint - \- \[dq]s3.ams03.cloud\-object\-storage.appdomain.cloud\[dq] - \- Amsterdam Single Site Endpoint - \- \[dq]s3.private.ams03.cloud\-object\-storage.appdomain.cloud\[dq] - \- Amsterdam Single Site Private Endpoint - \- \[dq]s3.che01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Chennai Single Site Endpoint - \- \[dq]s3.private.che01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Chennai Single Site Private Endpoint - \- \[dq]s3.mel01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Melbourne Single Site Endpoint - \- \[dq]s3.private.mel01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Melbourne Single Site Private Endpoint - \- \[dq]s3.osl01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Oslo Single Site Endpoint - \- \[dq]s3.private.osl01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Oslo Single Site Private Endpoint - \- \[dq]s3.tor01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Toronto Single Site Endpoint - \- \[dq]s3.private.tor01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Toronto Single Site Private Endpoint - \- \[dq]s3.seo01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Seoul Single Site Endpoint - \- \[dq]s3.private.seo01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Seoul Single Site Private Endpoint - \- \[dq]s3.mon01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Montreal Single Site Endpoint - \- \[dq]s3.private.mon01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Montreal Single Site Private Endpoint - \- \[dq]s3.mex01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Mexico Single Site Endpoint - \- \[dq]s3.private.mex01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Mexico Single Site Private Endpoint - \- \[dq]s3.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] - \- San Jose Single Site Endpoint - \- \[dq]s3.private.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] - \- San Jose Single Site Private Endpoint - \- \[dq]s3.mil01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Milan Single Site Endpoint - \- \[dq]s3.private.mil01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Milan Single Site Private Endpoint - \- \[dq]s3.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] - \- Hong Kong Single Site Endpoint - \- \[dq]s3.private.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] - \- Hong Kong Single Site Private Endpoint - \- \[dq]s3.par01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Paris Single Site Endpoint - \- \[dq]s3.private.par01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Paris Single Site Private Endpoint - \- \[dq]s3.sng01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Singapore Single Site Endpoint - \- \[dq]s3.private.sng01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Singapore Single Site Private Endpoint - -#### \-\-s3\-endpoint - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]s3.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Dallas Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Washington DC Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region San Jose Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Dallas Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Washington DC Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region San Jose Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region East Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region East Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region South Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region South Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Frankfurt Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Milan Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Amsterdam Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Frankfurt Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Milan Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Amsterdam Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Region DE Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Region DE Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Tokyo Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional HongKong Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Seoul Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Tokyo Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional HongKong Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Seoul Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Japan Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Japan Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Australia Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Australia Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.ams03.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.ams03.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.che01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Chennai Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.che01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Chennai Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mel01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mel01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.osl01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Oslo Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.osl01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Oslo Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.tor01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.tor01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.seo01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Seoul Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.seo01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Seoul Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mon01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Montreal Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mon01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Montreal Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mex01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Mexico Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mex01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Mexico Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +San Jose Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +San Jose Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mil01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Milan Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mil01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Milan Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.par01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Paris Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.par01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Paris Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.sng01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Singapore Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.sng01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Singapore Single Site Private Endpoint +.RE +.RE +.SS \-\-s3\-endpoint +.PP Endpoint for OSS API. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] - \- East China 1 (Hangzhou) - \- \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] - \- East China 2 (Shanghai) - \- \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] - \- North China 1 (Qingdao) - \- \[dq]oss\-cn\-beijing.aliyuncs.com\[dq] - \- North China 2 (Beijing) - \- \[dq]oss\-cn\-zhangjiakou.aliyuncs.com\[dq] - \- North China 3 (Zhangjiakou) - \- \[dq]oss\-cn\-huhehaote.aliyuncs.com\[dq] - \- North China 5 (Huhehaote) - \- \[dq]oss\-cn\-shenzhen.aliyuncs.com\[dq] - \- South China 1 (Shenzhen) - \- \[dq]oss\-cn\-hongkong.aliyuncs.com\[dq] - \- Hong Kong (Hong Kong) - \- \[dq]oss\-us\-west\-1.aliyuncs.com\[dq] - \- US West 1 (Silicon Valley) - \- \[dq]oss\-us\-east\-1.aliyuncs.com\[dq] - \- US East 1 (Virginia) - \- \[dq]oss\-ap\-southeast\-1.aliyuncs.com\[dq] - \- Southeast Asia Southeast 1 (Singapore) - \- \[dq]oss\-ap\-southeast\-2.aliyuncs.com\[dq] - \- Asia Pacific Southeast 2 (Sydney) - \- \[dq]oss\-ap\-southeast\-3.aliyuncs.com\[dq] - \- Southeast Asia Southeast 3 (Kuala Lumpur) - \- \[dq]oss\-ap\-southeast\-5.aliyuncs.com\[dq] - \- Asia Pacific Southeast 5 (Jakarta) - \- \[dq]oss\-ap\-northeast\-1.aliyuncs.com\[dq] - \- Asia Pacific Northeast 1 (Japan) - \- \[dq]oss\-ap\-south\-1.aliyuncs.com\[dq] - \- Asia Pacific South 1 (Mumbai) - \- \[dq]oss\-eu\-central\-1.aliyuncs.com\[dq] - \- Central Europe 1 (Frankfurt) - \- \[dq]oss\-eu\-west\-1.aliyuncs.com\[dq] - \- West Europe (London) - \- \[dq]oss\-me\-east\-1.aliyuncs.com\[dq] - \- Middle East 1 (Dubai) - -#### \-\-s3\-endpoint - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +East China 1 (Hangzhou) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +East China 2 (Shanghai) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 1 (Qingdao) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-beijing.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 2 (Beijing) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-zhangjiakou.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 3 (Zhangjiakou) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-huhehaote.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 5 (Huhehaote) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-shenzhen.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +South China 1 (Shenzhen) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-hongkong.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong (Hong Kong) +.RE +.IP \[bu] 2 +\[dq]oss\-us\-west\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +US West 1 (Silicon Valley) +.RE +.IP \[bu] 2 +\[dq]oss\-us\-east\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +US East 1 (Virginia) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Southeast Asia Southeast 1 (Singapore) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-2.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Southeast 2 (Sydney) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-3.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Southeast Asia Southeast 3 (Kuala Lumpur) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-5.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Southeast 5 (Jakarta) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-northeast\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Northeast 1 (Japan) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-south\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific South 1 (Mumbai) +.RE +.IP \[bu] 2 +\[dq]oss\-eu\-central\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Central Europe 1 (Frankfurt) +.RE +.IP \[bu] 2 +\[dq]oss\-eu\-west\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +West Europe (London) +.RE +.IP \[bu] 2 +\[dq]oss\-me\-east\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Middle East 1 (Dubai) +.RE +.RE +.SS \-\-s3\-endpoint +.PP Endpoint for Scaleway Object Storage. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]s3.nl\-ams.scw.cloud\[dq] - \- Amsterdam Endpoint - \- \[dq]s3.fr\-par.scw.cloud\[dq] - \- Paris Endpoint - -#### \-\-s3\-endpoint - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]s3.nl\-ams.scw.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.fr\-par.scw.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Paris Endpoint +.RE +.RE +.SS \-\-s3\-endpoint +.PP Endpoint for StackPath Object Storage. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]s3.us\-east\-2.stackpathstorage.com\[dq] - \- US East Endpoint - \- \[dq]s3.us\-west\-1.stackpathstorage.com\[dq] - \- US West Endpoint - \- \[dq]s3.eu\-central\-1.stackpathstorage.com\[dq] - \- EU Endpoint - -#### \-\-s3\-endpoint - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]s3.us\-east\-2.stackpathstorage.com\[dq] +.RS 2 +.IP \[bu] 2 +US East Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-west\-1.stackpathstorage.com\[dq] +.RS 2 +.IP \[bu] 2 +US West Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-central\-1.stackpathstorage.com\[dq] +.RS 2 +.IP \[bu] 2 +EU Endpoint +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for Tencent COS API. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]cos.ap\-beijing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Beijing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-nanjing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Nanjing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-shanghai.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Shanghai Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-guangzhou.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Guangzhou Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-nanjing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Nanjing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-chengdu.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Chengdu Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-chongqing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Chongqing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-hongkong.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong (China) Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-singapore.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Singapore Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-mumbai.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Mumbai Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-seoul.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Seoul Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-bangkok.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Bangkok Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-tokyo.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Tokyo Region. +.RE +.IP \[bu] 2 +\[dq]cos.na\-siliconvalley.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Silicon Valley Region. +.RE +.IP \[bu] 2 +\[dq]cos.na\-ashburn.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Virginia Region. +.RE +.IP \[bu] 2 +\[dq]cos.na\-toronto.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Region. +.RE +.IP \[bu] 2 +\[dq]cos.eu\-frankfurt.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Frankfurt Region. +.RE +.IP \[bu] 2 +\[dq]cos.eu\-moscow.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Moscow Region. +.RE +.IP \[bu] 2 +\[dq]cos.accelerate.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Use Tencent COS Accelerate Endpoint. +.RE +.RE +.SS \-\-s3\-endpoint +.PP Endpoint for S3 API. Required when using an S3 clone. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]objects\-us\-east\-1.dream.io\[dq] - \- Dream Objects endpoint - \- \[dq]nyc3.digitaloceanspaces.com\[dq] - \- Digital Ocean Spaces New York 3 - \- \[dq]ams3.digitaloceanspaces.com\[dq] - \- Digital Ocean Spaces Amsterdam 3 - \- \[dq]sgp1.digitaloceanspaces.com\[dq] - \- Digital Ocean Spaces Singapore 1 - \- \[dq]s3.wasabisys.com\[dq] - \- Wasabi US East endpoint - \- \[dq]s3.us\-west\-1.wasabisys.com\[dq] - \- Wasabi US West endpoint - \- \[dq]s3.eu\-central\-1.wasabisys.com\[dq] - \- Wasabi EU Central endpoint - -#### \-\-s3\-location\-constraint - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]objects\-us\-east\-1.dream.io\[dq] +.RS 2 +.IP \[bu] 2 +Dream Objects endpoint +.RE +.IP \[bu] 2 +\[dq]nyc3.digitaloceanspaces.com\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces New York 3 +.RE +.IP \[bu] 2 +\[dq]ams3.digitaloceanspaces.com\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces Amsterdam 3 +.RE +.IP \[bu] 2 +\[dq]sgp1.digitaloceanspaces.com\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces Singapore 1 +.RE +.IP \[bu] 2 +\[dq]s3.wasabisys.com\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi US East endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-west\-1.wasabisys.com\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi US West endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-central\-1.wasabisys.com\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi EU Central endpoint +.RE +.RE +.SS \-\-s3\-location\-constraint +.PP Location constraint \- must be set to match the Region. Used when creating buckets only. - -\- Config: location_constraint -\- Env Var: RCLONE_S3_LOCATION_CONSTRAINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Empty for US Region, Northern Virginia or Pacific Northwest. - \- \[dq]us\-east\-2\[dq] - \- US East (Ohio) Region. - \- \[dq]us\-west\-2\[dq] - \- US West (Oregon) Region. - \- \[dq]us\-west\-1\[dq] - \- US West (Northern California) Region. - \- \[dq]ca\-central\-1\[dq] - \- Canada (Central) Region. - \- \[dq]eu\-west\-1\[dq] - \- EU (Ireland) Region. - \- \[dq]eu\-west\-2\[dq] - \- EU (London) Region. - \- \[dq]eu\-north\-1\[dq] - \- EU (Stockholm) Region. - \- \[dq]EU\[dq] - \- EU Region. - \- \[dq]ap\-southeast\-1\[dq] - \- Asia Pacific (Singapore) Region. - \- \[dq]ap\-southeast\-2\[dq] - \- Asia Pacific (Sydney) Region. - \- \[dq]ap\-northeast\-1\[dq] - \- Asia Pacific (Tokyo) Region. - \- \[dq]ap\-northeast\-2\[dq] - \- Asia Pacific (Seoul) - \- \[dq]ap\-south\-1\[dq] - \- Asia Pacific (Mumbai) - \- \[dq]ap\-east\-1\[dq] - \- Asia Pacific (Hong Kong) - \- \[dq]sa\-east\-1\[dq] - \- South America (Sao Paulo) Region. - -#### \-\-s3\-location\-constraint - +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Empty for US Region, Northern Virginia or Pacific Northwest. +.RE +.IP \[bu] 2 +\[dq]us\-east\-2\[dq] +.RS 2 +.IP \[bu] 2 +US East (Ohio) Region. +.RE +.IP \[bu] 2 +\[dq]us\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +US West (Oregon) Region. +.RE +.IP \[bu] 2 +\[dq]us\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +US West (Northern California) Region. +.RE +.IP \[bu] 2 +\[dq]ca\-central\-1\[dq] +.RS 2 +.IP \[bu] 2 +Canada (Central) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Ireland) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +EU (London) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-north\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Stockholm) Region. +.RE +.IP \[bu] 2 +\[dq]EU\[dq] +.RS 2 +.IP \[bu] 2 +EU Region. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Singapore) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Sydney) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Tokyo) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Seoul) +.RE +.IP \[bu] 2 +\[dq]ap\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Mumbai) +.RE +.IP \[bu] 2 +\[dq]ap\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Hong Kong) +.RE +.IP \[bu] 2 +\[dq]sa\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +South America (Sao Paulo) Region. +.RE +.RE +.SS \-\-s3\-location\-constraint +.PP Location constraint \- must match endpoint when using IBM Cloud Public. For on\-prem COS, do not make a selection from this list, hit enter - -\- Config: location_constraint -\- Env Var: RCLONE_S3_LOCATION_CONSTRAINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]us\-standard\[dq] - \- US Cross Region Standard - \- \[dq]us\-vault\[dq] - \- US Cross Region Vault - \- \[dq]us\-cold\[dq] - \- US Cross Region Cold - \- \[dq]us\-flex\[dq] - \- US Cross Region Flex - \- \[dq]us\-east\-standard\[dq] - \- US East Region Standard - \- \[dq]us\-east\-vault\[dq] - \- US East Region Vault - \- \[dq]us\-east\-cold\[dq] - \- US East Region Cold - \- \[dq]us\-east\-flex\[dq] - \- US East Region Flex - \- \[dq]us\-south\-standard\[dq] - \- US South Region Standard - \- \[dq]us\-south\-vault\[dq] - \- US South Region Vault - \- \[dq]us\-south\-cold\[dq] - \- US South Region Cold - \- \[dq]us\-south\-flex\[dq] - \- US South Region Flex - \- \[dq]eu\-standard\[dq] - \- EU Cross Region Standard - \- \[dq]eu\-vault\[dq] - \- EU Cross Region Vault - \- \[dq]eu\-cold\[dq] - \- EU Cross Region Cold - \- \[dq]eu\-flex\[dq] - \- EU Cross Region Flex - \- \[dq]eu\-gb\-standard\[dq] - \- Great Britain Standard - \- \[dq]eu\-gb\-vault\[dq] - \- Great Britain Vault - \- \[dq]eu\-gb\-cold\[dq] - \- Great Britain Cold - \- \[dq]eu\-gb\-flex\[dq] - \- Great Britain Flex - \- \[dq]ap\-standard\[dq] - \- APAC Standard - \- \[dq]ap\-vault\[dq] - \- APAC Vault - \- \[dq]ap\-cold\[dq] - \- APAC Cold - \- \[dq]ap\-flex\[dq] - \- APAC Flex - \- \[dq]mel01\-standard\[dq] - \- Melbourne Standard - \- \[dq]mel01\-vault\[dq] - \- Melbourne Vault - \- \[dq]mel01\-cold\[dq] - \- Melbourne Cold - \- \[dq]mel01\-flex\[dq] - \- Melbourne Flex - \- \[dq]tor01\-standard\[dq] - \- Toronto Standard - \- \[dq]tor01\-vault\[dq] - \- Toronto Vault - \- \[dq]tor01\-cold\[dq] - \- Toronto Cold - \- \[dq]tor01\-flex\[dq] - \- Toronto Flex - -#### \-\-s3\-location\-constraint - +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]us\-standard\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Standard +.RE +.IP \[bu] 2 +\[dq]us\-vault\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Vault +.RE +.IP \[bu] 2 +\[dq]us\-cold\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Cold +.RE +.IP \[bu] 2 +\[dq]us\-flex\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Flex +.RE +.IP \[bu] 2 +\[dq]us\-east\-standard\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Standard +.RE +.IP \[bu] 2 +\[dq]us\-east\-vault\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Vault +.RE +.IP \[bu] 2 +\[dq]us\-east\-cold\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Cold +.RE +.IP \[bu] 2 +\[dq]us\-east\-flex\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Flex +.RE +.IP \[bu] 2 +\[dq]us\-south\-standard\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Standard +.RE +.IP \[bu] 2 +\[dq]us\-south\-vault\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Vault +.RE +.IP \[bu] 2 +\[dq]us\-south\-cold\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Cold +.RE +.IP \[bu] 2 +\[dq]us\-south\-flex\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Flex +.RE +.IP \[bu] 2 +\[dq]eu\-standard\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Standard +.RE +.IP \[bu] 2 +\[dq]eu\-vault\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Vault +.RE +.IP \[bu] 2 +\[dq]eu\-cold\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Cold +.RE +.IP \[bu] 2 +\[dq]eu\-flex\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Flex +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-standard\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Standard +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-vault\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Vault +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-cold\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Cold +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-flex\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Flex +.RE +.IP \[bu] 2 +\[dq]ap\-standard\[dq] +.RS 2 +.IP \[bu] 2 +APAC Standard +.RE +.IP \[bu] 2 +\[dq]ap\-vault\[dq] +.RS 2 +.IP \[bu] 2 +APAC Vault +.RE +.IP \[bu] 2 +\[dq]ap\-cold\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cold +.RE +.IP \[bu] 2 +\[dq]ap\-flex\[dq] +.RS 2 +.IP \[bu] 2 +APAC Flex +.RE +.IP \[bu] 2 +\[dq]mel01\-standard\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Standard +.RE +.IP \[bu] 2 +\[dq]mel01\-vault\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Vault +.RE +.IP \[bu] 2 +\[dq]mel01\-cold\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Cold +.RE +.IP \[bu] 2 +\[dq]mel01\-flex\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Flex +.RE +.IP \[bu] 2 +\[dq]tor01\-standard\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Standard +.RE +.IP \[bu] 2 +\[dq]tor01\-vault\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Vault +.RE +.IP \[bu] 2 +\[dq]tor01\-cold\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Cold +.RE +.IP \[bu] 2 +\[dq]tor01\-flex\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Flex +.RE +.RE +.SS \-\-s3\-location\-constraint +.PP Location constraint \- must be set to match the Region. -Leave blank if not sure. Used when creating buckets only. - -\- Config: location_constraint -\- Env Var: RCLONE_S3_LOCATION_CONSTRAINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-acl - +Leave blank if not sure. +Used when creating buckets only. +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-acl +.PP Canned ACL used when creating buckets and storing or copying objects. - -This ACL is used for creating objects and if bucket_acl isn\[aq]t set, for creating buckets too. - -For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl - +.PP +This ACL is used for creating objects and if bucket_acl isn\[aq]t set, +for creating buckets too. +.PP +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +.PP Note that this ACL is applied when server side copying objects as S3 doesn\[aq]t copy the ACL from the source but rather writes a fresh one. - -\- Config: acl -\- Env Var: RCLONE_S3_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]private\[dq] - \- Owner gets FULL_CONTROL. No one else has access rights (default). - \- \[dq]public\-read\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ access. - \- \[dq]public\-read\-write\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - \- Granting this on a bucket is generally not recommended. - \- \[dq]authenticated\-read\[dq] - \- Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - \- \[dq]bucket\-owner\-read\[dq] - \- Object owner gets FULL_CONTROL. Bucket owner gets READ access. - \- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - \- \[dq]bucket\-owner\-full\-control\[dq] - \- Both the object owner and the bucket owner get FULL_CONTROL over the object. - \- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - \- \[dq]private\[dq] - \- Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise COS - \- \[dq]public\-read\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise IBM COS - \- \[dq]public\-read\-write\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On\-Premise IBM COS - \- \[dq]authenticated\-read\[dq] - \- Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS - -#### \-\-s3\-server\-side\-encryption - -The server\-side encryption algorithm used when storing this object in S3. - -\- Config: server_side_encryption -\- Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - \- \[dq]AES256\[dq] - \- AES256 - \- \[dq]aws:kms\[dq] - \- aws:kms - -#### \-\-s3\-sse\-kms\-key\-id - +.IP \[bu] 2 +Config: acl +.IP \[bu] 2 +Env Var: RCLONE_S3_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]default\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets Full_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[dq]public\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +.RE +.IP \[bu] 2 +\[dq]public\-read\-write\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +.IP \[bu] 2 +Granting this on a bucket is generally not recommended. +.RE +.IP \[bu] 2 +\[dq]authenticated\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +.RE +.IP \[bu] 2 +\[dq]bucket\-owner\-read\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets FULL_CONTROL. +Bucket owner gets READ access. +.IP \[bu] 2 +If you specify this canned ACL when creating a bucket, Amazon S3 ignores +it. +.RE +.IP \[bu] 2 +\[dq]bucket\-owner\-full\-control\[dq] +.RS 2 +.IP \[bu] 2 +Both the object owner and the bucket owner get FULL_CONTROL over the +object. +.IP \[bu] 2 +If you specify this canned ACL when creating a bucket, Amazon S3 ignores +it. +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), +On\-Premise COS +.RE +.IP \[bu] 2 +\[dq]public\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), +On\-Premise IBM COS +.RE +.IP \[bu] 2 +\[dq]public\-read\-write\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +This acl is available on IBM Cloud (Infra), On\-Premise IBM COS +.RE +.IP \[bu] 2 +\[dq]authenticated\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +Not supported on Buckets. +This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS +.RE +.RE +.SS \-\-s3\-server\-side\-encryption +.PP +The server\-side encryption algorithm used when storing this object in +S3. +.IP \[bu] 2 +Config: server_side_encryption +.IP \[bu] 2 +Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[dq]AES256\[dq] +.RS 2 +.IP \[bu] 2 +AES256 +.RE +.IP \[bu] 2 +\[dq]aws:kms\[dq] +.RS 2 +.IP \[bu] 2 +aws:kms +.RE +.RE +.SS \-\-s3\-sse\-kms\-key\-id +.PP If using KMS ID you must provide the ARN of Key. - -\- Config: sse_kms_key_id -\- Env Var: RCLONE_S3_SSE_KMS_KEY_ID -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - \- \[dq]arn:aws:kms:us\-east\-1:*\[dq] - \- arn:aws:kms:* - -#### \-\-s3\-storage\-class - +.IP \[bu] 2 +Config: sse_kms_key_id +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_KMS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[dq]arn:aws:kms:us\-east\-1:*\[dq] +.RS 2 +.IP \[bu] 2 +arn:aws:kms:* +.RE +.RE +.SS \-\-s3\-storage\-class +.PP The storage class to use when storing new objects in S3. - -\- Config: storage_class -\- Env Var: RCLONE_S3_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]STANDARD\[dq] - \- Standard storage class - \- \[dq]REDUCED_REDUNDANCY\[dq] - \- Reduced redundancy storage class - \- \[dq]STANDARD_IA\[dq] - \- Standard Infrequent Access storage class - \- \[dq]ONEZONE_IA\[dq] - \- One Zone Infrequent Access storage class - \- \[dq]GLACIER\[dq] - \- Glacier storage class - \- \[dq]DEEP_ARCHIVE\[dq] - \- Glacier Deep Archive storage class - \- \[dq]INTELLIGENT_TIERING\[dq] - \- Intelligent\-Tiering storage class - -#### \-\-s3\-storage\-class - +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]REDUCED_REDUNDANCY\[dq] +.RS 2 +.IP \[bu] 2 +Reduced redundancy storage class +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Standard Infrequent Access storage class +.RE +.IP \[bu] 2 +\[dq]ONEZONE_IA\[dq] +.RS 2 +.IP \[bu] 2 +One Zone Infrequent Access storage class +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Glacier storage class +.RE +.IP \[bu] 2 +\[dq]DEEP_ARCHIVE\[dq] +.RS 2 +.IP \[bu] 2 +Glacier Deep Archive storage class +.RE +.IP \[bu] 2 +\[dq]INTELLIGENT_TIERING\[dq] +.RS 2 +.IP \[bu] 2 +Intelligent\-Tiering storage class +.RE +.RE +.SS \-\-s3\-storage\-class +.PP The storage class to use when storing new objects in OSS. - -\- Config: storage_class -\- Env Var: RCLONE_S3_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]STANDARD\[dq] - \- Standard storage class - \- \[dq]GLACIER\[dq] - \- Archive storage mode. - \- \[dq]STANDARD_IA\[dq] - \- Infrequent access storage mode. - -#### \-\-s3\-storage\-class - +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage mode. +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Infrequent access storage mode. +.RE +.RE +.SS \-\-s3\-storage\-class +.PP +The storage class to use when storing new objects in Tencent COS. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]ARCHIVE\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage mode. +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Infrequent access storage mode. +.RE +.RE +.SS \-\-s3\-storage\-class +.PP The storage class to use when storing new objects in S3. - -\- Config: storage_class -\- Env Var: RCLONE_S3_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]STANDARD\[dq] - \- The Standard class for any upload; suitable for on\-demand content like streaming or CDN. - \- \[dq]GLACIER\[dq] - \- Archived storage; prices are lower, but it needs to be restored first to be accessed. - -### Advanced Options - -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - -#### \-\-s3\-bucket\-acl - +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +The Standard class for any upload; suitable for on\-demand content like +streaming or CDN. +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Archived storage; prices are lower, but it needs to be restored first to +be accessed. +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to s3 (Amazon S3 Compliant +Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, Tencent COS, etc)). +.SS \-\-s3\-bucket\-acl +.PP Canned ACL used when creating buckets. - -For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl - -Note that this ACL is applied when only when creating buckets. If it -isn\[aq]t set then \[dq]acl\[dq] is used instead. - -\- Config: bucket_acl -\- Env Var: RCLONE_S3_BUCKET_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]private\[dq] - \- Owner gets FULL_CONTROL. No one else has access rights (default). - \- \[dq]public\-read\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ access. - \- \[dq]public\-read\-write\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - \- Granting this on a bucket is generally not recommended. - \- \[dq]authenticated\-read\[dq] - \- Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - -#### \-\-s3\-sse\-customer\-algorithm - -If using SSE\-C, the server\-side encryption algorithm used when storing this object in S3. - -\- Config: sse_customer_algorithm -\- Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - \- \[dq]AES256\[dq] - \- AES256 - -#### \-\-s3\-sse\-customer\-key - -If using SSE\-C you must provide the secret encryption key used to encrypt/decrypt your data. - -\- Config: sse_customer_key -\- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - -#### \-\-s3\-sse\-customer\-key\-md5 - +.PP +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +.PP +Note that this ACL is applied when only when creating buckets. +If it isn\[aq]t set then \[dq]acl\[dq] is used instead. +.IP \[bu] 2 +Config: bucket_acl +.IP \[bu] 2 +Env Var: RCLONE_S3_BUCKET_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[dq]public\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +.RE +.IP \[bu] 2 +\[dq]public\-read\-write\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +.IP \[bu] 2 +Granting this on a bucket is generally not recommended. +.RE +.IP \[bu] 2 +\[dq]authenticated\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +.RE +.RE +.SS \-\-s3\-sse\-customer\-algorithm +.PP +If using SSE\-C, the server\-side encryption algorithm used when storing +this object in S3. +.IP \[bu] 2 +Config: sse_customer_algorithm +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[dq]AES256\[dq] +.RS 2 +.IP \[bu] 2 +AES256 +.RE +.RE +.SS \-\-s3\-sse\-customer\-key +.PP +If using SSE\-C you must provide the secret encryption key used to +encrypt/decrypt your data. +.IP \[bu] 2 +Config: sse_customer_key +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_CUSTOMER_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.RE +.SS \-\-s3\-sse\-customer\-key\-md5 +.PP If using SSE\-C you must provide the secret encryption key MD5 checksum. - -\- Config: sse_customer_key_md5 -\- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - -#### \-\-s3\-upload\-cutoff - +.IP \[bu] 2 +Config: sse_customer_key_md5 +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.RE +.SS \-\-s3\-upload\-cutoff +.PP Cutoff for switching to chunked upload - +.PP Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB. - -\- Config: upload_cutoff -\- Env Var: RCLONE_S3_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 200M - -#### \-\-s3\-chunk\-size - +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_S3_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 200M +.SS \-\-s3\-chunk\-size +.PP Chunk size to use for uploading. - +.PP When uploading files larger than upload_cutoff or files with unknown -size (eg from \[dq]rclone rcat\[dq] or uploaded with \[dq]rclone mount\[dq] or google -photos or google docs) they will be uploaded as multipart uploads -using this chunk size. - -Note that \[dq]\-\-s3\-upload\-concurrency\[dq] chunks of this size are buffered -in memory per transfer. - +size (eg from \[dq]rclone rcat\[dq] or uploaded with \[dq]rclone +mount\[dq] or google photos or google docs) they will be uploaded as +multipart uploads using this chunk size. +.PP +Note that \[dq]\-\-s3\-upload\-concurrency\[dq] chunks of this size are +buffered in memory per transfer. +.PP If you are transferring large files over high speed links and you have enough memory, then increasing this will speed up the transfers. - -Rclone will automatically increase the chunk size when uploading a -large file of known size to stay below the 10,000 chunks limit. - -Files of unknown size are uploaded with the configured -chunk_size. Since the default chunk size is 5MB and there can be at -most 10,000 chunks, this means that by default the maximum size of -file you can stream upload is 48GB. If you wish to stream upload -larger files then you will need to increase chunk_size. - -\- Config: chunk_size -\- Env Var: RCLONE_S3_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 5M - -#### \-\-s3\-max\-upload\-parts - +.PP +Rclone will automatically increase the chunk size when uploading a large +file of known size to stay below the 10,000 chunks limit. +.PP +Files of unknown size are uploaded with the configured chunk_size. +Since the default chunk size is 5MB and there can be at most 10,000 +chunks, this means that by default the maximum size of file you can +stream upload is 48GB. +If you wish to stream upload larger files then you will need to increase +chunk_size. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_S3_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 5M +.SS \-\-s3\-max\-upload\-parts +.PP Maximum number of parts in a multipart upload. - -This option defines the maximum number of multipart chunks to use -when doing a multipart upload. - +.PP +This option defines the maximum number of multipart chunks to use when +doing a multipart upload. +.PP This can be useful if a service does not support the AWS S3 specification of 10,000 chunks. - -Rclone will automatically increase the chunk size when uploading a -large file of a known size to stay below this number of chunks limit. - - -\- Config: max_upload_parts -\- Env Var: RCLONE_S3_MAX_UPLOAD_PARTS -\- Type: int -\- Default: 10000 - -#### \-\-s3\-copy\-cutoff - +.PP +Rclone will automatically increase the chunk size when uploading a large +file of a known size to stay below this number of chunks limit. +.IP \[bu] 2 +Config: max_upload_parts +.IP \[bu] 2 +Env Var: RCLONE_S3_MAX_UPLOAD_PARTS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 10000 +.SS \-\-s3\-copy\-cutoff +.PP Cutoff for switching to multipart copy - +.PP Any files larger than this that need to be server side copied will be copied in chunks of this size. - +.PP The minimum is 0 and the maximum is 5GB. - -\- Config: copy_cutoff -\- Env Var: RCLONE_S3_COPY_CUTOFF -\- Type: SizeSuffix -\- Default: 4.656G - -#### \-\-s3\-disable\-checksum - +.IP \[bu] 2 +Config: copy_cutoff +.IP \[bu] 2 +Env Var: RCLONE_S3_COPY_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 4.656G +.SS \-\-s3\-disable\-checksum +.PP Don\[aq]t store MD5 checksum with object metadata - +.PP Normally rclone will calculate the MD5 checksum of the input before -uploading it so it can add it to metadata on the object. This is great -for data integrity checking but can cause long delays for large files -to start uploading. - -\- Config: disable_checksum -\- Env Var: RCLONE_S3_DISABLE_CHECKSUM -\- Type: bool -\- Default: false - -#### \-\-s3\-shared\-credentials\-file - +uploading it so it can add it to metadata on the object. +This is great for data integrity checking but can cause long delays for +large files to start uploading. +.IP \[bu] 2 +Config: disable_checksum +.IP \[bu] 2 +Env Var: RCLONE_S3_DISABLE_CHECKSUM +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-shared\-credentials\-file +.PP Path to the shared credentials file - +.PP If env_auth = true then rclone can use a shared credentials file. - +.PP If this variable is empty rclone will look for the -\[dq]AWS_SHARED_CREDENTIALS_FILE\[dq] env variable. If the env value is empty -it will default to the current user\[aq]s home directory. - - Linux/OSX: \[dq]$HOME/.aws/credentials\[dq] - Windows: \[dq]%USERPROFILE%\[rs].aws\[rs]credentials\[dq] - - -\- Config: shared_credentials_file -\- Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-profile - +\[dq]AWS_SHARED_CREDENTIALS_FILE\[dq] env variable. +If the env value is empty it will default to the current user\[aq]s home +directory. +.IP +.nf +\f[C] +Linux/OSX: \[dq]$HOME/.aws/credentials\[dq] +Windows: \[dq]%USERPROFILE%\[rs].aws\[rs]credentials\[dq] +\f[R] +.fi +.IP \[bu] 2 +Config: shared_credentials_file +.IP \[bu] 2 +Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-profile +.PP Profile to use in the shared credentials file - -If env_auth = true then rclone can use a shared credentials file. This -variable controls which profile is used in that file. - -If empty it will default to the environment variable \[dq]AWS_PROFILE\[dq] or -\[dq]default\[dq] if that environment variable is also not set. - - -\- Config: profile -\- Env Var: RCLONE_S3_PROFILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-session\-token - +.PP +If env_auth = true then rclone can use a shared credentials file. +This variable controls which profile is used in that file. +.PP +If empty it will default to the environment variable +\[dq]AWS_PROFILE\[dq] or \[dq]default\[dq] if that environment variable +is also not set. +.IP \[bu] 2 +Config: profile +.IP \[bu] 2 +Env Var: RCLONE_S3_PROFILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-session\-token +.PP An AWS session token - -\- Config: session_token -\- Env Var: RCLONE_S3_SESSION_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-upload\-concurrency - +.IP \[bu] 2 +Config: session_token +.IP \[bu] 2 +Env Var: RCLONE_S3_SESSION_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-upload\-concurrency +.PP Concurrency for multipart uploads. - +.PP This is the number of chunks of the same file that are uploaded concurrently. - +.PP If you are uploading small numbers of large file over high speed link and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers. - -\- Config: upload_concurrency -\- Env Var: RCLONE_S3_UPLOAD_CONCURRENCY -\- Type: int -\- Default: 4 - -#### \-\-s3\-force\-path\-style - +.IP \[bu] 2 +Config: upload_concurrency +.IP \[bu] 2 +Env Var: RCLONE_S3_UPLOAD_CONCURRENCY +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 4 +.SS \-\-s3\-force\-path\-style +.PP If true use path style access if false use virtual hosted style. - -If this is true (the default) then rclone will use path style access, -if false then rclone will use virtual path style. See [the AWS S3 -docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access\-bucket\-intro) +.PP +If this is true (the default) then rclone will use path style access, if +false then rclone will use virtual path style. +See the AWS S3 +docs (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. - -Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to -false \- rclone will do this automatically based on the provider -setting. - -\- Config: force_path_style -\- Env Var: RCLONE_S3_FORCE_PATH_STYLE -\- Type: bool -\- Default: true - -#### \-\-s3\-v2\-auth - +.PP +Some providers (eg AWS, Aliyun OSS, Netease COS or Tencent COS) require +this set to false \- rclone will do this automatically based on the +provider setting. +.IP \[bu] 2 +Config: force_path_style +.IP \[bu] 2 +Env Var: RCLONE_S3_FORCE_PATH_STYLE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.SS \-\-s3\-v2\-auth +.PP If true use v2 authentication. - +.PP If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication. - +.PP Use this only if v4 signatures don\[aq]t work, eg pre Jewel/v10 CEPH. - -\- Config: v2_auth -\- Env Var: RCLONE_S3_V2_AUTH -\- Type: bool -\- Default: false - -#### \-\-s3\-use\-accelerate\-endpoint - +.IP \[bu] 2 +Config: v2_auth +.IP \[bu] 2 +Env Var: RCLONE_S3_V2_AUTH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-use\-accelerate\-endpoint +.PP If true use the AWS S3 accelerated endpoint. - -See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer\-acceleration\-examples.html) - -\- Config: use_accelerate_endpoint -\- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT -\- Type: bool -\- Default: false - -#### \-\-s3\-leave\-parts\-on\-error - -If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. - +.PP +See: AWS S3 Transfer +acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) +.IP \[bu] 2 +Config: use_accelerate_endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-leave\-parts\-on\-error +.PP +If true avoid calling abort upload on a failure, leaving all +successfully uploaded parts on S3 for manual recovery. +.PP It should be set to true for resuming uploads across different sessions. - -WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. - - -\- Config: leave_parts_on_error -\- Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR -\- Type: bool -\- Default: false - -#### \-\-s3\-list\-chunk - +.PP +WARNING: Storing parts of an incomplete multipart upload counts towards +space usage on S3 and will add additional costs if not cleaned up. +.IP \[bu] 2 +Config: leave_parts_on_error +.IP \[bu] 2 +Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-list\-chunk +.PP Size of listing chunk (response list for each ListObject S3 request). - -This option is also known as \[dq]MaxKeys\[dq], \[dq]max\-items\[dq], or \[dq]page\-size\[dq] from the AWS S3 specification. -Most services truncate the response list to 1000 objects even if requested more than that. -In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). -In Ceph, this can be increased with the \[dq]rgw list buckets max chunk\[dq] option. - - -\- Config: list_chunk -\- Env Var: RCLONE_S3_LIST_CHUNK -\- Type: int -\- Default: 1000 - -#### \-\-s3\-no\-check\-bucket - +.PP +This option is also known as \[dq]MaxKeys\[dq], \[dq]max\-items\[dq], or +\[dq]page\-size\[dq] from the AWS S3 specification. +Most services truncate the response list to 1000 objects even if +requested more than that. +In AWS S3 this is a global maximum and cannot be changed, see AWS +S3 (https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). +In Ceph, this can be increased with the \[dq]rgw list buckets max +chunk\[dq] option. +.IP \[bu] 2 +Config: list_chunk +.IP \[bu] 2 +Env Var: RCLONE_S3_LIST_CHUNK +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1000 +.SS \-\-s3\-no\-check\-bucket +.PP If set don\[aq]t attempt to check the bucket exists or create it - +.PP This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. - - -\- Config: no_check_bucket -\- Env Var: RCLONE_S3_NO_CHECK_BUCKET -\- Type: bool -\- Default: false - -#### \-\-s3\-encoding - +.IP \[bu] 2 +Config: no_check_bucket +.IP \[bu] 2 +Env Var: RCLONE_S3_NO_CHECK_BUCKET +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_S3_ENCODING -\- Type: MultiEncoder -\- Default: Slash,InvalidUtf8,Dot - -#### \-\-s3\-memory\-pool\-flush\-time - +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_S3_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8,Dot +.SS \-\-s3\-memory\-pool\-flush\-time +.PP How often internal memory buffer pools will be flushed. -Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. -This option controls how often unused buffers will be removed from the pool. - -\- Config: memory_pool_flush_time -\- Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME -\- Type: Duration -\- Default: 1m0s - -#### \-\-s3\-memory\-pool\-use\-mmap - +Uploads which requires additional buffers (f.e multipart) will use +memory pool for allocations. +This option controls how often unused buffers will be removed from the +pool. +.IP \[bu] 2 +Config: memory_pool_flush_time +.IP \[bu] 2 +Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \-\-s3\-memory\-pool\-use\-mmap +.PP Whether to use mmap buffers in internal memory pool. - -\- Config: memory_pool_use_mmap -\- Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP -\- Type: bool -\- Default: false - -### Backend commands - +.IP \[bu] 2 +Config: memory_pool_use_mmap +.IP \[bu] 2 +Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Backend commands +.PP Here are the commands specific to the s3 backend. - +.PP Run them with - - rclone backend COMMAND remote: - +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### restore - +backend/command (https://rclone.org/rc/#backend/command). +.SS restore +.PP Restore objects from GLACIER to normal storage - - rclone backend restore remote: [options] [+] - -This command can be used to restore one or more objects from GLACIER -to normal storage. - +.IP +.nf +\f[C] +rclone backend restore remote: [options] [+] +\f[R] +.fi +.PP +This command can be used to restore one or more objects from GLACIER to +normal storage. +.PP Usage Examples: - - rclone backend restore s3:bucket/path/to/object [\-o priority=PRIORITY] [\-o lifetime=DAYS] - rclone backend restore s3:bucket/path/to/directory [\-o priority=PRIORITY] [\-o lifetime=DAYS] - rclone backend restore s3:bucket [\-o priority=PRIORITY] [\-o lifetime=DAYS] - -This flag also obeys the filters. Test first with \-i/\-\-interactive or \-\-dry\-run flags - - rclone \-i backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard - +.IP +.nf +\f[C] +rclone backend restore s3:bucket/path/to/object [\-o priority=PRIORITY] [\-o lifetime=DAYS] +rclone backend restore s3:bucket/path/to/directory [\-o priority=PRIORITY] [\-o lifetime=DAYS] +rclone backend restore s3:bucket [\-o priority=PRIORITY] [\-o lifetime=DAYS] +\f[R] +.fi +.PP +This flag also obeys the filters. +Test first with \-i/\-\-interactive or \-\-dry\-run flags +.IP +.nf +\f[C] +rclone \-i backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard +\f[R] +.fi +.PP All the objects shown will be marked for restore, then - - rclone backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard - -It returns a list of status dictionaries with Remote and Status -keys. The Status will be OK if it was successfull or an error message -if not. - - [ - { - \[dq]Status\[dq]: \[dq]OK\[dq], - \[dq]Path\[dq]: \[dq]test.txt\[dq] - }, - { - \[dq]Status\[dq]: \[dq]OK\[dq], - \[dq]Path\[dq]: \[dq]test/file4.txt\[dq] - } - ] - - - +.IP +.nf +\f[C] +rclone backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard +\f[R] +.fi +.PP +It returns a list of status dictionaries with Remote and Status keys. +The Status will be OK if it was successfull or an error message if not. +.IP +.nf +\f[C] +[ + { + \[dq]Status\[dq]: \[dq]OK\[dq], + \[dq]Path\[dq]: \[dq]test.txt\[dq] + }, + { + \[dq]Status\[dq]: \[dq]OK\[dq], + \[dq]Path\[dq]: \[dq]test/file4.txt\[dq] + } +] +\f[R] +.fi +.PP Options: - -\- \[dq]description\[dq]: The optional description for the job. -\- \[dq]lifetime\[dq]: Lifetime of the active copy in days -\- \[dq]priority\[dq]: Priority of restore: Standard|Expedited|Bulk - -#### list\-multipart\-uploads - +.IP \[bu] 2 +\[dq]description\[dq]: The optional description for the job. +.IP \[bu] 2 +\[dq]lifetime\[dq]: Lifetime of the active copy in days +.IP \[bu] 2 +\[dq]priority\[dq]: Priority of restore: Standard|Expedited|Bulk +.SS list\-multipart\-uploads +.PP List the unfinished multipart uploads - - rclone backend list\-multipart\-uploads remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend list\-multipart\-uploads remote: [options] [+] +\f[R] +.fi +.PP This command lists the unfinished multipart uploads in JSON format. - - rclone backend list\-multipart s3:bucket/path/to/object - +.IP +.nf +\f[C] +rclone backend list\-multipart s3:bucket/path/to/object +\f[R] +.fi +.PP It returns a dictionary of buckets with values as lists of unfinished multipart uploads. - -You can call it with no bucket in which case it lists all bucket, with -a bucket or with a bucket and path. - +.PP +You can call it with no bucket in which case it lists all bucket, with a +bucket or with a bucket and path. +.IP +.nf +\f[C] +{ + \[dq]rclone\[dq]: [ { - \[dq]rclone\[dq]: [ - { - \[dq]Initiated\[dq]: \[dq]2020\-06\-26T14:20:36Z\[dq], - \[dq]Initiator\[dq]: { - \[dq]DisplayName\[dq]: \[dq]XXX\[dq], - \[dq]ID\[dq]: \[dq]arn:aws:iam::XXX:user/XXX\[dq] - }, - \[dq]Key\[dq]: \[dq]KEY\[dq], - \[dq]Owner\[dq]: { - \[dq]DisplayName\[dq]: null, - \[dq]ID\[dq]: \[dq]XXX\[dq] - }, - \[dq]StorageClass\[dq]: \[dq]STANDARD\[dq], - \[dq]UploadId\[dq]: \[dq]XXX\[dq] - } - ], - \[dq]rclone\-1000files\[dq]: [], - \[dq]rclone\-dst\[dq]: [] + \[dq]Initiated\[dq]: \[dq]2020\-06\-26T14:20:36Z\[dq], + \[dq]Initiator\[dq]: { + \[dq]DisplayName\[dq]: \[dq]XXX\[dq], + \[dq]ID\[dq]: \[dq]arn:aws:iam::XXX:user/XXX\[dq] + }, + \[dq]Key\[dq]: \[dq]KEY\[dq], + \[dq]Owner\[dq]: { + \[dq]DisplayName\[dq]: null, + \[dq]ID\[dq]: \[dq]XXX\[dq] + }, + \[dq]StorageClass\[dq]: \[dq]STANDARD\[dq], + \[dq]UploadId\[dq]: \[dq]XXX\[dq] } - - - -#### cleanup - + ], + \[dq]rclone\-1000files\[dq]: [], + \[dq]rclone\-dst\[dq]: [] +} +\f[R] +.fi +.SS cleanup +.PP Remove unfinished multipart uploads. - - rclone backend cleanup remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend cleanup remote: [options] [+] +\f[R] +.fi +.PP This command removes unfinished multipart uploads of age greater than max\-age which defaults to 24 hours. - +.PP Note that you can use \-i/\-\-dry\-run with this command to see what it would do. - - rclone backend cleanup s3:bucket/path/to/object - rclone backend cleanup \-o max\-age=7w s3:bucket/path/to/object - +.IP +.nf +\f[C] +rclone backend cleanup s3:bucket/path/to/object +rclone backend cleanup \-o max\-age=7w s3:bucket/path/to/object +\f[R] +.fi +.PP Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. - - +.PP Options: - -\- \[dq]max\-age\[dq]: Max age of upload to delete - - - -### Anonymous access to public buckets ### - +.IP \[bu] 2 +\[dq]max\-age\[dq]: Max age of upload to delete +.SS Anonymous access to public buckets +.PP If you want to use rclone to access a public bucket, configure with a -blank \[ga]access_key_id\[ga] and \[ga]secret_access_key\[ga]. Your config should end -up looking like this: -\f[R] -.fi -.PP -[anons3] type = s3 provider = AWS env_auth = false access_key_id = -secret_access_key = region = us\-east\-1 endpoint = location_constraint -= acl = private server_side_encryption = storage_class = +blank \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. +Your config should end up looking like this: .IP .nf \f[C] - +[anons3] +type = s3 +provider = AWS +env_auth = false +access_key_id = +secret_access_key = +region = us\-east\-1 +endpoint = +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.PP Then use it as normal with the name of the public bucket, eg - - rclone lsd anons3:1000genomes - -You will be able to list and copy data but not upload it. - -### Ceph ### - -[Ceph](https://ceph.com/) is an open source unified, distributed -storage system designed for excellent performance, reliability and -scalability. It has an S3 compatible object storage interface. - -To use rclone with Ceph, configure as above but leave the region blank -and set the endpoint. You should end up with something like this in -your config: - -\f[R] -.fi -.PP -[ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX -secret_access_key = YYY region = endpoint = -https://ceph.endpoint.example.com location_constraint = acl = -server_side_encryption = storage_class = .IP .nf \f[C] - -If you are using an older version of CEPH, eg 10.2.x Jewel, then you -may need to supply the parameter \[ga]\-\-s3\-upload\-cutoff 0\[ga] or put this in -the config file as \[ga]upload_cutoff 0\[ga] to work around a bug which causes -uploading of small files to fail. - -Note also that Ceph sometimes puts \[ga]/\[ga] in the passwords it gives -users. If you read the secret access key using the command line tools -you will get a JSON blob with the \[ga]/\[ga] escaped as \[ga]\[rs]/\[ga]. Make sure you -only write \[ga]/\[ga] in the secret access key. - +rclone lsd anons3:1000genomes +\f[R] +.fi +.PP +You will be able to list and copy data but not upload it. +.SS Ceph +.PP +Ceph (https://ceph.com/) is an open source unified, distributed storage +system designed for excellent performance, reliability and scalability. +It has an S3 compatible object storage interface. +.PP +To use rclone with Ceph, configure as above but leave the region blank +and set the endpoint. +You should end up with something like this in your config: +.IP +.nf +\f[C] +[ceph] +type = s3 +provider = Ceph +env_auth = false +access_key_id = XXX +secret_access_key = YYY +region = +endpoint = https://ceph.endpoint.example.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.PP +If you are using an older version of CEPH, eg 10.2.x Jewel, then you may +need to supply the parameter \f[C]\-\-s3\-upload\-cutoff 0\f[R] or put +this in the config file as \f[C]upload_cutoff 0\f[R] to work around a +bug which causes uploading of small files to fail. +.PP +Note also that Ceph sometimes puts \f[C]/\f[R] in the passwords it gives +users. +If you read the secret access key using the command line tools you will +get a JSON blob with the \f[C]/\f[R] escaped as \f[C]\[rs]/\f[R]. +Make sure you only write \f[C]/\f[R] in the secret access key. +.PP Eg the dump from Ceph looks something like this (irrelevant keys removed). -\f[R] -.fi -.PP -{ \[dq]user_id\[dq]: \[dq]xxx\[dq], \[dq]display_name\[dq]: -\[dq]xxxx\[dq], \[dq]keys\[dq]: [ { \[dq]user\[dq]: \[dq]xxx\[dq], -\[dq]access_key\[dq]: \[dq]xxxxxx\[dq], \[dq]secret_key\[dq]: -\[dq]xxxxxx/xxxx\[dq] } ], } .IP .nf \f[C] - -Because this is a json dump, it is encoding the \[ga]/\[ga] as \[ga]\[rs]/\[ga], so if you -use the secret key as \[ga]xxxxxx/xxxx\[ga] it will work fine. - -### Dreamhost ### - -Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is -an object storage system based on CEPH. - -To use rclone with Dreamhost, configure as above but leave the region blank -and set the endpoint. You should end up with something like this in -your config: +{ + \[dq]user_id\[dq]: \[dq]xxx\[dq], + \[dq]display_name\[dq]: \[dq]xxxx\[dq], + \[dq]keys\[dq]: [ + { + \[dq]user\[dq]: \[dq]xxx\[dq], + \[dq]access_key\[dq]: \[dq]xxxxxx\[dq], + \[dq]secret_key\[dq]: \[dq]xxxxxx\[rs]/xxxx\[dq] + } + ], +} \f[R] .fi .PP -[dreamobjects] type = s3 provider = DreamHost env_auth = false -access_key_id = your_access_key secret_access_key = your_secret_key -region = endpoint = objects\-us\-west\-1.dream.io location_constraint = -acl = private server_side_encryption = storage_class = +Because this is a json dump, it is encoding the \f[C]/\f[R] as +\f[C]\[rs]/\f[R], so if you use the secret key as \f[C]xxxxxx/xxxx\f[R] +it will work fine. +.SS Dreamhost +.PP +Dreamhost DreamObjects (https://www.dreamhost.com/cloud/storage/) is an +object storage system based on CEPH. +.PP +To use rclone with Dreamhost, configure as above but leave the region +blank and set the endpoint. +You should end up with something like this in your config: .IP .nf \f[C] - -### DigitalOcean Spaces ### - -[Spaces](https://www.digitalocean.com/products/object\-storage/) is an [S3\-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean. - -To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the \[dq][Applications & API](https://cloud.digitalocean.com/settings/api/tokens)\[dq] page of the DigitalOcean control panel. They will be needed when prompted by \[ga]rclone config\[ga] for your \[ga]access_key_id\[ga] and \[ga]secret_access_key\[ga]. - -When prompted for a \[ga]region\[ga] or \[ga]location_constraint\[ga], press enter to use the default value. The region must be included in the \[ga]endpoint\[ga] setting (e.g. \[ga]nyc3.digitaloceanspaces.com\[ga]). The default values can be used for other settings. - -Going through the whole process of creating a new remote by running \[ga]rclone config\[ga], each prompt should be answered as shown below: +[dreamobjects] +type = s3 +provider = DreamHost +env_auth = false +access_key_id = your_access_key +secret_access_key = your_secret_key +region = +endpoint = objects\-us\-west\-1.dream.io +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.SS DigitalOcean Spaces +.PP +Spaces (https://www.digitalocean.com/products/object-storage/) is an +S3\-interoperable (https://developers.digitalocean.com/documentation/spaces/) +object storage service from cloud provider DigitalOcean. +.PP +To connect to DigitalOcean Spaces you will need an access key and secret +key. +These can be retrieved on the \[dq]Applications & +API (https://cloud.digitalocean.com/settings/api/tokens)\[dq] page of +the DigitalOcean control panel. +They will be needed when prompted by \f[C]rclone config\f[R] for your +\f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. +.PP +When prompted for a \f[C]region\f[R] or \f[C]location_constraint\f[R], +press enter to use the default value. +The region must be included in the \f[C]endpoint\f[R] setting (e.g. +\f[C]nyc3.digitaloceanspaces.com\f[R]). +The default values can be used for other settings. +.PP +Going through the whole process of creating a new remote by running +\f[C]rclone config\f[R], each prompt should be answered as shown below: +.IP +.nf +\f[C] +Storage> s3 +env_auth> 1 +access_key_id> YOUR_ACCESS_KEY +secret_access_key> YOUR_SECRET_KEY +region> +endpoint> nyc3.digitaloceanspaces.com +location_constraint> +acl> +storage_class> \f[R] .fi .PP -Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY -secret_access_key> YOUR_SECRET_KEY region> endpoint> -nyc3.digitaloceanspaces.com location_constraint> acl> storage_class> -.IP -.nf -\f[C] - The resulting configuration file should look like: -\f[R] -.fi -.PP -[spaces] type = s3 provider = DigitalOcean env_auth = false -access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY -region = endpoint = nyc3.digitaloceanspaces.com location_constraint = -acl = server_side_encryption = storage_class = .IP .nf \f[C] - -Once configured, you can create a new Space and begin copying files. For example: +[spaces] +type = s3 +provider = DigitalOcean +env_auth = false +access_key_id = YOUR_ACCESS_KEY +secret_access_key = YOUR_SECRET_KEY +region = +endpoint = nyc3.digitaloceanspaces.com +location_constraint = +acl = +server_side_encryption = +storage_class = \f[R] .fi .PP -rclone mkdir spaces:my\-new\-space rclone copy /path/to/files -spaces:my\-new\-space +Once configured, you can create a new Space and begin copying files. +For example: .IP .nf \f[C] - -### IBM COS (S3) ### - -Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM\[cq]s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object\-storage) - +rclone mkdir spaces:my\-new\-space +rclone copy /path/to/files spaces:my\-new\-space +\f[R] +.fi +.SS IBM COS (S3) +.PP +Information stored with IBM Cloud Object Storage is encrypted and +dispersed across multiple geographic locations, and accessed through an +implementation of the S3 API. +This service makes use of the distributed storage technologies provided +by IBM\[cq]s Cloud Object Storage System (formerly Cleversafe). +For more information visit: (http://www.ibm.com/cloud/object\-storage) +.PP To configure access to IBM COS S3, follow the steps below: - -1. Run rclone config and select n for a new remote. -\f[R] -.fi +.IP "1." 3 +Run rclone config and select n for a new remote. .IP .nf \f[C] -2018/02/14 14:13:11 NOTICE: Config file \[dq]C:\[rs]\[rs]Users\[rs]\[rs]a\[rs]\[rs].config\[rs]\[rs]rclone\[rs]\[rs]rclone.conf\[dq] not found \- using defaults + 2018/02/14 14:13:11 NOTICE: Config file \[dq]C:\[rs]\[rs]Users\[rs]\[rs]a\[rs]\[rs].config\[rs]\[rs]rclone\[rs]\[rs]rclone.conf\[dq] not found \- using defaults + No remotes found \- make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n +\f[R] +.fi +.IP "2." 3 +Enter the name for the configuration +.IP +.nf +\f[C] + name> +\f[R] +.fi +.IP "3." 3 +Select \[dq]s3\[dq] storage. +.IP +.nf +\f[C] +Choose a number from below, or type in your own value + 1 / Alias for an existing remote + \[rs] \[dq]alias\[dq] + 2 / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + \[rs] \[dq]s3\[dq] + 4 / Backblaze B2 + \[rs] \[dq]b2\[dq] +[snip] + 23 / http Connection + \[rs] \[dq]http\[dq] +Storage> 3 +\f[R] +.fi +.IP "4." 3 +Select IBM COS as the S3 Storage Provider. +.IP +.nf +\f[C] +Choose the S3 provider. +Choose a number from below, or type in your own value + 1 / Choose this option to configure Storage to AWS S3 + \[rs] \[dq]AWS\[dq] + 2 / Choose this option to configure Storage to Ceph Systems + \[rs] \[dq]Ceph\[dq] + 3 / Choose this option to configure Storage to Dreamhost + \[rs] \[dq]Dreamhost\[dq] + 4 / Choose this option to the configure Storage to IBM COS S3 + \[rs] \[dq]IBMCOS\[dq] + 5 / Choose this option to the configure Storage to Minio + \[rs] \[dq]Minio\[dq] + Provider>4 +\f[R] +.fi +.IP "5." 3 +Enter the Access Key and Secret. +.IP +.nf +\f[C] + AWS Access Key ID \- leave blank for anonymous access or runtime credentials. + access_key_id> <> + AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. + secret_access_key> <> +\f[R] +.fi +.IP "6." 3 +Specify the endpoint for IBM COS. +For Public IBM COS, choose from the option below. +For On Premise IBM COS, enter an enpoint address. +.IP +.nf +\f[C] + Endpoint for IBM COS S3 API. + Specify if using an IBM COS On Premise. + Choose a number from below, or type in your own value + 1 / US Cross Region Endpoint + \[rs] \[dq]s3\-api.us\-geo.objectstorage.softlayer.net\[dq] + 2 / US Cross Region Dallas Endpoint + \[rs] \[dq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[dq] + 3 / US Cross Region Washington DC Endpoint + \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[dq] + 4 / US Cross Region San Jose Endpoint + \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[dq] + 5 / US Cross Region Private Endpoint + \[rs] \[dq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[dq] + 6 / US Cross Region Dallas Private Endpoint + \[rs] \[dq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[dq] + 7 / US Cross Region Washington DC Private Endpoint + \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[dq] + 8 / US Cross Region San Jose Private Endpoint + \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[dq] + 9 / US Region East Endpoint + \[rs] \[dq]s3.us\-east.objectstorage.softlayer.net\[dq] + 10 / US Region East Private Endpoint + \[rs] \[dq]s3.us\-east.objectstorage.service.networklayer.com\[dq] + 11 / US Region South Endpoint +[snip] + 34 / Toronto Single Site Private Endpoint + \[rs] \[dq]s3.tor01.objectstorage.service.networklayer.com\[dq] + endpoint>1 +\f[R] +.fi +.IP "7." 3 +Specify a IBM COS Location Constraint. +The location constraint must match endpoint when using IBM Cloud Public. +For on\-prem COS, do not make a selection from this list, hit enter +.IP +.nf +\f[C] + 1 / US Cross Region Standard + \[rs] \[dq]us\-standard\[dq] + 2 / US Cross Region Vault + \[rs] \[dq]us\-vault\[dq] + 3 / US Cross Region Cold + \[rs] \[dq]us\-cold\[dq] + 4 / US Cross Region Flex + \[rs] \[dq]us\-flex\[dq] + 5 / US East Region Standard + \[rs] \[dq]us\-east\-standard\[dq] + 6 / US East Region Vault + \[rs] \[dq]us\-east\-vault\[dq] + 7 / US East Region Cold + \[rs] \[dq]us\-east\-cold\[dq] + 8 / US East Region Flex + \[rs] \[dq]us\-east\-flex\[dq] + 9 / US South Region Standard + \[rs] \[dq]us\-south\-standard\[dq] + 10 / US South Region Vault + \[rs] \[dq]us\-south\-vault\[dq] +[snip] + 32 / Toronto Flex + \[rs] \[dq]tor01\-flex\[dq] +location_constraint>1 +\f[R] +.fi +.IP "9." 3 +Specify a canned ACL. +IBM Cloud (Strorage) supports \[dq]public\-read\[dq] and +\[dq]private\[dq]. +IBM Cloud(Infra) supports all the canned ACLs. +On\-Premise COS supports all the canned ACLs. +.IP +.nf +\f[C] +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise COS + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise IBM COS + \[rs] \[dq]public\-read\[dq] + 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On\-Premise IBM COS + \[rs] \[dq]public\-read\-write\[dq] + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS + \[rs] \[dq]authenticated\-read\[dq] +acl> 1 +\f[R] +.fi +.IP "12." 4 +Review the displayed configuration and accept to save the +\[dq]remote\[dq] then quit. +The config file should look like this +.IP +.nf +\f[C] + [xxx] + type = s3 + Provider = IBMCOS + access_key_id = xxx + secret_access_key = yyy + endpoint = s3\-api.us\-geo.objectstorage.softlayer.net + location_constraint = us\-standard + acl = private +\f[R] +.fi +.IP "13." 4 +Execute rclone commands +.IP +.nf +\f[C] + 1) Create a bucket. + rclone mkdir IBM\-COS\-XREGION:newbucket + 2) List available buckets. + rclone lsd IBM\-COS\-XREGION: + \-1 2017\-11\-08 21:16:22 \-1 test + \-1 2018\-02\-14 20:16:39 \-1 newbucket + 3) List contents of a bucket. + rclone ls IBM\-COS\-XREGION:newbucket + 18685952 test.exe + 4) Copy a file from local to remote. + rclone copy /Users/file.txt IBM\-COS\-XREGION:newbucket + 5) Copy a file from remote to local. + rclone copy IBM\-COS\-XREGION:newbucket/file.txt . + 6) Delete a file on remote. + rclone delete IBM\-COS\-XREGION:newbucket/file.txt +\f[R] +.fi +.SS Minio +.PP +Minio (https://minio.io/) is an object storage server built for cloud +application developers and devops. +.PP +It is very easy to install and provides an S3 compatible server which +can be used by rclone. +.PP +To use it, install Minio following the instructions +here (https://docs.minio.io/docs/minio-quickstart-guide). +.PP +When it configures itself Minio will print something like this +.IP +.nf +\f[C] +Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 +AccessKey: USWUXHGYZQYFYFFIT3RE +SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +Region: us\-east\-1 +SQS ARNs: arn:minio:sqs:us\-east\-1:1:redis arn:minio:sqs:us\-east\-1:2:redis + +Browser Access: + http://192.168.1.106:9000 http://172.23.0.1:9000 + +Command\-line Access: https://docs.minio.io/docs/minio\-client\-quickstart\-guide + $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + +Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang\-client\-quickstart\-guide + Java: https://docs.minio.io/docs/java\-client\-quickstart\-guide + Python: https://docs.minio.io/docs/python\-client\-quickstart\-guide + JavaScript: https://docs.minio.io/docs/javascript\-client\-quickstart\-guide + .NET: https://docs.minio.io/docs/dotnet\-client\-quickstart\-guide + +Drive Capacity: 26 GiB Free, 165 GiB Total +\f[R] +.fi +.PP +These details need to go into \f[C]rclone config\f[R] like this. +Note that it is important to put the region in as stated above. +.IP +.nf +\f[C] +env_auth> 1 +access_key_id> USWUXHGYZQYFYFFIT3RE +secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +region> us\-east\-1 +endpoint> http://192.168.1.106:9000 +location_constraint> +server_side_encryption> +\f[R] +.fi +.PP +Which makes the config file look like this +.IP +.nf +\f[C] +[minio] +type = s3 +provider = Minio +env_auth = false +access_key_id = USWUXHGYZQYFYFFIT3RE +secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +region = us\-east\-1 +endpoint = http://192.168.1.106:9000 +location_constraint = +server_side_encryption = +\f[R] +.fi +.PP +So once set up, for example to copy files into a bucket +.IP +.nf +\f[C] +rclone copy /path/to/files minio:bucket +\f[R] +.fi +.SS Scaleway +.PP +Scaleway (https://www.scaleway.com/object-storage/) The Object Storage +platform allows you to store anything from backups, logs and web assets +to documents and photos. +Files can be dropped from the Scaleway console or transferred through +our API and CLI or using any S3\-compatible tool. +.PP +Scaleway provides an S3 interface which can be configured for use with +rclone like this: +.IP +.nf +\f[C] +[scaleway] +type = s3 +provider = Scaleway +env_auth = false +endpoint = s3.nl\-ams.scw.cloud +access_key_id = SCWXXXXXXXXXXXXXX +secret_access_key = 1111111\-2222\-3333\-44444\-55555555555555 +region = nl\-ams +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.SS Wasabi +.PP +Wasabi (https://wasabi.com) is a cloud\-based object storage service for +a broad range of applications and use cases. +Wasabi is designed for individuals and organizations that require a +high\-performance, reliable, and secure data storage infrastructure at +minimal cost. +.PP +Wasabi provides an S3 interface which can be configured for use with +rclone like this. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +n/s> n +name> wasabi +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon S3 (also Dreamhost, Ceph, Minio) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> YOURACCESSKEY +AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> YOURSECRETACCESSKEY +Region to connect to. +Choose a number from below, or type in your own value + / The default endpoint \- a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \[rs] \[dq]us\-east\-1\[dq] +[snip] +region> us\-east\-1 +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +Specify if using an S3 clone such as Ceph. +endpoint> s3.wasabisys.com +Location constraint \- must be set to match the Region. Used when creating buckets only. +Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \[rs] \[dq]\[dq] +[snip] +location_constraint> +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] +[snip] +acl> +The server\-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value + 1 / None + \[rs] \[dq]\[dq] + 2 / AES256 + \[rs] \[dq]AES256\[dq] +server_side_encryption> +The storage class to use when storing objects in S3. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Reduced redundancy storage class + \[rs] \[dq]REDUCED_REDUNDANCY\[dq] + 4 / Standard Infrequent Access storage class + \[rs] \[dq]STANDARD_IA\[dq] +storage_class> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[wasabi] +env_auth = false +access_key_id = YOURACCESSKEY +secret_access_key = YOURSECRETACCESSKEY +region = us\-east\-1 +endpoint = s3.wasabisys.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +This will leave the config file looking like this. +.IP +.nf +\f[C] +[wasabi] +type = s3 +provider = Wasabi +env_auth = false +access_key_id = YOURACCESSKEY +secret_access_key = YOURSECRETACCESSKEY +region = +endpoint = s3.wasabisys.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.SS Alibaba OSS +.PP +Here is an example of making an Alibaba Cloud (Aliyun) +OSS (https://www.alibabacloud.com/product/oss/) configuration. +First run: +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> oss +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Choose your S3 provider. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] + 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun + \[rs] \[dq]Alibaba\[dq] + 3 / Ceph Object Storage + \[rs] \[dq]Ceph\[dq] +[snip] +provider> Alibaba +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_key_id> accesskeyid +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +secret_access_key> secretaccesskey +Endpoint for OSS API. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / East China 1 (Hangzhou) + \[rs] \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] + 2 / East China 2 (Shanghai) + \[rs] \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] + 3 / North China 1 (Qingdao) + \[rs] \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] +[snip] +endpoint> 1 +Canned ACL used when creating buckets and storing or copying objects. + +Note that this ACL is applied when server side copying objects as S3 +doesn\[aq]t copy the ACL from the source but rather writes a fresh one. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \[rs] \[dq]public\-read\[dq] + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. +[snip] +acl> 1 +The storage class to use when storing new objects in OSS. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Archive storage mode. + \[rs] \[dq]GLACIER\[dq] + 4 / Infrequent access storage mode. + \[rs] \[dq]STANDARD_IA\[dq] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[oss] +type = s3 +provider = Alibaba +env_auth = false +access_key_id = accesskeyid +secret_access_key = secretaccesskey +endpoint = oss\-cn\-hangzhou.aliyuncs.com +acl = private +storage_class = Standard +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Tencent COS +.PP +Tencent Cloud Object Storage +(COS) (https://intl.cloud.tencent.com/product/cos) is a distributed +storage service offered by Tencent Cloud for unstructured data. +It is secure, stable, massive, convenient, low\-delay and low\-cost. +.PP +To configure access to Tencent COS, follow the steps below: +.IP "1." 3 +Run \f[C]rclone config\f[R] and select \f[C]n\f[R] for a new remote. +.IP +.nf +\f[C] +rclone config No remotes found \- make a new one n) New remote s) Set configuration password @@ -15135,5413 +18990,6914 @@ q) Quit config n/s/q> n \f[R] .fi +.IP "2." 3 +Give the name of the configuration. +For example, name it \[aq]cos\[aq]. .IP .nf \f[C] - -2. Enter the name for the configuration +name> cos \f[R] .fi +.IP "3." 3 +Select \f[C]s3\f[R] storage. .IP .nf \f[C] -name> -\f[R] -.fi -.IP -.nf -\f[C] - -3. Select \[dq]s3\[dq] storage. -\f[R] -.fi -.PP -Choose a number from below, or type in your own value 1 / Alias for an -existing remote \ \[dq]alias\[dq] 2 / Amazon Drive \ \[dq]amazon cloud -drive\[dq] 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, -Minio, IBM COS) \ \[dq]s3\[dq] 4 / Backblaze B2 \ \[dq]b2\[dq] [snip] 23 -/ http Connection \ \[dq]http\[dq] Storage> 3 -.IP -.nf -\f[C] - -4. Select IBM COS as the S3 Storage Provider. -\f[R] -.fi -.PP -Choose the S3 provider. -Choose a number from below, or type in your own value 1 / Choose this -option to configure Storage to AWS S3 \ \[dq]AWS\[dq] 2 / Choose this -option to configure Storage to Ceph Systems \ \[dq]Ceph\[dq] 3 / Choose -this option to configure Storage to Dreamhost \ \[dq]Dreamhost\[dq] 4 / -Choose this option to the configure Storage to IBM COS S3 -\ \[dq]IBMCOS\[dq] 5 / Choose this option to the configure Storage to -Minio \ \[dq]Minio\[dq] Provider>4 -.IP -.nf -\f[C] - -5. Enter the Access Key and Secret. -\f[R] -.fi -.IP -.nf -\f[C] -AWS Access Key ID \- leave blank for anonymous access or runtime credentials. -access_key_id> <> -AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. -secret_access_key> <> -\f[R] -.fi -.IP -.nf -\f[C] - -6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address. -\f[R] -.fi -.IP -.nf -\f[C] -Endpoint for IBM COS S3 API. -Specify if using an IBM COS On Premise. Choose a number from below, or type in your own value - 1 / US Cross Region Endpoint - \[rs] \[dq]s3\-api.us\-geo.objectstorage.softlayer.net\[dq] - 2 / US Cross Region Dallas Endpoint - \[rs] \[dq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[dq] - 3 / US Cross Region Washington DC Endpoint - \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[dq] - 4 / US Cross Region San Jose Endpoint - \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[dq] - 5 / US Cross Region Private Endpoint - \[rs] \[dq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[dq] - 6 / US Cross Region Dallas Private Endpoint - \[rs] \[dq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[dq] - 7 / US Cross Region Washington DC Private Endpoint - \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[dq] - 8 / US Cross Region San Jose Private Endpoint - \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[dq] - 9 / US Region East Endpoint - \[rs] \[dq]s3.us\-east.objectstorage.softlayer.net\[dq] -10 / US Region East Private Endpoint - \[rs] \[dq]s3.us\-east.objectstorage.service.networklayer.com\[dq] -11 / US Region South Endpoint +1 / 1Fichier + \[rs] \[dq]fichier\[dq] + 2 / Alias for an existing remote + \[rs] \[dq]alias\[dq] + 3 / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS, etc) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 \f[R] .fi -.PP -[snip] 34 / Toronto Single Site Private Endpoint -\ \[dq]s3.tor01.objectstorage.service.networklayer.com\[dq] endpoint>1 +.IP "4." 3 +Select \f[C]TencentCOS\f[R] provider. .IP .nf \f[C] - - -7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on\-prem COS, do not make a selection from this list, hit enter +Choose a number from below, or type in your own value +1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] +[snip] +11 / Tencent Cloud Object Storage (COS) + \[rs] \[dq]TencentCOS\[dq] +[snip] +provider> TencentCOS \f[R] .fi +.IP "5." 3 +Enter your SecretId and SecretKey of Tencent Cloud. .IP .nf \f[C] - 1 / US Cross Region Standard - \[rs] \[dq]us\-standard\[dq] - 2 / US Cross Region Vault - \[rs] \[dq]us\-vault\[dq] - 3 / US Cross Region Cold - \[rs] \[dq]us\-cold\[dq] - 4 / US Cross Region Flex - \[rs] \[dq]us\-flex\[dq] - 5 / US East Region Standard - \[rs] \[dq]us\-east\-standard\[dq] - 6 / US East Region Vault - \[rs] \[dq]us\-east\-vault\[dq] - 7 / US East Region Cold - \[rs] \[dq]us\-east\-cold\[dq] - 8 / US East Region Flex - \[rs] \[dq]us\-east\-flex\[dq] - 9 / US South Region Standard - \[rs] \[dq]us\-south\-standard\[dq] -10 / US South Region Vault - \[rs] \[dq]us\-south\-vault\[dq] -\f[R] -.fi -.PP -[snip] 32 / Toronto Flex \ \[dq]tor01\-flex\[dq] location_constraint>1 -.IP -.nf -\f[C] - -9. Specify a canned ACL. IBM Cloud (Strorage) supports \[dq]public\-read\[dq] and \[dq]private\[dq]. IBM Cloud(Infra) supports all the canned ACLs. On\-Premise COS supports all the canned ACLs. -\f[R] -.fi -.PP -Canned ACL used when creating buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On\-Premise COS \ \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On\-Premise IBM COS \ \[dq]public\-read\[dq] 3 / Owner gets -FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -This acl is available on IBM Cloud (Infra), On\-Premise IBM COS -\ \[dq]public\-read\-write\[dq] 4 / Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -Not supported on Buckets. -This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS -\ \[dq]authenticated\-read\[dq] acl> 1 -.IP -.nf -\f[C] - - -12. Review the displayed configuration and accept to save the \[dq]remote\[dq] then quit. The config file should look like this -\f[R] -.fi -.IP -.nf -\f[C] -[xxx] -type = s3 -Provider = IBMCOS -access_key_id = xxx -secret_access_key = yyy -endpoint = s3\-api.us\-geo.objectstorage.softlayer.net -location_constraint = us\-standard -acl = private -\f[R] -.fi -.IP -.nf -\f[C] - -13. Execute rclone commands -\f[R] -.fi -.IP -.nf -\f[C] -1) Create a bucket. - rclone mkdir IBM\-COS\-XREGION:newbucket -2) List available buckets. - rclone lsd IBM\-COS\-XREGION: - \-1 2017\-11\-08 21:16:22 \-1 test - \-1 2018\-02\-14 20:16:39 \-1 newbucket -3) List contents of a bucket. - rclone ls IBM\-COS\-XREGION:newbucket - 18685952 test.exe -4) Copy a file from local to remote. - rclone copy /Users/file.txt IBM\-COS\-XREGION:newbucket -5) Copy a file from remote to local. - rclone copy IBM\-COS\-XREGION:newbucket/file.txt . -6) Delete a file on remote. - rclone delete IBM\-COS\-XREGION:newbucket/file.txt -\f[R] -.fi -.IP -.nf -\f[C] - -### Minio ### - -[Minio](https://minio.io/) is an object storage server built for cloud application developers and devops. - -It is very easy to install and provides an S3 compatible server which can be used by rclone. - -To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio\-quickstart\-guide). - -When it configures itself Minio will print something like this -\f[R] -.fi -.PP -Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: -USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 -Region: us\-east\-1 SQS ARNs: arn:minio:sqs:us\-east\-1:1:redis -arn:minio:sqs:us\-east\-1:2:redis -.PP -Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000 -.PP -Command\-line Access: -https://docs.minio.io/docs/minio\-client\-quickstart\-guide $ mc config -host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 -.PP -Object API (Amazon S3 compatible): Go: -https://docs.minio.io/docs/golang\-client\-quickstart\-guide Java: -https://docs.minio.io/docs/java\-client\-quickstart\-guide Python: -https://docs.minio.io/docs/python\-client\-quickstart\-guide JavaScript: -https://docs.minio.io/docs/javascript\-client\-quickstart\-guide .NET: -https://docs.minio.io/docs/dotnet\-client\-quickstart\-guide -.PP -Drive Capacity: 26 GiB Free, 165 GiB Total -.IP -.nf -\f[C] - -These details need to go into \[ga]rclone config\[ga] like this. Note that it -is important to put the region in as stated above. -\f[R] -.fi -.PP -env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us\-east\-1 endpoint> -http://192.168.1.106:9000 location_constraint> server_side_encryption> -.IP -.nf -\f[C] - -Which makes the config file look like this -\f[R] -.fi -.PP -[minio] type = s3 provider = Minio env_auth = false access_key_id = -USWUXHGYZQYFYFFIT3RE secret_access_key = -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us\-east\-1 endpoint = -http://192.168.1.106:9000 location_constraint = server_side_encryption = -.IP -.nf -\f[C] - -So once set up, for example to copy files into a bucket -\f[R] -.fi -.PP -rclone copy /path/to/files minio:bucket -.IP -.nf -\f[C] - -### Scaleway {#scaleway} - -[Scaleway](https://www.scaleway.com/object\-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. -Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3\-compatible tool. - -Scaleway provides an S3 interface which can be configured for use with rclone like this: -\f[R] -.fi -.PP -[scaleway] type = s3 provider = Scaleway env_auth = false endpoint = -s3.nl\-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key -= 1111111\-2222\-3333\-44444\-55555555555555 region = nl\-ams -location_constraint = acl = private server_side_encryption = -storage_class = -.IP -.nf -\f[C] - -### Wasabi ### - -[Wasabi](https://wasabi.com) is a cloud\-based object storage service for a -broad range of applications and use cases. Wasabi is designed for -individuals and organizations that require a high\-performance, -reliable, and secure data storage infrastructure at minimal cost. - -Wasabi provides an S3 interface which can be configured for use with -rclone like this. -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password n/s> n name> wasabi Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -S3 (also Dreamhost, Ceph, Minio) \ \[dq]s3\[dq] [snip] Storage> s3 Get -AWS credentials from runtime (environment variables or EC2/ECS meta data -if no env vars). +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[dq]false\[dq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[dq]true\[dq] env_auth> 1 AWS -Access Key ID \- leave blank for anonymous access or runtime -credentials. -access_key_id> YOURACCESSKEY AWS Secret Access Key (password) \- leave -blank for anonymous access or runtime credentials. -secret_access_key> YOURSECRETACCESSKEY Region to connect to. -Choose a number from below, or type in your own value / The default -endpoint \- a good choice if you are unsure. -1 | US Region, Northern Virginia or Pacific Northwest. -| Leave location constraint empty. -\ \[dq]us\-east\-1\[dq] [snip] region> us\-east\-1 Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -Specify if using an S3 clone such as Ceph. -endpoint> s3.wasabisys.com Location constraint \- must be set to match -the Region. -Used when creating buckets only. -Choose a number from below, or type in your own value 1 / Empty for US -Region, Northern Virginia or Pacific Northwest. -\ \[dq]\[dq] [snip] location_constraint> Canned ACL used when creating -buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[dq]private\[dq] [snip] acl> The server\-side encryption algorithm -used when storing this object in S3. -Choose a number from below, or type in your own value 1 / None -\ \[dq]\[dq] 2 / AES256 \ \[dq]AES256\[dq] server_side_encryption> The -storage class to use when storing objects in S3. -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Standard storage class \ \[dq]STANDARD\[dq] 3 / Reduced -redundancy storage class \ \[dq]REDUCED_REDUNDANCY\[dq] 4 / Standard -Infrequent Access storage class \ \[dq]STANDARD_IA\[dq] storage_class> -Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [wasabi] env_auth -= false access_key_id = YOURACCESSKEY secret_access_key = -YOURSECRETACCESSKEY region = us\-east\-1 endpoint = s3.wasabisys.com -location_constraint = acl = server_side_encryption = storage_class = -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -This will leave the config file looking like this. -\f[R] -.fi -.PP -[wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint -= s3.wasabisys.com location_constraint = acl = server_side_encryption = -storage_class = -.IP -.nf -\f[C] - -### Alibaba OSS {#alibaba\-oss} - -Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/) -configuration. First run: - - rclone config - -This will guide you through an interactive setup process. -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> oss Type of storage to configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] 4 / Amazon -S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, -Dreamhost, IBM COS, Minio, etc) \ \[dq]s3\[dq] [snip] Storage> s3 Choose -your S3 provider. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Amazon Web -Services (AWS) S3 \ \[dq]AWS\[dq] 2 / Alibaba Cloud Object Storage -System (OSS) formerly Aliyun \ \[dq]Alibaba\[dq] 3 / Ceph Object Storage -\ \[dq]Ceph\[dq] [snip] provider> Alibaba Get AWS credentials from -runtime (environment variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Enter a boolean value (true or false). -Press Enter for the default (\[dq]false\[dq]). -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[dq]false\[dq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[dq]true\[dq] env_auth> 1 AWS -Access Key ID. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID. Leave blank for anonymous access or runtime credentials. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank -for anonymous access or runtime credentials. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -secret_access_key> secretaccesskey Endpoint for OSS API. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / East China 1 -(Hangzhou) \ \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] 2 / East China 2 -(Shanghai) \ \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] 3 / North China 1 -(Qingdao) \ \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] [snip] endpoint> 1 -Canned ACL used when creating buckets and storing or copying objects. -.PP +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_key_id> AKIDxxxxxxxxxx +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +secret_access_key> xxxxxxxxxxx +\f[R] +.fi +.IP "6." 3 +Select endpoint for Tencent COS. +This is the standard endpoint for different region. +.IP +.nf +\f[C] + 1 / Beijing Region. + \[rs] \[dq]cos.ap\-beijing.myqcloud.com\[dq] + 2 / Nanjing Region. + \[rs] \[dq]cos.ap\-nanjing.myqcloud.com\[dq] + 3 / Shanghai Region. + \[rs] \[dq]cos.ap\-shanghai.myqcloud.com\[dq] + 4 / Guangzhou Region. + \[rs] \[dq]cos.ap\-guangzhou.myqcloud.com\[dq] +[snip] +endpoint> 4 +\f[R] +.fi +.IP "7." 3 +Choose acl and storage class. +.IP +.nf +\f[C] Note that this ACL is applied when server side copying objects as S3 doesn\[aq]t copy the ACL from the source but rather writes a fresh one. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -\ \[dq]public\-read\[dq] / Owner gets FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -[snip] acl> 1 The storage class to use when storing new objects in OSS. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Standard storage class \ \[dq]STANDARD\[dq] 3 / Archive -storage mode. -\ \[dq]GLACIER\[dq] 4 / Infrequent access storage mode. -\ \[dq]STANDARD_IA\[dq] storage_class> 1 Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [oss] type = s3 provider = -Alibaba env_auth = false access_key_id = accesskeyid secret_access_key = -secretaccesskey endpoint = oss\-cn\-hangzhou.aliyuncs.com acl = private -storage_class = Standard \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes -this is OK e) Edit this remote d) Delete this remote y/e/d> y +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Owner gets Full_CONTROL. No one else has access rights (default). + \[rs] \[dq]default\[dq] +[snip] +acl> 1 +The storage class to use when storing new objects in Tencent COS. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] +[snip] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[cos] +type = s3 +provider = TencentCOS +env_auth = false +access_key_id = xxx +secret_access_key = xxx +endpoint = cos.ap\-guangzhou.myqcloud.com +acl = default +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: + +Name Type +==== ==== +cos s3 +\f[R] +.fi +.SS Netease NOS +.PP +For Netease NOS configure as per the configurator +\f[C]rclone config\f[R] setting the provider \f[C]Netease\f[R]. +This will automatically set \f[C]force_path_style = false\f[R] which is +necessary for it to run properly. +.SS Backblaze B2 +.PP +B2 is Backblaze\[aq]s cloud storage +system (https://www.backblaze.com/b2/). +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +Here is an example of making a b2 configuration. +First run .IP .nf \f[C] - -### Netease NOS ### - -For Netease NOS configure as per the configurator \[ga]rclone config\[ga] -setting the provider \[ga]Netease\[ga]. This will automatically set -\[ga]force_path_style = false\[ga] which is necessary for it to run properly. - - Backblaze B2 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -B2 is [Backblaze\[aq]s cloud storage system](https://www.backblaze.com/b2/). - -Paths are specified as \[ga]remote:bucket\[ga] (or \[ga]remote:\[ga] for the \[ga]lsd\[ga] -command.) You may put subdirectories in too, eg \[ga]remote:bucket/path/to/dir\[ga]. - -Here is an example of making a b2 configuration. First run - - rclone config - -This will guide you through an interactive setup process. To authenticate -you will either need your Account ID (a short hex number) and Master -Application Key (a long hex number) OR an Application Key, which is the -recommended method. See below for further details on generating and using -an Application Key. +rclone config \f[R] .fi .PP -No remotes found \- make a new one n) New remote q) Quit config n/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Backblaze B2 \ \[dq]b2\[dq] [snip] Storage> b2 Account ID or Application -Key ID account> 123456789abc Application Key key> -0123456789abcdef0123456789abcdef0123456789 Endpoint for the service \- -leave blank normally. -endpoint> Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -[remote] account = 123456789abc key = -0123456789abcdef0123456789abcdef0123456789 endpoint = -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +This will guide you through an interactive setup process. +To authenticate you will either need your Account ID (a short hex +number) and Master Application Key (a long hex number) OR an Application +Key, which is the recommended method. +See below for further details on generating and using an Application +Key. .IP .nf \f[C] - -This remote is called \[ga]remote\[ga] and can now be used like this - +No remotes found \- make a new one +n) New remote +q) Quit config +n/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Backblaze B2 + \[rs] \[dq]b2\[dq] +[snip] +Storage> b2 +Account ID or Application Key ID +account> 123456789abc +Application Key +key> 0123456789abcdef0123456789abcdef0123456789 +Endpoint for the service \- leave blank normally. +endpoint> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +account = 123456789abc +key = 0123456789abcdef0123456789abcdef0123456789 +endpoint = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP See all buckets - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP Create a new bucket - - rclone mkdir remote:bucket - +.IP +.nf +\f[C] +rclone mkdir remote:bucket +\f[R] +.fi +.PP List the contents of a bucket - - rclone ls remote:bucket - -Sync \[ga]/home/local/directory\[ga] to the remote bucket, deleting any +.IP +.nf +\f[C] +rclone ls remote:bucket +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any excess files in the bucket. - - rclone sync \-i /home/local/directory remote:bucket - -### Application Keys ### - -B2 supports multiple [Application Keys for different access permission -to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html). - -You can use these with rclone too; you will need to use rclone version 1.43 -or later. - -Follow Backblaze\[aq]s docs to create an Application Key with the required -permission and add the \[ga]applicationKeyId\[ga] as the \[ga]account\[ga] and the -\[ga]Application Key\[ga] itself as the \[ga]key\[ga]. - -Note that you must put the _applicationKeyId_ as the \[ga]account\[ga] \[en] you -can\[aq]t use the master Account ID. If you try then B2 will return 401 -errors. - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -### Modified time ### - +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:bucket +\f[R] +.fi +.SS Application Keys +.PP +B2 supports multiple Application Keys for different access permission to +B2 Buckets (https://www.backblaze.com/b2/docs/application_keys.html). +.PP +You can use these with rclone too; you will need to use rclone version +1.43 or later. +.PP +Follow Backblaze\[aq]s docs to create an Application Key with the +required permission and add the \f[C]applicationKeyId\f[R] as the +\f[C]account\f[R] and the \f[C]Application Key\f[R] itself as the +\f[C]key\f[R]. +.PP +Note that you must put the \f[I]applicationKeyId\f[R] as the +\f[C]account\f[R] \[en] you can\[aq]t use the master Account ID. +If you try then B2 will return 401 errors. +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS Modified time +.PP The modified time is stored as metadata on the object as -\[ga]X\-Bz\-Info\-src_last_modified_millis\[ga] as milliseconds since 1970\-01\-01 -in the Backblaze standard. Other tools should be able to use this as -a modified time. - -Modified times are used in syncing and are fully supported. Note that -if a modification time needs to be updated on an object then it will -create a new version of the object. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs] | 0x5C | \[uFF3C] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -Note that in 2020\-05 Backblaze started allowing \[rs] characters in file -names. Rclone hasn\[aq]t changed its encoding as this could cause syncs to -re\-transfer files. If you want rclone not to replace \[rs] then see the -\[ga]\-\-b2\-encoding\[ga] flag below and remove the \[ga]BackSlash\[ga] from the -string. This can be set in the config. - -### SHA1 checksums ### - +\f[C]X\-Bz\-Info\-src_last_modified_millis\f[R] as milliseconds since +1970\-01\-01 in the Backblaze standard. +Other tools should be able to use this as a modified time. +.PP +Modified times are used in syncing and are fully supported. +Note that if a modification time needs to be updated on an object then +it will create a new version of the object. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.PP +Note that in 2020\-05 Backblaze started allowing \ characters in file +names. +Rclone hasn\[aq]t changed its encoding as this could cause syncs to +re\-transfer files. +If you want rclone not to replace \ then see the +\f[C]\-\-b2\-encoding\f[R] flag below and remove the \f[C]BackSlash\f[R] +from the string. +This can be set in the config. +.SS SHA1 checksums +.PP The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process. - -Large files (bigger than the limit in \[ga]\-\-b2\-upload\-cutoff\[ga]) which are -uploaded in chunks will store their SHA1 on the object as -\[ga]X\-Bz\-Info\-large_file_sha1\[ga] as recommended by Backblaze. - -For a large file to be uploaded with an SHA1 checksum, the source -needs to support SHA1 checksums. The local disk supports SHA1 -checksums so large file transfers from local disk will have an SHA1. -See [the overview](https://rclone.org/overview/#features) for exactly which remotes -support SHA1. - -Sources which don\[aq]t support SHA1, in particular \[ga]crypt\[ga] will upload -large files without SHA1 checksums. This may be fixed in the future -(see [#1767](https://github.com/rclone/rclone/issues/1767)). - -Files sizes below \[ga]\-\-b2\-upload\-cutoff\[ga] will always have an SHA1 -regardless of the source. - -### Transfers ### - +.PP +Large files (bigger than the limit in \f[C]\-\-b2\-upload\-cutoff\f[R]) +which are uploaded in chunks will store their SHA1 on the object as +\f[C]X\-Bz\-Info\-large_file_sha1\f[R] as recommended by Backblaze. +.PP +For a large file to be uploaded with an SHA1 checksum, the source needs +to support SHA1 checksums. +The local disk supports SHA1 checksums so large file transfers from +local disk will have an SHA1. +See the overview (https://rclone.org/overview/#features) for exactly +which remotes support SHA1. +.PP +Sources which don\[aq]t support SHA1, in particular \f[C]crypt\f[R] will +upload large files without SHA1 checksums. +This may be fixed in the future (see +#1767 (https://github.com/rclone/rclone/issues/1767)). +.PP +Files sizes below \f[C]\-\-b2\-upload\-cutoff\f[R] will always have an +SHA1 regardless of the source. +.SS Transfers +.PP Backblaze recommends that you do lots of transfers simultaneously for -maximum speed. In tests from my SSD equipped laptop the optimum -setting is about \[ga]\-\-transfers 32\[ga] though higher numbers may be used -for a slight speed improvement. The optimum number for you may vary -depending on your hardware, how big the files are, how much you want -to load your computer, etc. The default of \[ga]\-\-transfers 4\[ga] is -definitely too low for Backblaze B2 though. - -Note that uploading big files (bigger than 200 MB by default) will use -a 96 MB RAM buffer by default. There can be at most \[ga]\-\-transfers\[ga] of -these in use at any moment, so this sets the upper limit on the memory -used. - -### Versions ### - -When rclone uploads a new version of a file it creates a [new version -of it](https://www.backblaze.com/b2/docs/file_versions.html). +maximum speed. +In tests from my SSD equipped laptop the optimum setting is about +\f[C]\-\-transfers 32\f[R] though higher numbers may be used for a +slight speed improvement. +The optimum number for you may vary depending on your hardware, how big +the files are, how much you want to load your computer, etc. +The default of \f[C]\-\-transfers 4\f[R] is definitely too low for +Backblaze B2 though. +.PP +Note that uploading big files (bigger than 200 MB by default) will use a +96 MB RAM buffer by default. +There can be at most \f[C]\-\-transfers\f[R] of these in use at any +moment, so this sets the upper limit on the memory used. +.SS Versions +.PP +When rclone uploads a new version of a file it creates a new version of +it (https://www.backblaze.com/b2/docs/file_versions.html). Likewise when you delete a file, the old version will be marked hidden -and still be available. Conversely, you may opt in to a \[dq]hard delete\[dq] -of files with the \[ga]\-\-b2\-hard\-delete\[ga] flag which would permanently remove -the file instead of hiding it. - -Old versions of files, where available, are visible using the -\[ga]\-\-b2\-versions\[ga] flag. - -**NB** Note that \[ga]\-\-b2\-versions\[ga] does not work with crypt at the -moment [#1627](https://github.com/rclone/rclone/issues/1627). Using -[\-\-backup\-dir](https://rclone.org/docs/#backup\-dir\-dir) with rclone is the recommended -way of working around this. - +and still be available. +Conversely, you may opt in to a \[dq]hard delete\[dq] of files with the +\f[C]\-\-b2\-hard\-delete\f[R] flag which would permanently remove the +file instead of hiding it. +.PP +Old versions of files, where available, are visible using the +\f[C]\-\-b2\-versions\f[R] flag. +.PP +\f[B]NB\f[R] Note that \f[C]\-\-b2\-versions\f[R] does not work with +crypt at the moment +#1627 (https://github.com/rclone/rclone/issues/1627). +Using \-\-backup\-dir (https://rclone.org/docs/#backup-dir-dir) with +rclone is the recommended way of working around this. +.PP If you wish to remove all the old versions then you can use the -\[ga]rclone cleanup remote:bucket\[ga] command which will delete all the old -versions of files, leaving the current ones intact. You can also -supply a path and only old versions under that path will be deleted, -eg \[ga]rclone cleanup remote:bucket/path/to/stuff\[ga]. - -Note that \[ga]cleanup\[ga] will remove partially uploaded files from the bucket -if they are more than a day old. - -When you \[ga]purge\[ga] a bucket, the current and the old versions will be -deleted then the bucket will be deleted. - -However \[ga]delete\[ga] will cause the current versions of the files to +\f[C]rclone cleanup remote:bucket\f[R] command which will delete all the +old versions of files, leaving the current ones intact. +You can also supply a path and only old versions under that path will be +deleted, eg \f[C]rclone cleanup remote:bucket/path/to/stuff\f[R]. +.PP +Note that \f[C]cleanup\f[R] will remove partially uploaded files from +the bucket if they are more than a day old. +.PP +When you \f[C]purge\f[R] a bucket, the current and the old versions will +be deleted then the bucket will be deleted. +.PP +However \f[C]delete\f[R] will cause the current versions of the files to become hidden old versions. - -Here is a session showing the listing and retrieval of an old -version followed by a \[ga]cleanup\[ga] of the old versions. - -Show current version and all the versions with \[ga]\-\-b2\-versions\[ga] flag. -\f[R] -.fi .PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt +Here is a session showing the listing and retrieval of an old version +followed by a \f[C]cleanup\f[R] of the old versions. .PP -$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test 9 one.txt 8 -one\-v2016\-07\-04\-141032\-000.txt 16 -one\-v2016\-07\-04\-141003\-000.txt 15 -one\-v2016\-07\-02\-155621\-000.txt +Show current version and all the versions with +\f[C]\-\-b2\-versions\f[R] flag. .IP .nf \f[C] +$ rclone \-q ls b2:cleanup\-test + 9 one.txt +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt + 8 one\-v2016\-07\-04\-141032\-000.txt + 16 one\-v2016\-07\-04\-141003\-000.txt + 15 one\-v2016\-07\-02\-155621\-000.txt +\f[R] +.fi +.PP Retrieve an old version -\f[R] -.fi -.PP -$ rclone \-q \-\-b2\-versions copy -b2:cleanup\-test/one\-v2016\-07\-04\-141003\-000.txt /tmp -.PP -$ ls \-l /tmp/one\-v2016\-07\-04\-141003\-000.txt \-rw\-rw\-r\-\- 1 ncw -ncw 16 Jul 2 17:46 /tmp/one\-v2016\-07\-04\-141003\-000.txt .IP .nf \f[C] +$ rclone \-q \-\-b2\-versions copy b2:cleanup\-test/one\-v2016\-07\-04\-141003\-000.txt /tmp +$ ls \-l /tmp/one\-v2016\-07\-04\-141003\-000.txt +\-rw\-rw\-r\-\- 1 ncw ncw 16 Jul 2 17:46 /tmp/one\-v2016\-07\-04\-141003\-000.txt +\f[R] +.fi +.PP Clean up all the old versions and show that they\[aq]ve gone. -\f[R] -.fi -.PP +.IP +.nf +\f[C] $ rclone \-q cleanup b2:cleanup\-test + +$ rclone \-q ls b2:cleanup\-test + 9 one.txt + +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt +\f[R] +.fi +.SS Data usage .PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt +It is useful to know how many requests are sent to the server in +different scenarios. .PP -$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test 9 one.txt +All copy commands send the following 4 requests: .IP .nf \f[C] - -### Data usage ### - -It is useful to know how many requests are sent to the server in different scenarios. - -All copy commands send the following 4 requests: +/b2api/v1/b2_authorize_account +/b2api/v1/b2_create_bucket +/b2api/v1/b2_list_buckets +/b2api/v1/b2_list_file_names \f[R] .fi .PP -/b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket -/b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names -.IP -.nf -\f[C] - -The \[ga]b2_list_file_names\[ga] request will be sent once for every 1k files -in the remote path, providing the checksum and modification time of -the listed files. As of version 1.33 issue -[#818](https://github.com/rclone/rclone/issues/818) causes extra requests -to be sent when using B2 with Crypt. When a copy operation does not -require any files to be uploaded, no more requests will be sent. - +The \f[C]b2_list_file_names\f[R] request will be sent once for every 1k +files in the remote path, providing the checksum and modification time +of the listed files. +As of version 1.33 issue +#818 (https://github.com/rclone/rclone/issues/818) causes extra requests +to be sent when using B2 with Crypt. +When a copy operation does not require any files to be uploaded, no more +requests will be sent. +.PP Uploading files that do not require chunking, will send 2 requests per file upload: -\f[R] -.fi -.PP -/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ .IP .nf \f[C] - +/b2api/v1/b2_get_upload_url +/b2api/v1/b2_upload_file/ +\f[R] +.fi +.PP Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk: -\f[R] -.fi -.PP -/b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url -/b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file .IP .nf \f[C] - -#### Versions #### - -Versions can be viewed with the \[ga]\-\-b2\-versions\[ga] flag. When it is set -rclone will show and act on older versions of files. For example - -Listing without \[ga]\-\-b2\-versions\[ga] +/b2api/v1/b2_start_large_file +/b2api/v1/b2_get_upload_part_url +/b2api/v1/b2_upload_part/ +/b2api/v1/b2_finish_large_file \f[R] .fi +.SS Versions .PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt +Versions can be viewed with the \f[C]\-\-b2\-versions\f[R] flag. +When it is set rclone will show and act on older versions of files. +For example +.PP +Listing without \f[C]\-\-b2\-versions\f[R] .IP .nf \f[C] - +$ rclone \-q ls b2:cleanup\-test + 9 one.txt +\f[R] +.fi +.PP And with -\f[R] -.fi -.PP -$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test 9 one.txt 8 -one\-v2016\-07\-04\-141032\-000.txt 16 -one\-v2016\-07\-04\-141003\-000.txt 15 -one\-v2016\-07\-02\-155621\-000.txt .IP .nf \f[C] - -Showing that the current version is unchanged but older versions can -be seen. These have the UTC date that they were uploaded to the -server to the nearest millisecond appended to them. - -Note that when using \[ga]\-\-b2\-versions\[ga] no file write operations are -permitted, so you can\[aq]t upload files or delete them. - -### B2 and rclone link ### - +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt + 8 one\-v2016\-07\-04\-141032\-000.txt + 16 one\-v2016\-07\-04\-141003\-000.txt + 15 one\-v2016\-07\-02\-155621\-000.txt +\f[R] +.fi +.PP +Showing that the current version is unchanged but older versions can be +seen. +These have the UTC date that they were uploaded to the server to the +nearest millisecond appended to them. +.PP +Note that when using \f[C]\-\-b2\-versions\f[R] no file write operations +are permitted, so you can\[aq]t upload files or delete them. +.SS B2 and rclone link +.PP Rclone supports generating file share links for private B2 buckets. They can either be for a file for example: -\f[R] -.fi -.PP +.IP +.nf +\f[C] \&./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx -.IP -.nf -\f[C] - -or if run on a directory you will get: \f[R] .fi .PP +or if run on a directory you will get: +.IP +.nf +\f[C] \&./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx -.IP -.nf -\f[C] - -you can then use the authorization token (the part of the url from the - \[ga]?Authorization=\[ga] on) on any file path under that directory. For example: \f[R] .fi .PP +you can then use the authorization token (the part of the url from the +\f[C]?Authorization=\f[R] on) on any file path under that directory. +For example: +.IP +.nf +\f[C] https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx -.IP -.nf -\f[C] - - -### Standard Options - +\f[R] +.fi +.SS Standard Options +.PP Here are the standard options specific to b2 (Backblaze B2). - -#### \-\-b2\-account - +.SS \-\-b2\-account +.PP Account ID or Application Key ID - -\- Config: account -\- Env Var: RCLONE_B2_ACCOUNT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-key - +.IP \[bu] 2 +Config: account +.IP \[bu] 2 +Env Var: RCLONE_B2_ACCOUNT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-key +.PP Application Key - -\- Config: key -\- Env Var: RCLONE_B2_KEY -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-hard\-delete - +.IP \[bu] 2 +Config: key +.IP \[bu] 2 +Env Var: RCLONE_B2_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-hard\-delete +.PP Permanently delete files on remote removal, otherwise hide files. - -\- Config: hard_delete -\- Env Var: RCLONE_B2_HARD_DELETE -\- Type: bool -\- Default: false - -### Advanced Options - +.IP \[bu] 2 +Config: hard_delete +.IP \[bu] 2 +Env Var: RCLONE_B2_HARD_DELETE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP Here are the advanced options specific to b2 (Backblaze B2). - -#### \-\-b2\-endpoint - +.SS \-\-b2\-endpoint +.PP Endpoint for the service. Leave blank normally. - -\- Config: endpoint -\- Env Var: RCLONE_B2_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-test\-mode - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_B2_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-test\-mode +.PP A flag string for X\-Bz\-Test\-Mode header for debugging. - -This is for debugging purposes only. Setting it to one of the strings -below will cause b2 to return specific errors: - - * \[dq]fail_some_uploads\[dq] - * \[dq]expire_some_account_authorization_tokens\[dq] - * \[dq]force_cap_exceeded\[dq] - -These will be set in the \[dq]X\-Bz\-Test\-Mode\[dq] header which is documented -in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html). - -\- Config: test_mode -\- Env Var: RCLONE_B2_TEST_MODE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-versions - +.PP +This is for debugging purposes only. +Setting it to one of the strings below will cause b2 to return specific +errors: +.IP \[bu] 2 +\[dq]fail_some_uploads\[dq] +.IP \[bu] 2 +\[dq]expire_some_account_authorization_tokens\[dq] +.IP \[bu] 2 +\[dq]force_cap_exceeded\[dq] +.PP +These will be set in the \[dq]X\-Bz\-Test\-Mode\[dq] header which is +documented in the b2 integrations +checklist (https://www.backblaze.com/b2/docs/integration_checklist.html). +.IP \[bu] 2 +Config: test_mode +.IP \[bu] 2 +Env Var: RCLONE_B2_TEST_MODE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-versions +.PP Include old versions in directory listings. -Note that when using this no file write operations are permitted, -so you can\[aq]t upload files or delete them. - -\- Config: versions -\- Env Var: RCLONE_B2_VERSIONS -\- Type: bool -\- Default: false - -#### \-\-b2\-upload\-cutoff - +Note that when using this no file write operations are permitted, so you +can\[aq]t upload files or delete them. +.IP \[bu] 2 +Config: versions +.IP \[bu] 2 +Env Var: RCLONE_B2_VERSIONS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-b2\-upload\-cutoff +.PP Cutoff for switching to chunked upload. - -Files above this size will be uploaded in chunks of \[dq]\-\-b2\-chunk\-size\[dq]. - +.PP +Files above this size will be uploaded in chunks of +\[dq]\-\-b2\-chunk\-size\[dq]. +.PP This value should be set no larger than 4.657GiB (== 5GB). - -\- Config: upload_cutoff -\- Env Var: RCLONE_B2_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 200M - -#### \-\-b2\-copy\-cutoff - +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_B2_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 200M +.SS \-\-b2\-copy\-cutoff +.PP Cutoff for switching to multipart copy - +.PP Any files larger than this that need to be server side copied will be copied in chunks of this size. - +.PP The minimum is 0 and the maximum is 4.6GB. - -\- Config: copy_cutoff -\- Env Var: RCLONE_B2_COPY_CUTOFF -\- Type: SizeSuffix -\- Default: 4G - -#### \-\-b2\-chunk\-size - -Upload chunk size. Must fit in memory. - -When uploading large files, chunk the file into this size. Note that -these chunks are buffered in memory and there might a maximum of -\[dq]\-\-transfers\[dq] chunks in progress at once. 5,000,000 Bytes is the -minimum size. - -\- Config: chunk_size -\- Env Var: RCLONE_B2_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 96M - -#### \-\-b2\-disable\-checksum - +.IP \[bu] 2 +Config: copy_cutoff +.IP \[bu] 2 +Env Var: RCLONE_B2_COPY_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 4G +.SS \-\-b2\-chunk\-size +.PP +Upload chunk size. +Must fit in memory. +.PP +When uploading large files, chunk the file into this size. +Note that these chunks are buffered in memory and there might a maximum +of \[dq]\-\-transfers\[dq] chunks in progress at once. +5,000,000 Bytes is the minimum size. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_B2_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 96M +.SS \-\-b2\-disable\-checksum +.PP Disable checksums for large (> upload cutoff) files - +.PP Normally rclone will calculate the SHA1 checksum of the input before -uploading it so it can add it to metadata on the object. This is great -for data integrity checking but can cause long delays for large files -to start uploading. - -\- Config: disable_checksum -\- Env Var: RCLONE_B2_DISABLE_CHECKSUM -\- Type: bool -\- Default: false - -#### \-\-b2\-download\-url - +uploading it so it can add it to metadata on the object. +This is great for data integrity checking but can cause long delays for +large files to start uploading. +.IP \[bu] 2 +Config: disable_checksum +.IP \[bu] 2 +Env Var: RCLONE_B2_DISABLE_CHECKSUM +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-b2\-download\-url +.PP Custom endpoint for downloads. - -This is usually set to a Cloudflare CDN URL as Backblaze offers -free egress for data downloaded through the Cloudflare network. +.PP +This is usually set to a Cloudflare CDN URL as Backblaze offers free +egress for data downloaded through the Cloudflare network. This is probably only useful for a public bucket. Leave blank if you want to use the endpoint provided by Backblaze. - -\- Config: download_url -\- Env Var: RCLONE_B2_DOWNLOAD_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-download\-auth\-duration - -Time before the authorization token will expire in s or suffix ms|s|m|h|d. - +.IP \[bu] 2 +Config: download_url +.IP \[bu] 2 +Env Var: RCLONE_B2_DOWNLOAD_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-download\-auth\-duration +.PP +Time before the authorization token will expire in s or suffix +ms|s|m|h|d. +.PP The duration before the download authorization token will expire. -The minimum value is 1 second. The maximum value is one week. - -\- Config: download_auth_duration -\- Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION -\- Type: Duration -\- Default: 1w - -#### \-\-b2\-memory\-pool\-flush\-time - +The minimum value is 1 second. +The maximum value is one week. +.IP \[bu] 2 +Config: download_auth_duration +.IP \[bu] 2 +Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1w +.SS \-\-b2\-memory\-pool\-flush\-time +.PP How often internal memory buffer pools will be flushed. -Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. -This option controls how often unused buffers will be removed from the pool. - -\- Config: memory_pool_flush_time -\- Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME -\- Type: Duration -\- Default: 1m0s - -#### \-\-b2\-memory\-pool\-use\-mmap - +Uploads which requires additional buffers (f.e multipart) will use +memory pool for allocations. +This option controls how often unused buffers will be removed from the +pool. +.IP \[bu] 2 +Config: memory_pool_flush_time +.IP \[bu] 2 +Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \-\-b2\-memory\-pool\-use\-mmap +.PP Whether to use mmap buffers in internal memory pool. - -\- Config: memory_pool_use_mmap -\- Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP -\- Type: bool -\- Default: false - -#### \-\-b2\-encoding - +.IP \[bu] 2 +Config: memory_pool_use_mmap +.IP \[bu] 2 +Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-b2\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_B2_ENCODING -\- Type: MultiEncoder -\- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - - - - Box -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]remote:path\[ga] - -Paths may be as deep as required, eg \[ga]remote:directory/subdirectory\[ga]. - +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_B2_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot +.SS Box +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.PP The initial setup for Box involves getting a token from Box which you can do either in your browser, or with a config.json downloaded from Box -to use JWT authentication. \[ga]rclone config\[ga] walks you through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - +to use JWT authentication. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Box -\ \[dq]box\[dq] [snip] Storage> box Box App Client Id \- leave blank -normally. -client_id> Box App Client Secret \- leave blank normally. -client_secret> Box App config.json location Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -box_config_file> Box App Primary Access Token Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -access_token> -.PP -Enter a string value. -Press Enter for the default (\[dq]user\[dq]). -Choose a number from below, or type in your own value 1 / Rclone should -act on behalf of a user \ \[dq]user\[dq] 2 / Rclone should act on behalf -of a service account \ \[dq]enterprise\[dq] box_sub_type> Remote config -Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: http://127.0.0.1:53682/auth Log -in and authorize rclone for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] client_id = -client_secret = token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]XXX\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y .IP .nf \f[C] - -See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a -machine with no Internet 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 on \[ga]http://127.0.0.1:53682/\[ga] and this it may require you to unblock -it temporarily if you are running a host firewall. - -Once configured you can then use \[ga]rclone\[ga] like this, - -List directories in top level of your Box - - rclone lsd remote: - -List all the files in your Box - - rclone ls remote: - -To copy a local directory to an Box directory called backup - - rclone copy /home/source remote:backup - -### Using rclone with an Enterprise account with SSO ### - -If you have an \[dq]Enterprise\[dq] account type with Box with single sign on -(SSO), you need to create a password to use Box with rclone. This can -be done at your Enterprise Box account by going to Settings, \[dq]Account\[dq] -Tab, and then set the password in the \[dq]Authentication\[dq] field. - -Once you have done this, you can setup your Enterprise Box account -using the same procedure detailed above in the, using the password you -have just set. - -### Invalid refresh token ### - -According to the [box docs](https://developer.box.com/v2.0/docs/oauth\-20#section\-6\-using\-the\-access\-and\-refresh\-tokens): - -> Each refresh_token is valid for one use in 60 days. - -This means that if you - - * Don\[aq]t use the box remote for 60 days - * Copy the config file with a box refresh token in and use it in two places - * Get an error on a token refresh - -then rclone will return an error which includes the text \[ga]Invalid -refresh token\[ga]. - -To fix this you will need to use oauth2 again to update the refresh -token. You can use the methods in [the remote setup -docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the -config file method, you should not use that remote on the computer you -did the authentication on. - -Here is how to do it. -\f[R] -.fi -.PP -$ rclone config Current remotes: -.PP -Name Type ==== ==== remote box -.IP "e)" 3 -Edit existing remote -.IP "f)" 3 -New remote -.IP "g)" 3 -Delete remote -.IP "h)" 3 -Rename remote -.IP "i)" 3 -Copy remote -.IP "j)" 3 -Set configuration password -.IP "k)" 3 -Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in an -existing value 1 > remote remote> remote -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = box token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-08T23:40:08.059167677+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Edit remote Value -\[dq]client_id\[dq] = \[dq]\[dq] Edit? -(y/n)> -.IP "l)" 3 -Yes -.IP "m)" 3 -No y/n> n Value \[dq]client_secret\[dq] = \[dq]\[dq] Edit? -(y/n)> -.IP "n)" 3 -Yes -.IP "o)" 3 -No y/n> n Remote config Already have a token \- refresh? -.IP "p)" 3 -Yes -.IP "q)" 3 -No y/n> y Use auto config? -.IP \[bu] 2 -Say Y if not sure -.IP \[bu] 2 -Say N if you are working on a remote or headless machine -.IP "y)" 3 -Yes -.IP "z)" 3 -No y/n> y If your browser doesn\[aq]t open automatically go to the -following link: http://127.0.0.1:53682/auth Log in and authorize rclone -for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = box -token = -{\[dq]access_token\[dq]:\[dq]YYY\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]YYY\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-23T12:22:29.259137901+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.IP "a)" 3 -Yes this is OK -.IP "b)" 3 -Edit this remote -.IP "c)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -### Modified time and hashes ### - -Box allows modification times to be set on objects accurate to 1 -second. These will be used to detect whether objects need syncing or -not. - -Box supports SHA1 type hashes, so you can use the \[ga]\-\-checksum\[ga] -flag. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs] | 0x5C | \[uFF3C] | - -File names can also not end with the following characters. -These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -### Transfers ### - -For files above 50MB rclone will use a chunked transfer. Rclone will -upload up to \[ga]\-\-transfers\[ga] chunks at the same time (shared among all -the multipart uploads). Chunks are buffered in memory and are -normally 8MB so increasing \[ga]\-\-transfers\[ga] will increase memory use. - -### Deleting files ### - -Depending on the enterprise settings for your user, the item will -either be actually deleted from Box or moved to the trash. - -Emptying the trash is supported via the rclone however cleanup command -however this deletes every trashed file and folder individually so it -may take a very long time. -Emptying the trash via the WebUI does not have this limitation -so it is advised to empty the trash via the WebUI. - -### Root folder ID ### - -You can set the \[ga]root_folder_id\[ga] for rclone. This is the directory -(identified by its \[ga]Folder ID\[ga]) that rclone considers to be the root -of your Box drive. - -Normally you will leave this blank and rclone will determine the -correct root to use itself. - -However you can set this to restrict rclone to a specific folder -hierarchy. - -In order to do this you will have to find the \[ga]Folder ID\[ga] of the -directory you wish rclone to display. This will be the last segment -of the URL when you open the relevant folder in the Box web -interface. - -So if the folder you want rclone to use has a URL which looks like -\[ga]https://app.box.com/folder/11xxxxxxxxx8\[ga] -in the browser, then you use \[ga]11xxxxxxxxx8\[ga] as -the \[ga]root_folder_id\[ga] in the config. - - -### Standard Options - -Here are the standard options specific to box (Box). - -#### \-\-box\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_BOX_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_BOX_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-box\-config\-file - +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Box + \[rs] \[dq]box\[dq] +[snip] +Storage> box +Box App Client Id \- leave blank normally. +client_id> +Box App Client Secret \- leave blank normally. +client_secret> Box App config.json location Leave blank normally. - -Leading \[ga]\[ti]\[ga] will be expanded in the file name as will environment variables such as \[ga]${RCLONE_CONFIG_DIR}\[ga]. - - -\- Config: box_config_file -\- Env Var: RCLONE_BOX_BOX_CONFIG_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-access\-token - +Enter a string value. Press Enter for the default (\[dq]\[dq]). +box_config_file> Box App Primary Access Token Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_token> -\- Config: access_token -\- Env Var: RCLONE_BOX_ACCESS_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-box\-sub\-type - - - -\- Config: box_sub_type -\- Env Var: RCLONE_BOX_BOX_SUB_TYPE -\- Type: string -\- Default: \[dq]user\[dq] -\- Examples: - \- \[dq]user\[dq] - \- Rclone should act on behalf of a user - \- \[dq]enterprise\[dq] - \- Rclone should act on behalf of a service account - -### Advanced Options - -Here are the advanced options specific to box (Box). - -#### \-\-box\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_BOX_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_BOX_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_BOX_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-root\-folder\-id - -Fill in for rclone to use a non root folder as its starting point. - -\- Config: root_folder_id -\- Env Var: RCLONE_BOX_ROOT_FOLDER_ID -\- Type: string -\- Default: \[dq]0\[dq] - -#### \-\-box\-upload\-cutoff - -Cutoff for switching to multipart upload (>= 50MB). - -\- Config: upload_cutoff -\- Env Var: RCLONE_BOX_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 50M - -#### \-\-box\-commit\-retries - -Max number of times to try committing a multipart file. - -\- Config: commit_retries -\- Env Var: RCLONE_BOX_COMMIT_RETRIES -\- Type: int -\- Default: 100 - -#### \-\-box\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_BOX_ENCODING -\- Type: MultiEncoder -\- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot - - - -### Limitations ### - -Note that Box is case insensitive so you can\[aq]t have a file called -\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -Box file names can\[aq]t have the \[ga]\[rs]\[ga] character in. rclone maps this to -and from an identical looking unicode equivalent \[ga]\[uFF3C]\[ga]. - -Box only supports filenames up to 255 characters in length. - - Cache (BETA) -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]cache\[ga] remote wraps another existing remote and stores file structure -and its data for long running tasks like \[ga]rclone mount\[ga]. - -## Status - -The cache backend code is working but it currently doesn\[aq]t -have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren\[aq]t getting fixed. - -The cache backend is due to be phased out in favour of the VFS caching -layer eventually which is more tightly integrated into rclone. - -Until this happens we recommend only using the cache backend if you -find you can\[aq]t work without it. There are many docs online describing -the use of the cache backend to minimize API hits and by\-and\-large -these are out of date and the cache backend isn\[aq]t needed in those -scenarios any more. - -## Setup - -To get started you just need to have an existing remote which can be configured -with \[ga]cache\[ga]. - -Here is an example of how to make a remote called \[ga]test\-cache\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +Enter a string value. Press Enter for the default (\[dq]user\[dq]). +Choose a number from below, or type in your own value + 1 / Rclone should act on behalf of a user + \[rs] \[dq]user\[dq] + 2 / Rclone should act on behalf of a service account + \[rs] \[dq]enterprise\[dq] +box_sub_type> +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]XXX\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y \f[R] .fi .PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> test\-cache Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Cache -a remote \ \[dq]cache\[dq] [snip] Storage> cache Remote to cache. -Normally should contain a \[aq]:\[aq] and a path, eg -\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe -\[dq]myremote:\[dq] (not recommended). -remote> local:/test Optional: The URL of the Plex server plex_url> -http://127.0.0.1:32400 Optional: The username of the Plex user -plex_username> dummyusername Optional: The password of the Plex user y) -Yes type in my own password g) Generate random password n) No leave this -optional password blank y/g/n> y Enter the password: password: Confirm -the password: password: The size of a chunk. -Lower value good for slow connections but can affect seamless reading. -Default: 5M Choose a number from below, or type in your own value 1 / -1MB \ \[dq]1m\[dq] 2 / 5 MB \ \[dq]5M\[dq] 3 / 10 MB \ \[dq]10M\[dq] -chunk_size> 2 How much time should object info (file size, file hashes -etc) be stored in cache. -Use a very high value if you don\[aq]t plan on changing the source FS -from outside the cache. -Accepted units are: \[dq]s\[dq], \[dq]m\[dq], \[dq]h\[dq]. -Default: 5m Choose a number from below, or type in your own value 1 / 1 -hour \ \[dq]1h\[dq] 2 / 24 hours \ \[dq]24h\[dq] 3 / 24 hours -\ \[dq]48h\[dq] info_age> 2 The maximum size of stored chunks. -When the storage grows beyond this size, the oldest chunks will be -deleted. -Default: 10G Choose a number from below, or type in your own value 1 / -500 MB \ \[dq]500M\[dq] 2 / 1 GB \ \[dq]1G\[dq] 3 / 10 GB -\ \[dq]10G\[dq] chunk_total_size> 3 Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [test\-cache] remote = -local:/test plex_url = http://127.0.0.1:32400 plex_username = -dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age -= 48h chunk_total_size = 10G +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Box. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level of your Box .IP .nf \f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your Box +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an Box directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Using rclone with an Enterprise account with SSO +.PP +If you have an \[dq]Enterprise\[dq] account type with Box with single +sign on (SSO), you need to create a password to use Box with rclone. +This can be done at your Enterprise Box account by going to Settings, +\[dq]Account\[dq] Tab, and then set the password in the +\[dq]Authentication\[dq] field. +.PP +Once you have done this, you can setup your Enterprise Box account using +the same procedure detailed above in the, using the password you have +just set. +.SS Invalid refresh token +.PP +According to the box +docs (https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): +.RS +.PP +Each refresh_token is valid for one use in 60 days. +.RE +.PP +This means that if you +.IP \[bu] 2 +Don\[aq]t use the box remote for 60 days +.IP \[bu] 2 +Copy the config file with a box refresh token in and use it in two +places +.IP \[bu] 2 +Get an error on a token refresh +.PP +then rclone will return an error which includes the text +\f[C]Invalid refresh token\f[R]. +.PP +To fix this you will need to use oauth2 again to update the refresh +token. +You can use the methods in the remote setup +docs (https://rclone.org/remote_setup/), bearing in mind that if you use +the copy the config file method, you should not use that remote on the +computer you did the authentication on. +.PP +Here is how to do it. +.IP +.nf +\f[C] +$ rclone config +Current remotes: -You can then use it like this, - -List directories in top level of your drive - - rclone lsd test\-cache: - -List all the files in your drive - - rclone ls test\-cache: - -To start a cached mount - - rclone mount \-\-allow\-other test\-cache: /var/tmp/test\-cache - -### Write Features ### - -### Offline uploading ### - -In an effort to make writing through cache more reliable, the backend -now supports this feature which can be activated by specifying a -\[ga]cache\-tmp\-upload\-path\[ga]. - -A files goes through these states when using this feature: - -1. An upload is started (usually by copying a file on the cache remote) -2. When the copy to the temporary location is complete the file is part -of the cached remote and looks and behaves like any other file (reading included) -3. After \[ga]cache\-tmp\-wait\-time\[ga] passes and the file is next in line, \[ga]rclone move\[ga] -is used to move the file to the cloud provider -4. Reading the file still works during the upload but most modifications on it will be prohibited -5. Once the move is complete the file is unlocked for modifications as it -becomes as any other regular file -6. If the file is being read through \[ga]cache\[ga] when it\[aq]s actually -deleted from the temporary path then \[ga]cache\[ga] will simply swap the source -to the cloud provider without interrupting the reading (small blip can happen though) - -Files are uploaded in sequence and only one file is uploaded at a time. -Uploads will be stored in a queue and be processed based on the order they were added. -The queue and the temporary storage is persistent across restarts but -can be cleared on startup with the \[ga]\-\-cache\-db\-purge\[ga] flag. - -### Write Support ### - -Writes are supported through \[ga]cache\[ga]. -One caveat is that a mounted cache remote does not add any retry or fallback -mechanism to the upload operation. This will depend on the implementation -of the wrapped remote. Consider using \[ga]Offline uploading\[ga] for reliable writes. - -One special case is covered with \[ga]cache\-writes\[ga] which will cache the file -data at the same time as the upload when it is enabled making it available -from the cache store immediately once the upload is finished. - -### Read Features ### - -#### Multiple connections #### - -To counter the high latency between a local PC where rclone is running -and cloud providers, the cache remote can split multiple requests to the -cloud provider for smaller file chunks and combines them together locally -where they can be available almost immediately before the reader usually -needs them. - -This is similar to buffering when media files are played online. Rclone -will stay around the current marker but always try its best to stay ahead -and prepare the data before. - -#### Plex Integration #### - -There is a direct integration with Plex which allows cache to detect during reading -if the file is in playback or not. This helps cache to adapt how it queries -the cloud provider depending on what is needed for. - -Scans will have a minimum amount of workers (1) while in a confirmed playback cache -will deploy the configured number of workers. - -This integration opens the doorway to additional performance improvements -which will be explored in the near future. - -**Note:** If Plex options are not configured, \[ga]cache\[ga] will function with its -configured options without adapting any of its settings. - -How to enable? Run \[ga]rclone config\[ga] and add all the Plex options (endpoint, username -and password) in your remote and it will be automatically enabled. - -Affected settings: -\- \[ga]cache\-workers\[ga]: _Configured value_ during confirmed playback or _1_ all the other times - -##### Certificate Validation ##### - -When the Plex server is configured to only accept secure connections, it is -possible to use \[ga].plex.direct\[ga] URLs to ensure certificate validation succeeds. -These URLs are used by Plex internally to connect to the Plex server securely. - -The format for these URLs is the following: - -https://ip\-with\-dots\-replaced.server\-hash.plex.direct:32400/ - -The \[ga]ip\-with\-dots\-replaced\[ga] part can be any IPv4 address, where the dots -have been replaced with dashes, e.g. \[ga]127.0.0.1\[ga] becomes \[ga]127\-0\-0\-1\[ga]. - -To get the \[ga]server\-hash\[ga] part, the easiest way is to visit - -https://plex.tv/api/resources?includeHttps=1&X\-Plex\-Token=your\-plex\-token - -This page will list all the available Plex servers for your account -with at least one \[ga].plex.direct\[ga] link for each. Copy one URL and replace -the IP address with the desired address. This can be used as the -\[ga]plex_url\[ga] value. - -### Known issues ### - -#### Mount and \-\-dir\-cache\-time #### - -\-\-dir\-cache\-time controls the first layer of directory caching which works at the mount layer. -Being an independent caching mechanism from the \[ga]cache\[ga] backend, it will manage its own entries -based on the configured time. - -To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct -one, try to set \[ga]\-\-dir\-cache\-time\[ga] to a lower time than \[ga]\-\-cache\-info\-age\[ga]. Default values are -already configured in this way. - -#### Windows support \- Experimental #### - -There are a couple of issues with Windows \[ga]mount\[ga] functionality that still require some investigations. -It should be considered as experimental thus far as fixes come in for this OS. - -Most of the issues seem to be related to the difference between filesystems -on Linux flavors and Windows as cache is heavily dependent on them. - -Any reports or feedback on how cache behaves on this OS is greatly appreciated. - -\- https://github.com/rclone/rclone/issues/1935 -\- https://github.com/rclone/rclone/issues/1907 -\- https://github.com/rclone/rclone/issues/1834 - -#### Risk of throttling #### - -Future iterations of the cache backend will make use of the pooling functionality -of the cloud provider to synchronize and at the same time make writing through it -more tolerant to failures. - -There are a couple of enhancements in track to add these but in the meantime -there is a valid concern that the expiring cache listings can lead to cloud provider -throttles or bans due to repeated queries on it for very large mounts. - -Some recommendations: -\- don\[aq]t use a very small interval for entry information (\[ga]\-\-cache\-info\-age\[ga]) -\- while writes aren\[aq]t yet optimised, you can still write through \[ga]cache\[ga] which gives you the advantage -of adding the file in the cache at the same time if configured to do so. - -Future enhancements: - -\- https://github.com/rclone/rclone/issues/1937 -\- https://github.com/rclone/rclone/issues/1936 - -#### cache and crypt #### - -One common scenario is to keep your data encrypted in the cloud provider -using the \[ga]crypt\[ga] remote. \[ga]crypt\[ga] uses a similar technique to wrap around -an existing remote and handles this translation in a seamless way. - -There is an issue with wrapping the remotes in this order: -**cloud remote** \-> **crypt** \-> **cache** - -During testing, I experienced a lot of bans with the remotes in this order. -I suspect it might be related to how crypt opens files on the cloud provider -which makes it think we\[aq]re downloading the full file instead of small chunks. -Organizing the remotes in this order yields better results: -**cloud remote** \-> **cache** \-> **crypt** - -#### absolute remote paths #### - -\[ga]cache\[ga] can not differentiate between relative and absolute paths for the wrapped remote. -Any path given in the \[ga]remote\[ga] config setting and on the command line will be passed to -the wrapped remote as is, but for storing the chunks on disk the path will be made -relative by removing any leading \[ga]/\[ga] character. - -This behavior is irrelevant for most backend types, but there are backends where a leading \[ga]/\[ga] -changes the effective directory, e.g. in the \[ga]sftp\[ga] backend paths starting with a \[ga]/\[ga] are -relative to the root of the SSH server and paths without are relative to the user home directory. -As a result \[ga]sftp:bin\[ga] and \[ga]sftp:/bin\[ga] will share the same cache folder, even if they represent -a different directory on the SSH server. - -### Cache and Remote Control (\-\-rc) ### -Cache supports the new \[ga]\-\-rc\[ga] mode in rclone and can be remote controlled through the following end points: -By default, the listener is disabled if you do not add the flag. - -### rc cache/expire -Purge a remote from the cache backend. Supports either a directory or a file. -It supports both encrypted and unencrypted file names if cache is wrapped by crypt. - -Params: - \- **remote** = path to remote **(required)** - \- **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - - -### Standard Options - -Here are the standard options specific to cache (Cache a remote). - -#### \-\-cache\-remote +Name Type +==== ==== +remote box +e) Edit existing remote +n) New remote +d) Delete remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +e/n/d/r/c/s/q> e +Choose a number from below, or type in an existing value + 1 > remote +remote> remote +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = box +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-08T23:40:08.059167677+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +Edit remote +Value \[dq]client_id\[dq] = \[dq]\[dq] +Edit? (y/n)> +y) Yes +n) No +y/n> n +Value \[dq]client_secret\[dq] = \[dq]\[dq] +Edit? (y/n)> +y) Yes +n) No +y/n> n +Remote config +Already have a token \- refresh? +y) Yes +n) No +y/n> y +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = box +token = {\[dq]access_token\[dq]:\[dq]YYY\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]YYY\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-23T12:22:29.259137901+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Modified time and hashes +.PP +Box allows modification times to be set on objects accurate to 1 second. +These will be used to detect whether objects need syncing or not. +.PP +Box supports SHA1 type hashes, so you can use the \f[C]\-\-checksum\f[R] +flag. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP +File names can also not end with the following characters. +These only get replaced if they are the last character in the name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Transfers +.PP +For files above 50MB rclone will use a chunked transfer. +Rclone will upload up to \f[C]\-\-transfers\f[R] chunks at the same time +(shared among all the multipart uploads). +Chunks are buffered in memory and are normally 8MB so increasing +\f[C]\-\-transfers\f[R] will increase memory use. +.SS Deleting files +.PP +Depending on the enterprise settings for your user, the item will either +be actually deleted from Box or moved to the trash. +.PP +Emptying the trash is supported via the rclone however cleanup command +however this deletes every trashed file and folder individually so it +may take a very long time. +Emptying the trash via the WebUI does not have this limitation so it is +advised to empty the trash via the WebUI. +.SS Root folder ID +.PP +You can set the \f[C]root_folder_id\f[R] for rclone. +This is the directory (identified by its \f[C]Folder ID\f[R]) that +rclone considers to be the root of your Box drive. +.PP +Normally you will leave this blank and rclone will determine the correct +root to use itself. +.PP +However you can set this to restrict rclone to a specific folder +hierarchy. +.PP +In order to do this you will have to find the \f[C]Folder ID\f[R] of the +directory you wish rclone to display. +This will be the last segment of the URL when you open the relevant +folder in the Box web interface. +.PP +So if the folder you want rclone to use has a URL which looks like +\f[C]https://app.box.com/folder/11xxxxxxxxx8\f[R] in the browser, then +you use \f[C]11xxxxxxxxx8\f[R] as the \f[C]root_folder_id\f[R] in the +config. +.SS Standard Options +.PP +Here are the standard options specific to box (Box). +.SS \-\-box\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_BOX_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_BOX_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-box\-config\-file +.PP +Box App config.json location Leave blank normally. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: box_config_file +.IP \[bu] 2 +Env Var: RCLONE_BOX_BOX_CONFIG_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-access\-token +.PP +Box App Primary Access Token Leave blank normally. +.IP \[bu] 2 +Config: access_token +.IP \[bu] 2 +Env Var: RCLONE_BOX_ACCESS_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-box\-sub\-type +.IP \[bu] 2 +Config: box_sub_type +.IP \[bu] 2 +Env Var: RCLONE_BOX_BOX_SUB_TYPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]user\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]user\[dq] +.RS 2 +.IP \[bu] 2 +Rclone should act on behalf of a user +.RE +.IP \[bu] 2 +\[dq]enterprise\[dq] +.RS 2 +.IP \[bu] 2 +Rclone should act on behalf of a service account +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to box (Box). +.SS \-\-box\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_BOX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_BOX_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_BOX_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-root\-folder\-id +.PP +Fill in for rclone to use a non root folder as its starting point. +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_BOX_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]0\[dq] +.SS \-\-box\-upload\-cutoff +.PP +Cutoff for switching to multipart upload (>= 50MB). +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_BOX_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 50M +.SS \-\-box\-commit\-retries +.PP +Max number of times to try committing a multipart file. +.IP \[bu] 2 +Config: commit_retries +.IP \[bu] 2 +Env Var: RCLONE_BOX_COMMIT_RETRIES +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 100 +.SS \-\-box\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_BOX_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot +.SS Limitations +.PP +Note that Box is case insensitive so you can\[aq]t have a file called +\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +Box file names can\[aq]t have the \f[C]\[rs]\f[R] character in. +rclone maps this to and from an identical looking unicode equivalent +\f[C]\[uFF3C]\f[R]. +.PP +Box only supports filenames up to 255 characters in length. +.SS Cache (BETA) +.PP +The \f[C]cache\f[R] remote wraps another existing remote and stores file +structure and its data for long running tasks like +\f[C]rclone mount\f[R]. +.SS Status +.PP +The cache backend code is working but it currently doesn\[aq]t have a +maintainer so there are outstanding +bugs (https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) +which aren\[aq]t getting fixed. +.PP +The cache backend is due to be phased out in favour of the VFS caching +layer eventually which is more tightly integrated into rclone. +.PP +Until this happens we recommend only using the cache backend if you find +you can\[aq]t work without it. +There are many docs online describing the use of the cache backend to +minimize API hits and by\-and\-large these are out of date and the cache +backend isn\[aq]t needed in those scenarios any more. +.SS Setup +.PP +To get started you just need to have an existing remote which can be +configured with \f[C]cache\f[R]. +.PP +Here is an example of how to make a remote called \f[C]test\-cache\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> test\-cache +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Cache a remote + \[rs] \[dq]cache\[dq] +[snip] +Storage> cache Remote to cache. Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). - -\- Config: remote -\- Env Var: RCLONE_CACHE_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-url - -The URL of the Plex server - -\- Config: plex_url -\- Env Var: RCLONE_CACHE_PLEX_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-username - -The username of the Plex user - -\- Config: plex_username -\- Env Var: RCLONE_CACHE_PLEX_USERNAME -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-password - -The password of the Plex user - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: plex_password -\- Env Var: RCLONE_CACHE_PLEX_PASSWORD -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-chunk\-size - -The size of a chunk (partial file data). - -Use lower numbers for slower connections. If the chunk size is -changed, any downloaded chunks will be invalid and cache\-chunk\-path -will need to be cleared or unexpected EOF errors will occur. - -\- Config: chunk_size -\- Env Var: RCLONE_CACHE_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 5M -\- Examples: - \- \[dq]1m\[dq] - \- 1MB - \- \[dq]5M\[dq] - \- 5 MB - \- \[dq]10M\[dq] - \- 10 MB - -#### \-\-cache\-info\-age - -How long to cache file structure information (directory listings, file size, times etc). -If all write operations are done through the cache then you can safely make -this value very large as the cache store will also be updated in real time. - -\- Config: info_age -\- Env Var: RCLONE_CACHE_INFO_AGE -\- Type: Duration -\- Default: 6h0m0s -\- Examples: - \- \[dq]1h\[dq] - \- 1 hour - \- \[dq]24h\[dq] - \- 24 hours - \- \[dq]48h\[dq] - \- 48 hours - -#### \-\-cache\-chunk\-total\-size - -The total size that the chunks can take up on the local disk. - -If the cache exceeds this value then it will start to delete the -oldest chunks until it goes under this value. - -\- Config: chunk_total_size -\- Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE -\- Type: SizeSuffix -\- Default: 10G -\- Examples: - \- \[dq]500M\[dq] - \- 500 MB - \- \[dq]1G\[dq] - \- 1 GB - \- \[dq]10G\[dq] - \- 10 GB - -### Advanced Options - -Here are the advanced options specific to cache (Cache a remote). - -#### \-\-cache\-plex\-token - -The plex token for authentication \- auto set normally - -\- Config: plex_token -\- Env Var: RCLONE_CACHE_PLEX_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-insecure - -Skip all certificate verification when connecting to the Plex server - -\- Config: plex_insecure -\- Env Var: RCLONE_CACHE_PLEX_INSECURE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-db\-path - -Directory to store file structure metadata DB. -The remote name is used as the DB file name. - -\- Config: db_path -\- Env Var: RCLONE_CACHE_DB_PATH -\- Type: string -\- Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] - -#### \-\-cache\-chunk\-path - -Directory to cache chunk files. - -Path to where partial file data (chunks) are stored locally. The remote -name is appended to the final path. - -This config follows the \[dq]\-\-cache\-db\-path\[dq]. If you specify a custom -location for \[dq]\-\-cache\-db\-path\[dq] and don\[aq]t specify one for \[dq]\-\-cache\-chunk\-path\[dq] -then \[dq]\-\-cache\-chunk\-path\[dq] will use the same path as \[dq]\-\-cache\-db\-path\[dq]. - -\- Config: chunk_path -\- Env Var: RCLONE_CACHE_CHUNK_PATH -\- Type: string -\- Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] - -#### \-\-cache\-db\-purge - -Clear all the cached data for this remote on start. - -\- Config: db_purge -\- Env Var: RCLONE_CACHE_DB_PURGE -\- Type: bool -\- Default: false - -#### \-\-cache\-chunk\-clean\-interval - -How often should the cache perform cleanups of the chunk storage. -The default value should be ok for most people. If you find that the -cache goes over \[dq]cache\-chunk\-total\-size\[dq] too often then try to lower -this value to force it to perform cleanups more often. - -\- Config: chunk_clean_interval -\- Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL -\- Type: Duration -\- Default: 1m0s - -#### \-\-cache\-read\-retries - -How many times to retry a read from a cache storage. - -Since reading from a cache stream is independent from downloading file -data, readers can get to a point where there\[aq]s no more data in the -cache. Most of the times this can indicate a connectivity issue if -cache isn\[aq]t able to provide file data anymore. - -For really slow connections, increase this to a point where the stream is -able to provide data but your experience will be very stuttering. - -\- Config: read_retries -\- Env Var: RCLONE_CACHE_READ_RETRIES -\- Type: int -\- Default: 10 - -#### \-\-cache\-workers - -How many workers should run in parallel to download chunks. - -Higher values will mean more parallel processing (better CPU needed) -and more concurrent requests on the cloud provider. This impacts -several aspects like the cloud provider API limits, more stress on the -hardware that rclone runs on but it also means that streams will be -more fluid and data will be available much more faster to readers. - -**Note**: If the optional Plex integration is enabled then this -setting will adapt to the type of reading performed and the value -specified here will be used as a maximum number of workers to use. - -\- Config: workers -\- Env Var: RCLONE_CACHE_WORKERS -\- Type: int -\- Default: 4 - -#### \-\-cache\-chunk\-no\-memory - -Disable the in\-memory cache for storing chunks during streaming. - -By default, cache will keep file data during streaming in RAM as well -to provide it to readers as fast as possible. - -This transient data is evicted as soon as it is read and the number of -chunks stored doesn\[aq]t exceed the number of workers. However, depending -on other settings like \[dq]cache\-chunk\-size\[dq] and \[dq]cache\-workers\[dq] this footprint -can increase if there are parallel streams too (multiple files being read -at the same time). - -If the hardware permits it, use this feature to provide an overall better -performance during streaming but it can also be disabled if RAM is not -available on the local machine. - -\- Config: chunk_no_memory -\- Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY -\- Type: bool -\- Default: false - -#### \-\-cache\-rps - -Limits the number of requests per second to the source FS (\-1 to disable) - -This setting places a hard limit on the number of requests per second -that cache will be doing to the cloud provider remote and try to -respect that value by setting waits between reads. - -If you find that you\[aq]re getting banned or limited on the cloud -provider through cache and know that a smaller number of requests per -second will allow you to work with it then you can use this setting -for that. - -A good balance of all the other settings should make this setting -useless but it is available to set for more special cases. - -**NOTE**: This will limit the number of requests during streams but -other API calls to the cloud provider like directory listings will -still pass. - -\- Config: rps -\- Env Var: RCLONE_CACHE_RPS -\- Type: int -\- Default: \-1 - -#### \-\-cache\-writes - -Cache file data on writes through the FS - -If you need to read files immediately after you upload them through -cache you can enable this flag to have their data stored in the -cache store at the same time during upload. - -\- Config: writes -\- Env Var: RCLONE_CACHE_WRITES -\- Type: bool -\- Default: false - -#### \-\-cache\-tmp\-upload\-path - -Directory to keep temporary files until they are uploaded. - -This is the path where cache will use as a temporary storage for new -files that need to be uploaded to the cloud provider. - -Specifying a value will enable this feature. Without it, it is -completely disabled and files will be uploaded directly to the cloud -provider - -\- Config: tmp_upload_path -\- Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-tmp\-wait\-time - -How long should files be stored in local cache before being uploaded - -This is the duration that a file must wait in the temporary location -_cache\-tmp\-upload\-path_ before it is selected for upload. - -Note that only one file is uploaded at a time and it can take longer -to start the upload if a queue formed for this purpose. - -\- Config: tmp_wait_time -\- Env Var: RCLONE_CACHE_TMP_WAIT_TIME -\- Type: Duration -\- Default: 15s - -#### \-\-cache\-db\-wait\-time - -How long to wait for the DB to be available \- 0 is unlimited - -Only one process can have the DB open at any one time, so rclone waits -for this duration for the DB to become available before it gives an -error. - -If you set it to 0 then it will wait forever. - -\- Config: db_wait_time -\- Env Var: RCLONE_CACHE_DB_WAIT_TIME -\- Type: Duration -\- Default: 1s - -### Backend commands - -Here are the commands specific to the cache backend. - -Run them with - - rclone backend COMMAND remote: - -The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - -These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### stats - -Print stats on the cache backend in JSON format. - - rclone backend stats remote: [options] [+] - - - -Chunker (BETA) -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]chunker\[ga] overlay transparently splits large files into smaller chunks -during upload to wrapped remote and transparently assembles them back -when the file is downloaded. This allows to effectively overcome size limits -imposed by storage providers. - -To use it, first set up the underlying remote following the configuration -instructions for that remote. You can also use a local pathname instead of -a remote. - -First check your chosen remote is working \- we\[aq]ll call it \[ga]remote:path\[ga] here. -Note that anything inside \[ga]remote:path\[ga] will be chunked and anything outside -won\[aq]t. This means that if you are using a bucket based remote (eg S3, B2, swift) -then you should probably put the bucket in the remote \[ga]s3:bucket\[ga]. - -Now configure \[ga]chunker\[ga] using \[ga]rclone config\[ga]. We will call this one \[ga]overlay\[ga] -to separate it from the \[ga]remote\[ga] itself. +remote> local:/test +Optional: The URL of the Plex server +plex_url> http://127.0.0.1:32400 +Optional: The username of the Plex user +plex_username> dummyusername +Optional: The password of the Plex user +y) Yes type in my own password +g) Generate random password +n) No leave this optional password blank +y/g/n> y +Enter the password: +password: +Confirm the password: +password: +The size of a chunk. Lower value good for slow connections but can affect seamless reading. +Default: 5M +Choose a number from below, or type in your own value + 1 / 1MB + \[rs] \[dq]1m\[dq] + 2 / 5 MB + \[rs] \[dq]5M\[dq] + 3 / 10 MB + \[rs] \[dq]10M\[dq] +chunk_size> 2 +How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don\[aq]t plan on changing the source FS from outside the cache. +Accepted units are: \[dq]s\[dq], \[dq]m\[dq], \[dq]h\[dq]. +Default: 5m +Choose a number from below, or type in your own value + 1 / 1 hour + \[rs] \[dq]1h\[dq] + 2 / 24 hours + \[rs] \[dq]24h\[dq] + 3 / 24 hours + \[rs] \[dq]48h\[dq] +info_age> 2 +The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. +Default: 10G +Choose a number from below, or type in your own value + 1 / 500 MB + \[rs] \[dq]500M\[dq] + 2 / 1 GB + \[rs] \[dq]1G\[dq] + 3 / 10 GB + \[rs] \[dq]10G\[dq] +chunk_total_size> 3 +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[test\-cache] +remote = local:/test +plex_url = http://127.0.0.1:32400 +plex_username = dummyusername +plex_password = *** ENCRYPTED *** +chunk_size = 5M +info_age = 48h +chunk_total_size = 10G \f[R] .fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> overlay Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / -Transparently chunk/split large files \ \[dq]chunker\[dq] [snip] -Storage> chunker Remote to chunk/unchunk. -Normally should contain a \[aq]:\[aq] and a path, eg -\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe -\[dq]myremote:\[dq] (not recommended). -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -remote> remote:path Files larger than chunk size will be split in -chunks. -Enter a size with suffix k,M,G,T. -Press Enter for the default (\[dq]2G\[dq]). -chunk_size> 100M Choose how chunker handles hash sums. -All modes but \[dq]none\[dq] require metadata. -Enter a string value. -Press Enter for the default (\[dq]md5\[dq]). -Choose a number from below, or type in your own value 1 / Pass any hash -supported by wrapped remote for non\-chunked files, return nothing -otherwise \ \[dq]none\[dq] 2 / MD5 for composite files \ \[dq]md5\[dq] 3 -/ SHA1 for composite files \ \[dq]sha1\[dq] 4 / MD5 for all files -\ \[dq]md5all\[dq] 5 / SHA1 for all files \ \[dq]sha1all\[dq] 6 / -Copying a file to chunker will request MD5 from the source falling back -to SHA1 if unsupported \ \[dq]md5quick\[dq] 7 / Similar to -\[dq]md5quick\[dq] but prefers SHA1 over MD5 \ \[dq]sha1quick\[dq] -hash_type> md5 Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [overlay] type = chunker remote -= remote:bucket chunk_size = 100M hash_type = md5 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +You can then use it like this, +.PP +List directories in top level of your drive .IP .nf \f[C] - -### Specifying the remote - -In normal use, make sure the remote has a \[ga]:\[ga] in. If you specify the remote -without a \[ga]:\[ga] then rclone will use a local directory of that name. -So if you use a remote of \[ga]/path/to/secret/files\[ga] then rclone will -chunk stuff in that directory. If you use a remote of \[ga]name\[ga] then rclone -will put files in a directory called \[ga]name\[ga] in the current directory. - - -### Chunking - -When rclone starts a file upload, chunker checks the file size. If it -doesn\[aq]t exceed the configured chunk size, chunker will just pass the file -to the wrapped remote. If a file is large, chunker will transparently cut -data in pieces with temporary names and stream them one by one, on the fly. -Each data chunk will contain the specified number of bytes, except for the -last one which may have less data. If file size is unknown in advance -(this is called a streaming upload), chunker will internally create -a temporary copy, record its size and repeat the above process. - +rclone lsd test\-cache: +\f[R] +.fi +.PP +List all the files in your drive +.IP +.nf +\f[C] +rclone ls test\-cache: +\f[R] +.fi +.PP +To start a cached mount +.IP +.nf +\f[C] +rclone mount \-\-allow\-other test\-cache: /var/tmp/test\-cache +\f[R] +.fi +.SS Write Features +.SS Offline uploading +.PP +In an effort to make writing through cache more reliable, the backend +now supports this feature which can be activated by specifying a +\f[C]cache\-tmp\-upload\-path\f[R]. +.PP +A files goes through these states when using this feature: +.IP "1." 3 +An upload is started (usually by copying a file on the cache remote) +.IP "2." 3 +When the copy to the temporary location is complete the file is part of +the cached remote and looks and behaves like any other file (reading +included) +.IP "3." 3 +After \f[C]cache\-tmp\-wait\-time\f[R] passes and the file is next in +line, \f[C]rclone move\f[R] is used to move the file to the cloud +provider +.IP "4." 3 +Reading the file still works during the upload but most modifications on +it will be prohibited +.IP "5." 3 +Once the move is complete the file is unlocked for modifications as it +becomes as any other regular file +.IP "6." 3 +If the file is being read through \f[C]cache\f[R] when it\[aq]s actually +deleted from the temporary path then \f[C]cache\f[R] will simply swap +the source to the cloud provider without interrupting the reading (small +blip can happen though) +.PP +Files are uploaded in sequence and only one file is uploaded at a time. +Uploads will be stored in a queue and be processed based on the order +they were added. +The queue and the temporary storage is persistent across restarts but +can be cleared on startup with the \f[C]\-\-cache\-db\-purge\f[R] flag. +.SS Write Support +.PP +Writes are supported through \f[C]cache\f[R]. +One caveat is that a mounted cache remote does not add any retry or +fallback mechanism to the upload operation. +This will depend on the implementation of the wrapped remote. +Consider using \f[C]Offline uploading\f[R] for reliable writes. +.PP +One special case is covered with \f[C]cache\-writes\f[R] which will +cache the file data at the same time as the upload when it is enabled +making it available from the cache store immediately once the upload is +finished. +.SS Read Features +.SS Multiple connections +.PP +To counter the high latency between a local PC where rclone is running +and cloud providers, the cache remote can split multiple requests to the +cloud provider for smaller file chunks and combines them together +locally where they can be available almost immediately before the reader +usually needs them. +.PP +This is similar to buffering when media files are played online. +Rclone will stay around the current marker but always try its best to +stay ahead and prepare the data before. +.SS Plex Integration +.PP +There is a direct integration with Plex which allows cache to detect +during reading if the file is in playback or not. +This helps cache to adapt how it queries the cloud provider depending on +what is needed for. +.PP +Scans will have a minimum amount of workers (1) while in a confirmed +playback cache will deploy the configured number of workers. +.PP +This integration opens the doorway to additional performance +improvements which will be explored in the near future. +.PP +\f[B]Note:\f[R] If Plex options are not configured, \f[C]cache\f[R] will +function with its configured options without adapting any of its +settings. +.PP +How to enable? +Run \f[C]rclone config\f[R] and add all the Plex options (endpoint, +username and password) in your remote and it will be automatically +enabled. +.PP +Affected settings: \- \f[C]cache\-workers\f[R]: \f[I]Configured +value\f[R] during confirmed playback or \f[I]1\f[R] all the other times +.SS Certificate Validation +.PP +When the Plex server is configured to only accept secure connections, it +is possible to use \f[C].plex.direct\f[R] URLs to ensure certificate +validation succeeds. +These URLs are used by Plex internally to connect to the Plex server +securely. +.PP +The format for these URLs is the following: +.PP +https://ip\-with\-dots\-replaced.server\-hash.plex.direct:32400/ +.PP +The \f[C]ip\-with\-dots\-replaced\f[R] part can be any IPv4 address, +where the dots have been replaced with dashes, e.g. +\f[C]127.0.0.1\f[R] becomes \f[C]127\-0\-0\-1\f[R]. +.PP +To get the \f[C]server\-hash\f[R] part, the easiest way is to visit +.PP +https://plex.tv/api/resources?includeHttps=1&X\-Plex\-Token=your\-plex\-token +.PP +This page will list all the available Plex servers for your account with +at least one \f[C].plex.direct\f[R] link for each. +Copy one URL and replace the IP address with the desired address. +This can be used as the \f[C]plex_url\f[R] value. +.SS Known issues +.SS Mount and \-\-dir\-cache\-time +.PP +\-\-dir\-cache\-time controls the first layer of directory caching which +works at the mount layer. +Being an independent caching mechanism from the \f[C]cache\f[R] backend, +it will manage its own entries based on the configured time. +.PP +To avoid getting in a scenario where dir cache has obsolete data and +cache would have the correct one, try to set +\f[C]\-\-dir\-cache\-time\f[R] to a lower time than +\f[C]\-\-cache\-info\-age\f[R]. +Default values are already configured in this way. +.SS Windows support \- Experimental +.PP +There are a couple of issues with Windows \f[C]mount\f[R] functionality +that still require some investigations. +It should be considered as experimental thus far as fixes come in for +this OS. +.PP +Most of the issues seem to be related to the difference between +filesystems on Linux flavors and Windows as cache is heavily dependent +on them. +.PP +Any reports or feedback on how cache behaves on this OS is greatly +appreciated. +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1935 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1907 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1834 +.SS Risk of throttling +.PP +Future iterations of the cache backend will make use of the pooling +functionality of the cloud provider to synchronize and at the same time +make writing through it more tolerant to failures. +.PP +There are a couple of enhancements in track to add these but in the +meantime there is a valid concern that the expiring cache listings can +lead to cloud provider throttles or bans due to repeated queries on it +for very large mounts. +.PP +Some recommendations: \- don\[aq]t use a very small interval for entry +information (\f[C]\-\-cache\-info\-age\f[R]) \- while writes aren\[aq]t +yet optimised, you can still write through \f[C]cache\f[R] which gives +you the advantage of adding the file in the cache at the same time if +configured to do so. +.PP +Future enhancements: +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1937 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1936 +.SS cache and crypt +.PP +One common scenario is to keep your data encrypted in the cloud provider +using the \f[C]crypt\f[R] remote. +\f[C]crypt\f[R] uses a similar technique to wrap around an existing +remote and handles this translation in a seamless way. +.PP +There is an issue with wrapping the remotes in this order: \f[B]cloud +remote\f[R] \-> \f[B]crypt\f[R] \-> \f[B]cache\f[R] +.PP +During testing, I experienced a lot of bans with the remotes in this +order. +I suspect it might be related to how crypt opens files on the cloud +provider which makes it think we\[aq]re downloading the full file +instead of small chunks. +Organizing the remotes in this order yields better results: \f[B]cloud +remote\f[R] \-> \f[B]cache\f[R] \-> \f[B]crypt\f[R] +.SS absolute remote paths +.PP +\f[C]cache\f[R] can not differentiate between relative and absolute +paths for the wrapped remote. +Any path given in the \f[C]remote\f[R] config setting and on the command +line will be passed to the wrapped remote as is, but for storing the +chunks on disk the path will be made relative by removing any leading +\f[C]/\f[R] character. +.PP +This behavior is irrelevant for most backend types, but there are +backends where a leading \f[C]/\f[R] changes the effective directory, +e.g. +in the \f[C]sftp\f[R] backend paths starting with a \f[C]/\f[R] are +relative to the root of the SSH server and paths without are relative to +the user home directory. +As a result \f[C]sftp:bin\f[R] and \f[C]sftp:/bin\f[R] will share the +same cache folder, even if they represent a different directory on the +SSH server. +.SS Cache and Remote Control (\-\-rc) +.PP +Cache supports the new \f[C]\-\-rc\f[R] mode in rclone and can be remote +controlled through the following end points: By default, the listener is +disabled if you do not add the flag. +.SS rc cache/expire +.PP +Purge a remote from the cache backend. +Supports either a directory or a file. +It supports both encrypted and unencrypted file names if cache is +wrapped by crypt. +.PP +Params: \- \f[B]remote\f[R] = path to remote \f[B](required)\f[R] \- +\f[B]withData\f[R] = true/false to delete cached data (chunks) as well +\f[I](optional, false by default)\f[R] +.SS Standard Options +.PP +Here are the standard options specific to cache (Cache a remote). +.SS \-\-cache\-remote +.PP +Remote to cache. +Normally should contain a \[aq]:\[aq] and a path, eg +\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe +\[dq]myremote:\[dq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CACHE_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-url +.PP +The URL of the Plex server +.IP \[bu] 2 +Config: plex_url +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-username +.PP +The username of the Plex user +.IP \[bu] 2 +Config: plex_username +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_USERNAME +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-password +.PP +The password of the Plex user +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: plex_password +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-chunk\-size +.PP +The size of a chunk (partial file data). +.PP +Use lower numbers for slower connections. +If the chunk size is changed, any downloaded chunks will be invalid and +cache\-chunk\-path will need to be cleared or unexpected EOF errors will +occur. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 5M +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]1m\[dq] +.RS 2 +.IP \[bu] 2 +1MB +.RE +.IP \[bu] 2 +\[dq]5M\[dq] +.RS 2 +.IP \[bu] 2 +5 MB +.RE +.IP \[bu] 2 +\[dq]10M\[dq] +.RS 2 +.IP \[bu] 2 +10 MB +.RE +.RE +.SS \-\-cache\-info\-age +.PP +How long to cache file structure information (directory listings, file +size, times etc). +If all write operations are done through the cache then you can safely +make this value very large as the cache store will also be updated in +real time. +.IP \[bu] 2 +Config: info_age +.IP \[bu] 2 +Env Var: RCLONE_CACHE_INFO_AGE +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 6h0m0s +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]1h\[dq] +.RS 2 +.IP \[bu] 2 +1 hour +.RE +.IP \[bu] 2 +\[dq]24h\[dq] +.RS 2 +.IP \[bu] 2 +24 hours +.RE +.IP \[bu] 2 +\[dq]48h\[dq] +.RS 2 +.IP \[bu] 2 +48 hours +.RE +.RE +.SS \-\-cache\-chunk\-total\-size +.PP +The total size that the chunks can take up on the local disk. +.PP +If the cache exceeds this value then it will start to delete the oldest +chunks until it goes under this value. +.IP \[bu] 2 +Config: chunk_total_size +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 10G +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]500M\[dq] +.RS 2 +.IP \[bu] 2 +500 MB +.RE +.IP \[bu] 2 +\[dq]1G\[dq] +.RS 2 +.IP \[bu] 2 +1 GB +.RE +.IP \[bu] 2 +\[dq]10G\[dq] +.RS 2 +.IP \[bu] 2 +10 GB +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to cache (Cache a remote). +.SS \-\-cache\-plex\-token +.PP +The plex token for authentication \- auto set normally +.IP \[bu] 2 +Config: plex_token +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-insecure +.PP +Skip all certificate verification when connecting to the Plex server +.IP \[bu] 2 +Config: plex_insecure +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_INSECURE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-db\-path +.PP +Directory to store file structure metadata DB. +The remote name is used as the DB file name. +.IP \[bu] 2 +Config: db_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] +.SS \-\-cache\-chunk\-path +.PP +Directory to cache chunk files. +.PP +Path to where partial file data (chunks) are stored locally. +The remote name is appended to the final path. +.PP +This config follows the \[dq]\-\-cache\-db\-path\[dq]. +If you specify a custom location for \[dq]\-\-cache\-db\-path\[dq] and +don\[aq]t specify one for \[dq]\-\-cache\-chunk\-path\[dq] then +\[dq]\-\-cache\-chunk\-path\[dq] will use the same path as +\[dq]\-\-cache\-db\-path\[dq]. +.IP \[bu] 2 +Config: chunk_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] +.SS \-\-cache\-db\-purge +.PP +Clear all the cached data for this remote on start. +.IP \[bu] 2 +Config: db_purge +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_PURGE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-cache\-chunk\-clean\-interval +.PP +How often should the cache perform cleanups of the chunk storage. +The default value should be ok for most people. +If you find that the cache goes over \[dq]cache\-chunk\-total\-size\[dq] +too often then try to lower this value to force it to perform cleanups +more often. +.IP \[bu] 2 +Config: chunk_clean_interval +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \-\-cache\-read\-retries +.PP +How many times to retry a read from a cache storage. +.PP +Since reading from a cache stream is independent from downloading file +data, readers can get to a point where there\[aq]s no more data in the +cache. +Most of the times this can indicate a connectivity issue if cache +isn\[aq]t able to provide file data anymore. +.PP +For really slow connections, increase this to a point where the stream +is able to provide data but your experience will be very stuttering. +.IP \[bu] 2 +Config: read_retries +.IP \[bu] 2 +Env Var: RCLONE_CACHE_READ_RETRIES +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 10 +.SS \-\-cache\-workers +.PP +How many workers should run in parallel to download chunks. +.PP +Higher values will mean more parallel processing (better CPU needed) and +more concurrent requests on the cloud provider. +This impacts several aspects like the cloud provider API limits, more +stress on the hardware that rclone runs on but it also means that +streams will be more fluid and data will be available much more faster +to readers. +.PP +\f[B]Note\f[R]: If the optional Plex integration is enabled then this +setting will adapt to the type of reading performed and the value +specified here will be used as a maximum number of workers to use. +.IP \[bu] 2 +Config: workers +.IP \[bu] 2 +Env Var: RCLONE_CACHE_WORKERS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 4 +.SS \-\-cache\-chunk\-no\-memory +.PP +Disable the in\-memory cache for storing chunks during streaming. +.PP +By default, cache will keep file data during streaming in RAM as well to +provide it to readers as fast as possible. +.PP +This transient data is evicted as soon as it is read and the number of +chunks stored doesn\[aq]t exceed the number of workers. +However, depending on other settings like \[dq]cache\-chunk\-size\[dq] +and \[dq]cache\-workers\[dq] this footprint can increase if there are +parallel streams too (multiple files being read at the same time). +.PP +If the hardware permits it, use this feature to provide an overall +better performance during streaming but it can also be disabled if RAM +is not available on the local machine. +.IP \[bu] 2 +Config: chunk_no_memory +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-cache\-rps +.PP +Limits the number of requests per second to the source FS (\-1 to +disable) +.PP +This setting places a hard limit on the number of requests per second +that cache will be doing to the cloud provider remote and try to respect +that value by setting waits between reads. +.PP +If you find that you\[aq]re getting banned or limited on the cloud +provider through cache and know that a smaller number of requests per +second will allow you to work with it then you can use this setting for +that. +.PP +A good balance of all the other settings should make this setting +useless but it is available to set for more special cases. +.PP +\f[B]NOTE\f[R]: This will limit the number of requests during streams +but other API calls to the cloud provider like directory listings will +still pass. +.IP \[bu] 2 +Config: rps +.IP \[bu] 2 +Env Var: RCLONE_CACHE_RPS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: \-1 +.SS \-\-cache\-writes +.PP +Cache file data on writes through the FS +.PP +If you need to read files immediately after you upload them through +cache you can enable this flag to have their data stored in the cache +store at the same time during upload. +.IP \[bu] 2 +Config: writes +.IP \[bu] 2 +Env Var: RCLONE_CACHE_WRITES +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-cache\-tmp\-upload\-path +.PP +Directory to keep temporary files until they are uploaded. +.PP +This is the path where cache will use as a temporary storage for new +files that need to be uploaded to the cloud provider. +.PP +Specifying a value will enable this feature. +Without it, it is completely disabled and files will be uploaded +directly to the cloud provider +.IP \[bu] 2 +Config: tmp_upload_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-tmp\-wait\-time +.PP +How long should files be stored in local cache before being uploaded +.PP +This is the duration that a file must wait in the temporary location +\f[I]cache\-tmp\-upload\-path\f[R] before it is selected for upload. +.PP +Note that only one file is uploaded at a time and it can take longer to +start the upload if a queue formed for this purpose. +.IP \[bu] 2 +Config: tmp_wait_time +.IP \[bu] 2 +Env Var: RCLONE_CACHE_TMP_WAIT_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 15s +.SS \-\-cache\-db\-wait\-time +.PP +How long to wait for the DB to be available \- 0 is unlimited +.PP +Only one process can have the DB open at any one time, so rclone waits +for this duration for the DB to become available before it gives an +error. +.PP +If you set it to 0 then it will wait forever. +.IP \[bu] 2 +Config: db_wait_time +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_WAIT_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1s +.SS Backend commands +.PP +Here are the commands specific to the cache backend. +.PP +Run them with +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP +The help below will explain what arguments each command takes. +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP +These can be run on a running backend using the rc command +backend/command (https://rclone.org/rc/#backend/command). +.SS stats +.PP +Print stats on the cache backend in JSON format. +.IP +.nf +\f[C] +rclone backend stats remote: [options] [+] +\f[R] +.fi +.SS Chunker (BETA) +.PP +The \f[C]chunker\f[R] overlay transparently splits large files into +smaller chunks during upload to wrapped remote and transparently +assembles them back when the file is downloaded. +This allows to effectively overcome size limits imposed by storage +providers. +.PP +To use it, first set up the underlying remote following the +configuration instructions for that remote. +You can also use a local pathname instead of a remote. +.PP +First check your chosen remote is working \- we\[aq]ll call it +\f[C]remote:path\f[R] here. +Note that anything inside \f[C]remote:path\f[R] will be chunked and +anything outside won\[aq]t. +This means that if you are using a bucket based remote (eg S3, B2, +swift) then you should probably put the bucket in the remote +\f[C]s3:bucket\f[R]. +.PP +Now configure \f[C]chunker\f[R] using \f[C]rclone config\f[R]. +We will call this one \f[C]overlay\f[R] to separate it from the +\f[C]remote\f[R] itself. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> overlay +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Transparently chunk/split large files + \[rs] \[dq]chunker\[dq] +[snip] +Storage> chunker +Remote to chunk/unchunk. +Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], +\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). +Enter a string value. Press Enter for the default (\[dq]\[dq]). +remote> remote:path +Files larger than chunk size will be split in chunks. +Enter a size with suffix k,M,G,T. Press Enter for the default (\[dq]2G\[dq]). +chunk_size> 100M +Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. +Enter a string value. Press Enter for the default (\[dq]md5\[dq]). +Choose a number from below, or type in your own value + 1 / Pass any hash supported by wrapped remote for non\-chunked files, return nothing otherwise + \[rs] \[dq]none\[dq] + 2 / MD5 for composite files + \[rs] \[dq]md5\[dq] + 3 / SHA1 for composite files + \[rs] \[dq]sha1\[dq] + 4 / MD5 for all files + \[rs] \[dq]md5all\[dq] + 5 / SHA1 for all files + \[rs] \[dq]sha1all\[dq] + 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported + \[rs] \[dq]md5quick\[dq] + 7 / Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 + \[rs] \[dq]sha1quick\[dq] +hash_type> md5 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[overlay] +type = chunker +remote = remote:bucket +chunk_size = 100M +hash_type = md5 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Specifying the remote +.PP +In normal use, make sure the remote has a \f[C]:\f[R] in. +If you specify the remote without a \f[C]:\f[R] then rclone will use a +local directory of that name. +So if you use a remote of \f[C]/path/to/secret/files\f[R] then rclone +will chunk stuff in that directory. +If you use a remote of \f[C]name\f[R] then rclone will put files in a +directory called \f[C]name\f[R] in the current directory. +.SS Chunking +.PP +When rclone starts a file upload, chunker checks the file size. +If it doesn\[aq]t exceed the configured chunk size, chunker will just +pass the file to the wrapped remote. +If a file is large, chunker will transparently cut data in pieces with +temporary names and stream them one by one, on the fly. +Each data chunk will contain the specified number of bytes, except for +the last one which may have less data. +If file size is unknown in advance (this is called a streaming upload), +chunker will internally create a temporary copy, record its size and +repeat the above process. +.PP When upload completes, temporary chunk files are finally renamed. This scheme guarantees that operations can be run in parallel and look from outside as atomic. -A similar method with hidden temporary chunks is used for other operations -(copy/move/rename etc). If an operation fails, hidden chunks are normally -destroyed, and the target composite file stays intact. - +A similar method with hidden temporary chunks is used for other +operations (copy/move/rename etc). +If an operation fails, hidden chunks are normally destroyed, and the +target composite file stays intact. +.PP When a composite file download is requested, chunker transparently -assembles it by concatenating data chunks in order. As the split is trivial -one could even manually concatenate data chunks together to obtain the -original content. - -When the \[ga]list\[ga] rclone command scans a directory on wrapped remote, -the potential chunk files are accounted for, grouped and assembled into -composite directory entries. Any temporary chunks are hidden. - +assembles it by concatenating data chunks in order. +As the split is trivial one could even manually concatenate data chunks +together to obtain the original content. +.PP +When the \f[C]list\f[R] rclone command scans a directory on wrapped +remote, the potential chunk files are accounted for, grouped and +assembled into composite directory entries. +Any temporary chunks are hidden. +.PP List and other commands can sometimes come across composite files with -missing or invalid chunks, eg. shadowed by like\-named directory or -another file. This usually means that wrapped file system has been directly -tampered with or damaged. If chunker detects a missing chunk it will -by default print warning, skip the whole incomplete group of chunks but -proceed with current command. -You can set the \[ga]\-\-chunker\-fail\-hard\[ga] flag to have commands abort with -error message in such cases. - - -#### Chunk names - -The default chunk name format is \[ga]*.rclone_chunk.###\[ga], hence by default -chunk names are \[ga]BIG_FILE_NAME.rclone_chunk.001\[ga], -\[ga]BIG_FILE_NAME.rclone_chunk.002\[ga] etc. You can configure another name format -using the \[ga]name_format\[ga] configuration file option. The format uses asterisk -\[ga]*\[ga] as a placeholder for the base file name and one or more consecutive -hash characters \[ga]#\[ga] as a placeholder for sequential chunk number. -There must be one and only one asterisk. The number of consecutive hash -characters defines the minimum length of a string representing a chunk number. +missing or invalid chunks, eg. +shadowed by like\-named directory or another file. +This usually means that wrapped file system has been directly tampered +with or damaged. +If chunker detects a missing chunk it will by default print warning, +skip the whole incomplete group of chunks but proceed with current +command. +You can set the \f[C]\-\-chunker\-fail\-hard\f[R] flag to have commands +abort with error message in such cases. +.SS Chunk names +.PP +The default chunk name format is \f[C]*.rclone_chunk.###\f[R], hence by +default chunk names are \f[C]BIG_FILE_NAME.rclone_chunk.001\f[R], +\f[C]BIG_FILE_NAME.rclone_chunk.002\f[R] etc. +You can configure another name format using the \f[C]name_format\f[R] +configuration file option. +The format uses asterisk \f[C]*\f[R] as a placeholder for the base file +name and one or more consecutive hash characters \f[C]#\f[R] as a +placeholder for sequential chunk number. +There must be one and only one asterisk. +The number of consecutive hash characters defines the minimum length of +a string representing a chunk number. If decimal chunk number has less digits than the number of hashes, it is -left\-padded by zeros. If the decimal string is longer, it is left intact. -By default numbering starts from 1 but there is another option that allows -user to start from 0, eg. for compatibility with legacy software. - -For example, if name format is \[ga]big_*\-##.part\[ga] and original file name is -\[ga]data.txt\[ga] and numbering starts from 0, then the first chunk will be named -\[ga]big_data.txt\-00.part\[ga], the 99th chunk will be \[ga]big_data.txt\-98.part\[ga] -and the 302nd chunk will become \[ga]big_data.txt\-301.part\[ga]. - -Note that \[ga]list\[ga] assembles composite directory entries only when chunk names -match the configured format and treats non\-conforming file names as normal -non\-chunked files. - - -### Metadata - -Besides data chunks chunker will by default create metadata object for -a composite file. The object is named after the original file. -Chunker allows user to disable metadata completely (the \[ga]none\[ga] format). +left\-padded by zeros. +If the decimal string is longer, it is left intact. +By default numbering starts from 1 but there is another option that +allows user to start from 0, eg. +for compatibility with legacy software. +.PP +For example, if name format is \f[C]big_*\-##.part\f[R] and original +file name is \f[C]data.txt\f[R] and numbering starts from 0, then the +first chunk will be named \f[C]big_data.txt\-00.part\f[R], the 99th +chunk will be \f[C]big_data.txt\-98.part\f[R] and the 302nd chunk will +become \f[C]big_data.txt\-301.part\f[R]. +.PP +Note that \f[C]list\f[R] assembles composite directory entries only when +chunk names match the configured format and treats non\-conforming file +names as normal non\-chunked files. +.SS Metadata +.PP +Besides data chunks chunker will by default create metadata object for a +composite file. +The object is named after the original file. +Chunker allows user to disable metadata completely (the \f[C]none\f[R] +format). Note that metadata is normally not created for files smaller than the -configured chunk size. This may change in future rclone releases. - -#### Simple JSON metadata format - -This is the default format. It supports hash sums and chunk validation -for composite files. Meta objects carry the following fields: - -\- \[ga]ver\[ga] \- version of format, currently \[ga]1\[ga] -\- \[ga]size\[ga] \- total size of composite file -\- \[ga]nchunks\[ga] \- number of data chunks in file -\- \[ga]md5\[ga] \- MD5 hashsum of composite file (if present) -\- \[ga]sha1\[ga] \- SHA1 hashsum (if present) - -There is no field for composite file name as it\[aq]s simply equal to the name -of meta object on the wrapped remote. Please refer to respective sections -for details on hashsums and modified time handling. - -#### No metadata - -You can disable meta objects by setting the meta format option to \[ga]none\[ga]. +configured chunk size. +This may change in future rclone releases. +.SS Simple JSON metadata format +.PP +This is the default format. +It supports hash sums and chunk validation for composite files. +Meta objects carry the following fields: +.IP \[bu] 2 +\f[C]ver\f[R] \- version of format, currently \f[C]1\f[R] +.IP \[bu] 2 +\f[C]size\f[R] \- total size of composite file +.IP \[bu] 2 +\f[C]nchunks\f[R] \- number of data chunks in file +.IP \[bu] 2 +\f[C]md5\f[R] \- MD5 hashsum of composite file (if present) +.IP \[bu] 2 +\f[C]sha1\f[R] \- SHA1 hashsum (if present) +.PP +There is no field for composite file name as it\[aq]s simply equal to +the name of meta object on the wrapped remote. +Please refer to respective sections for details on hashsums and modified +time handling. +.SS No metadata +.PP +You can disable meta objects by setting the meta format option to +\f[C]none\f[R]. In this mode chunker will scan directory for all files that follow -configured chunk name format, group them by detecting chunks with the same -base name and show group names as virtual composite files. +configured chunk name format, group them by detecting chunks with the +same base name and show group names as virtual composite files. This method is more prone to missing chunk errors (especially missing last chunk) than format with metadata enabled. - - -### Hashsums - +.SS Hashsums +.PP Chunker supports hashsums only when a compatible metadata is present. -Hence, if you choose metadata format of \[ga]none\[ga], chunker will report hashsum -as \[ga]UNSUPPORTED\[ga]. - +Hence, if you choose metadata format of \f[C]none\f[R], chunker will +report hashsum as \f[C]UNSUPPORTED\f[R]. +.PP Please note that by default metadata is stored only for composite files. -If a file is smaller than configured chunk size, chunker will transparently -redirect hash requests to wrapped remote, so support depends on that. +If a file is smaller than configured chunk size, chunker will +transparently redirect hash requests to wrapped remote, so support +depends on that. You will see the empty string as a hashsum of requested type for small files if the wrapped remote doesn\[aq]t support it. - +.PP Many storage backends support MD5 and SHA1 hash types, so does chunker. With chunker you can choose one or another but not both. MD5 is set by default as the most supported type. Since chunker keeps hashes for composite files and falls back to the -wrapped remote hash for non\-chunked ones, we advise you to choose the same -hash type as supported by wrapped remote so that your file listings +wrapped remote hash for non\-chunked ones, we advise you to choose the +same hash type as supported by wrapped remote so that your file listings look coherent. - -If your storage backend does not support MD5 or SHA1 but you need consistent -file hashing, configure chunker with \[ga]md5all\[ga] or \[ga]sha1all\[ga]. These two modes -guarantee given hash for all files. If wrapped remote doesn\[aq]t support it, -chunker will then add metadata to all files, even small. However, this can -double the amount of small files in storage and incur additional service charges. +.PP +If your storage backend does not support MD5 or SHA1 but you need +consistent file hashing, configure chunker with \f[C]md5all\f[R] or +\f[C]sha1all\f[R]. +These two modes guarantee given hash for all files. +If wrapped remote doesn\[aq]t support it, chunker will then add metadata +to all files, even small. +However, this can double the amount of small files in storage and incur +additional service charges. You can even use chunker to force md5/sha1 support in any other remote -at expense of sidecar meta objects by setting eg. \[ga]chunk_type=sha1all\[ga] -to force hashsums and \[ga]chunk_size=1P\[ga] to effectively disable chunking. - +at expense of sidecar meta objects by setting eg. +\f[C]chunk_type=sha1all\f[R] to force hashsums and +\f[C]chunk_size=1P\f[R] to effectively disable chunking. +.PP Normally, when a file is copied to chunker controlled remote, chunker -will ask the file source for compatible file hash and revert to on\-the\-fly -calculation if none is found. This involves some CPU overhead but provides -a guarantee that given hashsum is available. Also, chunker will reject -a server\-side copy or move operation if source and destination hashsum -types are different resulting in the extra network bandwidth, too. -In some rare cases this may be undesired, so chunker provides two optional -choices: \[ga]sha1quick\[ga] and \[ga]md5quick\[ga]. If the source does not support primary -hash type and the quick mode is enabled, chunker will try to fall back to -the secondary type. This will save CPU and bandwidth but can result in empty -hashsums at destination. Beware of consequences: the \[ga]sync\[ga] command will -revert (sometimes silently) to time/size comparison if compatible hashsums +will ask the file source for compatible file hash and revert to +on\-the\-fly calculation if none is found. +This involves some CPU overhead but provides a guarantee that given +hashsum is available. +Also, chunker will reject a server\-side copy or move operation if +source and destination hashsum types are different resulting in the +extra network bandwidth, too. +In some rare cases this may be undesired, so chunker provides two +optional choices: \f[C]sha1quick\f[R] and \f[C]md5quick\f[R]. +If the source does not support primary hash type and the quick mode is +enabled, chunker will try to fall back to the secondary type. +This will save CPU and bandwidth but can result in empty hashsums at +destination. +Beware of consequences: the \f[C]sync\f[R] command will revert +(sometimes silently) to time/size comparison if compatible hashsums between source and target are not found. - - -### Modified time - +.SS Modified time +.PP Chunker stores modification times using the wrapped remote so support -depends on that. For a small non\-chunked file the chunker overlay simply -manipulates modification time of the wrapped remote file. -For a composite file with metadata chunker will get and set -modification time of the metadata object on the wrapped remote. -If file is chunked but metadata format is \[ga]none\[ga] then chunker will -use modification time of the first data chunk. - - -### Migrations - +depends on that. +For a small non\-chunked file the chunker overlay simply manipulates +modification time of the wrapped remote file. +For a composite file with metadata chunker will get and set modification +time of the metadata object on the wrapped remote. +If file is chunked but metadata format is \f[C]none\f[R] then chunker +will use modification time of the first data chunk. +.SS Migrations +.PP The idiomatic way to migrate to a different chunk size, hash type or chunk naming scheme is to: - -\- Collect all your chunked files under a directory and have your - chunker remote point to it. -\- Create another directory (most probably on the same cloud storage) - and configure a new remote with desired metadata format, - hash type, chunk naming etc. -\- Now run \[ga]rclone sync \-i oldchunks: newchunks:\[ga] and all your data - will be transparently converted in transfer. - This may take some time, yet chunker will try server\-side - copy if possible. -\- After checking data integrity you may remove configuration section - of the old remote. - +.IP \[bu] 2 +Collect all your chunked files under a directory and have your chunker +remote point to it. +.IP \[bu] 2 +Create another directory (most probably on the same cloud storage) and +configure a new remote with desired metadata format, hash type, chunk +naming etc. +.IP \[bu] 2 +Now run \f[C]rclone sync \-i oldchunks: newchunks:\f[R] and all your +data will be transparently converted in transfer. +This may take some time, yet chunker will try server\-side copy if +possible. +.IP \[bu] 2 +After checking data integrity you may remove configuration section of +the old remote. +.PP If rclone gets killed during a long operation on a big composite file, -hidden temporary chunks may stay in the directory. They will not be -shown by the \[ga]list\[ga] command but will eat up your account quota. -Please note that the \[ga]deletefile\[ga] command deletes only active -chunks of a file. As a workaround, you can use remote of the wrapped -file system to see them. +hidden temporary chunks may stay in the directory. +They will not be shown by the \f[C]list\f[R] command but will eat up +your account quota. +Please note that the \f[C]deletefile\f[R] command deletes only active +chunks of a file. +As a workaround, you can use remote of the wrapped file system to see +them. An easy way to get rid of hidden garbage is to copy littered directory somewhere using the chunker remote and purge the original directory. -The \[ga]copy\[ga] command will copy only active chunks while the \[ga]purge\[ga] will -remove everything including garbage. - - -### Caveats and Limitations - -Chunker requires wrapped remote to support server side \[ga]move\[ga] (or \[ga]copy\[ga] + -\[ga]delete\[ga]) operations, otherwise it will explicitly refuse to start. -This is because it internally renames temporary chunk files to their final -names when an operation completes successfully. - -Chunker encodes chunk number in file name, so with default \[ga]name_format\[ga] -setting it adds 17 characters. Also chunker adds 7 characters of temporary -suffix during operations. Many file systems limit base file name without path -by 255 characters. Using rclone\[aq]s crypt remote as a base file system limits -file name by 143 characters. Thus, maximum name length is 231 for most files -and 119 for chunker\-over\-crypt. A user in need can change name format to -eg. \[ga]*.rcc##\[ga] and save 10 characters (provided at most 99 chunks per file). - -Note that a move implemented using the copy\-and\-delete method may incur -double charging with some cloud storage providers. - +The \f[C]copy\f[R] command will copy only active chunks while the +\f[C]purge\f[R] will remove everything including garbage. +.SS Caveats and Limitations +.PP +Chunker requires wrapped remote to support server side \f[C]move\f[R] +(or \f[C]copy\f[R] + \f[C]delete\f[R]) operations, otherwise it will +explicitly refuse to start. +This is because it internally renames temporary chunk files to their +final names when an operation completes successfully. +.PP +Chunker encodes chunk number in file name, so with default +\f[C]name_format\f[R] setting it adds 17 characters. +Also chunker adds 7 characters of temporary suffix during operations. +Many file systems limit base file name without path by 255 characters. +Using rclone\[aq]s crypt remote as a base file system limits file name +by 143 characters. +Thus, maximum name length is 231 for most files and 119 for +chunker\-over\-crypt. +A user in need can change name format to eg. +\f[C]*.rcc##\f[R] and save 10 characters (provided at most 99 chunks per +file). +.PP +Note that a move implemented using the copy\-and\-delete method may +incur double charging with some cloud storage providers. +.PP Chunker will not automatically rename existing chunks when you run -\[ga]rclone config\[ga] on a live remote and change the chunk name format. -Beware that in result of this some files which have been treated as chunks -before the change can pop up in directory listings as normal files -and vice versa. The same warning holds for the chunk size. +\f[C]rclone config\f[R] on a live remote and change the chunk name +format. +Beware that in result of this some files which have been treated as +chunks before the change can pop up in directory listings as normal +files and vice versa. +The same warning holds for the chunk size. If you desperately need to change critical chunking settings, you should run data migration as described above. - +.PP If wrapped remote is case insensitive, the chunker overlay will inherit -that property (so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and \[dq]hello.doc\[dq] -in the same directory). - - - -### Standard Options - -Here are the standard options specific to chunker (Transparently chunk/split large files). - -#### \-\-chunker\-remote - +that property (so you can\[aq]t have a file called \[dq]Hello.doc\[dq] +and \[dq]hello.doc\[dq] in the same directory). +.SS Standard Options +.PP +Here are the standard options specific to chunker (Transparently +chunk/split large files). +.SS \-\-chunker\-remote +.PP Remote to chunk/unchunk. -Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], -\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). - -\- Config: remote -\- Env Var: RCLONE_CHUNKER_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-chunker\-chunk\-size - +Normally should contain a \[aq]:\[aq] and a path, eg +\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe +\[dq]myremote:\[dq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-chunker\-chunk\-size +.PP Files larger than chunk size will be split in chunks. - -\- Config: chunk_size -\- Env Var: RCLONE_CHUNKER_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 2G - -#### \-\-chunker\-hash\-type - -Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. - -\- Config: hash_type -\- Env Var: RCLONE_CHUNKER_HASH_TYPE -\- Type: string -\- Default: \[dq]md5\[dq] -\- Examples: - \- \[dq]none\[dq] - \- Pass any hash supported by wrapped remote for non\-chunked files, return nothing otherwise - \- \[dq]md5\[dq] - \- MD5 for composite files - \- \[dq]sha1\[dq] - \- SHA1 for composite files - \- \[dq]md5all\[dq] - \- MD5 for all files - \- \[dq]sha1all\[dq] - \- SHA1 for all files - \- \[dq]md5quick\[dq] - \- Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported - \- \[dq]sha1quick\[dq] - \- Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 - -### Advanced Options - -Here are the advanced options specific to chunker (Transparently chunk/split large files). - -#### \-\-chunker\-name\-format - +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 2G +.SS \-\-chunker\-hash\-type +.PP +Choose how chunker handles hash sums. +All modes but \[dq]none\[dq] require metadata. +.IP \[bu] 2 +Config: hash_type +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_HASH_TYPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]md5\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]none\[dq] +.RS 2 +.IP \[bu] 2 +Pass any hash supported by wrapped remote for non\-chunked files, return +nothing otherwise +.RE +.IP \[bu] 2 +\[dq]md5\[dq] +.RS 2 +.IP \[bu] 2 +MD5 for composite files +.RE +.IP \[bu] 2 +\[dq]sha1\[dq] +.RS 2 +.IP \[bu] 2 +SHA1 for composite files +.RE +.IP \[bu] 2 +\[dq]md5all\[dq] +.RS 2 +.IP \[bu] 2 +MD5 for all files +.RE +.IP \[bu] 2 +\[dq]sha1all\[dq] +.RS 2 +.IP \[bu] 2 +SHA1 for all files +.RE +.IP \[bu] 2 +\[dq]md5quick\[dq] +.RS 2 +.IP \[bu] 2 +Copying a file to chunker will request MD5 from the source falling back +to SHA1 if unsupported +.RE +.IP \[bu] 2 +\[dq]sha1quick\[dq] +.RS 2 +.IP \[bu] 2 +Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to chunker (Transparently +chunk/split large files). +.SS \-\-chunker\-name\-format +.PP String format of chunk file names. The two placeholders are: base file name (*) and chunk number (#...). -There must be one and only one asterisk and one or more consecutive hash characters. -If chunk number has less digits than the number of hashes, it is left\-padded by zeros. +There must be one and only one asterisk and one or more consecutive hash +characters. +If chunk number has less digits than the number of hashes, it is +left\-padded by zeros. If there are more digits in the number, they are left as is. -Possible chunk files are ignored if their name does not match given format. - -\- Config: name_format -\- Env Var: RCLONE_CHUNKER_NAME_FORMAT -\- Type: string -\- Default: \[dq]*.rclone_chunk.###\[dq] - -#### \-\-chunker\-start\-from - -Minimum valid chunk number. Usually 0 or 1. +Possible chunk files are ignored if their name does not match given +format. +.IP \[bu] 2 +Config: name_format +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_NAME_FORMAT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]*.rclone_chunk.###\[dq] +.SS \-\-chunker\-start\-from +.PP +Minimum valid chunk number. +Usually 0 or 1. By default chunk numbers start from 1. - -\- Config: start_from -\- Env Var: RCLONE_CHUNKER_START_FROM -\- Type: int -\- Default: 1 - -#### \-\-chunker\-meta\-format - -Format of the metadata object or \[dq]none\[dq]. By default \[dq]simplejson\[dq]. +.IP \[bu] 2 +Config: start_from +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_START_FROM +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1 +.SS \-\-chunker\-meta\-format +.PP +Format of the metadata object or \[dq]none\[dq]. +By default \[dq]simplejson\[dq]. Metadata is a small JSON file named after the composite file. - -\- Config: meta_format -\- Env Var: RCLONE_CHUNKER_META_FORMAT -\- Type: string -\- Default: \[dq]simplejson\[dq] -\- Examples: - \- \[dq]none\[dq] - \- Do not use metadata files at all. Requires hash type \[dq]none\[dq]. - \- \[dq]simplejson\[dq] - \- Simple JSON supports hash sums and chunk validation. - \- It has the following fields: ver, size, nchunks, md5, sha1. - -#### \-\-chunker\-fail\-hard - +.IP \[bu] 2 +Config: meta_format +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_META_FORMAT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]simplejson\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]none\[dq] +.RS 2 +.IP \[bu] 2 +Do not use metadata files at all. +Requires hash type \[dq]none\[dq]. +.RE +.IP \[bu] 2 +\[dq]simplejson\[dq] +.RS 2 +.IP \[bu] 2 +Simple JSON supports hash sums and chunk validation. +.IP \[bu] 2 +It has the following fields: ver, size, nchunks, md5, sha1. +.RE +.RE +.SS \-\-chunker\-fail\-hard +.PP Choose how chunker should handle files with missing or invalid chunks. - -\- Config: fail_hard -\- Env Var: RCLONE_CHUNKER_FAIL_HARD -\- Type: bool -\- Default: false -\- Examples: - \- \[dq]true\[dq] - \- Report errors and abort current command. - \- \[dq]false\[dq] - \- Warn user, skip incomplete file and proceed. - - - -## Citrix ShareFile - -[Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. - +.IP \[bu] 2 +Config: fail_hard +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_FAIL_HARD +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]true\[dq] +.RS 2 +.IP \[bu] 2 +Report errors and abort current command. +.RE +.IP \[bu] 2 +\[dq]false\[dq] +.RS 2 +.IP \[bu] 2 +Warn user, skip incomplete file and proceed. +.RE +.RE +.SS Citrix ShareFile +.PP +Citrix ShareFile (https://sharefile.com) is a secure file sharing and +transfer service aimed as business. +.PP The initial setup for Citrix ShareFile involves getting a token from -Citrix ShareFile which you can in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +Citrix ShareFile which you can in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config \f[R] .fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value XX / Citrix -Sharefile \ \[dq]sharefile\[dq] Storage> sharefile ** See help for -sharefile backend at: https://rclone.org/sharefile/ ** +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +XX / Citrix Sharefile + \[rs] \[dq]sharefile\[dq] +Storage> sharefile +** See help for sharefile backend at: https://rclone.org/sharefile/ ** + +ID of the root folder + +Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the +standard values here or any folder ID (long hex number ID). +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Access the Personal Folders. (Default) + \[rs] \[dq]\[dq] + 2 / Access the Favorites folder. + \[rs] \[dq]favorites\[dq] + 3 / Access all the shared folders. + \[rs] \[dq]allshared\[dq] + 4 / Access all the individual connectors. + \[rs] \[dq]connectors\[dq] + 5 / Access the home, favorites, and shared folders as well as the connectors. + \[rs] \[dq]top\[dq] +root_folder_id> +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = sharefile +endpoint = https://XXX.sharefile.com +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-09\-30T19:41:45.878561877+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Citrix ShareFile. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level of your ShareFile +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your ShareFile +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an ShareFile directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.SS Modified time and hashes +.PP +ShareFile allows modification times to be set on objects accurate to 1 +second. +These will be used to detect whether objects need syncing or not. +.PP +ShareFile supports MD5 type hashes, so you can use the +\f[C]\-\-checksum\f[R] flag. +.SS Transfers +.PP +For files above 128MB rclone will use a chunked transfer. +Rclone will upload up to \f[C]\-\-transfers\f[R] chunks at the same time +(shared among all the multipart uploads). +Chunks are buffered in memory and are normally 64MB so increasing +\f[C]\-\-transfers\f[R] will increase memory use. +.SS Limitations +.PP +Note that ShareFile is case insensitive so you can\[aq]t have a file +called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +ShareFile only supports filenames up to 256 characters in length. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +T{ +* +T}@T{ +0x2A +T}@T{ +\[uFF0A] +T} +T{ +< +T}@T{ +0x3C +T}@T{ +\[uFF1C] +T} +T{ +> +T}@T{ +0x3E +T}@T{ +\[uFF1E] +T} +T{ +? +T}@T{ +0x3F +T}@T{ +\[uFF1F] +T} +T{ +: +T}@T{ +0x3A +T}@T{ +\[uFF1A] +T} +T{ +| +T}@T{ +0x7C +T}@T{ +\[uFF5C] +T} +T{ +\[dq] +T}@T{ +0x22 +T}@T{ +\[uFF02] +T} +.TE +.PP +File names can also not start or end with the following characters. +These only get replaced if they are the first or last character in the +name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +T{ +\&. +T}@T{ +0x2E +T}@T{ +\[uFF0E] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to sharefile (Citrix Sharefile). +.SS \-\-sharefile\-root\-folder\-id .PP ID of the root folder .PP Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the standard values here or any folder ID (long hex number ID). -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Access the -Personal Folders. -(Default) \ \[dq]\[dq] 2 / Access the Favorites folder. -\ \[dq]favorites\[dq] 3 / Access all the shared folders. -\ \[dq]allshared\[dq] 4 / Access all the individual connectors. -\ \[dq]connectors\[dq] 5 / Access the home, favorites, and shared -folders as well as the connectors. -\ \[dq]top\[dq] root_folder_id> Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: -http://127.0.0.1:53682/auth?state=XXX Log in and authorize rclone for -access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = -sharefile endpoint = https://XXX.sharefile.com token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-09\-30T19:41:45.878561877+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a -machine with no Internet 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 code. This -is on \[ga]http://127.0.0.1:53682/\[ga] and this it may require you to unblock -it temporarily if you are running a host firewall. - -Once configured you can then use \[ga]rclone\[ga] like this, - -List directories in top level of your ShareFile - - rclone lsd remote: - -List all the files in your ShareFile - - rclone ls remote: - -To copy a local directory to an ShareFile directory called backup - - rclone copy /home/source remote:backup - -Paths may be as deep as required, eg \[ga]remote:directory/subdirectory\[ga]. - -### Modified time and hashes ### - -ShareFile allows modification times to be set on objects accurate to 1 -second. These will be used to detect whether objects need syncing or -not. - -ShareFile supports MD5 type hashes, so you can use the \[ga]\-\-checksum\[ga] -flag. - -### Transfers ### - -For files above 128MB rclone will use a chunked transfer. Rclone will -upload up to \[ga]\-\-transfers\[ga] chunks at the same time (shared among all -the multipart uploads). Chunks are buffered in memory and are -normally 64MB so increasing \[ga]\-\-transfers\[ga] will increase memory use. - -### Limitations ### - -Note that ShareFile is case insensitive so you can\[aq]t have a file called -\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -ShareFile only supports filenames up to 256 characters in length. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs]\[rs] | 0x5C | \[uFF3C] | -| * | 0x2A | \[uFF0A] | -| < | 0x3C | \[uFF1C] | -| > | 0x3E | \[uFF1E] | -| ? | 0x3F | \[uFF1F] | -| : | 0x3A | \[uFF1A] | -| \[rs]| | 0x7C | \[uFF5C] | -| \[dq] | 0x22 | \[uFF02] | - -File names can also not start or end with the following characters. -These only get replaced if they are the first or last character in the -name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | -| . | 0x2E | \[uFF0E] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - -Here are the standard options specific to sharefile (Citrix Sharefile). - -#### \-\-sharefile\-root\-folder\-id - -ID of the root folder - -Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the -standard values here or any folder ID (long hex number ID). - -\- Config: root_folder_id -\- Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Access the Personal Folders. (Default) - \- \[dq]favorites\[dq] - \- Access the Favorites folder. - \- \[dq]allshared\[dq] - \- Access all the shared folders. - \- \[dq]connectors\[dq] - \- Access all the individual connectors. - \- \[dq]top\[dq] - \- Access the home, favorites, and shared folders as well as the connectors. - -### Advanced Options - +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Access the Personal Folders. +(Default) +.RE +.IP \[bu] 2 +\[dq]favorites\[dq] +.RS 2 +.IP \[bu] 2 +Access the Favorites folder. +.RE +.IP \[bu] 2 +\[dq]allshared\[dq] +.RS 2 +.IP \[bu] 2 +Access all the shared folders. +.RE +.IP \[bu] 2 +\[dq]connectors\[dq] +.RS 2 +.IP \[bu] 2 +Access all the individual connectors. +.RE +.IP \[bu] 2 +\[dq]top\[dq] +.RS 2 +.IP \[bu] 2 +Access the home, favorites, and shared folders as well as the +connectors. +.RE +.RE +.SS Advanced Options +.PP Here are the advanced options specific to sharefile (Citrix Sharefile). - -#### \-\-sharefile\-upload\-cutoff - +.SS \-\-sharefile\-upload\-cutoff +.PP Cutoff for switching to multipart upload. - -\- Config: upload_cutoff -\- Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 128M - -#### \-\-sharefile\-chunk\-size - -Upload chunk size. Must a power of 2 >= 256k. - -Making this larger will improve performance, but note that each chunk -is buffered in memory one per transfer. - +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 128M +.SS \-\-sharefile\-chunk\-size +.PP +Upload chunk size. +Must a power of 2 >= 256k. +.PP +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. +.PP Reducing this will reduce memory usage but decrease performance. - -\- Config: chunk_size -\- Env Var: RCLONE_SHAREFILE_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 64M - -#### \-\-sharefile\-endpoint - +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 64M +.SS \-\-sharefile\-endpoint +.PP Endpoint for API calls. - -This is usually auto discovered as part of the oauth process, but can -be set manually to something like: https://XXX.sharefile.com - - -\- Config: endpoint -\- Env Var: RCLONE_SHAREFILE_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-sharefile\-encoding - +.PP +This is usually auto discovered as part of the oauth process, but can be +set manually to something like: https://XXX.sharefile.com +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-sharefile\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_SHAREFILE_ENCODING -\- Type: MultiEncoder -\- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot - - - -Crypt -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]crypt\[ga] remote encrypts and decrypts another remote. - +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot +.SS Crypt +.PP +The \f[C]crypt\f[R] remote encrypts and decrypts another remote. +.PP To use it first set up the underlying remote following the config -instructions for that remote. You can also use a local pathname -instead of a remote which will encrypt and decrypt from that directory -which might be useful for encrypting onto a USB stick for example. - +instructions for that remote. +You can also use a local pathname instead of a remote which will encrypt +and decrypt from that directory which might be useful for encrypting +onto a USB stick for example. +.PP First check your chosen remote is working \- we\[aq]ll call it -\[ga]remote:path\[ga] in these docs. Note that anything inside \[ga]remote:path\[ga] -will be encrypted and anything outside won\[aq]t. This means that if you -are using a bucket based remote (eg S3, B2, swift) then you should -probably put the bucket in the remote \[ga]s3:bucket\[ga]. If you just use -\[ga]s3:\[ga] then rclone will make encrypted bucket names too (if using file -name encryption) which may or may not be what you want. - -Now configure \[ga]crypt\[ga] using \[ga]rclone config\[ga]. We will call this one -\[ga]secret\[ga] to differentiate it from the \[ga]remote\[ga]. -\f[R] -.fi +\f[C]remote:path\f[R] in these docs. +Note that anything inside \f[C]remote:path\f[R] will be encrypted and +anything outside won\[aq]t. +This means that if you are using a bucket based remote (eg S3, B2, +swift) then you should probably put the bucket in the remote +\f[C]s3:bucket\f[R]. +If you just use \f[C]s3:\f[R] then rclone will make encrypted bucket +names too (if using file name encryption) which may or may not be what +you want. .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n -.PD 0 -.P -.PD -name> secret Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Encrypt/Decrypt a remote \ \[dq]crypt\[dq] [snip] Storage> crypt Remote -to encrypt/decrypt. -Normally should contain a \[aq]:\[aq] and a path, eg -\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe -\[dq]myremote:\[dq] (not recommended). -remote> remote:path How to encrypt the filenames. -Choose a number from below, or type in your own value 1 / Don\[aq]t -encrypt the file names. -Adds a \[dq].bin\[dq] extension only. -\ \[dq]off\[dq] 2 / Encrypt the filenames see the docs for the details. -\ \[dq]standard\[dq] 3 / Very simple filename obfuscation. -\ \[dq]obfuscate\[dq] filename_encryption> 2 Option to either encrypt -directory names or leave them intact. -Choose a number from below, or type in your own value 1 / Encrypt -directory names. -\ \[dq]true\[dq] 2 / Don\[aq]t encrypt directory names, leave them -intact. -\ \[dq]false\[dq] filename_encryption> 1 Password or pass phrase for -encryption. -y) Yes type in my own password g) Generate random password y/g> y Enter -the password: password: Confirm the password: password: Password or pass -phrase for salt. -Optional but recommended. -Should be different to the previous password. -y) Yes type in my own password g) Generate random password n) No leave -this optional password blank y/g/n> g Password strength in bits. -64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 -Your password is: JAsJvRcgR\-_veXNfy_sGmQ Use this password? -y) Yes n) No y/n> y Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [secret] remote = remote:path -filename_encryption = standard password = *** ENCRYPTED \f[B]\f[BI] -password2 = \f[B]\f[R] ENCRYPTED *** -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +Now configure \f[C]crypt\f[R] using \f[C]rclone config\f[R]. +We will call this one \f[C]secret\f[R] to differentiate it from the +\f[C]remote\f[R]. .IP .nf \f[C] - -**Important** The password is stored in the config file is lightly -obscured so it isn\[aq]t immediately obvious what it is. It is in no way -secure unless you use config file encryption. - -A long passphrase is recommended, or you can use a random one. - -The obscured password is created by using AES\-CTR with a static key, with -the salt stored verbatim at the beginning of the obscured password. This -static key is shared by between all versions of rclone. - -If you reconfigure rclone with the same passwords/passphrases -elsewhere it will be compatible, but the obscured version will be different -due to the different salt. - -Note that rclone does not encrypt - - * file length \- this can be calculated within 16 bytes - * modification time \- used for syncing - -## Specifying the remote ## - -In normal use, make sure the remote has a \[ga]:\[ga] in. If you specify the -remote without a \[ga]:\[ga] then rclone will use a local directory of that -name. So if you use a remote of \[ga]/path/to/secret/files\[ga] then rclone -will encrypt stuff to that directory. If you use a remote of \[ga]name\[ga] -then rclone will put files in a directory called \[ga]name\[ga] in the current -directory. - -If you specify the remote as \[ga]remote:path/to/dir\[ga] then rclone will -store encrypted files in \[ga]path/to/dir\[ga] on the remote. If you are using -file name encryption, then when you save files to -\[ga]secret:subdir/subfile\[ga] this will store them in the unencrypted path -\[ga]path/to/dir\[ga] but the \[ga]subdir/subpath\[ga] bit will be encrypted. - -Note that unless you want encrypted bucket names (which are difficult -to manage because you won\[aq]t know what directory they represent in web -interfaces etc), you should probably specify a bucket, eg -\[ga]remote:secretbucket\[ga] when using bucket based remotes such as S3, -Swift, Hubic, B2, GCS. - -## Example ## - -To test I made a little directory of files using \[dq]standard\[dq] file name -encryption. -\f[R] -.fi -.PP -plaintext/ \[u251C]\[u2500]\[u2500] file0.txt \[u251C]\[u2500]\[u2500] -file1.txt \[u2514]\[u2500]\[u2500] subdir \[u251C]\[u2500]\[u2500] -file2.txt \[u251C]\[u2500]\[u2500] file3.txt \[u2514]\[u2500]\[u2500] -subsubdir \[u2514]\[u2500]\[u2500] file4.txt -.IP -.nf -\f[C] - -Copy these to the remote and list them back -\f[R] -.fi -.PP -$ rclone \-q copy plaintext secret: $ rclone \-q ls secret: 7 file1.txt -6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 -subdir/file3.txt -.IP -.nf -\f[C] - -Now see what that looked like when encrypted -\f[R] -.fi -.PP -$ rclone \-q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 -v05749mltvv1tf4onltun46gls 57 -86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 -86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc -56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps -.IP -.nf -\f[C] - -Note that this retains the directory structure which means you can do this -\f[R] -.fi -.PP -$ rclone \-q ls secret:subdir 8 file2.txt 9 file3.txt 10 -subsubdir/file4.txt -.IP -.nf -\f[C] - -If don\[aq]t use file name encryption then the remote will look like this -\- note the \[ga].bin\[ga] extensions added to prevent the cloud provider -attempting to interpret the data. -\f[R] -.fi -.PP -$ rclone \-q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 -subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin -.IP -.nf -\f[C] - -### File name encryption modes ### - -Here are some of the features of the file name encryption modes - -Off - - * doesn\[aq]t hide file names or directory structure - * allows for longer file names (\[ti]246 characters) - * can use sub paths and copy single files - -Standard - - * file names encrypted - * file names can\[aq]t be as long (\[ti]143 characters) - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - * can use shortcuts to shorten the directory recursion - -Obfuscation - -This is a simple \[dq]rotate\[dq] of the filename, with each file having a rot -distance based on the filename. We store the distance at the beginning -of the filename. So a file called \[dq]hello\[dq] may become \[dq]53.jgnnq\[dq]. - -This is not a strong encryption of filenames, but it may stop automated -scanning tools from picking up on filename patterns. As such it\[aq]s an -intermediate between \[dq]off\[dq] and \[dq]standard\[dq]. The advantage is that it -allows for longer path segment names. - -There is a possibility with some unicode based filenames that the -obfuscation is weak and may map lower case characters to upper case -equivalents. You can not rely on this for strong protection. - - * file names very lightly obfuscated - * file names can be longer than standard encryption - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - -Cloud storage systems have various limits on file name length and -total path length which you are more likely to hit using \[dq]Standard\[dq] -file name encryption. If you keep your file names to below 156 -characters in length then you should be OK on all providers. - -There may be an even more secure file name encryption mode in the -future which will address the long file name problem. - -### Directory name encryption ### -Crypt offers the option of encrypting dir names or leaving them intact. -There are two options: - -True - -Encrypts the whole file path including directory names -Example: -\[ga]1/12/123.txt\[ga] is encrypted to -\[ga]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\[ga] - -False - -Only encrypts file names, skips directory names -Example: -\[ga]1/12/123.txt\[ga] is encrypted to -\[ga]1/12/qgm4avr35m5loi1th53ato71v0\[ga] - - -### Modified time and hashes ### - -Crypt stores modification times using the underlying remote so support -depends on that. - -Hashes are not stored for crypt. However the data integrity is -protected by an extremely strong crypto authenticator. - -Note that you should use the \[ga]rclone cryptcheck\[ga] command to check the -integrity of a crypted remote instead of \[ga]rclone check\[ga] which can\[aq]t -check the checksums properly. - - -### Standard Options - -Here are the standard options specific to crypt (Encrypt/Decrypt a remote). - -#### \-\-crypt\-remote - +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> secret +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Encrypt/Decrypt a remote + \[rs] \[dq]crypt\[dq] +[snip] +Storage> crypt Remote to encrypt/decrypt. Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). - -\- Config: remote -\- Env Var: RCLONE_CRYPT_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-crypt\-filename\-encryption - +remote> remote:path How to encrypt the filenames. - -\- Config: filename_encryption -\- Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION -\- Type: string -\- Default: \[dq]standard\[dq] -\- Examples: - \- \[dq]standard\[dq] - \- Encrypt the filenames see the docs for the details. - \- \[dq]obfuscate\[dq] - \- Very simple filename obfuscation. - \- \[dq]off\[dq] - \- Don\[aq]t encrypt the file names. Adds a \[dq].bin\[dq] extension only. - -#### \-\-crypt\-directory\-name\-encryption - +Choose a number from below, or type in your own value + 1 / Don\[aq]t encrypt the file names. Adds a \[dq].bin\[dq] extension only. + \[rs] \[dq]off\[dq] + 2 / Encrypt the filenames see the docs for the details. + \[rs] \[dq]standard\[dq] + 3 / Very simple filename obfuscation. + \[rs] \[dq]obfuscate\[dq] +filename_encryption> 2 Option to either encrypt directory names or leave them intact. - -NB If filename_encryption is \[dq]off\[dq] then this option will do nothing. - -\- Config: directory_name_encryption -\- Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION -\- Type: bool -\- Default: true -\- Examples: - \- \[dq]true\[dq] - \- Encrypt directory names. - \- \[dq]false\[dq] - \- Don\[aq]t encrypt directory names, leave them intact. - -#### \-\-crypt\-password - +Choose a number from below, or type in your own value + 1 / Encrypt directory names. + \[rs] \[dq]true\[dq] + 2 / Don\[aq]t encrypt directory names, leave them intact. + \[rs] \[dq]false\[dq] +filename_encryption> 1 Password or pass phrase for encryption. - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: password -\- Env Var: RCLONE_CRYPT_PASSWORD -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-crypt\-password2 - +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: +password: +Confirm the password: +password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: password2 -\- Env Var: RCLONE_CRYPT_PASSWORD2 -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - -Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). - -#### \-\-crypt\-server\-side\-across\-configs - -Allow server side operations (eg copy) to work across different crypt configs. - +y) Yes type in my own password +g) Generate random password +n) No leave this optional password blank +y/g/n> g +Password strength in bits. +64 is just about memorable +128 is secure +1024 is the maximum +Bits> 128 +Your password is: JAsJvRcgR\-_veXNfy_sGmQ +Use this password? +y) Yes +n) No +y/n> y +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[secret] +remote = remote:path +filename_encryption = standard +password = *** ENCRYPTED *** +password2 = *** ENCRYPTED *** +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +\f[B]Important\f[R] The password is stored in the config file is lightly +obscured so it isn\[aq]t immediately obvious what it is. +It is in no way secure unless you use config file encryption. +.PP +A long passphrase is recommended, or you can use a random one. +.PP +The obscured password is created by using AES\-CTR with a static key, +with the salt stored verbatim at the beginning of the obscured password. +This static key is shared by between all versions of rclone. +.PP +If you reconfigure rclone with the same passwords/passphrases elsewhere +it will be compatible, but the obscured version will be different due to +the different salt. +.PP +Note that rclone does not encrypt +.IP \[bu] 2 +file length \- this can be calculated within 16 bytes +.IP \[bu] 2 +modification time \- used for syncing +.SS Specifying the remote +.PP +In normal use, make sure the remote has a \f[C]:\f[R] in. +If you specify the remote without a \f[C]:\f[R] then rclone will use a +local directory of that name. +So if you use a remote of \f[C]/path/to/secret/files\f[R] then rclone +will encrypt stuff to that directory. +If you use a remote of \f[C]name\f[R] then rclone will put files in a +directory called \f[C]name\f[R] in the current directory. +.PP +If you specify the remote as \f[C]remote:path/to/dir\f[R] then rclone +will store encrypted files in \f[C]path/to/dir\f[R] on the remote. +If you are using file name encryption, then when you save files to +\f[C]secret:subdir/subfile\f[R] this will store them in the unencrypted +path \f[C]path/to/dir\f[R] but the \f[C]subdir/subpath\f[R] bit will be +encrypted. +.PP +Note that unless you want encrypted bucket names (which are difficult to +manage because you won\[aq]t know what directory they represent in web +interfaces etc), you should probably specify a bucket, eg +\f[C]remote:secretbucket\f[R] when using bucket based remotes such as +S3, Swift, Hubic, B2, GCS. +.SS Example +.PP +To test I made a little directory of files using \[dq]standard\[dq] file +name encryption. +.IP +.nf +\f[C] +plaintext/ +\[u251C]\[u2500]\[u2500] file0.txt +\[u251C]\[u2500]\[u2500] file1.txt +\[u2514]\[u2500]\[u2500] subdir + \[u251C]\[u2500]\[u2500] file2.txt + \[u251C]\[u2500]\[u2500] file3.txt + \[u2514]\[u2500]\[u2500] subsubdir + \[u2514]\[u2500]\[u2500] file4.txt +\f[R] +.fi +.PP +Copy these to the remote and list them back +.IP +.nf +\f[C] +$ rclone \-q copy plaintext secret: +$ rclone \-q ls secret: + 7 file1.txt + 6 file0.txt + 8 subdir/file2.txt + 10 subdir/subsubdir/file4.txt + 9 subdir/file3.txt +\f[R] +.fi +.PP +Now see what that looked like when encrypted +.IP +.nf +\f[C] +$ rclone \-q ls remote:path + 55 hagjclgavj2mbiqm6u6cnjjqcg + 54 v05749mltvv1tf4onltun46gls + 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo + 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc + 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps +\f[R] +.fi +.PP +Note that this retains the directory structure which means you can do +this +.IP +.nf +\f[C] +$ rclone \-q ls secret:subdir + 8 file2.txt + 9 file3.txt + 10 subsubdir/file4.txt +\f[R] +.fi +.PP +If don\[aq]t use file name encryption then the remote will look like +this \- note the \f[C].bin\f[R] extensions added to prevent the cloud +provider attempting to interpret the data. +.IP +.nf +\f[C] +$ rclone \-q ls remote:path + 54 file0.txt.bin + 57 subdir/file3.txt.bin + 56 subdir/file2.txt.bin + 58 subdir/subsubdir/file4.txt.bin + 55 file1.txt.bin +\f[R] +.fi +.SS File name encryption modes +.PP +Here are some of the features of the file name encryption modes +.PP +Off +.IP \[bu] 2 +doesn\[aq]t hide file names or directory structure +.IP \[bu] 2 +allows for longer file names (\[ti]246 characters) +.IP \[bu] 2 +can use sub paths and copy single files +.PP +Standard +.IP \[bu] 2 +file names encrypted +.IP \[bu] 2 +file names can\[aq]t be as long (\[ti]143 characters) +.IP \[bu] 2 +can use sub paths and copy single files +.IP \[bu] 2 +directory structure visible +.IP \[bu] 2 +identical files names will have identical uploaded names +.IP \[bu] 2 +can use shortcuts to shorten the directory recursion +.PP +Obfuscation +.PP +This is a simple \[dq]rotate\[dq] of the filename, with each file having +a rot distance based on the filename. +We store the distance at the beginning of the filename. +So a file called \[dq]hello\[dq] may become \[dq]53.jgnnq\[dq]. +.PP +This is not a strong encryption of filenames, but it may stop automated +scanning tools from picking up on filename patterns. +As such it\[aq]s an intermediate between \[dq]off\[dq] and +\[dq]standard\[dq]. +The advantage is that it allows for longer path segment names. +.PP +There is a possibility with some unicode based filenames that the +obfuscation is weak and may map lower case characters to upper case +equivalents. +You can not rely on this for strong protection. +.IP \[bu] 2 +file names very lightly obfuscated +.IP \[bu] 2 +file names can be longer than standard encryption +.IP \[bu] 2 +can use sub paths and copy single files +.IP \[bu] 2 +directory structure visible +.IP \[bu] 2 +identical files names will have identical uploaded names +.PP +Cloud storage systems have various limits on file name length and total +path length which you are more likely to hit using \[dq]Standard\[dq] +file name encryption. +If you keep your file names to below 156 characters in length then you +should be OK on all providers. +.PP +There may be an even more secure file name encryption mode in the future +which will address the long file name problem. +.SS Directory name encryption +.PP +Crypt offers the option of encrypting dir names or leaving them intact. +There are two options: +.PP +True +.PP +Encrypts the whole file path including directory names Example: +\f[C]1/12/123.txt\f[R] is encrypted to +\f[C]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\f[R] +.PP +False +.PP +Only encrypts file names, skips directory names Example: +\f[C]1/12/123.txt\f[R] is encrypted to +\f[C]1/12/qgm4avr35m5loi1th53ato71v0\f[R] +.SS Modified time and hashes +.PP +Crypt stores modification times using the underlying remote so support +depends on that. +.PP +Hashes are not stored for crypt. +However the data integrity is protected by an extremely strong crypto +authenticator. +.PP +Note that you should use the \f[C]rclone cryptcheck\f[R] command to +check the integrity of a crypted remote instead of +\f[C]rclone check\f[R] which can\[aq]t check the checksums properly. +.SS Standard Options +.PP +Here are the standard options specific to crypt (Encrypt/Decrypt a +remote). +.SS \-\-crypt\-remote +.PP +Remote to encrypt/decrypt. +Normally should contain a \[aq]:\[aq] and a path, eg +\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe +\[dq]myremote:\[dq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-crypt\-filename\-encryption +.PP +How to encrypt the filenames. +.IP \[bu] 2 +Config: filename_encryption +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]standard\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]standard\[dq] +.RS 2 +.IP \[bu] 2 +Encrypt the filenames see the docs for the details. +.RE +.IP \[bu] 2 +\[dq]obfuscate\[dq] +.RS 2 +.IP \[bu] 2 +Very simple filename obfuscation. +.RE +.IP \[bu] 2 +\[dq]off\[dq] +.RS 2 +.IP \[bu] 2 +Don\[aq]t encrypt the file names. +Adds a \[dq].bin\[dq] extension only. +.RE +.RE +.SS \-\-crypt\-directory\-name\-encryption +.PP +Option to either encrypt directory names or leave them intact. +.PP +NB If filename_encryption is \[dq]off\[dq] then this option will do +nothing. +.IP \[bu] 2 +Config: directory_name_encryption +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]true\[dq] +.RS 2 +.IP \[bu] 2 +Encrypt directory names. +.RE +.IP \[bu] 2 +\[dq]false\[dq] +.RS 2 +.IP \[bu] 2 +Don\[aq]t encrypt directory names, leave them intact. +.RE +.RE +.SS \-\-crypt\-password +.PP +Password or pass phrase for encryption. +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: password +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-crypt\-password2 +.PP +Password or pass phrase for salt. +Optional but recommended. +Should be different to the previous password. +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: password2 +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_PASSWORD2 +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to crypt (Encrypt/Decrypt a +remote). +.SS \-\-crypt\-server\-side\-across\-configs +.PP +Allow server side operations (eg copy) to work across different crypt +configs. +.PP Normally this option is not what you want, but if you have two crypts pointing to the same backend you can use it. - +.PP This can be used, for example, to change file name encryption type -without re\-uploading all the data. Just make two crypt backends -pointing to two different directories with the single changed -parameter and use rclone move to move the files between the crypt -remotes. - -\- Config: server_side_across_configs -\- Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS -\- Type: bool -\- Default: false - -#### \-\-crypt\-show\-mapping - +without re\-uploading all the data. +Just make two crypt backends pointing to two different directories with +the single changed parameter and use rclone move to move the files +between the crypt remotes. +.IP \[bu] 2 +Config: server_side_across_configs +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-crypt\-show\-mapping +.PP For all files listed show how the names encrypt. - -If this flag is set then for each file that the remote is asked to -list, it will log (at level INFO) a line stating the decrypted file -name and the encrypted file name. - +.PP +If this flag is set then for each file that the remote is asked to list, +it will log (at level INFO) a line stating the decrypted file name and +the encrypted file name. +.PP This is so you can work out which encrypted names are which decrypted names just in case you need to do something with the encrypted file names, or for debugging purposes. - -\- Config: show_mapping -\- Env Var: RCLONE_CRYPT_SHOW_MAPPING -\- Type: bool -\- Default: false - -### Backend commands - +.IP \[bu] 2 +Config: show_mapping +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_SHOW_MAPPING +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Backend commands +.PP Here are the commands specific to the crypt backend. - +.PP Run them with - - rclone backend COMMAND remote: - +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### encode - +backend/command (https://rclone.org/rc/#backend/command). +.SS encode +.PP Encode the given filename(s) - - rclone backend encode remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend encode remote: [options] [+] +\f[R] +.fi +.PP This encodes the filenames given as arguments returning a list of strings of the encoded results. - +.PP Usage Example: - - rclone backend encode crypt: file1 [file2...] - rclone rc backend/command command=encode fs=crypt: file1 [file2...] - - -#### decode - +.IP +.nf +\f[C] +rclone backend encode crypt: file1 [file2...] +rclone rc backend/command command=encode fs=crypt: file1 [file2...] +\f[R] +.fi +.SS decode +.PP Decode the given filename(s) - - rclone backend decode remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend decode remote: [options] [+] +\f[R] +.fi +.PP This decodes the filenames given as arguments returning a list of -strings of the decoded results. It will return an error if any of the -inputs are invalid. - +strings of the decoded results. +It will return an error if any of the inputs are invalid. +.PP Usage Example: - - rclone backend decode crypt: encryptedfile1 [encryptedfile2...] - rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] - - - - -## Backing up a crypted remote ## - +.IP +.nf +\f[C] +rclone backend decode crypt: encryptedfile1 [encryptedfile2...] +rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] +\f[R] +.fi +.SS Backing up a crypted remote +.PP If you wish to backup a crypted remote, it is recommended that you use -\[ga]rclone sync\[ga] on the encrypted files, and make sure the passwords are -the same in the new encrypted remote. - +\f[C]rclone sync\f[R] on the encrypted files, and make sure the +passwords are the same in the new encrypted remote. +.PP This will have the following advantages - - * \[ga]rclone sync\[ga] will check the checksums while copying - * you can use \[ga]rclone check\[ga] between the encrypted remotes - * you don\[aq]t decrypt and encrypt unnecessarily - -For example, let\[aq]s say you have your original remote at \[ga]remote:\[ga] with -the encrypted version at \[ga]eremote:\[ga] with path \[ga]remote:crypt\[ga]. You -would then set up the new remote \[ga]remote2:\[ga] and then the encrypted -version \[ga]eremote2:\[ga] with path \[ga]remote2:crypt\[ga] using the same passwords -as \[ga]eremote:\[ga]. - +.IP \[bu] 2 +\f[C]rclone sync\f[R] will check the checksums while copying +.IP \[bu] 2 +you can use \f[C]rclone check\f[R] between the encrypted remotes +.IP \[bu] 2 +you don\[aq]t decrypt and encrypt unnecessarily +.PP +For example, let\[aq]s say you have your original remote at +\f[C]remote:\f[R] with the encrypted version at \f[C]eremote:\f[R] with +path \f[C]remote:crypt\f[R]. +You would then set up the new remote \f[C]remote2:\f[R] and then the +encrypted version \f[C]eremote2:\f[R] with path \f[C]remote2:crypt\f[R] +using the same passwords as \f[C]eremote:\f[R]. +.PP To sync the two remotes you would do - - rclone sync \-i remote:crypt remote2:crypt - +.IP +.nf +\f[C] +rclone sync \-i remote:crypt remote2:crypt +\f[R] +.fi +.PP And to check the integrity you would do - - rclone check remote:crypt remote2:crypt - -## File formats ## - -### File encryption ### - -Files are encrypted 1:1 source file to destination object. The file -has a header and is divided into chunks. - -#### Header #### - - * 8 bytes magic string \[ga]RCLONE\[rs]x00\[rs]x00\[ga] - * 24 bytes Nonce (IV) - -The initial nonce is generated from the operating systems crypto -strong random number generator. The nonce is incremented for each -chunk read making sure each nonce is unique for each block written. -The chance of a nonce being re\-used is minuscule. If you wrote an -exabyte of data (10\[S1]\[u2078] bytes) you would have a probability of -approximately 2\[tmu]10\[u207B]\[S3]\[S2] of re\-using a nonce. - -#### Chunk #### - -Each chunk will contain 64kB of data, except for the last one which -may have less data. The data chunk is in standard NACL secretbox -format. Secretbox uses XSalsa20 and Poly1305 to encrypt and -authenticate messages. - +.IP +.nf +\f[C] +rclone check remote:crypt remote2:crypt +\f[R] +.fi +.SS File formats +.SS File encryption +.PP +Files are encrypted 1:1 source file to destination object. +The file has a header and is divided into chunks. +.SS Header +.IP \[bu] 2 +8 bytes magic string \f[C]RCLONE\[rs]x00\[rs]x00\f[R] +.IP \[bu] 2 +24 bytes Nonce (IV) +.PP +The initial nonce is generated from the operating systems crypto strong +random number generator. +The nonce is incremented for each chunk read making sure each nonce is +unique for each block written. +The chance of a nonce being re\-used is minuscule. +If you wrote an exabyte of data (10\[S1]\[u2078] bytes) you would have a +probability of approximately 2\[tmu]10\[u207B]\[S3]\[S2] of re\-using a +nonce. +.SS Chunk +.PP +Each chunk will contain 64kB of data, except for the last one which may +have less data. +The data chunk is in standard NACL secretbox format. +Secretbox uses XSalsa20 and Poly1305 to encrypt and authenticate +messages. +.PP Each chunk contains: - - * 16 Bytes of Poly1305 authenticator - * 1 \- 65536 bytes XSalsa20 encrypted data - +.IP \[bu] 2 +16 Bytes of Poly1305 authenticator +.IP \[bu] 2 +1 \- 65536 bytes XSalsa20 encrypted data +.PP 64k chunk size was chosen as the best performing chunk size (the authenticator takes too much time below this and the performance drops -off due to cache effects above this). Note that these chunks are -buffered in memory so they can\[aq]t be too big. - +off due to cache effects above this). +Note that these chunks are buffered in memory so they can\[aq]t be too +big. +.PP This uses a 32 byte (256 bit key) key derived from the user password. - -#### Examples #### - +.SS Examples +.PP 1 byte file will encrypt to - - * 32 bytes header - * 17 bytes data chunk - +.IP \[bu] 2 +32 bytes header +.IP \[bu] 2 +17 bytes data chunk +.PP 49 bytes total - +.PP 1MB (1048576 bytes) file will encrypt to - - * 32 bytes header - * 16 chunks of 65568 bytes - -1049120 bytes total (a 0.05% overhead). This is the overhead for big -files. - -### Name encryption ### - +.IP \[bu] 2 +32 bytes header +.IP \[bu] 2 +16 chunks of 65568 bytes +.PP +1049120 bytes total (a 0.05% overhead). +This is the overhead for big files. +.SS Name encryption +.PP File names are encrypted segment by segment \- the path is broken up -into \[ga]/\[ga] separated strings and these are encrypted individually. - -File segments are padded using PKCS#7 to a multiple of 16 bytes -before encryption. - -They are then encrypted with EME using AES with 256 bit key. EME -(ECB\-Mix\-ECB) is a wide\-block encryption mode presented in the 2003 -paper \[dq]A Parallelizable Enciphering Mode\[dq] by Halevi and Rogaway. - +into \f[C]/\f[R] separated strings and these are encrypted individually. +.PP +File segments are padded using PKCS#7 to a multiple of 16 bytes before +encryption. +.PP +They are then encrypted with EME using AES with 256 bit key. +EME (ECB\-Mix\-ECB) is a wide\-block encryption mode presented in the +2003 paper \[dq]A Parallelizable Enciphering Mode\[dq] by Halevi and +Rogaway. +.PP This makes for deterministic encryption which is what we want \- the same filename must encrypt to the same thing otherwise we can\[aq]t find it on the cloud storage system. - +.PP This means that - - * filenames with the same name will encrypt the same - * filenames which start the same won\[aq]t have a common prefix - +.IP \[bu] 2 +filenames with the same name will encrypt the same +.IP \[bu] 2 +filenames which start the same won\[aq]t have a common prefix +.PP This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of which are derived from the user password. - +.PP After encryption they are written out using a modified version of -standard \[ga]base32\[ga] encoding as described in RFC4648. The standard -encoding is modified in two ways: - - * it becomes lower case (no\-one likes upper case filenames!) - * we strip the padding character \[ga]=\[ga] - -\[ga]base32\[ga] is used rather than the more efficient \[ga]base64\[ga] so rclone can be -used on case insensitive remotes (eg Windows, Amazon Drive). - -### Key derivation ### - -Rclone uses \[ga]scrypt\[ga] with parameters \[ga]N=16384, r=8, p=1\[ga] with an -optional user supplied salt (password2) to derive the 32+32+16 = 80 -bytes of key material required. If the user doesn\[aq]t supply a salt -then rclone uses an internal one. - -\[ga]scrypt\[ga] makes it impractical to mount a dictionary attack on rclone -encrypted data. For full protection against this you should always use -a salt. - - Dropbox -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]remote:path\[ga] - +standard \f[C]base32\f[R] encoding as described in RFC4648. +The standard encoding is modified in two ways: +.IP \[bu] 2 +it becomes lower case (no\-one likes upper case filenames!) +.IP \[bu] 2 +we strip the padding character \f[C]=\f[R] +.PP +\f[C]base32\f[R] is used rather than the more efficient \f[C]base64\f[R] +so rclone can be used on case insensitive remotes (eg Windows, Amazon +Drive). +.SS Key derivation +.PP +Rclone uses \f[C]scrypt\f[R] with parameters \f[C]N=16384, r=8, p=1\f[R] +with an optional user supplied salt (password2) to derive the 32+32+16 = +80 bytes of key material required. +If the user doesn\[aq]t supply a salt then rclone uses an internal one. +.PP +\f[C]scrypt\f[R] makes it impractical to mount a dictionary attack on +rclone encrypted data. +For full protection against this you should always use a salt. +.SS Dropbox +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP Dropbox paths may be as deep as required, eg -\[ga]remote:directory/subdirectory\[ga]. - +\f[C]remote:directory/subdirectory\f[R]. +.PP The initial setup for dropbox involves getting a token from Dropbox -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config \f[R] .fi -.IP "n)" 3 -New remote -.IP "o)" 3 -Delete remote -.IP "p)" 3 -Quit config e/n/d/q> n name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Dropbox \ \[dq]dropbox\[dq] [snip] Storage> dropbox Dropbox App Key \- -leave blank normally. -app_key> Dropbox App Secret \- leave blank normally. -app_secret> Remote config Please visit: +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +n) New remote +d) Delete remote +q) Quit config +e/n/d/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Dropbox + \[rs] \[dq]dropbox\[dq] +[snip] +Storage> dropbox +Dropbox App Key \- leave blank normally. +app_key> +Dropbox App Secret \- leave blank normally. +app_secret> +Remote config +Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] app_key = app_secret = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +app_key = +app_secret = token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.IP "q)" 3 -Yes this is OK -.IP "r)" 3 -Edit this remote -.IP "s)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -You can then use it like this, - -List directories in top level of your dropbox - - rclone lsd remote: - -List all the files in your dropbox - - rclone ls remote: - -To copy a local directory to a dropbox directory called backup - - rclone copy /home/source remote:backup - -### Dropbox for business ### - -Rclone supports Dropbox for business and Team Folders. - -When using Dropbox for business \[ga]remote:\[ga] and \[ga]remote:path/to/file\[ga] -will refer to your personal folder. - -If you wish to see Team Folders you must use a leading \[ga]/\[ga] in the -path, so \[ga]rclone lsd remote:/\[ga] will refer to the root and show you all -Team Folders and your User Folder. - -You can then use team folders like this \[ga]remote:/TeamFolder\[ga] and -\[ga]remote:/TeamFolder/path/to/file\[ga]. - -A leading \[ga]/\[ga] for a Dropbox personal account will do nothing, but it -will take an extra HTTP transaction so it should be avoided. - -### Modified time and Hashes ### - -Dropbox supports modified times, but the only way to set a -modification time is to re\-upload the file. - -This means that if you uploaded your data with an older version of -rclone which didn\[aq]t support the v2 API and modified times, rclone will -decide to upload all your old data to fix the modification times. If -you don\[aq]t want this to happen use \[ga]\-\-size\-only\[ga] or \[ga]\-\-checksum\[ga] flag -to stop it. - -Dropbox supports [its own hash -type](https://www.dropbox.com/developers/reference/content\-hash) which -is checked for all transfers. - -#### Restricted filename characters - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| / | 0x2F | \[uFF0F] | -| DEL | 0x7F | \[u2421] | -| \[rs] | 0x5C | \[uFF3C] | - -File names can also not end with the following characters. -These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - -Here are the standard options specific to dropbox (Dropbox). - -#### \-\-dropbox\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_DROPBOX_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_DROPBOX_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - -Here are the advanced options specific to dropbox (Dropbox). - -#### \-\-dropbox\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_DROPBOX_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_DROPBOX_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_DROPBOX_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-chunk\-size - -Upload chunk size. (< 150M). - -Any files larger than this will be uploaded in chunks of this size. - -Note that chunks are buffered in memory (one at a time) so rclone can -deal with retries. Setting this larger will increase the speed -slightly (at most 10% for 128MB in tests) at the cost of using more -memory. It can be set smaller if you are tight on memory. - -\- Config: chunk_size -\- Env Var: RCLONE_DROPBOX_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 48M - -#### \-\-dropbox\-impersonate - -Impersonate this user when using a business account. - -\- Config: impersonate -\- Env Var: RCLONE_DROPBOX_IMPERSONATE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_DROPBOX_ENCODING -\- Type: MultiEncoder -\- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - - - -### Limitations ### - -Note that Dropbox is case insensitive so you can\[aq]t have a file called -\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -There are some file names such as \[ga]thumbs.db\[ga] which Dropbox can\[aq]t -store. There is a full list of them in the [\[dq]Ignored Files\[dq] section -of this document](https://www.dropbox.com/en/help/145). Rclone will -issue an error message \[ga]File name disallowed \- not uploading\[ga] if it -attempts to upload one of those file names, but the sync won\[aq]t fail. - -Some errors may occur if you try to sync copyright\-protected files -because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how\-dropbox\-knows\-when\-youre\-sharing\-copyrighted\-stuff\-without\-actually\-looking\-at\-your\-stuff/) that -prevents this sort of file being downloaded. This will return the error \[ga]ERROR : -/path/to/your/file: Failed to copy: failed to open source object: -path/restricted_content/.\[ga] - -If you have more than 10,000 files in a directory then \[ga]rclone purge -dropbox:dir\[ga] will return the error \[ga]Failed to purge: There are too -many files involved in this operation\[ga]. As a work\-around do an -\[ga]rclone delete dropbox:dir\[ga] followed by an \[ga]rclone rmdir dropbox:dir\[ga]. - -### Get your own Dropbox App ID ### - -When you use rclone with Dropbox in its default configuration you are using rclone\[aq]s App ID. This is shared between all the rclone users. - -Here is how to create your own Dropbox App ID for rclone: - -1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not -to be the same account as the Dropbox you want to access) - -2. Choose an API => Usually this should be \[ga]Dropbox API\[ga] - -3. Choose the type of access you want to use => \[ga]Full Dropbox\[ga] or \[ga]App Folder\[ga] - -4. Name your App. The app name is global, so you can\[aq]t use \[ga]rclone\[ga] for example - -5. Click the button \[ga]Create App\[ga] - -5. Fill \[ga]Redirect URIs\[ga] as \[ga]http://localhost:53682/\[ga] - -6. Find the \[ga]App key\[ga] and \[ga]App secret\[ga] Use these values in rclone config to add a new remote or edit an existing remote. - - FTP -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -FTP is the File Transfer Protocol. FTP support is provided using the -[github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) -package. - -Paths are specified as \[ga]remote:path\[ga]. If the path does not begin with -a \[ga]/\[ga] it is relative to the home directory of the user. An empty path -\[ga]remote:\[ga] refers to the user\[aq]s home directory. - -Here is an example of making an FTP configuration. First run - - rclone config - -This will guide you through an interactive setup process. An FTP remote only -needs a host together with and a username and a password. With anonymous FTP -server, you will need to use \[ga]anonymous\[ga] as username and your email address as -the password. +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y \f[R] .fi .PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] XX / FTP -Connection \ \[dq]ftp\[dq] [snip] Storage> ftp ** See help for ftp -backend at: https://rclone.org/ftp/ ** +You can then use it like this, .PP -FTP host to connect to Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Connect to -ftp.example.com \ \[dq]ftp.example.com\[dq] host> ftp.example.com FTP -username, leave blank for current username, ncw Enter a string value. -Press Enter for the default (\[dq]\[dq]). -user> FTP port, leave blank to use default (21) Enter a string value. -Press Enter for the default (\[dq]\[dq]). -port> FTP password y) Yes type in my own password g) Generate random -password y/g> y Enter the password: password: Confirm the password: -password: Use FTP over TLS (Implicit) Enter a boolean value (true or -false). -Press Enter for the default (\[dq]false\[dq]). -tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). -Press Enter for the default (\[dq]false\[dq]). -explicit_tls> Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -[remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +List directories in top level of your dropbox .IP .nf \f[C] - -This remote is called \[ga]remote\[ga] and can now be used like this - -See all directories in the home directory - - rclone lsd remote: - -Make a new directory - - rclone mkdir remote:path/to/directory - -List the contents of a directory - - rclone ls remote:path/to/directory - -Sync \[ga]/home/local/directory\[ga] to the remote directory, deleting any -excess files in the directory. - - rclone sync \-i /home/local/directory remote:directory - -### Modified time ### - -FTP does not support modified times. Any times you see on the server -will be time of upload. - -### Checksums ### - -FTP does not support any checksums. - -### Usage without a config file ### - -An example how to use the ftp remote without a config file: - - rclone lsf :ftp: \-\-ftp\-host=speedtest.tele2.net \-\-ftp\-user=anonymous \-\-ftp\-pass=\[ga]rclone obscure dummy\[ga] - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your dropbox +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to a dropbox directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Dropbox for business +.PP +Rclone supports Dropbox for business and Team Folders. +.PP +When using Dropbox for business \f[C]remote:\f[R] and +\f[C]remote:path/to/file\f[R] will refer to your personal folder. +.PP +If you wish to see Team Folders you must use a leading \f[C]/\f[R] in +the path, so \f[C]rclone lsd remote:/\f[R] will refer to the root and +show you all Team Folders and your User Folder. +.PP +You can then use team folders like this \f[C]remote:/TeamFolder\f[R] and +\f[C]remote:/TeamFolder/path/to/file\f[R]. +.PP +A leading \f[C]/\f[R] for a Dropbox personal account will do nothing, +but it will take an extra HTTP transaction so it should be avoided. +.SS Modified time and Hashes +.PP +Dropbox supports modified times, but the only way to set a modification +time is to re\-upload the file. +.PP +This means that if you uploaded your data with an older version of +rclone which didn\[aq]t support the v2 API and modified times, rclone +will decide to upload all your old data to fix the modification times. +If you don\[aq]t want this to happen use \f[C]\-\-size\-only\f[R] or +\f[C]\-\-checksum\f[R] flag to stop it. +.PP +Dropbox supports its own hash +type (https://www.dropbox.com/developers/reference/content-hash) which +is checked for all transfers. +.SS Restricted filename characters +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +T{ +DEL +T}@T{ +0x7F +T}@T{ +\[u2421] +T} +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP File names can also not end with the following characters. These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Note that not all FTP servers can have all characters in file names, for example: - -| FTP Server| Forbidden characters | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:| -| proftpd | \[ga]*\[ga] | -| pureftpd | \[ga]\[rs] [ ]\[ga] | - -### Implicit TLS ### - -FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled -in the config for the remote. The default FTPS port is \[ga]990\[ga] so the -port will likely have to be explicitly set in the config for the remote. - - -### Standard Options - -Here are the standard options specific to ftp (FTP Connection). - -#### \-\-ftp\-host +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to dropbox (Dropbox). +.SS \-\-dropbox\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to dropbox (Dropbox). +.SS \-\-dropbox\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-chunk\-size +.PP +Upload chunk size. +(< 150M). +.PP +Any files larger than this will be uploaded in chunks of this size. +.PP +Note that chunks are buffered in memory (one at a time) so rclone can +deal with retries. +Setting this larger will increase the speed slightly (at most 10% for +128MB in tests) at the cost of using more memory. +It can be set smaller if you are tight on memory. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 48M +.SS \-\-dropbox\-impersonate +.PP +Impersonate this user when using a business account. +.IP \[bu] 2 +Config: impersonate +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_IMPERSONATE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot +.SS Limitations +.PP +Note that Dropbox is case insensitive so you can\[aq]t have a file +called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +There are some file names such as \f[C]thumbs.db\f[R] which Dropbox +can\[aq]t store. +There is a full list of them in the \[dq]Ignored Files\[dq] section of +this document (https://www.dropbox.com/en/help/145). +Rclone will issue an error message +\f[C]File name disallowed \- not uploading\f[R] if it attempts to upload +one of those file names, but the sync won\[aq]t fail. +.PP +Some errors may occur if you try to sync copyright\-protected files +because Dropbox has its own copyright +detector (https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) +that prevents this sort of file being downloaded. +This will return the error +\f[C]ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/.\f[R] +.PP +If you have more than 10,000 files in a directory then +\f[C]rclone purge dropbox:dir\f[R] will return the error +\f[C]Failed to purge: There are too many files involved in this operation\f[R]. +As a work\-around do an \f[C]rclone delete dropbox:dir\f[R] followed by +an \f[C]rclone rmdir dropbox:dir\f[R]. +.SS Get your own Dropbox App ID +.PP +When you use rclone with Dropbox in its default configuration you are +using rclone\[aq]s App ID. +This is shared between all the rclone users. +.PP +Here is how to create your own Dropbox App ID for rclone: +.IP "1." 3 +Log into the Dropbox App +console (https://www.dropbox.com/developers/apps/create) with your +Dropbox Account (It need not to be the same account as the Dropbox you +want to access) +.IP "2." 3 +Choose an API => Usually this should be \f[C]Dropbox API\f[R] +.IP "3." 3 +Choose the type of access you want to use => \f[C]Full Dropbox\f[R] or +\f[C]App Folder\f[R] +.IP "4." 3 +Name your App. +The app name is global, so you can\[aq]t use \f[C]rclone\f[R] for +example +.IP "5." 3 +Click the button \f[C]Create App\f[R] +.IP "6." 3 +Fill \f[C]Redirect URIs\f[R] as \f[C]http://localhost:53682/\f[R] +.IP "7." 3 +Find the \f[C]App key\f[R] and \f[C]App secret\f[R] Use these values in +rclone config to add a new remote or edit an existing remote. +.SS FTP +.PP +FTP is the File Transfer Protocol. +FTP support is provided using the +github.com/jlaffaye/ftp (https://godoc.org/github.com/jlaffaye/ftp) +package. +.PP +Paths are specified as \f[C]remote:path\f[R]. +If the path does not begin with a \f[C]/\f[R] it is relative to the home +directory of the user. +An empty path \f[C]remote:\f[R] refers to the user\[aq]s home directory. +.PP +Here is an example of making an FTP configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +An FTP remote only needs a host together with and a username and a +password. +With anonymous FTP server, you will need to use \f[C]anonymous\f[R] as +username and your email address as the password. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / FTP Connection + \[rs] \[dq]ftp\[dq] +[snip] +Storage> ftp +** See help for ftp backend at: https://rclone.org/ftp/ ** FTP host to connect to - -\- Config: host -\- Env Var: RCLONE_FTP_HOST -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]ftp.example.com\[dq] - \- Connect to ftp.example.com - -#### \-\-ftp\-user - -FTP username, leave blank for current username, $USER - -\- Config: user -\- Env Var: RCLONE_FTP_USER -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-ftp\-port - +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Connect to ftp.example.com + \[rs] \[dq]ftp.example.com\[dq] +host> ftp.example.com +FTP username, leave blank for current username, ncw +Enter a string value. Press Enter for the default (\[dq]\[dq]). +user> FTP port, leave blank to use default (21) - -\- Config: port -\- Env Var: RCLONE_FTP_PORT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-ftp\-pass - +Enter a string value. Press Enter for the default (\[dq]\[dq]). +port> FTP password - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: pass -\- Env Var: RCLONE_FTP_PASS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-ftp\-tls - -Use FTPS over TLS (Implicit) -When using implicit FTP over TLS the client will connect using TLS -right from the start, which in turn breaks the compatibility with -non\-TLS\-aware servers. This is usually served over port 990 rather -than port 21. Cannot be used in combination with explicit FTP. - -\- Config: tls -\- Env Var: RCLONE_FTP_TLS -\- Type: bool -\- Default: false - -#### \-\-ftp\-explicit\-tls - +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: +password: +Confirm the password: +password: +Use FTP over TLS (Implicit) +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +tls> Use FTP over TLS (Explicit) -When using explicit FTP over TLS the client explicitly request -security from the server in order to upgrade a plain text connection -to an encrypted one. Cannot be used in combination with implicit FTP. - -\- Config: explicit_tls -\- Env Var: RCLONE_FTP_EXPLICIT_TLS -\- Type: bool -\- Default: false - -### Advanced Options - -Here are the advanced options specific to ftp (FTP Connection). - -#### \-\-ftp\-concurrency - -Maximum number of FTP simultaneous connections, 0 for unlimited - -\- Config: concurrency -\- Env Var: RCLONE_FTP_CONCURRENCY -\- Type: int -\- Default: 0 - -#### \-\-ftp\-no\-check\-certificate - -Do not verify the TLS certificate of the server - -\- Config: no_check_certificate -\- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE -\- Type: bool -\- Default: false - -#### \-\-ftp\-disable\-epsv - -Disable using EPSV even if server advertises support - -\- Config: disable_epsv -\- Env Var: RCLONE_FTP_DISABLE_EPSV -\- Type: bool -\- Default: false - -#### \-\-ftp\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_FTP_ENCODING -\- Type: MultiEncoder -\- Default: Slash,Del,Ctl,RightSpace,Dot - - - -### Limitations ### - -Note that FTP does have its own implementation of : \[ga]\-\-dump headers\[ga], -\[ga]\-\-dump bodies\[ga], \[ga]\-\-dump auth\[ga] for debugging which isn\[aq]t the same as -the HTTP based backends \- it has less fine grained control. - -Note that \[ga]\-\-timeout\[ga] isn\[aq]t supported (but \[ga]\-\-contimeout\[ga] is). - -Note that \[ga]\-\-bind\[ga] isn\[aq]t supported. - -FTP could support server side move but doesn\[aq]t yet. - -Note that the ftp backend does not support the \[ga]ftp_proxy\[ga] environment -variable yet. - - Google Cloud Storage -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]remote:bucket\[ga] (or \[ga]remote:\[ga] for the \[ga]lsd\[ga] -command.) You may put subdirectories in too, eg \[ga]remote:bucket/path/to/dir\[ga]. - -The initial setup for google cloud storage involves getting a token from Google Cloud Storage -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +explicit_tls> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = ftp +host = ftp.example.com +pass = *** ENCRYPTED *** +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y \f[R] .fi -.IP "n)" 3 -New remote -.IP "o)" 3 -Delete remote -.IP "p)" 3 -Quit config e/n/d/q> n name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Google -Cloud Storage (this is not Google Drive) \ \[dq]google cloud -storage\[dq] [snip] Storage> google cloud storage Google Application -Client Id \- leave blank normally. -client_id> Google Application Client Secret \- leave blank normally. -client_secret> Project number optional \- needed only for -list/create/delete buckets \- see your developer console. -project_number> 12345678 Service Account Credentials JSON file path \- -needed only if you want use SA instead of interactive login. -service_account_file> Access Control List for new objects. -Choose a number from below, or type in your own value 1 / Object owner -gets OWNER access, and all Authenticated Users get READER access. -\ \[dq]authenticatedRead\[dq] 2 / Object owner gets OWNER access, and -project team owners get OWNER access. -\ \[dq]bucketOwnerFullControl\[dq] 3 / Object owner gets OWNER access, -and project team owners get READER access. -\ \[dq]bucketOwnerRead\[dq] 4 / Object owner gets OWNER access [default -if left blank]. -\ \[dq]private\[dq] 5 / Object owner gets OWNER access, and project team -members get access according to their roles. -\ \[dq]projectPrivate\[dq] 6 / Object owner gets OWNER access, and all -Users get READER access. -\ \[dq]publicRead\[dq] object_acl> 4 Access Control List for new -buckets. -Choose a number from below, or type in your own value 1 / Project team -owners get OWNER access, and all Authenticated Users get READER access. -\ \[dq]authenticatedRead\[dq] 2 / Project team owners get OWNER access -[default if left blank]. -\ \[dq]private\[dq] 3 / Project team members get access according to -their roles. -\ \[dq]projectPrivate\[dq] 4 / Project team owners get OWNER access, and -all Users get READER access. -\ \[dq]publicRead\[dq] 5 / Project team owners get OWNER access, and all -Users get WRITER access. -\ \[dq]publicReadWrite\[dq] bucket_acl> 2 Location for the newly created -buckets. -Choose a number from below, or type in your own value 1 / Empty for -default location (US). -\ \[dq]\[dq] 2 / Multi\-regional location for Asia. -\ \[dq]asia\[dq] 3 / Multi\-regional location for Europe. -\ \[dq]eu\[dq] 4 / Multi\-regional location for United States. -\ \[dq]us\[dq] 5 / Taiwan. -\ \[dq]asia\-east1\[dq] 6 / Tokyo. -\ \[dq]asia\-northeast1\[dq] 7 / Singapore. -\ \[dq]asia\-southeast1\[dq] 8 / Sydney. -\ \[dq]australia\-southeast1\[dq] 9 / Belgium. -\ \[dq]europe\-west1\[dq] 10 / London. -\ \[dq]europe\-west2\[dq] 11 / Iowa. -\ \[dq]us\-central1\[dq] 12 / South Carolina. -\ \[dq]us\-east1\[dq] 13 / Northern Virginia. -\ \[dq]us\-east4\[dq] 14 / Oregon. -\ \[dq]us\-west1\[dq] location> 12 The storage class to use when storing -objects in Google Cloud Storage. -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Multi\-regional storage class -\ \[dq]MULTI_REGIONAL\[dq] 3 / Regional storage class -\ \[dq]REGIONAL\[dq] 4 / Nearline storage class \ \[dq]NEARLINE\[dq] 5 / -Coldline storage class \ \[dq]COLDLINE\[dq] 6 / Durable reduced -availability storage class \ \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] -storage_class> 5 Remote config Use auto config? -.IP \[bu] 2 -Say Y if not sure -.IP \[bu] 2 -Say N if you are working on a remote or headless machine or Y didn\[aq]t -work -.IP "y)" 3 -Yes -.IP "z)" 3 -No y/n> y If your browser doesn\[aq]t open automatically go to the -following link: http://127.0.0.1:53682/auth Log in and authorize rclone -for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = google -cloud storage client_id = client_secret = token = -{\[dq]AccessToken\[dq]:\[dq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-07\-17T20:49:14.929208288+01:00\[dq],\[dq]Extra\[dq]:null} -project_number = 12345678 object_acl = private bucket_acl = private -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.IP "a)" 3 -Yes this is OK -.IP "b)" 3 -Edit this remote -.IP "c)" 3 -Delete this remote y/e/d> y +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP +See all directories in the home directory .IP .nf \f[C] - -Note that rclone runs a webserver on your local machine to collect the -token as returned from Google if you use auto config mode. This only -runs from the moment it opens your browser to the moment you get back -the verification code. This is on \[ga]http://127.0.0.1:53682/\[ga] and this -it may require you to unblock it temporarily if you are running a host -firewall, or use manual mode. - -This remote is called \[ga]remote\[ga] and can now be used like this - -See all the buckets in your project - - rclone lsd remote: - -Make a new bucket - - rclone mkdir remote:bucket - -List the contents of a bucket - - rclone ls remote:bucket - -Sync \[ga]/home/local/directory\[ga] to the remote bucket, deleting any excess -files in the bucket. - - rclone sync \-i /home/local/directory remote:bucket - -### Service Account support ### - -You can set up rclone with Google Cloud Storage in an unattended mode, -i.e. not tied to a specific end\-user Google account. This is useful -when you want to synchronise files onto machines that don\[aq]t have -actively logged\-in users, for example build machines. - -To get credentials for Google Cloud Platform -[IAM Service Accounts](https://cloud.google.com/iam/docs/service\-accounts), -please head to the -[Service Account](https://console.cloud.google.com/permissions/serviceaccounts) -section of the Google Developer Console. Service Accounts behave just -like normal \[ga]User\[ga] permissions in -[Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access\-control), -so you can limit their access (e.g. make them read only). After -creating an account, a JSON file containing the Service Account\[aq]s -credentials will be downloaded onto your machines. These credentials -are what rclone will use for authentication. - -To use a Service Account instead of OAuth2 token flow, enter the path -to your Service Account credentials at the \[ga]service_account_file\[ga] -prompt and rclone won\[aq]t use the browser based authentication -flow. If you\[aq]d rather stuff the contents of the credentials file into -the rclone config file, you can set \[ga]service_account_credentials\[ga] with -the actual contents of the file instead, or set the equivalent -environment variable. - -### Anonymous Access ### - -For downloads of objects that permit public access you can configure rclone -to use anonymous access by setting \[ga]anonymous\[ga] to \[ga]true\[ga]. -With unauthorized access you can\[aq]t write or create files but only read or list -those buckets and objects that have public read access. - -### Application Default Credentials ### - -If no other source of credentials is provided, rclone will fall back -to -[Application Default Credentials](https://cloud.google.com/video\-intelligence/docs/common/auth#authenticating_with_application_default_credentials) -this is useful both when you already have configured authentication -for your developer account, or in production when running on a google -compute host. Note that if running in docker, you may need to run -additional commands on your google compute machine \- -[see this page](https://cloud.google.com/container\-registry/docs/advanced\-authentication#gcloud_as_a_docker_credential_helper). - -Note that in the case application default credentials are used, there -is no need to explicitly configure a project number. - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -### Custom upload headers ### - -You can set custom upload headers with the \[ga]\-\-header\-upload\[ga] -flag. Google Cloud Storage supports the headers as described in the -[working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) - -\- Cache\-Control -\- Content\-Disposition -\- Content\-Encoding -\- Content\-Language -\- Content\-Type -\- X\-Goog\-Meta\- - -Eg \[ga]\-\-header\-upload \[dq]Content\-Type text/potato\[dq]\[ga] - -Note that the last of these is for setting custom metadata in the form -\[ga]\-\-header\-upload \[dq]x\-goog\-meta\-key: value\[dq]\[ga] - -### Modified time ### - -Google google cloud storage stores md5sums natively and rclone stores -modification times as metadata on the object, under the \[dq]mtime\[dq] key in -RFC3339 format accurate to 1ns. - -#### Restricted filename characters - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| LF | 0x0A | \[u240A] | -| CR | 0x0D | \[u240D] | -| / | 0x2F | \[uFF0F] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - -Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - -#### \-\-gcs\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_GCS_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_GCS_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-project\-number - -Project number. -Optional \- needed only for list/create/delete buckets \- see your developer console. - -\- Config: project_number -\- Env Var: RCLONE_GCS_PROJECT_NUMBER -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-service\-account\-file - -Service Account Credentials JSON file path -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -Leading \[ga]\[ti]\[ga] will be expanded in the file name as will environment variables such as \[ga]${RCLONE_CONFIG_DIR}\[ga]. - - -\- Config: service_account_file -\- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-service\-account\-credentials - -Service Account Credentials JSON blob -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -\- Config: service_account_credentials -\- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-anonymous - -Access public buckets and objects without credentials -Set to \[aq]true\[aq] if you just want to download files and don\[aq]t configure credentials. - -\- Config: anonymous -\- Env Var: RCLONE_GCS_ANONYMOUS -\- Type: bool -\- Default: false - -#### \-\-gcs\-object\-acl - +rclone lsd remote: +\f[R] +.fi +.PP +Make a new directory +.IP +.nf +\f[C] +rclone mkdir remote:path/to/directory +\f[R] +.fi +.PP +List the contents of a directory +.IP +.nf +\f[C] +rclone ls remote:path/to/directory +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote directory, deleting +any excess files in the directory. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:directory +\f[R] +.fi +.SS Modified time +.PP +FTP does not support modified times. +Any times you see on the server will be time of upload. +.SS Checksums +.PP +FTP does not support any checksums. +.SS Usage without a config file +.PP +An example how to use the ftp remote without a config file: +.IP +.nf +\f[C] +rclone lsf :ftp: \-\-ftp\-host=speedtest.tele2.net \-\-ftp\-user=anonymous \-\-ftp\-pass=\[ga]rclone obscure dummy\[ga] +\f[R] +.fi +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +File names can also not end with the following characters. +These only get replaced if they are the last character in the name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Note that not all FTP servers can have all characters in file names, for +example: +.PP +.TS +tab(@); +l c. +T{ +FTP Server +T}@T{ +Forbidden characters +T} +_ +T{ +proftpd +T}@T{ +\f[C]*\f[R] +T} +T{ +pureftpd +T}@T{ +\f[C]\[rs] [ ]\f[R] +T} +.TE +.SS Implicit TLS +.PP +FTP supports implicit FTP over TLS servers (FTPS). +This has to be enabled in the config for the remote. +The default FTPS port is \f[C]990\f[R] so the port will likely have to +be explicitly set in the config for the remote. +.SS Standard Options +.PP +Here are the standard options specific to ftp (FTP Connection). +.SS \-\-ftp\-host +.PP +FTP host to connect to +.IP \[bu] 2 +Config: host +.IP \[bu] 2 +Env Var: RCLONE_FTP_HOST +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]ftp.example.com\[dq] +.RS 2 +.IP \[bu] 2 +Connect to ftp.example.com +.RE +.RE +.SS \-\-ftp\-user +.PP +FTP username, leave blank for current username, $USER +.IP \[bu] 2 +Config: user +.IP \[bu] 2 +Env Var: RCLONE_FTP_USER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-ftp\-port +.PP +FTP port, leave blank to use default (21) +.IP \[bu] 2 +Config: port +.IP \[bu] 2 +Env Var: RCLONE_FTP_PORT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-ftp\-pass +.PP +FTP password +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: pass +.IP \[bu] 2 +Env Var: RCLONE_FTP_PASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-ftp\-tls +.PP +Use FTPS over TLS (Implicit) When using implicit FTP over TLS the client +will connect using TLS right from the start, which in turn breaks the +compatibility with non\-TLS\-aware servers. +This is usually served over port 990 rather than port 21. +Cannot be used in combination with explicit FTP. +.IP \[bu] 2 +Config: tls +.IP \[bu] 2 +Env Var: RCLONE_FTP_TLS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-explicit\-tls +.PP +Use FTP over TLS (Explicit) When using explicit FTP over TLS the client +explicitly request security from the server in order to upgrade a plain +text connection to an encrypted one. +Cannot be used in combination with implicit FTP. +.IP \[bu] 2 +Config: explicit_tls +.IP \[bu] 2 +Env Var: RCLONE_FTP_EXPLICIT_TLS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to ftp (FTP Connection). +.SS \-\-ftp\-concurrency +.PP +Maximum number of FTP simultaneous connections, 0 for unlimited +.IP \[bu] 2 +Config: concurrency +.IP \[bu] 2 +Env Var: RCLONE_FTP_CONCURRENCY +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 0 +.SS \-\-ftp\-no\-check\-certificate +.PP +Do not verify the TLS certificate of the server +.IP \[bu] 2 +Config: no_check_certificate +.IP \[bu] 2 +Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-disable\-epsv +.PP +Disable using EPSV even if server advertises support +.IP \[bu] 2 +Config: disable_epsv +.IP \[bu] 2 +Env Var: RCLONE_FTP_DISABLE_EPSV +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FTP_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Del,Ctl,RightSpace,Dot +.SS Limitations +.PP +Note that FTP does have its own implementation of : +\f[C]\-\-dump headers\f[R], \f[C]\-\-dump bodies\f[R], +\f[C]\-\-dump auth\f[R] for debugging which isn\[aq]t the same as the +HTTP based backends \- it has less fine grained control. +.PP +Note that \f[C]\-\-timeout\f[R] isn\[aq]t supported (but +\f[C]\-\-contimeout\f[R] is). +.PP +Note that \f[C]\-\-bind\f[R] isn\[aq]t supported. +.PP +FTP could support server side move but doesn\[aq]t yet. +.PP +Note that the ftp backend does not support the \f[C]ftp_proxy\f[R] +environment variable yet. +.SS Google Cloud Storage +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +The initial setup for google cloud storage involves getting a token from +Google Cloud Storage which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +n) New remote +d) Delete remote +q) Quit config +e/n/d/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Google Cloud Storage (this is not Google Drive) + \[rs] \[dq]google cloud storage\[dq] +[snip] +Storage> google cloud storage +Google Application Client Id \- leave blank normally. +client_id> +Google Application Client Secret \- leave blank normally. +client_secret> +Project number optional \- needed only for list/create/delete buckets \- see your developer console. +project_number> 12345678 +Service Account Credentials JSON file path \- needed only if you want use SA instead of interactive login. +service_account_file> Access Control List for new objects. - -\- Config: object_acl -\- Env Var: RCLONE_GCS_OBJECT_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]authenticatedRead\[dq] - \- Object owner gets OWNER access, and all Authenticated Users get READER access. - \- \[dq]bucketOwnerFullControl\[dq] - \- Object owner gets OWNER access, and project team owners get OWNER access. - \- \[dq]bucketOwnerRead\[dq] - \- Object owner gets OWNER access, and project team owners get READER access. - \- \[dq]private\[dq] - \- Object owner gets OWNER access [default if left blank]. - \- \[dq]projectPrivate\[dq] - \- Object owner gets OWNER access, and project team members get access according to their roles. - \- \[dq]publicRead\[dq] - \- Object owner gets OWNER access, and all Users get READER access. - -#### \-\-gcs\-bucket\-acl - +Choose a number from below, or type in your own value + 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. + \[rs] \[dq]authenticatedRead\[dq] + 2 / Object owner gets OWNER access, and project team owners get OWNER access. + \[rs] \[dq]bucketOwnerFullControl\[dq] + 3 / Object owner gets OWNER access, and project team owners get READER access. + \[rs] \[dq]bucketOwnerRead\[dq] + 4 / Object owner gets OWNER access [default if left blank]. + \[rs] \[dq]private\[dq] + 5 / Object owner gets OWNER access, and project team members get access according to their roles. + \[rs] \[dq]projectPrivate\[dq] + 6 / Object owner gets OWNER access, and all Users get READER access. + \[rs] \[dq]publicRead\[dq] +object_acl> 4 Access Control List for new buckets. - -\- Config: bucket_acl -\- Env Var: RCLONE_GCS_BUCKET_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]authenticatedRead\[dq] - \- Project team owners get OWNER access, and all Authenticated Users get READER access. - \- \[dq]private\[dq] - \- Project team owners get OWNER access [default if left blank]. - \- \[dq]projectPrivate\[dq] - \- Project team members get access according to their roles. - \- \[dq]publicRead\[dq] - \- Project team owners get OWNER access, and all Users get READER access. - \- \[dq]publicReadWrite\[dq] - \- Project team owners get OWNER access, and all Users get WRITER access. - -#### \-\-gcs\-bucket\-policy\-only - +Choose a number from below, or type in your own value + 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. + \[rs] \[dq]authenticatedRead\[dq] + 2 / Project team owners get OWNER access [default if left blank]. + \[rs] \[dq]private\[dq] + 3 / Project team members get access according to their roles. + \[rs] \[dq]projectPrivate\[dq] + 4 / Project team owners get OWNER access, and all Users get READER access. + \[rs] \[dq]publicRead\[dq] + 5 / Project team owners get OWNER access, and all Users get WRITER access. + \[rs] \[dq]publicReadWrite\[dq] +bucket_acl> 2 +Location for the newly created buckets. +Choose a number from below, or type in your own value + 1 / Empty for default location (US). + \[rs] \[dq]\[dq] + 2 / Multi\-regional location for Asia. + \[rs] \[dq]asia\[dq] + 3 / Multi\-regional location for Europe. + \[rs] \[dq]eu\[dq] + 4 / Multi\-regional location for United States. + \[rs] \[dq]us\[dq] + 5 / Taiwan. + \[rs] \[dq]asia\-east1\[dq] + 6 / Tokyo. + \[rs] \[dq]asia\-northeast1\[dq] + 7 / Singapore. + \[rs] \[dq]asia\-southeast1\[dq] + 8 / Sydney. + \[rs] \[dq]australia\-southeast1\[dq] + 9 / Belgium. + \[rs] \[dq]europe\-west1\[dq] +10 / London. + \[rs] \[dq]europe\-west2\[dq] +11 / Iowa. + \[rs] \[dq]us\-central1\[dq] +12 / South Carolina. + \[rs] \[dq]us\-east1\[dq] +13 / Northern Virginia. + \[rs] \[dq]us\-east4\[dq] +14 / Oregon. + \[rs] \[dq]us\-west1\[dq] +location> 12 +The storage class to use when storing objects in Google Cloud Storage. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Multi\-regional storage class + \[rs] \[dq]MULTI_REGIONAL\[dq] + 3 / Regional storage class + \[rs] \[dq]REGIONAL\[dq] + 4 / Nearline storage class + \[rs] \[dq]NEARLINE\[dq] + 5 / Coldline storage class + \[rs] \[dq]COLDLINE\[dq] + 6 / Durable reduced availability storage class + \[rs] \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] +storage_class> 5 +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn\[aq]t work +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = google cloud storage +client_id = +client_secret = +token = {\[dq]AccessToken\[dq]:\[dq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-07\-17T20:49:14.929208288+01:00\[dq],\[dq]Extra\[dq]:null} +project_number = 12345678 +object_acl = private +bucket_acl = private +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall, or use +manual mode. +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP +See all the buckets in your project +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +Make a new bucket +.IP +.nf +\f[C] +rclone mkdir remote:bucket +\f[R] +.fi +.PP +List the contents of a bucket +.IP +.nf +\f[C] +rclone ls remote:bucket +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any +excess files in the bucket. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:bucket +\f[R] +.fi +.SS Service Account support +.PP +You can set up rclone with Google Cloud Storage in an unattended mode, +i.e. +not tied to a specific end\-user Google account. +This is useful when you want to synchronise files onto machines that +don\[aq]t have actively logged\-in users, for example build machines. +.PP +To get credentials for Google Cloud Platform IAM Service +Accounts (https://cloud.google.com/iam/docs/service-accounts), please +head to the Service +Account (https://console.cloud.google.com/permissions/serviceaccounts) +section of the Google Developer Console. +Service Accounts behave just like normal \f[C]User\f[R] permissions in +Google Cloud Storage +ACLs (https://cloud.google.com/storage/docs/access-control), so you can +limit their access (e.g. +make them read only). +After creating an account, a JSON file containing the Service +Account\[aq]s credentials will be downloaded onto your machines. +These credentials are what rclone will use for authentication. +.PP +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the \f[C]service_account_file\f[R] +prompt and rclone won\[aq]t use the browser based authentication flow. +If you\[aq]d rather stuff the contents of the credentials file into the +rclone config file, you can set \f[C]service_account_credentials\f[R] +with the actual contents of the file instead, or set the equivalent +environment variable. +.SS Anonymous Access +.PP +For downloads of objects that permit public access you can configure +rclone to use anonymous access by setting \f[C]anonymous\f[R] to +\f[C]true\f[R]. +With unauthorized access you can\[aq]t write or create files but only +read or list those buckets and objects that have public read access. +.SS Application Default Credentials +.PP +If no other source of credentials is provided, rclone will fall back to +Application Default +Credentials (https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) +this is useful both when you already have configured authentication for +your developer account, or in production when running on a google +compute host. +Note that if running in docker, you may need to run additional commands +on your google compute machine \- see this +page (https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). +.PP +Note that in the case application default credentials are used, there is +no need to explicitly configure a project number. +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS Custom upload headers +.PP +You can set custom upload headers with the \f[C]\-\-header\-upload\f[R] +flag. +Google Cloud Storage supports the headers as described in the working +with metadata +documentation (https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) +.IP \[bu] 2 +Cache\-Control +.IP \[bu] 2 +Content\-Disposition +.IP \[bu] 2 +Content\-Encoding +.IP \[bu] 2 +Content\-Language +.IP \[bu] 2 +Content\-Type +.IP \[bu] 2 +X\-Goog\-Meta\- +.PP +Eg \f[C]\-\-header\-upload \[dq]Content\-Type text/potato\[dq]\f[R] +.PP +Note that the last of these is for setting custom metadata in the form +\f[C]\-\-header\-upload \[dq]x\-goog\-meta\-key: value\[dq]\f[R] +.SS Modified time +.PP +Google google cloud storage stores md5sums natively and rclone stores +modification times as metadata on the object, under the \[dq]mtime\[dq] +key in RFC3339 format accurate to 1ns. +.SS Restricted filename characters +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +LF +T}@T{ +0x0A +T}@T{ +\[u240A] +T} +T{ +CR +T}@T{ +0x0D +T}@T{ +\[u240D] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). +.SS \-\-gcs\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_GCS_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_GCS_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-project\-number +.PP +Project number. +Optional \- needed only for list/create/delete buckets \- see your +developer console. +.IP \[bu] 2 +Config: project_number +.IP \[bu] 2 +Env Var: RCLONE_GCS_PROJECT_NUMBER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-service\-account\-file +.PP +Service Account Credentials JSON file path Leave blank normally. +Needed only if you want use SA instead of interactive login. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: service_account_file +.IP \[bu] 2 +Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-service\-account\-credentials +.PP +Service Account Credentials JSON blob Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_credentials +.IP \[bu] 2 +Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-anonymous +.PP +Access public buckets and objects without credentials Set to +\[aq]true\[aq] if you just want to download files and don\[aq]t +configure credentials. +.IP \[bu] 2 +Config: anonymous +.IP \[bu] 2 +Env Var: RCLONE_GCS_ANONYMOUS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-gcs\-object\-acl +.PP +Access Control List for new objects. +.IP \[bu] 2 +Config: object_acl +.IP \[bu] 2 +Env Var: RCLONE_GCS_OBJECT_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]authenticatedRead\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and all Authenticated Users get READER +access. +.RE +.IP \[bu] 2 +\[dq]bucketOwnerFullControl\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team owners get OWNER +access. +.RE +.IP \[bu] 2 +\[dq]bucketOwnerRead\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team owners get READER +access. +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access [default if left blank]. +.RE +.IP \[bu] 2 +\[dq]projectPrivate\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team members get access +according to their roles. +.RE +.IP \[bu] 2 +\[dq]publicRead\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and all Users get READER access. +.RE +.RE +.SS \-\-gcs\-bucket\-acl +.PP +Access Control List for new buckets. +.IP \[bu] 2 +Config: bucket_acl +.IP \[bu] 2 +Env Var: RCLONE_GCS_BUCKET_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]authenticatedRead\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Authenticated Users get +READER access. +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access [default if left blank]. +.RE +.IP \[bu] 2 +\[dq]projectPrivate\[dq] +.RS 2 +.IP \[bu] 2 +Project team members get access according to their roles. +.RE +.IP \[bu] 2 +\[dq]publicRead\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Users get READER access. +.RE +.IP \[bu] 2 +\[dq]publicReadWrite\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Users get WRITER access. +.RE +.RE +.SS \-\-gcs\-bucket\-policy\-only +.PP Access checks should use bucket\-level IAM policies. - +.PP If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this. - +.PP When it is set, rclone: - -\- ignores ACLs set on buckets -\- ignores ACLs set on objects -\- creates buckets with Bucket Policy Only set - +.IP \[bu] 2 +ignores ACLs set on buckets +.IP \[bu] 2 +ignores ACLs set on objects +.IP \[bu] 2 +creates buckets with Bucket Policy Only set +.PP Docs: https://cloud.google.com/storage/docs/bucket\-policy\-only - - -\- Config: bucket_policy_only -\- Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY -\- Type: bool -\- Default: false - -#### \-\-gcs\-location - +.IP \[bu] 2 +Config: bucket_policy_only +.IP \[bu] 2 +Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-gcs\-location +.PP Location for the newly created buckets. - -\- Config: location -\- Env Var: RCLONE_GCS_LOCATION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Empty for default location (US). - \- \[dq]asia\[dq] - \- Multi\-regional location for Asia. - \- \[dq]eu\[dq] - \- Multi\-regional location for Europe. - \- \[dq]us\[dq] - \- Multi\-regional location for United States. - \- \[dq]asia\-east1\[dq] - \- Taiwan. - \- \[dq]asia\-east2\[dq] - \- Hong Kong. - \- \[dq]asia\-northeast1\[dq] - \- Tokyo. - \- \[dq]asia\-south1\[dq] - \- Mumbai. - \- \[dq]asia\-southeast1\[dq] - \- Singapore. - \- \[dq]australia\-southeast1\[dq] - \- Sydney. - \- \[dq]europe\-north1\[dq] - \- Finland. - \- \[dq]europe\-west1\[dq] - \- Belgium. - \- \[dq]europe\-west2\[dq] - \- London. - \- \[dq]europe\-west3\[dq] - \- Frankfurt. - \- \[dq]europe\-west4\[dq] - \- Netherlands. - \- \[dq]us\-central1\[dq] - \- Iowa. - \- \[dq]us\-east1\[dq] - \- South Carolina. - \- \[dq]us\-east4\[dq] - \- Northern Virginia. - \- \[dq]us\-west1\[dq] - \- Oregon. - \- \[dq]us\-west2\[dq] - \- California. - -#### \-\-gcs\-storage\-class - +.IP \[bu] 2 +Config: location +.IP \[bu] 2 +Env Var: RCLONE_GCS_LOCATION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Empty for default location (US). +.RE +.IP \[bu] 2 +\[dq]asia\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for Asia. +.RE +.IP \[bu] 2 +\[dq]eu\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for Europe. +.RE +.IP \[bu] 2 +\[dq]us\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for United States. +.RE +.IP \[bu] 2 +\[dq]asia\-east1\[dq] +.RS 2 +.IP \[bu] 2 +Taiwan. +.RE +.IP \[bu] 2 +\[dq]asia\-east2\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong. +.RE +.IP \[bu] 2 +\[dq]asia\-northeast1\[dq] +.RS 2 +.IP \[bu] 2 +Tokyo. +.RE +.IP \[bu] 2 +\[dq]asia\-south1\[dq] +.RS 2 +.IP \[bu] 2 +Mumbai. +.RE +.IP \[bu] 2 +\[dq]asia\-southeast1\[dq] +.RS 2 +.IP \[bu] 2 +Singapore. +.RE +.IP \[bu] 2 +\[dq]australia\-southeast1\[dq] +.RS 2 +.IP \[bu] 2 +Sydney. +.RE +.IP \[bu] 2 +\[dq]europe\-north1\[dq] +.RS 2 +.IP \[bu] 2 +Finland. +.RE +.IP \[bu] 2 +\[dq]europe\-west1\[dq] +.RS 2 +.IP \[bu] 2 +Belgium. +.RE +.IP \[bu] 2 +\[dq]europe\-west2\[dq] +.RS 2 +.IP \[bu] 2 +London. +.RE +.IP \[bu] 2 +\[dq]europe\-west3\[dq] +.RS 2 +.IP \[bu] 2 +Frankfurt. +.RE +.IP \[bu] 2 +\[dq]europe\-west4\[dq] +.RS 2 +.IP \[bu] 2 +Netherlands. +.RE +.IP \[bu] 2 +\[dq]us\-central1\[dq] +.RS 2 +.IP \[bu] 2 +Iowa. +.RE +.IP \[bu] 2 +\[dq]us\-east1\[dq] +.RS 2 +.IP \[bu] 2 +South Carolina. +.RE +.IP \[bu] 2 +\[dq]us\-east4\[dq] +.RS 2 +.IP \[bu] 2 +Northern Virginia. +.RE +.IP \[bu] 2 +\[dq]us\-west1\[dq] +.RS 2 +.IP \[bu] 2 +Oregon. +.RE +.IP \[bu] 2 +\[dq]us\-west2\[dq] +.RS 2 +.IP \[bu] 2 +California. +.RE +.RE +.SS \-\-gcs\-storage\-class +.PP The storage class to use when storing objects in Google Cloud Storage. - -\- Config: storage_class -\- Env Var: RCLONE_GCS_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]MULTI_REGIONAL\[dq] - \- Multi\-regional storage class - \- \[dq]REGIONAL\[dq] - \- Regional storage class - \- \[dq]NEARLINE\[dq] - \- Nearline storage class - \- \[dq]COLDLINE\[dq] - \- Coldline storage class - \- \[dq]ARCHIVE\[dq] - \- Archive storage class - \- \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] - \- Durable reduced availability storage class - -### Advanced Options - -Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - -#### \-\-gcs\-token - +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_GCS_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]MULTI_REGIONAL\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional storage class +.RE +.IP \[bu] 2 +\[dq]REGIONAL\[dq] +.RS 2 +.IP \[bu] 2 +Regional storage class +.RE +.IP \[bu] 2 +\[dq]NEARLINE\[dq] +.RS 2 +.IP \[bu] 2 +Nearline storage class +.RE +.IP \[bu] 2 +\[dq]COLDLINE\[dq] +.RS 2 +.IP \[bu] 2 +Coldline storage class +.RE +.IP \[bu] 2 +\[dq]ARCHIVE\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage class +.RE +.IP \[bu] 2 +\[dq]DURABLE_REDUCED_AVAILABILITY\[dq] +.RS 2 +.IP \[bu] 2 +Durable reduced availability storage class +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). +.SS \-\-gcs\-token +.PP OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_GCS_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-auth\-url - +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_GCS_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-auth\-url +.PP Auth server URL. Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_GCS_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-token\-url - +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_GCS_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-token\-url +.PP Token server url. Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_GCS_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_GCS_ENCODING -\- Type: MultiEncoder -\- Default: Slash,CrLf,InvalidUtf8,Dot - - - - Google Drive -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]drive:path\[ga] - -Drive paths may be as deep as required, eg \[ga]drive:directory/subdirectory\[ga]. - -The initial setup for drive involves getting a token from Google drive -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_GCS_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-encoding .PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Google -Drive \ \[dq]drive\[dq] [snip] Storage> drive Google Application Client -Id \- leave blank normally. -client_id> Google Application Client Secret \- leave blank normally. -client_secret> Scope that rclone should use when requesting access from -drive. -Choose a number from below, or type in your own value 1 / Full access -all files, excluding Application Data Folder. -\ \[dq]drive\[dq] 2 / Read\-only access to file metadata and file -contents. -\ \[dq]drive.readonly\[dq] / Access to files created by rclone only. -3 | These are visible in the drive website. -| File authorization is revoked when the user deauthorizes the app. -\ \[dq]drive.file\[dq] / Allows read and write access to the Application -Data folder. -4 | This is not visible in the drive website. -\ \[dq]drive.appfolder\[dq] / Allows read\-only access to file metadata -but 5 | does not allow any access to read or download file content. -\ \[dq]drive.metadata.readonly\[dq] scope> 1 ID of the root folder \- -leave blank normally. -Fill in to access \[dq]Computers\[dq] folders. -(see docs). -root_folder_id> Service Account Credentials JSON file path \- needed -only if you want use SA instead of interactive login. -service_account_file> Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine or Y didn\[aq]t work y) Yes n) No y/n> y If your browser -doesn\[aq]t open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code... -Got code Configure this as a team drive? -y) Yes n) No y/n> n \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -client_id = client_secret = scope = drive root_folder_id = -service_account_file = token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_GCS_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,CrLf,InvalidUtf8,Dot +.SS Google Drive +.PP +Paths are specified as \f[C]drive:path\f[R] +.PP +Drive paths may be as deep as required, eg +\f[C]drive:directory/subdirectory\f[R]. +.PP +The initial setup for drive involves getting a token from Google drive +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: .IP .nf \f[C] - + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Google Drive + \[rs] \[dq]drive\[dq] +[snip] +Storage> drive +Google Application Client Id \- leave blank normally. +client_id> +Google Application Client Secret \- leave blank normally. +client_secret> +Scope that rclone should use when requesting access from drive. +Choose a number from below, or type in your own value + 1 / Full access all files, excluding Application Data Folder. + \[rs] \[dq]drive\[dq] + 2 / Read\-only access to file metadata and file contents. + \[rs] \[dq]drive.readonly\[dq] + / Access to files created by rclone only. + 3 | These are visible in the drive website. + | File authorization is revoked when the user deauthorizes the app. + \[rs] \[dq]drive.file\[dq] + / Allows read and write access to the Application Data folder. + 4 | This is not visible in the drive website. + \[rs] \[dq]drive.appfolder\[dq] + / Allows read\-only access to file metadata but + 5 | does not allow any access to read or download file content. + \[rs] \[dq]drive.metadata.readonly\[dq] +scope> 1 +ID of the root folder \- leave blank normally. Fill in to access \[dq]Computers\[dq] folders. (see docs). +root_folder_id> +Service Account Credentials JSON file path \- needed only if you want use SA instead of interactive login. +service_account_file> +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn\[aq]t work +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +Configure this as a team drive? +y) Yes +n) No +y/n> n +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +scope = drive +root_folder_id = +service_account_file = +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP Note that rclone runs a webserver on your local machine to collect the -token as returned from Google if you use auto config mode. This only -runs from the moment it opens your browser to the moment you get back -the verification code. This is on \[ga]http://127.0.0.1:53682/\[ga] and this -it may require you to unblock it temporarily if you are running a host -firewall, or use manual mode. - +token as returned from Google if you use auto config mode. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall, or use +manual mode. +.PP You can then use it like this, - +.PP List directories in top level of your drive - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP List all the files in your drive - - rclone ls remote: - +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP To copy a local directory to a drive directory called backup - - rclone copy /home/source remote:backup - -### Scopes ### - +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Scopes +.PP Rclone allows you to select which scope you would like for rclone to -use. This changes what type of token is granted to rclone. [The -scopes are defined -here](https://developers.google.com/drive/v3/web/about\-auth). - +use. +This changes what type of token is granted to rclone. +The scopes are defined +here (https://developers.google.com/drive/v3/web/about-auth). +.PP The scope are - -#### drive #### - +.SS drive +.PP This is the default scope and allows full access to all files, except for the Application Data Folder (see below). - +.PP Choose this one if you aren\[aq]t sure. - -#### drive.readonly #### - -This allows read only access to all files. Files may be listed and -downloaded but not uploaded, renamed or deleted. - -#### drive.file #### - -With this scope rclone can read/view/modify only those files and -folders it creates. - +.SS drive.readonly +.PP +This allows read only access to all files. +Files may be listed and downloaded but not uploaded, renamed or deleted. +.SS drive.file +.PP +With this scope rclone can read/view/modify only those files and folders +it creates. +.PP So if you uploaded files to drive via the web interface (or any other means) they will not be visible to rclone. - +.PP This can be useful if you are using rclone to backup data and you want to be sure confidential data on your drive is not visible to rclone. - +.PP Files created with this scope are visible in the web interface. - -#### drive.appfolder #### - -This gives rclone its own private area to store files. Rclone will -not be able to see any other files on your drive and you won\[aq]t be able -to see rclone\[aq]s files from the web interface either. - -#### drive.metadata.readonly #### - -This allows read only access to file names only. It does not allow -rclone to download or upload data, or rename or delete files or -directories. - -### Root folder ID ### - -You can set the \[ga]root_folder_id\[ga] for rclone. This is the directory -(identified by its \[ga]Folder ID\[ga]) that rclone considers to be the root -of your drive. - -Normally you will leave this blank and rclone will determine the -correct root to use itself. - +.SS drive.appfolder +.PP +This gives rclone its own private area to store files. +Rclone will not be able to see any other files on your drive and you +won\[aq]t be able to see rclone\[aq]s files from the web interface +either. +.SS drive.metadata.readonly +.PP +This allows read only access to file names only. +It does not allow rclone to download or upload data, or rename or delete +files or directories. +.SS Root folder ID +.PP +You can set the \f[C]root_folder_id\f[R] for rclone. +This is the directory (identified by its \f[C]Folder ID\f[R]) that +rclone considers to be the root of your drive. +.PP +Normally you will leave this blank and rclone will determine the correct +root to use itself. +.PP However you can set this to restrict rclone to a specific folder -hierarchy or to access data within the \[dq]Computers\[dq] tab on the drive -web interface (where files from Google\[aq]s Backup and Sync desktop -program go). - -In order to do this you will have to find the \[ga]Folder ID\[ga] of the -directory you wish rclone to display. This will be the last segment -of the URL when you open the relevant folder in the drive web -interface. - +hierarchy or to access data within the \[dq]Computers\[dq] tab on the +drive web interface (where files from Google\[aq]s Backup and Sync +desktop program go). +.PP +In order to do this you will have to find the \f[C]Folder ID\f[R] of the +directory you wish rclone to display. +This will be the last segment of the URL when you open the relevant +folder in the drive web interface. +.PP So if the folder you want rclone to use has a URL which looks like -\[ga]https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\[ga] -in the browser, then you use \[ga]1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\[ga] as -the \[ga]root_folder_id\[ga] in the config. - -**NB** folders under the \[dq]Computers\[dq] tab seem to be read only (drive -gives a 500 error) when using rclone. - +\f[C]https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[R] +in the browser, then you use \f[C]1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[R] +as the \f[C]root_folder_id\f[R] in the config. +.PP +\f[B]NB\f[R] folders under the \[dq]Computers\[dq] tab seem to be read +only (drive gives a 500 error) when using rclone. +.PP There doesn\[aq]t appear to be an API to discover the folder IDs of the \[dq]Computers\[dq] tab \- please contact us if you know otherwise! - -Note also that rclone can\[aq]t access any data under the \[dq]Backups\[dq] tab on -the google drive web interface yet. - -### Service Account support ### - -You can set up rclone with Google Drive in an unattended mode, -i.e. not tied to a specific end\-user Google account. This is useful -when you want to synchronise files onto machines that don\[aq]t have -actively logged\-in users, for example build machines. - -To use a Service Account instead of OAuth2 token flow, enter the path -to your Service Account credentials at the \[ga]service_account_file\[ga] -prompt during \[ga]rclone config\[ga] and rclone won\[aq]t use the browser based -authentication flow. If you\[aq]d rather stuff the contents of the -credentials file into the rclone config file, you can set -\[ga]service_account_credentials\[ga] with the actual contents of the file -instead, or set the equivalent environment variable. - -#### Use case \- Google Apps/G\-suite account and individual Drive #### - +.PP +Note also that rclone can\[aq]t access any data under the +\[dq]Backups\[dq] tab on the google drive web interface yet. +.SS Service Account support +.PP +You can set up rclone with Google Drive in an unattended mode, i.e. +not tied to a specific end\-user Google account. +This is useful when you want to synchronise files onto machines that +don\[aq]t have actively logged\-in users, for example build machines. +.PP +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the \f[C]service_account_file\f[R] +prompt during \f[C]rclone config\f[R] and rclone won\[aq]t use the +browser based authentication flow. +If you\[aq]d rather stuff the contents of the credentials file into the +rclone config file, you can set \f[C]service_account_credentials\f[R] +with the actual contents of the file instead, or set the equivalent +environment variable. +.SS Use case \- Google Apps/G\-suite account and individual Drive +.PP Let\[aq]s say that you are the administrator of a Google Apps (old) or G\-suite account. -The goal is to store data on an individual\[aq]s Drive account, who IS -a member of the domain. -We\[aq]ll call the domain **example.com**, and the user -**foo\[at]example.com**. - +The goal is to store data on an individual\[aq]s Drive account, who IS a +member of the domain. +We\[aq]ll call the domain \f[B]example.com\f[R], and the user +\f[B]foo\[at]example.com\f[R]. +.PP There\[aq]s a few steps we need to go through to accomplish this: - -##### 1. Create a service account for example.com ##### - \- To create a service account and obtain its credentials, go to the -[Google Developer Console](https://console.developers.google.com). - \- You must have a project \- create one if you don\[aq]t. - \- Then go to \[dq]IAM & admin\[dq] \-> \[dq]Service Accounts\[dq]. - \- Use the \[dq]Create Credentials\[dq] button. Fill in \[dq]Service account name\[dq] -with something that identifies your client. \[dq]Role\[dq] can be empty. - \- Tick \[dq]Furnish a new private key\[dq] \- select \[dq]Key type JSON\[dq]. - \- Tick \[dq]Enable G Suite Domain\-wide Delegation\[dq]. This option makes -\[dq]impersonation\[dq] possible, as documented here: -[Delegating domain\-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) - \- These credentials are what rclone will use for authentication. -If you ever need to remove access, press the \[dq]Delete service -account key\[dq] button. - -##### 2. Allowing API access to example.com Google Drive ##### - \- Go to example.com\[aq]s admin console - \- Go into \[dq]Security\[dq] (or use the search bar) - \- Select \[dq]Show more\[dq] and then \[dq]Advanced settings\[dq] - \- Select \[dq]Manage API client access\[dq] in the \[dq]Authentication\[dq] section - \- In the \[dq]Client Name\[dq] field enter the service account\[aq]s +.SS 1. Create a service account for example.com +.IP \[bu] 2 +To create a service account and obtain its credentials, go to the Google +Developer Console (https://console.developers.google.com). +.IP \[bu] 2 +You must have a project \- create one if you don\[aq]t. +.IP \[bu] 2 +Then go to \[dq]IAM & admin\[dq] \-> \[dq]Service Accounts\[dq]. +.IP \[bu] 2 +Use the \[dq]Create Credentials\[dq] button. +Fill in \[dq]Service account name\[dq] with something that identifies +your client. +\[dq]Role\[dq] can be empty. +.IP \[bu] 2 +Tick \[dq]Furnish a new private key\[dq] \- select \[dq]Key type +JSON\[dq]. +.IP \[bu] 2 +Tick \[dq]Enable G Suite Domain\-wide Delegation\[dq]. +This option makes \[dq]impersonation\[dq] possible, as documented here: +Delegating domain\-wide authority to the service +account (https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) +.IP \[bu] 2 +These credentials are what rclone will use for authentication. +If you ever need to remove access, press the \[dq]Delete service account +key\[dq] button. +.SS 2. Allowing API access to example.com Google Drive +.IP \[bu] 2 +Go to example.com\[aq]s admin console +.IP \[bu] 2 +Go into \[dq]Security\[dq] (or use the search bar) +.IP \[bu] 2 +Select \[dq]Show more\[dq] and then \[dq]Advanced settings\[dq] +.IP \[bu] 2 +Select \[dq]Manage API client access\[dq] in the +\[dq]Authentication\[dq] section +.IP \[bu] 2 +In the \[dq]Client Name\[dq] field enter the service account\[aq]s \[dq]Client ID\[dq] \- this can be found in the Developer Console under -\[dq]IAM & Admin\[dq] \-> \[dq]Service Accounts\[dq], then \[dq]View Client ID\[dq] for -the newly created service account. +\[dq]IAM & Admin\[dq] \-> \[dq]Service Accounts\[dq], then \[dq]View +Client ID\[dq] for the newly created service account. It is a \[ti]21 character numerical string. - \- In the next field, \[dq]One or More API Scopes\[dq], enter -\[ga]https://www.googleapis.com/auth/drive\[ga] -to grant access to Google Drive specifically. - -##### 3. Configure rclone, assuming a new install ##### -\f[R] -.fi -.PP +.IP \[bu] 2 +In the next field, \[dq]One or More API Scopes\[dq], enter +\f[C]https://www.googleapis.com/auth/drive\f[R] to grant access to +Google Drive specifically. +.SS 3. Configure rclone, assuming a new install +.IP +.nf +\f[C] rclone config + +n/s/q> n # New +name>gdrive # Gdrive is an example name +Storage> # Select the number shown for Google Drive +client_id> # Can be left blank +client_secret> # Can be left blank +scope> # Select your scope, 1 for example +root_folder_id> # Can be left blank +service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! +y/n> # Auto config, y +\f[R] +.fi +.SS 4. Verify that it\[aq]s working +.IP \[bu] 2 +\f[C]rclone \-v \-\-drive\-impersonate foo\[at]example.com lsf gdrive:backup\f[R] +.IP \[bu] 2 +The arguments do: +.RS 2 +.IP \[bu] 2 +\f[C]\-v\f[R] \- verbose logging +.IP \[bu] 2 +\f[C]\-\-drive\-impersonate foo\[at]example.com\f[R] \- this is what +does the magic, pretending to be user foo. +.IP \[bu] 2 +\f[C]lsf\f[R] \- list files in a parsing friendly way +.IP \[bu] 2 +\f[C]gdrive:backup\f[R] \- use the remote called gdrive, work in the +folder named backup. +.RE +.PP +Note: in case you configured a specific root folder on gdrive and rclone +is unable to access the contents of that folder when using +\f[C]\-\-drive\-impersonate\f[R], do this instead: \- in the gdrive web +interface, share your root folder with the user/email of the new Service +Account you created/selected at step #1 \- use rclone without specifying +the \f[C]\-\-drive\-impersonate\f[R] option, like this: +\f[C]rclone \-v foo\[at]example.com lsf gdrive:backup\f[R] +.SS Team drives +.PP +If you want to configure the remote to point to a Google Team Drive then +answer \f[C]y\f[R] to the question +\f[C]Configure this as a team drive?\f[R]. .PP -n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select -the number shown for Google Drive client_id> # Can be left blank -client_secret> # Can be left blank scope> # Select your scope, 1 for -example root_folder_id> # Can be left blank service_account_file> -/home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # -Auto config, y -.IP -.nf -\f[C] - -##### 4. Verify that it\[aq]s working ##### - \- \[ga]rclone \-v \-\-drive\-impersonate foo\[at]example.com lsf gdrive:backup\[ga] - \- The arguments do: - \- \[ga]\-v\[ga] \- verbose logging - \- \[ga]\-\-drive\-impersonate foo\[at]example.com\[ga] \- this is what does -the magic, pretending to be user foo. - \- \[ga]lsf\[ga] \- list files in a parsing friendly way - \- \[ga]gdrive:backup\[ga] \- use the remote called gdrive, work in -the folder named backup. - -Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using \[ga]\-\-drive\-impersonate\[ga], do this instead: - \- in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 - \- use rclone without specifying the \[ga]\-\-drive\-impersonate\[ga] option, like this: - \[ga]rclone \-v foo\[at]example.com lsf gdrive:backup\[ga] - - -### Team drives ### - -If you want to configure the remote to point to a Google Team Drive -then answer \[ga]y\[ga] to the question \[ga]Configure this as a team drive?\[ga]. - This will fetch the list of Team Drives from google and allow you to -configure which one you want to use. You can also type in a team -drive ID if you prefer. - +configure which one you want to use. +You can also type in a team drive ID if you prefer. +.PP For example: -\f[R] -.fi -.PP +.IP +.nf +\f[C] Configure this as a team drive? -y) Yes n) No y/n> y Fetching team drive list... -Choose a number from below, or type in your own value 1 / Rclone Test -\ \[dq]xxxxxxxxxxxxxxxxxxxx\[dq] 2 / Rclone Test 2 -\ \[dq]yyyyyyyyyyyyyyyyyyyy\[dq] 3 / Rclone Test 3 -\ \[dq]zzzzzzzzzzzzzzzzzzzz\[dq] Enter a Team Drive ID> 1 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] client_id = -client_secret = token = -{\[dq]AccessToken\[dq]:\[dq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq],\[dq]Extra\[dq]:null} +y) Yes +n) No +y/n> y +Fetching team drive list... +Choose a number from below, or type in your own value + 1 / Rclone Test + \[rs] \[dq]xxxxxxxxxxxxxxxxxxxx\[dq] + 2 / Rclone Test 2 + \[rs] \[dq]yyyyyyyyyyyyyyyyyyyy\[dq] + 3 / Rclone Test 3 + \[rs] \[dq]zzzzzzzzzzzzzzzzzzzz\[dq] +Enter a Team Drive ID> 1 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +token = {\[dq]AccessToken\[dq]:\[dq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq],\[dq]Extra\[dq]:null} team_drive = xxxxxxxxxxxxxxxxxxxx -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.PP +It does this by combining multiple \f[C]list\f[R] calls into a single +API request. +.PP +This works by combining many \f[C]\[aq]%s\[aq] in parents\f[R] filters +into one expression. +To list the contents of directories a, b and c, the following requests +will be send by the regular \f[C]List\f[R] function: .IP .nf \f[C] - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -It does this by combining multiple \[ga]list\[ga] calls into a single API request. - -This works by combining many \[ga]\[aq]%s\[aq] in parents\[ga] filters into one expression. -To list the contents of directories a, b and c, the following requests will be send by the regular \[ga]List\[ga] function: +trashed=false and \[aq]a\[aq] in parents +trashed=false and \[aq]b\[aq] in parents +trashed=false and \[aq]c\[aq] in parents \f[R] .fi .PP -trashed=false and \[aq]a\[aq] in parents trashed=false and \[aq]b\[aq] -in parents trashed=false and \[aq]c\[aq] in parents -.IP -.nf -\f[C] These can now be combined into a single request: -\f[R] -.fi -.PP -trashed=false and (\[aq]a\[aq] in parents or \[aq]b\[aq] in parents or -\[aq]c\[aq] in parents) .IP .nf \f[C] - -The implementation of \[ga]ListR\[ga] will put up to 50 \[ga]parents\[ga] filters into one request. -It will use the \[ga]\-\-checkers\[ga] value to specify the number of requests to run in parallel. - -In tests, these batch requests were up to 20x faster than the regular method. +trashed=false and (\[aq]a\[aq] in parents or \[aq]b\[aq] in parents or \[aq]c\[aq] in parents) +\f[R] +.fi +.PP +The implementation of \f[C]ListR\f[R] will put up to 50 +\f[C]parents\f[R] filters into one request. +It will use the \f[C]\-\-checkers\f[R] value to specify the number of +requests to run in parallel. +.PP +In tests, these batch requests were up to 20x faster than the regular +method. Running the following command against different sized folders gives: -\f[R] -.fi -.PP -rclone lsjson \-vv \-R \-\-checkers=6 gdrive:folder .IP .nf \f[C] - +rclone lsjson \-vv \-R \-\-checkers=6 gdrive:folder +\f[R] +.fi +.PP small folder (220 directories, 700 files): - -\- without \[ga]\-\-fast\-list\[ga]: 38s -\- with \[ga]\-\-fast\-list\[ga]: 10s - +.IP \[bu] 2 +without \f[C]\-\-fast\-list\f[R]: 38s +.IP \[bu] 2 +with \f[C]\-\-fast\-list\f[R]: 10s +.PP large folder (10600 directories, 39000 files): - -\- without \[ga]\-\-fast\-list\[ga]: 22:05 min -\- with \[ga]\-\-fast\-list\[ga]: 58s - -### Modified time ### - +.IP \[bu] 2 +without \f[C]\-\-fast\-list\f[R]: 22:05 min +.IP \[bu] 2 +with \f[C]\-\-fast\-list\f[R]: 58s +.SS Modified time +.PP Google drive stores modification times accurate to 1 ms. - -#### Restricted filename characters - -Only Invalid UTF\-8 bytes will be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -In contrast to other backends, \[ga]/\[ga] can also be used in names and \[ga].\[ga] -or \[ga]..\[ga] are valid names. - -### Revisions ### - -Google drive stores revisions of files. When you upload a change to -an existing file to google drive using rclone it will create a new -revision of that file. - -Revisions follow the standard google policy which at time of writing -was - - * They are deleted after 30 days or 100 revisions (whatever comes first). - * They do not count towards a user storage quota. - -### Deleting files ### - -By default rclone will send all files to the trash when deleting -files. If deleting them permanently is required then use the -\[ga]\-\-drive\-use\-trash=false\[ga] flag, or set the equivalent environment -variable. - -### Shortcuts ### - +.SS Restricted filename characters +.PP +Only Invalid UTF\-8 bytes will be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.PP +In contrast to other backends, \f[C]/\f[R] can also be used in names and +\f[C].\f[R] or \f[C]..\f[R] are valid names. +.SS Revisions +.PP +Google drive stores revisions of files. +When you upload a change to an existing file to google drive using +rclone it will create a new revision of that file. +.PP +Revisions follow the standard google policy which at time of writing was +.IP \[bu] 2 +They are deleted after 30 days or 100 revisions (whatever comes first). +.IP \[bu] 2 +They do not count towards a user storage quota. +.SS Deleting files +.PP +By default rclone will send all files to the trash when deleting files. +If deleting them permanently is required then use the +\f[C]\-\-drive\-use\-trash=false\f[R] flag, or set the equivalent +environment variable. +.SS Shortcuts +.PP In March 2020 Google introduced a new feature in Google Drive called -[drive shortcuts](https://support.google.com/drive/answer/9700156) -([API](https://developers.google.com/drive/api/v3/shortcuts)). These -will (by September 2020) [replace the ability for files or folders to -be in multiple folders at once](https://cloud.google.com/blog/products/g\-suite/simplifying\-google\-drives\-folder\-structure\-and\-sharing\-models). - +drive shortcuts (https://support.google.com/drive/answer/9700156) +(API (https://developers.google.com/drive/api/v3/shortcuts)). +These will (by September 2020) replace the ability for files or folders +to be in multiple folders at +once (https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models). +.PP Shortcuts are files that link to other files on Google Drive somewhat like a symlink in unix, except they point to the underlying file data (eg the inode in unix terms) so they don\[aq]t break if the source is renamed or moved about. - +.PP Be default rclone treats these as follows. - +.PP For shortcuts pointing to files: - -\- When listing a file shortcut appears as the destination file. -\- When downloading the contents of the destination file is downloaded. -\- When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. -\- When server side moving (renaming) the shortcut is renamed, not the destination file. -\- When server side copying the shortcut is copied, not the contents of the shortcut. -\- When deleting the shortcut is deleted not the linked file. -\- When setting the modification time, the modification time of the linked file will be set. - +.IP \[bu] 2 +When listing a file shortcut appears as the destination file. +.IP \[bu] 2 +When downloading the contents of the destination file is downloaded. +.IP \[bu] 2 +When updating shortcut file with a non shortcut file, the shortcut is +removed then a new file is uploaded in place of the shortcut. +.IP \[bu] 2 +When server side moving (renaming) the shortcut is renamed, not the +destination file. +.IP \[bu] 2 +When server side copying the shortcut is copied, not the contents of the +shortcut. +.IP \[bu] 2 +When deleting the shortcut is deleted not the linked file. +.IP \[bu] 2 +When setting the modification time, the modification time of the linked +file will be set. +.PP For shortcuts pointing to folders: - -\- When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) -\- When downloading the contents of the linked folder and sub contents are downloaded -\- When uploading to a shortcut folder the file will be placed in the linked folder -\- When server side moving (renaming) the shortcut is renamed, not the destination folder -\- When server side copying the contents of the linked folder is copied, not the shortcut. -\- When deleting with \[ga]rclone rmdir\[ga] or \[ga]rclone purge\[ga] the shortcut is deleted not the linked folder. -\- **NB** When deleting with \[ga]rclone remove\[ga] or \[ga]rclone mount\[ga] the contents of the linked folder will be deleted. - -The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts. - -Shortcuts can be completely ignored with the \[ga]\-\-drive\-skip\-shortcuts\[ga] flag -or the corresponding \[ga]skip_shortcuts\[ga] configuration setting. - -### Emptying trash ### - -If you wish to empty your trash you can use the \[ga]rclone cleanup remote:\[ga] -command which will permanently delete all your trashed files. This command -does not take any path arguments. - +.IP \[bu] 2 +When listing the shortcut appears as a folder and that folder will +contain the contents of the linked folder appear (including any sub +folders) +.IP \[bu] 2 +When downloading the contents of the linked folder and sub contents are +downloaded +.IP \[bu] 2 +When uploading to a shortcut folder the file will be placed in the +linked folder +.IP \[bu] 2 +When server side moving (renaming) the shortcut is renamed, not the +destination folder +.IP \[bu] 2 +When server side copying the contents of the linked folder is copied, +not the shortcut. +.IP \[bu] 2 +When deleting with \f[C]rclone rmdir\f[R] or \f[C]rclone purge\f[R] the +shortcut is deleted not the linked folder. +.IP \[bu] 2 +\f[B]NB\f[R] When deleting with \f[C]rclone remove\f[R] or +\f[C]rclone mount\f[R] the contents of the linked folder will be +deleted. +.PP +The rclone backend (https://rclone.org/commands/rclone_backend/) command +can be used to create shortcuts. +.PP +Shortcuts can be completely ignored with the +\f[C]\-\-drive\-skip\-shortcuts\f[R] flag or the corresponding +\f[C]skip_shortcuts\f[R] configuration setting. +.SS Emptying trash +.PP +If you wish to empty your trash you can use the +\f[C]rclone cleanup remote:\f[R] command which will permanently delete +all your trashed files. +This command does not take any path arguments. +.PP Note that Google Drive takes some time (minutes to days) to empty the -trash even though the command returns within a few seconds. No output -is echoed, so there will be no confirmation even using \-v or \-vv. - -### Quota information ### - -To view your current quota you can use the \[ga]rclone about remote:\[ga] -command which will display your usage limit (quota), the usage in Google -Drive, the size of all files in the Trash and the space used by other -Google services such as Gmail. This command does not take any path -arguments. - -#### Import/Export of google documents #### - +trash even though the command returns within a few seconds. +No output is echoed, so there will be no confirmation even using \-v or +\-vv. +.SS Quota information +.PP +To view your current quota you can use the +\f[C]rclone about remote:\f[R] command which will display your usage +limit (quota), the usage in Google Drive, the size of all files in the +Trash and the space used by other Google services such as Gmail. +This command does not take any path arguments. +.SS Import/Export of google documents +.PP Google documents can be exported from and uploaded to Google Drive. - +.PP When rclone downloads a Google doc it chooses a format to download -depending upon the \[ga]\-\-drive\-export\-formats\[ga] setting. -By default the export formats are \[ga]docx,xlsx,pptx,svg\[ga] which are a -sensible default for an editable document. - -When choosing a format, rclone runs down the list provided in order -and chooses the first file format the doc can be exported as from the -list. If the file can\[aq]t be exported to a format on the formats list, -then rclone will choose a format from the default list. - -If you prefer an archive copy then you might use \[ga]\-\-drive\-export\-formats -pdf\[ga], or if you prefer openoffice/libreoffice formats you might use -\[ga]\-\-drive\-export\-formats ods,odt,odp\[ga]. - +depending upon the \f[C]\-\-drive\-export\-formats\f[R] setting. +By default the export formats are \f[C]docx,xlsx,pptx,svg\f[R] which are +a sensible default for an editable document. +.PP +When choosing a format, rclone runs down the list provided in order and +chooses the first file format the doc can be exported as from the list. +If the file can\[aq]t be exported to a format on the formats list, then +rclone will choose a format from the default list. +.PP +If you prefer an archive copy then you might use +\f[C]\-\-drive\-export\-formats pdf\f[R], or if you prefer +openoffice/libreoffice formats you might use +\f[C]\-\-drive\-export\-formats ods,odt,odp\f[R]. +.PP Note that rclone adds the extension to the google doc, so if it is -called \[ga]My Spreadsheet\[ga] on google docs, it will be exported as \[ga]My -Spreadsheet.xlsx\[ga] or \[ga]My Spreadsheet.pdf\[ga] etc. - -When importing files into Google Drive, rclone will convert all -files with an extension in \[ga]\-\-drive\-import\-formats\[ga] to their +called \f[C]My Spreadsheet\f[R] on google docs, it will be exported as +\f[C]My Spreadsheet.xlsx\f[R] or \f[C]My Spreadsheet.pdf\f[R] etc. +.PP +When importing files into Google Drive, rclone will convert all files +with an extension in \f[C]\-\-drive\-import\-formats\f[R] to their associated document type. -rclone will not convert any files by default, since the conversion -is lossy process. - -The conversion must result in a file with the same extension when -the \[ga]\-\-drive\-export\-formats\[ga] rules are applied to the uploaded document. - +rclone will not convert any files by default, since the conversion is +lossy process. +.PP +The conversion must result in a file with the same extension when the +\f[C]\-\-drive\-export\-formats\f[R] rules are applied to the uploaded +document. +.PP Here are some examples for allowed and prohibited conversions. - -| export\-formats | import\-formats | Upload Ext | Document Ext | Allowed | -| \-\-\-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\- | -| odt | odt | odt | odt | Yes | -| odt | docx,odt | odt | odt | Yes | -| | docx | docx | docx | Yes | -| | odt | odt | docx | No | -| odt,docx | docx,odt | docx | odt | No | -| docx,odt | docx,odt | docx | docx | Yes | -| docx,odt | docx,odt | odt | docx | No | - -This limitation can be disabled by specifying \[ga]\-\-drive\-allow\-import\-name\-change\[ga]. -When using this flag, rclone can convert multiple files types resulting -in the same document type at once, eg with \[ga]\-\-drive\-import\-formats docx,odt,txt\[ga], -all files having these extension would result in a document represented as a docx file. -This brings the additional risk of overwriting a document, if multiple files -have the same stem. Many rclone operations will not handle this name change -in any way. They assume an equal name when copying files and might copy the -file again or delete them when the name changes. - -Here are the possible export extensions with their corresponding mime types. -Most of these can also be used for importing, but there more that are not -listed here. Some of these additional ones might only be available when -the operating system provides the correct MIME type entries. - -This list can be changed by Google Drive at any time and might not -represent the currently available conversions. - -| Extension | Mime Type | Description | -| \-\-\-\-\-\-\-\-\- |\-\-\-\-\-\-\-\-\-\-\-| \-\-\-\-\-\-\-\-\-\-\-\-| -| csv | text/csv | Standard CSV format for Spreadsheets | -| docx | application/vnd.openxmlformats\-officedocument.wordprocessingml.document | Microsoft Office Document | -| epub | application/epub+zip | E\-book format | -| html | text/html | An HTML Document | -| jpg | image/jpeg | A JPEG Image File | -| json | application/vnd.google\-apps.script+json | JSON Text Format | -| odp | application/vnd.oasis.opendocument.presentation | Openoffice Presentation | -| ods | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | -| ods | application/x\-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | -| odt | application/vnd.oasis.opendocument.text | Openoffice Document | -| pdf | application/pdf | Adobe PDF Format | -| png | image/png | PNG Image Format| -| pptx | application/vnd.openxmlformats\-officedocument.presentationml.presentation | Microsoft Office Powerpoint | -| rtf | application/rtf | Rich Text Format | -| svg | image/svg+xml | Scalable Vector Graphics Format | -| tsv | text/tab\-separated\-values | Standard TSV format for spreadsheets | -| txt | text/plain | Plain Text | -| xlsx | application/vnd.openxmlformats\-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | -| zip | application/zip | A ZIP file of HTML, Images CSS | - -Google documents can also be exported as link files. These files will -open a browser window for the Google Docs website of that document -when opened. The link file extension has to be specified as a -\[ga]\-\-drive\-export\-formats\[ga] parameter. They will match all available -Google Documents. - -| Extension | Description | OS Support | -| \-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\- | -| desktop | freedesktop.org specified desktop entry | Linux | -| link.html | An HTML Document with a redirect | All | -| url | INI style link file | macOS, Windows | -| webloc | macOS specific XML format | macOS | - - -### Standard Options - -Here are the standard options specific to drive (Google Drive). - -#### \-\-drive\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_DRIVE_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_DRIVE_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-scope - -Scope that rclone should use when requesting access from drive. - -\- Config: scope -\- Env Var: RCLONE_DRIVE_SCOPE -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]drive\[dq] - \- Full access all files, excluding Application Data Folder. - \- \[dq]drive.readonly\[dq] - \- Read\-only access to file metadata and file contents. - \- \[dq]drive.file\[dq] - \- Access to files created by rclone only. - \- These are visible in the drive website. - \- File authorization is revoked when the user deauthorizes the app. - \- \[dq]drive.appfolder\[dq] - \- Allows read and write access to the Application Data folder. - \- This is not visible in the drive website. - \- \[dq]drive.metadata.readonly\[dq] - \- Allows read\-only access to file metadata but - \- does not allow any access to read or download file content. - -#### \-\-drive\-root\-folder\-id - -ID of the root folder -Leave blank normally. - -Fill in to access \[dq]Computers\[dq] folders (see docs), or for rclone to use -a non root folder as its starting point. - - -\- Config: root_folder_id -\- Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-service\-account\-file - -Service Account Credentials JSON file path -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -Leading \[ga]\[ti]\[ga] will be expanded in the file name as will environment variables such as \[ga]${RCLONE_CONFIG_DIR}\[ga]. - - -\- Config: service_account_file -\- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-alternate\-export - -Deprecated: no longer needed - -\- Config: alternate_export -\- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT -\- Type: bool -\- Default: false - -### Advanced Options - -Here are the advanced options specific to drive (Google Drive). - -#### \-\-drive\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_DRIVE_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_DRIVE_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_DRIVE_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-service\-account\-credentials - -Service Account Credentials JSON blob -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -\- Config: service_account_credentials -\- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-team\-drive - -ID of the Team Drive - -\- Config: team_drive -\- Env Var: RCLONE_DRIVE_TEAM_DRIVE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-auth\-owner\-only - -Only consider files owned by the authenticated user. - -\- Config: auth_owner_only -\- Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY -\- Type: bool -\- Default: false - -#### \-\-drive\-use\-trash - -Send files to the trash instead of deleting permanently. -Defaults to true, namely sending files to the trash. -Use \[ga]\-\-drive\-use\-trash=false\[ga] to delete files permanently instead. - -\- Config: use_trash -\- Env Var: RCLONE_DRIVE_USE_TRASH -\- Type: bool -\- Default: true - -#### \-\-drive\-skip\-gdocs - -Skip google documents in all listings. -If given, gdocs practically become invisible to rclone. - -\- Config: skip_gdocs -\- Env Var: RCLONE_DRIVE_SKIP_GDOCS -\- Type: bool -\- Default: false - -#### \-\-drive\-skip\-checksum\-gphotos - -Skip MD5 checksum on Google photos and videos only. - -Use this if you get checksum errors when transferring Google photos or -videos. - -Setting this flag will cause Google photos and videos to return a -blank MD5 checksum. - -Google photos are identified by being in the \[dq]photos\[dq] space. - -Corrupted checksums are caused by Google modifying the image/video but -not updating the checksum. - -\- Config: skip_checksum_gphotos -\- Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS -\- Type: bool -\- Default: false - -#### \-\-drive\-shared\-with\-me - -Only show files that are shared with me. - -Instructs rclone to operate on your \[dq]Shared with me\[dq] folder (where -Google Drive lets you access the files and folders others have shared -with you). - -This works both with the \[dq]list\[dq] (lsd, lsl, etc) and the \[dq]copy\[dq] -commands (copy, sync, etc), and with all other commands too. - -\- Config: shared_with_me -\- Env Var: RCLONE_DRIVE_SHARED_WITH_ME -\- Type: bool -\- Default: false - -#### \-\-drive\-trashed\-only - -Only show files that are in the trash. -This will show trashed files in their original directory structure. - -\- Config: trashed_only -\- Env Var: RCLONE_DRIVE_TRASHED_ONLY -\- Type: bool -\- Default: false - -#### \-\-drive\-starred\-only - -Only show files that are starred. - -\- Config: starred_only -\- Env Var: RCLONE_DRIVE_STARRED_ONLY -\- Type: bool -\- Default: false - -#### \-\-drive\-formats - -Deprecated: see export_formats - -\- Config: formats -\- Env Var: RCLONE_DRIVE_FORMATS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-export\-formats - -Comma separated list of preferred formats for downloading Google docs. - -\- Config: export_formats -\- Env Var: RCLONE_DRIVE_EXPORT_FORMATS -\- Type: string -\- Default: \[dq]docx,xlsx,pptx,svg\[dq] - -#### \-\-drive\-import\-formats - -Comma separated list of preferred formats for uploading Google docs. - -\- Config: import_formats -\- Env Var: RCLONE_DRIVE_IMPORT_FORMATS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-allow\-import\-name\-change - -Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. - -\- Config: allow_import_name_change -\- Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE -\- Type: bool -\- Default: false - -#### \-\-drive\-use\-created\-date - -Use file created date instead of modified date., - -Useful when downloading data and you want the creation date used in -place of the last modified date. - -**WARNING**: This flag may have some unexpected consequences. - -When uploading to your drive all files will be overwritten unless they -haven\[aq]t been modified since their creation. And the inverse will occur -while downloading. This side effect can be avoided by using the -\[dq]\-\-checksum\[dq] flag. - -This feature was implemented to retain photos capture date as recorded -by google photos. You will first need to check the \[dq]Create a Google -Photos folder\[dq] option in your google drive settings. You can then copy -or move the photos locally and use the date the image was taken -(created) set as the modification date. - -\- Config: use_created_date -\- Env Var: RCLONE_DRIVE_USE_CREATED_DATE -\- Type: bool -\- Default: false - -#### \-\-drive\-use\-shared\-date - -Use date file was shared instead of modified date. - -Note that, as with \[dq]\-\-drive\-use\-created\-date\[dq], this flag may have -unexpected consequences when uploading/downloading files. - -If both this flag and \[dq]\-\-drive\-use\-created\-date\[dq] are set, the created -date is used. - -\- Config: use_shared_date -\- Env Var: RCLONE_DRIVE_USE_SHARED_DATE -\- Type: bool -\- Default: false - -#### \-\-drive\-list\-chunk - -Size of listing chunk 100\-1000. 0 to disable. - -\- Config: list_chunk -\- Env Var: RCLONE_DRIVE_LIST_CHUNK -\- Type: int -\- Default: 1000 - -#### \-\-drive\-impersonate - -Impersonate this user when using a service account. - -\- Config: impersonate -\- Env Var: RCLONE_DRIVE_IMPERSONATE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-upload\-cutoff - -Cutoff for switching to chunked upload - -\- Config: upload_cutoff -\- Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 8M - -#### \-\-drive\-chunk\-size - -Upload chunk size. Must a power of 2 >= 256k. - -Making this larger will improve performance, but note that each chunk -is buffered in memory one per transfer. - -Reducing this will reduce memory usage but decrease performance. - -\- Config: chunk_size -\- Env Var: RCLONE_DRIVE_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 8M - -#### \-\-drive\-acknowledge\-abuse - -Set to allow files which return cannotDownloadAbusiveFile to be downloaded. - -If downloading a file returns the error \[dq]This file has been identified -as malware or spam and cannot be downloaded\[dq] with the error code -\[dq]cannotDownloadAbusiveFile\[dq] then supply this flag to rclone to -indicate you acknowledge the risks of downloading the file and rclone -will download it anyway. - -\- Config: acknowledge_abuse -\- Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE -\- Type: bool -\- Default: false - -#### \-\-drive\-keep\-revision\-forever - -Keep new head revision of each file forever. - -\- Config: keep_revision_forever -\- Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER -\- Type: bool -\- Default: false - -#### \-\-drive\-size\-as\-quota - -Show sizes as storage quota usage, not actual size. - -Show the size of a file as the storage quota used. This is the -current version plus any older versions that have been set to keep -forever. - -**WARNING**: This flag may have some unexpected consequences. - -It is not recommended to set this flag in your config \- the -recommended usage is using the flag form \-\-drive\-size\-as\-quota when -doing rclone ls/lsl/lsf/lsjson/etc only. - -If you do use this flag for syncing (not recommended) then you will -need to use \-\-ignore size also. - -\- Config: size_as_quota -\- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA -\- Type: bool -\- Default: false - -#### \-\-drive\-v2\-download\-min\-size - -If Object\[aq]s are greater, use drive v2 API to download. - -\- Config: v2_download_min_size -\- Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE -\- Type: SizeSuffix -\- Default: off - -#### \-\-drive\-pacer\-min\-sleep - -Minimum time to sleep between API calls. - -\- Config: pacer_min_sleep -\- Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP -\- Type: Duration -\- Default: 100ms - -#### \-\-drive\-pacer\-burst - -Number of API calls to allow without sleeping. - -\- Config: pacer_burst -\- Env Var: RCLONE_DRIVE_PACER_BURST -\- Type: int -\- Default: 100 - -#### \-\-drive\-server\-side\-across\-configs - -Allow server side operations (eg copy) to work across different drive configs. - -This can be useful if you wish to do a server side copy between two -different Google drives. Note that this isn\[aq]t enabled by default -because it isn\[aq]t easy to tell if it will work between any two -configurations. - -\- Config: server_side_across_configs -\- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS -\- Type: bool -\- Default: false - -#### \-\-drive\-disable\-http2 - -Disable drive using http2 - -There is currently an unsolved issue with the google drive backend and -HTTP/2. HTTP/2 is therefore disabled by default for the drive backend -but can be re\-enabled here. When the issue is solved this flag will -be removed. - -See: https://github.com/rclone/rclone/issues/3631 - - - -\- Config: disable_http2 -\- Env Var: RCLONE_DRIVE_DISABLE_HTTP2 -\- Type: bool -\- Default: true - -#### \-\-drive\-stop\-on\-upload\-limit - -Make upload limit errors be fatal - -At the time of writing it is only possible to upload 750GB of data to -Google Drive a day (this is an undocumented limit). When this limit is -reached Google Drive produces a slightly different error message. When -this flag is set it causes these errors to be fatal. These will stop -the in\-progress sync. - -Note that this detection is relying on error message strings which -Google don\[aq]t document so it may break in the future. - -See: https://github.com/rclone/rclone/issues/3857 - - -\- Config: stop_on_upload_limit -\- Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT -\- Type: bool -\- Default: false - -#### \-\-drive\-skip\-shortcuts - -If set skip shortcut files - -Normally rclone dereferences shortcut files making them appear as if -they are the original file (see [the shortcuts section](#shortcuts)). -If this flag is set then rclone will ignore shortcut files completely. - - -\- Config: skip_shortcuts -\- Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS -\- Type: bool -\- Default: false - -#### \-\-drive\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_DRIVE_ENCODING -\- Type: MultiEncoder -\- Default: InvalidUtf8 - -### Backend commands - -Here are the commands specific to the drive backend. - -Run them with - - rclone backend COMMAND remote: - -The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - -These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### get - -Get command for fetching the drive config parameters - - rclone backend get remote: [options] [+] - -This is a get command which will be used to fetch the various drive config parameters - -Usage Examples: - - rclone backend get drive: [\-o service_account_file] [\-o chunk_size] - rclone rc backend/command command=get fs=drive: [\-o service_account_file] [\-o chunk_size] - - -Options: - -\- \[dq]chunk_size\[dq]: show the current upload chunk size -\- \[dq]service_account_file\[dq]: show the current service account file - -#### set - -Set command for updating the drive config parameters - - rclone backend set remote: [options] [+] - -This is a set command which will be used to update the various drive config parameters - -Usage Examples: - - rclone backend set drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] - rclone rc backend/command command=set fs=drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] - - -Options: - -\- \[dq]chunk_size\[dq]: update the current upload chunk size -\- \[dq]service_account_file\[dq]: update the current service account file - -#### shortcut - -Create shortcuts from files or directories - - rclone backend shortcut remote: [options] [+] - -This command creates shortcuts from files or directories. - -Usage: - - rclone backend shortcut drive: source_item destination_shortcut - rclone backend shortcut drive: source_item \-o target=drive2: destination_shortcut - -In the first example this creates a shortcut from the \[dq]source_item\[dq] -which can be a file or a directory to the \[dq]destination_shortcut\[dq]. The -\[dq]source_item\[dq] and the \[dq]destination_shortcut\[dq] should be relative paths -from \[dq]drive:\[dq] - -In the second example this creates a shortcut from the \[dq]source_item\[dq] -relative to \[dq]drive:\[dq] to the \[dq]destination_shortcut\[dq] relative to -\[dq]drive2:\[dq]. This may fail with a permission error if the user -authenticated with \[dq]drive2:\[dq] can\[aq]t read files from \[dq]drive:\[dq]. - - -Options: - -\- \[dq]target\[dq]: optional target remote for the shortcut destination - -#### drives - -List the shared drives available to this account - - rclone backend drives remote: [options] [+] - -This command lists the shared drives (teamdrives) available to this -account. - -Usage: - - rclone backend drives drive: - -This will return a JSON list of objects like this - - [ - { - \[dq]id\[dq]: \[dq]0ABCDEF\-01234567890\[dq], - \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], - \[dq]name\[dq]: \[dq]My Drive\[dq] - }, - { - \[dq]id\[dq]: \[dq]0ABCDEFabcdefghijkl\[dq], - \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], - \[dq]name\[dq]: \[dq]Test Drive\[dq] - } - ] - - - -#### untrash - -Untrash files and directories - - rclone backend untrash remote: [options] [+] - -This command untrashes all the files and directories in the directory -passed in recursively. - -Usage: - -This takes an optional directory to trash which make this easier to -use via the API. - - rclone backend untrash drive:directory - rclone backend \-i untrash drive:directory subdir - -Use the \-i flag to see what would be restored before restoring it. - -Result: - - { - \[dq]Untrashed\[dq]: 17, - \[dq]Errors\[dq]: 0 - } - - - - -### Limitations ### - -Drive has quite a lot of rate limiting. This causes rclone to be -limited to transferring about 2 files per second only. Individual -files may be transferred much faster at 100s of MBytes/s but lots of -small files can take a long time. - -Server side copies are also subject to a separate rate limit. If you -see User rate limit exceeded errors, wait at least 24 hours and retry. -You can disable server side copies with \[ga]\-\-disable copy\[ga] to download -and upload the files if you prefer. - -#### Limitations of Google Docs #### - -Google docs will appear as size \-1 in \[ga]rclone ls\[ga] and as size 0 in -anything which uses the VFS layer, eg \[ga]rclone mount\[ga], \[ga]rclone serve\[ga]. - -This is because rclone can\[aq]t find out the size of the Google docs -without downloading them. - -Google docs will transfer correctly with \[ga]rclone sync\[ga], \[ga]rclone copy\[ga] -etc as rclone knows to ignore the size when doing the transfer. - -However an unfortunate consequence of this is that you may not be able -to download Google docs using \[ga]rclone mount\[ga]. If it doesn\[aq]t work you -will get a 0 sized file. If you try again the doc may gain its -correct size and be downloadable. Whether it will work on not depends -on the application accessing the mount and the OS you are running \- -experiment to find out if it does work for you! - -### Duplicated files ### - -Sometimes, for no reason I\[aq]ve been able to track down, drive will -duplicate a file that rclone uploads. Drive unlike all the other -remotes can have duplicated files. - -Duplicated files cause problems with the syncing and you will see -messages in the log about duplicates. - -Use \[ga]rclone dedupe\[ga] to fix duplicated files. - -Note that this isn\[aq]t just a problem with rclone, even Google Photos on -Android duplicates files on drive sometimes. - -### Rclone appears to be re\-copying files it shouldn\[aq]t ### - -The most likely cause of this is the duplicated file issue above \- run -\[ga]rclone dedupe\[ga] and check your logs for duplicate object or directory -messages. - -This can also be caused by a delay/caching on google drive\[aq]s end when -comparing directory listings. Specifically with team drives used in -combination with \-\-fast\-list. Files that were uploaded recently may -not appear on the directory list sent to rclone when using \-\-fast\-list. - -Waiting a moderate period of time between attempts (estimated to be -approximately 1 hour) and/or not using \-\-fast\-list both seem to be -effective in preventing the problem. - -### Making your own client_id ### - -When you use rclone with Google drive in its default configuration you -are using rclone\[aq]s client_id. This is shared between all the rclone -users. There is a global rate limit on the number of queries per -second that each client_id can do set by Google. rclone already has a -high quota and I will continue to make sure it is high enough by -contacting Google. - -It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower. - -Here is how to create your own Google Drive client ID for rclone: - -1. Log into the [Google API -Console](https://console.developers.google.com/) with your Google -account. It doesn\[aq]t matter what Google account you use. (It need not -be the same account as the Google Drive you want to access) - -2. Select a project or create a new project. - -3. Under \[dq]ENABLE APIS AND SERVICES\[dq] search for \[dq]Drive\[dq], and enable the -\[dq]Google Drive API\[dq]. - -4. Click \[dq]Credentials\[dq] in the left\-side panel (not \[dq]Create -credentials\[dq], which opens the wizard), then \[dq]Create credentials\[dq] - -5. If you already configured an \[dq]Oauth Consent Screen\[dq], then skip -to the next step; if not, click on \[dq]CONFIGURE CONSENT SCREEN\[dq] button -(near the top right corner of the right panel), then select \[dq]External\[dq] -and click on \[dq]CREATE\[dq]; on the next screen, enter an \[dq]Application name\[dq] -(\[dq]rclone\[dq] is OK) then click on \[dq]Save\[dq] (all other data is optional). -Click again on \[dq]Credentials\[dq] on the left panel to go back to the -\[dq]Credentials\[dq] screen. - -(PS: if you are a GSuite user, you could also select \[dq]Internal\[dq] instead -of \[dq]External\[dq] above, but this has not been tested/documented so far). - -6. Click on the \[dq]+ CREATE CREDENTIALS\[dq] button at the top of the screen, -then select \[dq]OAuth client ID\[dq]. - -7. Choose an application type of \[dq]Desktop app\[dq] if you using a Google account or \[dq]Other\[dq] if -you using a GSuite account and click \[dq]Create\[dq]. (the default name is fine) - -8. It will show you a client ID and client secret. Use these values -in rclone config to add a new remote or edit an existing remote. - -Be aware that, due to the \[dq]enhanced security\[dq] recently introduced by -Google, you are theoretically expected to \[dq]submit your app for verification\[dq] -and then wait a few weeks(!) for their response; in practice, you can go right -ahead and use the client ID and client secret with rclone, the only issue will -be a very scary confirmation screen shown when you connect via your browser -for rclone to be able to get its token\-id (but as this only happens during -the remote configuration, it\[aq]s not such a big deal). - -(Thanks to \[at]balazer on github for these instructions.) - -Sometimes, creation of an OAuth consent in Google API Console fails due to an error message -\[lq]The request failed because changes to one of the field of the resource is not supported\[rq]. -As a convenient workaround, the necessary Google Drive API key can be created on the -[Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page. -Just push the Enable the Drive API button to receive the Client ID and Secret. -Note that it will automatically create a new project in the API Console. - - Google Photos -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The rclone backend for [Google Photos](https://www.google.com/photos/about/) is -a specialized backend for transferring photos and videos to and from -Google Photos. - -**NB** The Google Photos API which rclone uses has quite a few -limitations, so please read the [limitations section](#limitations) -carefully to make sure it is suitable for your use. - -## Configuring Google Photos - -The initial setup for google cloud storage involves getting a token from Google Photos -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] XX / Google -Photos \ \[dq]google photos\[dq] [snip] Storage> google photos ** See -help for google photos backend at: https://rclone.org/googlephotos/ ** -.PP -Google Application Client Id Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -client_id> Google Application Client Secret Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -client_secret> Set to make the Google Photos backend read only. -.PP -If you choose read only then rclone will only request read only access -to your photos, otherwise rclone will request full access. -Enter a boolean value (true or false). -Press Enter for the default (\[dq]false\[dq]). -read_only> Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: http://127.0.0.1:53682/auth Log -in and authorize rclone for access Waiting for code... -Got code -.PP -*** IMPORTANT: All media items uploaded to Google Photos with rclone *** -are stored in full resolution at original quality. -These uploads *** will count towards storage in your Google Account. .PP .TS tab(@); -lw(20.4n). +l l l l l. T{ -[remote] type = google photos token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-06\-28T17:38:04.644930156+01:00\[dq]} +export\-formats +T}@T{ +import\-formats +T}@T{ +Upload Ext +T}@T{ +Document Ext +T}@T{ +Allowed T} _ T{ -y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y -\[ga]\[ga]\[ga] +odt +T}@T{ +odt +T}@T{ +odt +T}@T{ +odt +T}@T{ +Yes T} T{ +odt +T}@T{ +docx,odt +T}@T{ +odt +T}@T{ +odt +T}@T{ +Yes +T} +T{ +T}@T{ +docx +T}@T{ +docx +T}@T{ +docx +T}@T{ +Yes +T} +T{ +T}@T{ +odt +T}@T{ +odt +T}@T{ +docx +T}@T{ +No +T} +T{ +odt,docx +T}@T{ +docx,odt +T}@T{ +docx +T}@T{ +odt +T}@T{ +No +T} +T{ +docx,odt +T}@T{ +docx,odt +T}@T{ +docx +T}@T{ +docx +T}@T{ +Yes +T} +T{ +docx,odt +T}@T{ +docx,odt +T}@T{ +odt +T}@T{ +docx +T}@T{ +No +T} +.TE +.PP +This limitation can be disabled by specifying +\f[C]\-\-drive\-allow\-import\-name\-change\f[R]. +When using this flag, rclone can convert multiple files types resulting +in the same document type at once, eg with +\f[C]\-\-drive\-import\-formats docx,odt,txt\f[R], all files having +these extension would result in a document represented as a docx file. +This brings the additional risk of overwriting a document, if multiple +files have the same stem. +Many rclone operations will not handle this name change in any way. +They assume an equal name when copying files and might copy the file +again or delete them when the name changes. +.PP +Here are the possible export extensions with their corresponding mime +types. +Most of these can also be used for importing, but there more that are +not listed here. +Some of these additional ones might only be available when the operating +system provides the correct MIME type entries. +.PP +This list can be changed by Google Drive at any time and might not +represent the currently available conversions. +.PP +.TS +tab(@); +lw(19.7n) lw(24.1n) lw(26.2n). +T{ +Extension +T}@T{ +Mime Type +T}@T{ +Description +T} +_ +T{ +csv +T}@T{ +text/csv +T}@T{ +Standard CSV format for Spreadsheets +T} +T{ +docx +T}@T{ +application/vnd.openxmlformats\-officedocument.wordprocessingml.document +T}@T{ +Microsoft Office Document +T} +T{ +epub +T}@T{ +application/epub+zip +T}@T{ +E\-book format +T} +T{ +html +T}@T{ +text/html +T}@T{ +An HTML Document +T} +T{ +jpg +T}@T{ +image/jpeg +T}@T{ +A JPEG Image File +T} +T{ +json +T}@T{ +application/vnd.google\-apps.script+json +T}@T{ +JSON Text Format +T} +T{ +odp +T}@T{ +application/vnd.oasis.opendocument.presentation +T}@T{ +Openoffice Presentation +T} +T{ +ods +T}@T{ +application/vnd.oasis.opendocument.spreadsheet +T}@T{ +Openoffice Spreadsheet +T} +T{ +ods +T}@T{ +application/x\-vnd.oasis.opendocument.spreadsheet +T}@T{ +Openoffice Spreadsheet +T} +T{ +odt +T}@T{ +application/vnd.oasis.opendocument.text +T}@T{ +Openoffice Document +T} +T{ +pdf +T}@T{ +application/pdf +T}@T{ +Adobe PDF Format +T} +T{ +png +T}@T{ +image/png +T}@T{ +PNG Image Format +T} +T{ +pptx +T}@T{ +application/vnd.openxmlformats\-officedocument.presentationml.presentation +T}@T{ +Microsoft Office Powerpoint +T} +T{ +rtf +T}@T{ +application/rtf +T}@T{ +Rich Text Format +T} +T{ +svg +T}@T{ +image/svg+xml +T}@T{ +Scalable Vector Graphics Format +T} +T{ +tsv +T}@T{ +text/tab\-separated\-values +T}@T{ +Standard TSV format for spreadsheets +T} +T{ +txt +T}@T{ +text/plain +T}@T{ +Plain Text +T} +T{ +xlsx +T}@T{ +application/vnd.openxmlformats\-officedocument.spreadsheetml.sheet +T}@T{ +Microsoft Office Spreadsheet +T} +T{ +zip +T}@T{ +application/zip +T}@T{ +A ZIP file of HTML, Images CSS +T} +.TE +.PP +Google documents can also be exported as link files. +These files will open a browser window for the Google Docs website of +that document when opened. +The link file extension has to be specified as a +\f[C]\-\-drive\-export\-formats\f[R] parameter. +They will match all available Google Documents. +.PP +.TS +tab(@); +l l l. +T{ +Extension +T}@T{ +Description +T}@T{ +OS Support +T} +_ +T{ +desktop +T}@T{ +freedesktop.org specified desktop entry +T}@T{ +Linux +T} +T{ +link.html +T}@T{ +An HTML Document with a redirect +T}@T{ +All +T} +T{ +url +T}@T{ +INI style link file +T}@T{ +macOS, Windows +T} +T{ +webloc +T}@T{ +macOS specific XML format +T}@T{ +macOS +T} +.TE +.SS Standard Options +.PP +Here are the standard options specific to drive (Google Drive). +.SS \-\-drive\-client\-id +.PP +Google Application Client Id Setting your own is recommended. +See https://rclone.org/drive/#making\-your\-own\-client\-id for how to +create your own. +If you leave this blank, it will use an internal key which is low +performance. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-scope +.PP +Scope that rclone should use when requesting access from drive. +.IP \[bu] 2 +Config: scope +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SCOPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]drive\[dq] +.RS 2 +.IP \[bu] 2 +Full access all files, excluding Application Data Folder. +.RE +.IP \[bu] 2 +\[dq]drive.readonly\[dq] +.RS 2 +.IP \[bu] 2 +Read\-only access to file metadata and file contents. +.RE +.IP \[bu] 2 +\[dq]drive.file\[dq] +.RS 2 +.IP \[bu] 2 +Access to files created by rclone only. +.IP \[bu] 2 +These are visible in the drive website. +.IP \[bu] 2 +File authorization is revoked when the user deauthorizes the app. +.RE +.IP \[bu] 2 +\[dq]drive.appfolder\[dq] +.RS 2 +.IP \[bu] 2 +Allows read and write access to the Application Data folder. +.IP \[bu] 2 +This is not visible in the drive website. +.RE +.IP \[bu] 2 +\[dq]drive.metadata.readonly\[dq] +.RS 2 +.IP \[bu] 2 +Allows read\-only access to file metadata but +.IP \[bu] 2 +does not allow any access to read or download file content. +.RE +.RE +.SS \-\-drive\-root\-folder\-id +.PP +ID of the root folder Leave blank normally. +.PP +Fill in to access \[dq]Computers\[dq] folders (see docs), or for rclone +to use a non root folder as its starting point. +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-service\-account\-file +.PP +Service Account Credentials JSON file path Leave blank normally. +Needed only if you want use SA instead of interactive login. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: service_account_file +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-alternate\-export +.PP +Deprecated: no longer needed +.IP \[bu] 2 +Config: alternate_export +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to drive (Google Drive). +.SS \-\-drive\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-service\-account\-credentials +.PP +Service Account Credentials JSON blob Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_credentials +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-team\-drive +.PP +ID of the Team Drive +.IP \[bu] 2 +Config: team_drive +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TEAM_DRIVE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-auth\-owner\-only +.PP +Only consider files owned by the authenticated user. +.IP \[bu] 2 +Config: auth_owner_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-use\-trash +.PP +Send files to the trash instead of deleting permanently. +Defaults to true, namely sending files to the trash. +Use \f[C]\-\-drive\-use\-trash=false\f[R] to delete files permanently +instead. +.IP \[bu] 2 +Config: use_trash +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_TRASH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.SS \-\-drive\-skip\-gdocs +.PP +Skip google documents in all listings. +If given, gdocs practically become invisible to rclone. +.IP \[bu] 2 +Config: skip_gdocs +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_GDOCS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-skip\-checksum\-gphotos +.PP +Skip MD5 checksum on Google photos and videos only. +.PP +Use this if you get checksum errors when transferring Google photos or +videos. +.PP +Setting this flag will cause Google photos and videos to return a blank +MD5 checksum. +.PP +Google photos are identified by being in the \[dq]photos\[dq] space. +.PP +Corrupted checksums are caused by Google modifying the image/video but +not updating the checksum. +.IP \[bu] 2 +Config: skip_checksum_gphotos +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-shared\-with\-me +.PP +Only show files that are shared with me. +.PP +Instructs rclone to operate on your \[dq]Shared with me\[dq] folder +(where Google Drive lets you access the files and folders others have +shared with you). +.PP +This works both with the \[dq]list\[dq] (lsd, lsl, etc) and the +\[dq]copy\[dq] commands (copy, sync, etc), and with all other commands +too. +.IP \[bu] 2 +Config: shared_with_me +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SHARED_WITH_ME +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-trashed\-only +.PP +Only show files that are in the trash. +This will show trashed files in their original directory structure. +.IP \[bu] 2 +Config: trashed_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TRASHED_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-starred\-only +.PP +Only show files that are starred. +.IP \[bu] 2 +Config: starred_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_STARRED_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-formats +.PP +Deprecated: see export_formats +.IP \[bu] 2 +Config: formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-export\-formats +.PP +Comma separated list of preferred formats for downloading Google docs. +.IP \[bu] 2 +Config: export_formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_EXPORT_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]docx,xlsx,pptx,svg\[dq] +.SS \-\-drive\-import\-formats +.PP +Comma separated list of preferred formats for uploading Google docs. +.IP \[bu] 2 +Config: import_formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_IMPORT_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-allow\-import\-name\-change +.PP +Allow the filetype to change when uploading Google docs (e.g. +file.doc to file.docx). +This will confuse sync and reupload every time. +.IP \[bu] 2 +Config: allow_import_name_change +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-use\-created\-date +.PP +Use file created date instead of modified date., +.PP +Useful when downloading data and you want the creation date used in +place of the last modified date. +.PP +\f[B]WARNING\f[R]: This flag may have some unexpected consequences. +.PP +When uploading to your drive all files will be overwritten unless they +haven\[aq]t been modified since their creation. +And the inverse will occur while downloading. +This side effect can be avoided by using the \[dq]\-\-checksum\[dq] +flag. +.PP +This feature was implemented to retain photos capture date as recorded +by google photos. +You will first need to check the \[dq]Create a Google Photos folder\[dq] +option in your google drive settings. +You can then copy or move the photos locally and use the date the image +was taken (created) set as the modification date. +.IP \[bu] 2 +Config: use_created_date +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_CREATED_DATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-use\-shared\-date +.PP +Use date file was shared instead of modified date. +.PP +Note that, as with \[dq]\-\-drive\-use\-created\-date\[dq], this flag +may have unexpected consequences when uploading/downloading files. +.PP +If both this flag and \[dq]\-\-drive\-use\-created\-date\[dq] are set, +the created date is used. +.IP \[bu] 2 +Config: use_shared_date +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_SHARED_DATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-list\-chunk +.PP +Size of listing chunk 100\-1000. +0 to disable. +.IP \[bu] 2 +Config: list_chunk +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_LIST_CHUNK +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1000 +.SS \-\-drive\-impersonate +.PP +Impersonate this user when using a service account. +.IP \[bu] 2 +Config: impersonate +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_IMPERSONATE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-upload\-cutoff +.PP +Cutoff for switching to chunked upload +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 8M +.SS \-\-drive\-chunk\-size +.PP +Upload chunk size. +Must a power of 2 >= 256k. +.PP +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. +.PP +Reducing this will reduce memory usage but decrease performance. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 8M +.SS \-\-drive\-acknowledge\-abuse +.PP +Set to allow files which return cannotDownloadAbusiveFile to be +downloaded. +.PP +If downloading a file returns the error \[dq]This file has been +identified as malware or spam and cannot be downloaded\[dq] with the +error code \[dq]cannotDownloadAbusiveFile\[dq] then supply this flag to +rclone to indicate you acknowledge the risks of downloading the file and +rclone will download it anyway. +.IP \[bu] 2 +Config: acknowledge_abuse +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-keep\-revision\-forever +.PP +Keep new head revision of each file forever. +.IP \[bu] 2 +Config: keep_revision_forever +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-size\-as\-quota +.PP +Show sizes as storage quota usage, not actual size. +.PP +Show the size of a file as the storage quota used. +This is the current version plus any older versions that have been set +to keep forever. +.PP +\f[B]WARNING\f[R]: This flag may have some unexpected consequences. +.PP +It is not recommended to set this flag in your config \- the recommended +usage is using the flag form \-\-drive\-size\-as\-quota when doing +rclone ls/lsl/lsf/lsjson/etc only. +.PP +If you do use this flag for syncing (not recommended) then you will need +to use \-\-ignore size also. +.IP \[bu] 2 +Config: size_as_quota +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-v2\-download\-min\-size +.PP +If Object\[aq]s are greater, use drive v2 API to download. +.IP \[bu] 2 +Config: v2_download_min_size +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: off +.SS \-\-drive\-pacer\-min\-sleep +.PP +Minimum time to sleep between API calls. +.IP \[bu] 2 +Config: pacer_min_sleep +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 100ms +.SS \-\-drive\-pacer\-burst +.PP +Number of API calls to allow without sleeping. +.IP \[bu] 2 +Config: pacer_burst +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_PACER_BURST +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 100 +.SS \-\-drive\-server\-side\-across\-configs +.PP +Allow server side operations (eg copy) to work across different drive +configs. +.PP +This can be useful if you wish to do a server side copy between two +different Google drives. +Note that this isn\[aq]t enabled by default because it isn\[aq]t easy to +tell if it will work between any two configurations. +.IP \[bu] 2 +Config: server_side_across_configs +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-disable\-http2 +.PP +Disable drive using http2 +.PP +There is currently an unsolved issue with the google drive backend and +HTTP/2. +HTTP/2 is therefore disabled by default for the drive backend but can be +re\-enabled here. +When the issue is solved this flag will be removed. +.PP +See: https://github.com/rclone/rclone/issues/3631 +.IP \[bu] 2 +Config: disable_http2 +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_DISABLE_HTTP2 +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.SS \-\-drive\-stop\-on\-upload\-limit +.PP +Make upload limit errors be fatal +.PP +At the time of writing it is only possible to upload 750GB of data to +Google Drive a day (this is an undocumented limit). +When this limit is reached Google Drive produces a slightly different +error message. +When this flag is set it causes these errors to be fatal. +These will stop the in\-progress sync. +.PP +Note that this detection is relying on error message strings which +Google don\[aq]t document so it may break in the future. +.PP +See: https://github.com/rclone/rclone/issues/3857 +.IP \[bu] 2 +Config: stop_on_upload_limit +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-skip\-shortcuts +.PP +If set skip shortcut files +.PP +Normally rclone dereferences shortcut files making them appear as if +they are the original file (see the shortcuts section). +If this flag is set then rclone will ignore shortcut files completely. +.IP \[bu] 2 +Config: skip_shortcuts +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: InvalidUtf8 +.SS Backend commands +.PP +Here are the commands specific to the drive backend. +.PP +Run them with +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP +The help below will explain what arguments each command takes. +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP +These can be run on a running backend using the rc command +backend/command (https://rclone.org/rc/#backend/command). +.SS get +.PP +Get command for fetching the drive config parameters +.IP +.nf +\f[C] +rclone backend get remote: [options] [+] +\f[R] +.fi +.PP +This is a get command which will be used to fetch the various drive +config parameters +.PP +Usage Examples: +.IP +.nf +\f[C] +rclone backend get drive: [\-o service_account_file] [\-o chunk_size] +rclone rc backend/command command=get fs=drive: [\-o service_account_file] [\-o chunk_size] +\f[R] +.fi +.PP +Options: +.IP \[bu] 2 +\[dq]chunk_size\[dq]: show the current upload chunk size +.IP \[bu] 2 +\[dq]service_account_file\[dq]: show the current service account file +.SS set +.PP +Set command for updating the drive config parameters +.IP +.nf +\f[C] +rclone backend set remote: [options] [+] +\f[R] +.fi +.PP +This is a set command which will be used to update the various drive +config parameters +.PP +Usage Examples: +.IP +.nf +\f[C] +rclone backend set drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] +rclone rc backend/command command=set fs=drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] +\f[R] +.fi +.PP +Options: +.IP \[bu] 2 +\[dq]chunk_size\[dq]: update the current upload chunk size +.IP \[bu] 2 +\[dq]service_account_file\[dq]: update the current service account file +.SS shortcut +.PP +Create shortcuts from files or directories +.IP +.nf +\f[C] +rclone backend shortcut remote: [options] [+] +\f[R] +.fi +.PP +This command creates shortcuts from files or directories. +.PP +Usage: +.IP +.nf +\f[C] +rclone backend shortcut drive: source_item destination_shortcut +rclone backend shortcut drive: source_item \-o target=drive2: destination_shortcut +\f[R] +.fi +.PP +In the first example this creates a shortcut from the +\[dq]source_item\[dq] which can be a file or a directory to the +\[dq]destination_shortcut\[dq]. +The \[dq]source_item\[dq] and the \[dq]destination_shortcut\[dq] should +be relative paths from \[dq]drive:\[dq] +.PP +In the second example this creates a shortcut from the +\[dq]source_item\[dq] relative to \[dq]drive:\[dq] to the +\[dq]destination_shortcut\[dq] relative to \[dq]drive2:\[dq]. +This may fail with a permission error if the user authenticated with +\[dq]drive2:\[dq] can\[aq]t read files from \[dq]drive:\[dq]. +.PP +Options: +.IP \[bu] 2 +\[dq]target\[dq]: optional target remote for the shortcut destination +.SS drives +.PP +List the shared drives available to this account +.IP +.nf +\f[C] +rclone backend drives remote: [options] [+] +\f[R] +.fi +.PP +This command lists the shared drives (teamdrives) available to this +account. +.PP +Usage: +.IP +.nf +\f[C] +rclone backend drives drive: +\f[R] +.fi +.PP +This will return a JSON list of objects like this +.IP +.nf +\f[C] +[ + { + \[dq]id\[dq]: \[dq]0ABCDEF\-01234567890\[dq], + \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], + \[dq]name\[dq]: \[dq]My Drive\[dq] + }, + { + \[dq]id\[dq]: \[dq]0ABCDEFabcdefghijkl\[dq], + \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], + \[dq]name\[dq]: \[dq]Test Drive\[dq] + } +] +\f[R] +.fi +.SS untrash +.PP +Untrash files and directories +.IP +.nf +\f[C] +rclone backend untrash remote: [options] [+] +\f[R] +.fi +.PP +This command untrashes all the files and directories in the directory +passed in recursively. +.PP +Usage: +.PP +This takes an optional directory to trash which make this easier to use +via the API. +.IP +.nf +\f[C] +rclone backend untrash drive:directory +rclone backend \-i untrash drive:directory subdir +\f[R] +.fi +.PP +Use the \-i flag to see what would be restored before restoring it. +.PP +Result: +.IP +.nf +\f[C] +{ + \[dq]Untrashed\[dq]: 17, + \[dq]Errors\[dq]: 0 +} +\f[R] +.fi +.SS Limitations +.PP +Drive has quite a lot of rate limiting. +This causes rclone to be limited to transferring about 2 files per +second only. +Individual files may be transferred much faster at 100s of MBytes/s but +lots of small files can take a long time. +.PP +Server side copies are also subject to a separate rate limit. +If you see User rate limit exceeded errors, wait at least 24 hours and +retry. +You can disable server side copies with \f[C]\-\-disable copy\f[R] to +download and upload the files if you prefer. +.SS Limitations of Google Docs +.PP +Google docs will appear as size \-1 in \f[C]rclone ls\f[R] and as size 0 +in anything which uses the VFS layer, eg \f[C]rclone mount\f[R], +\f[C]rclone serve\f[R]. +.PP +This is because rclone can\[aq]t find out the size of the Google docs +without downloading them. +.PP +Google docs will transfer correctly with \f[C]rclone sync\f[R], +\f[C]rclone copy\f[R] etc as rclone knows to ignore the size when doing +the transfer. +.PP +However an unfortunate consequence of this is that you may not be able +to download Google docs using \f[C]rclone mount\f[R]. +If it doesn\[aq]t work you will get a 0 sized file. +If you try again the doc may gain its correct size and be downloadable. +Whether it will work on not depends on the application accessing the +mount and the OS you are running \- experiment to find out if it does +work for you! +.SS Duplicated files +.PP +Sometimes, for no reason I\[aq]ve been able to track down, drive will +duplicate a file that rclone uploads. +Drive unlike all the other remotes can have duplicated files. +.PP +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. +.PP +Use \f[C]rclone dedupe\f[R] to fix duplicated files. +.PP +Note that this isn\[aq]t just a problem with rclone, even Google Photos +on Android duplicates files on drive sometimes. +.SS Rclone appears to be re\-copying files it shouldn\[aq]t +.PP +The most likely cause of this is the duplicated file issue above \- run +\f[C]rclone dedupe\f[R] and check your logs for duplicate object or +directory messages. +.PP +This can also be caused by a delay/caching on google drive\[aq]s end +when comparing directory listings. +Specifically with team drives used in combination with \-\-fast\-list. +Files that were uploaded recently may not appear on the directory list +sent to rclone when using \-\-fast\-list. +.PP +Waiting a moderate period of time between attempts (estimated to be +approximately 1 hour) and/or not using \-\-fast\-list both seem to be +effective in preventing the problem. +.SS Making your own client_id +.PP +When you use rclone with Google drive in its default configuration you +are using rclone\[aq]s client_id. +This is shared between all the rclone users. +There is a global rate limit on the number of queries per second that +each client_id can do set by Google. +rclone already has a high quota and I will continue to make sure it is +high enough by contacting Google. +.PP +It is strongly recommended to use your own client ID as the default +rclone ID is heavily used. +If you have multiple services running, it is recommended to use an API +key for each service. +The default Google quota is 10 transactions per second so it is +recommended to stay under that number as if you use more than that, it +will cause rclone to rate limit and make things slower. +.PP +Here is how to create your own Google Drive client ID for rclone: +.IP "1." 3 +Log into the Google API Console (https://console.developers.google.com/) +with your Google account. +It doesn\[aq]t matter what Google account you use. +(It need not be the same account as the Google Drive you want to access) +.IP "2." 3 +Select a project or create a new project. +.IP "3." 3 +Under \[dq]ENABLE APIS AND SERVICES\[dq] search for \[dq]Drive\[dq], and +enable the \[dq]Google Drive API\[dq]. +.IP "4." 3 +Click \[dq]Credentials\[dq] in the left\-side panel (not \[dq]Create +credentials\[dq], which opens the wizard), then \[dq]Create +credentials\[dq] +.IP "5." 3 +If you already configured an \[dq]Oauth Consent Screen\[dq], then skip +to the next step; if not, click on \[dq]CONFIGURE CONSENT SCREEN\[dq] +button (near the top right corner of the right panel), then select +\[dq]External\[dq] and click on \[dq]CREATE\[dq]; on the next screen, +enter an \[dq]Application name\[dq] (\[dq]rclone\[dq] is OK) then click +on \[dq]Save\[dq] (all other data is optional). +Click again on \[dq]Credentials\[dq] on the left panel to go back to the +\[dq]Credentials\[dq] screen. +.PP +(PS: if you are a GSuite user, you could also select \[dq]Internal\[dq] +instead of \[dq]External\[dq] above, but this has not been +tested/documented so far). +.IP "6." 3 +Click on the \[dq]+ CREATE CREDENTIALS\[dq] button at the top of the +screen, then select \[dq]OAuth client ID\[dq]. +.IP "7." 3 +Choose an application type of \[dq]Desktop app\[dq] if you using a +Google account or \[dq]Other\[dq] if you using a GSuite account and +click \[dq]Create\[dq]. +(the default name is fine) +.IP "8." 3 +It will show you a client ID and client secret. +Use these values in rclone config to add a new remote or edit an +existing remote. +.PP +Be aware that, due to the \[dq]enhanced security\[dq] recently +introduced by Google, you are theoretically expected to \[dq]submit your +app for verification\[dq] and then wait a few weeks(!) for their +response; in practice, you can go right ahead and use the client ID and +client secret with rclone, the only issue will be a very scary +confirmation screen shown when you connect via your browser for rclone +to be able to get its token\-id (but as this only happens during the +remote configuration, it\[aq]s not such a big deal). +.PP +(Thanks to \[at]balazer on github for these instructions.) +.PP +Sometimes, creation of an OAuth consent in Google API Console fails due +to an error message \[lq]The request failed because changes to one of +the field of the resource is not supported\[rq]. +As a convenient workaround, the necessary Google Drive API key can be +created on the Python +Quickstart (https://developers.google.com/drive/api/v3/quickstart/python) +page. +Just push the Enable the Drive API button to receive the Client ID and +Secret. +Note that it will automatically create a new project in the API Console. +.SS Google Photos +.PP +The rclone backend for Google +Photos (https://www.google.com/photos/about/) is a specialized backend +for transferring photos and videos to and from Google Photos. +.PP +\f[B]NB\f[R] The Google Photos API which rclone uses has quite a few +limitations, so please read the limitations section carefully to make +sure it is suitable for your use. +.SS Configuring Google Photos +.PP +The initial setup for google cloud storage involves getting a token from +Google Photos which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / Google Photos + \[rs] \[dq]google photos\[dq] +[snip] +Storage> google photos +** See help for google photos backend at: https://rclone.org/googlephotos/ ** + +Google Application Client Id +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +client_id> +Google Application Client Secret +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +client_secret> +Set to make the Google Photos backend read only. + +If you choose read only then rclone will only request read only access +to your photos, otherwise rclone will request full access. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +read_only> +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code + +*** IMPORTANT: All media items uploaded to Google Photos with rclone +*** are stored in full resolution at original quality. These uploads +*** will count towards storage in your Google Account. + +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = google photos +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-06\-28T17:38:04.644930156+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you @@ -20549,43 +25905,46 @@ get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode. -T} -T{ +.PP This remote is called \f[C]remote\f[R] and can now be used like this -T} -T{ +.PP See all the albums in your photos -T} -T{ +.IP +.nf +\f[C] rclone lsd remote:album -T} -T{ +\f[R] +.fi +.PP Make a new album -T} -T{ +.IP +.nf +\f[C] rclone mkdir remote:album/newAlbum -T} -T{ +\f[R] +.fi +.PP List the contents of an album -T} -T{ +.IP +.nf +\f[C] rclone ls remote:album/newAlbum -T} -T{ +\f[R] +.fi +.PP Sync \f[C]/home/local/images\f[R] to the Google Photos, removing any excess files in the album. -T} -T{ +.IP +.nf +\f[C] rclone sync \-i /home/local/image remote:album/newAlbum -T} -T{ -## Layout -T} -T{ +\f[R] +.fi +.SS Layout +.PP As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it. -T} -T{ +.PP The directories under \f[C]media\f[R] show different ways of categorizing the media. Each file will appear multiple times. @@ -20593,20 +25952,65 @@ So if you want to make a backup of your google photos you might choose to backup \f[C]remote:media/by\-month\f[R]. (\f[B]NB\f[R] \f[C]remote:media/by\-day\f[R] is rather slow at the moment so avoid for syncing.) -T} -T{ +.PP Note that all your photos and videos will appear somewhere under \f[C]media\f[R], but they may not appear under \f[C]album\f[R] unless you\[aq]ve put them into albums. -T} -T{ -\f[C]/ \- upload \- file1.jpg \- file2.jpg \- ... \- media \- all \- file1.jpg \- file2.jpg \- ... \- by\-year \- 2000 \- file1.jpg \- ... \- 2001 \- file2.jpg \- ... \- ... \- by\-month \- 2000 \- 2000\-01 \- file1.jpg \- ... \- 2000\-02 \- file2.jpg \- ... \- ... \- by\-day \- 2000 \- 2000\-01\-01 \- file1.jpg \- ... \- 2000\-01\-02 \- file2.jpg \- ... \- ... \- album \- album name \- album name/sub \- shared\-album \- album name \- album name/sub \- feature \- favorites \- file1.jpg \- file2.jpg\f[R] -T} -T{ +.IP +.nf +\f[C] +/ +\- upload + \- file1.jpg + \- file2.jpg + \- ... +\- media + \- all + \- file1.jpg + \- file2.jpg + \- ... + \- by\-year + \- 2000 + \- file1.jpg + \- ... + \- 2001 + \- file2.jpg + \- ... + \- ... + \- by\-month + \- 2000 + \- 2000\-01 + \- file1.jpg + \- ... + \- 2000\-02 + \- file2.jpg + \- ... + \- ... + \- by\-day + \- 2000 + \- 2000\-01\-01 + \- file1.jpg + \- ... + \- 2000\-01\-02 + \- file2.jpg + \- ... + \- ... +\- album + \- album name + \- album name/sub +\- shared\-album + \- album name + \- album name/sub +\- feature + \- favorites + \- file1.jpg + \- file2.jpg +\f[R] +.fi +.PP There are two writable parts of the tree, the \f[C]upload\f[R] directory and sub directories of the \f[C]album\f[R] directory. -T} -T{ +.PP The \f[C]upload\f[R] directory is for uploading files you don\[aq]t want to put into albums. This will be empty to start with and will contain the files you\[aq]ve @@ -20615,93 +26019,99 @@ restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to \f[C]album\f[R] will work better. -T} -T{ +.PP Directories within the \f[C]album\f[R] directory are also writeable and you may create new directories (albums) under \f[C]album\f[R]. If you copy files with a directory hierarchy in there then rclone will create albums with the \f[C]/\f[R] character in them. For example if you do -T} -T{ +.IP +.nf +\f[C] rclone copy /path/to/images remote:album/images -T} -T{ +\f[R] +.fi +.PP and the images directory contains -T} -T{ -\f[C]images \- file1.jpg dir file2.jpg dir2 dir3 file3.jpg\f[R] -T} -T{ +.IP +.nf +\f[C] +images + \- file1.jpg + dir + file2.jpg + dir2 + dir3 + file3.jpg +\f[R] +.fi +.PP Then rclone will create the following albums with the following files in -T} -T{ -\- images \- file1.jpg \- images/dir \- file2.jpg \- images/dir2/dir3 \- +.IP \[bu] 2 +images +.RS 2 +.IP \[bu] 2 +file1.jpg +.RE +.IP \[bu] 2 +images/dir +.RS 2 +.IP \[bu] 2 +file2.jpg +.RE +.IP \[bu] 2 +images/dir2/dir3 +.RS 2 +.IP \[bu] 2 file3.jpg -T} -T{ +.RE +.PP This means that you can use the \f[C]album\f[R] path pretty much like a normal filesystem and it is a good target for repeated syncing. -T} -T{ +.PP The \f[C]shared\-album\f[R] directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface. -T} -T{ -## Limitations -T} -T{ +.SS Limitations +.PP Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn\[aq]t understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item. -T} -T{ +.PP Note that all media items uploaded to Google Photos through the API are stored in full resolution at \[dq]original quality\[dq] and \f[B]will\f[R] count towards your storage quota in your Google Account. The API does \f[B]not\f[R] offer a way to upload in \[dq]high quality\[dq] mode.. -T} -T{ -### Downloading Images -T} -T{ +.SS Downloading Images +.PP When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115 (https://issuetracker.google.com/issues/112096115). -T} -T{ +.PP \f[B]The current google API does not allow photos to be downloaded at original resolution. This is very important if you are, for example, relying on \[dq]Google Photos\[dq] as a backup of your photos. You will not be able to use rclone to redownload original images. You could use \[aq]google takeout\[aq] to recover the original photos as a last resort\f[R] -T} -T{ -### Downloading Videos -T} -T{ +.SS Downloading Videos +.PP When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044 (https://issuetracker.google.com/issues/113672044). -T} -T{ -### Duplicates -T} -T{ +.SS Duplicates +.PP If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called \f[C]file.jpg\f[R] would then appear as \f[C]file {123456}.jpg\f[R] and \f[C]file {ABCDEF}.jpg\f[R] (the actual IDs are a lot longer alas!). -T} -T{ +.PP If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may @@ -20711,184 +26121,160 @@ the same image to \f[C]album/my_album\f[R] the filename of the image in \f[C]album/my_album\f[R] will be what it was uploaded with initially, not what you uploaded it with to \f[C]album\f[R]. In practise this shouldn\[aq]t cause too many problems. -T} -T{ -### Modified time -T} -T{ +.SS Modified time +.PP The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known. -T} -T{ +.PP This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes. -T} -T{ -### Size -T} -T{ +.SS Size +.PP The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check. -T} -T{ +.PP It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is \f[B]very slow\f[R] and uses up a lot of transactions. This can be enabled with the \f[C]\-\-gphotos\-read\-size\f[R] option or the \f[C]read_size = true\f[R] config parameter. -T} -T{ +.PP If you want to use the backend with \f[C]rclone mount\f[R] you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You\[aq]ll need to experiment to see if it works for you without the flag. -T} -T{ -### Albums -T} -T{ +.SS Albums +.PP Rclone can only upload files to albums it created. This is a limitation of the Google Photos API (https://developers.google.com/photos/library/guides/manage-albums). -T} -T{ +.PP Rclone can remove files it uploaded from albums it created only. -T} -T{ -### Deleting files -T} -T{ +.SS Deleting files +.PP Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781 (https://issuetracker.google.com/issues/109759781). -T} -T{ +.PP Rclone cannot delete files anywhere except under \f[C]album\f[R]. -T} -T{ -### Deleting albums -T} -T{ +.SS Deleting albums +.PP The Google Photos API does not support deleting albums \- see bug #135714733 (https://issuetracker.google.com/issues/135714733). -T} -T{ -### Standard Options -T} -T{ +.SS Standard Options +.PP Here are the standard options specific to google photos (Google Photos). -T} -T{ -#### \-\-gphotos\-client\-id -T} -T{ +.SS \-\-gphotos\-client\-id +.PP OAuth Client Id Leave blank normally. -T} -T{ -\- Config: client_id \- Env Var: RCLONE_GPHOTOS_CLIENT_ID \- Type: -string \- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-client\-secret -T} -T{ +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-client\-secret +.PP OAuth Client Secret Leave blank normally. -T} -T{ -\- Config: client_secret \- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET \- -Type: string \- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-read\-only -T} -T{ +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-read\-only +.PP Set to make the Google Photos backend read only. -T} -T{ +.PP If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. -T} -T{ -\- Config: read_only \- Env Var: RCLONE_GPHOTOS_READ_ONLY \- Type: bool -\- Default: false -T} -T{ -### Advanced Options -T} -T{ +.IP \[bu] 2 +Config: read_only +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_READ_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP Here are the advanced options specific to google photos (Google Photos). -T} -T{ -#### \-\-gphotos\-token -T} -T{ +.SS \-\-gphotos\-token +.PP OAuth Access Token as a JSON blob. -T} -T{ -\- Config: token \- Env Var: RCLONE_GPHOTOS_TOKEN \- Type: string \- +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-auth\-url -T} -T{ +.SS \-\-gphotos\-auth\-url +.PP Auth server URL. Leave blank to use the provider defaults. -T} -T{ -\- Config: auth_url \- Env Var: RCLONE_GPHOTOS_AUTH_URL \- Type: string -\- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-token\-url -T} -T{ +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-token\-url +.PP Token server url. Leave blank to use the provider defaults. -T} -T{ -\- Config: token_url \- Env Var: RCLONE_GPHOTOS_TOKEN_URL \- Type: -string \- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-read\-size -T} -T{ +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-read\-size +.PP Set to read the size of media items. -T} -T{ +.PP Normally rclone does not read the size of media items since this takes another transaction. This isn\[aq]t necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media. -T} -T{ -\- Config: read_size \- Env Var: RCLONE_GPHOTOS_READ_SIZE \- Type: bool -\- Default: false -T} -T{ -#### \-\-gphotos\-start\-year -T} -T{ +.IP \[bu] 2 +Config: read_size +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_READ_SIZE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-gphotos\-start\-year +.PP Year limits the photos to be downloaded to those which are uploaded after the given year -T} -T{ -\- Config: start_year \- Env Var: RCLONE_GPHOTOS_START_YEAR \- Type: int -\- Default: 2000 -T} -T{ -HTTP -T} -.TE +.IP \[bu] 2 +Config: start_year +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_START_YEAR +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 2000 +.SS HTTP .PP The HTTP remote is a read only remote for reading files of a webserver. The webserver should provide file listings which rclone will read and @@ -21531,6 +26917,12 @@ temporarily on disk (wherever the \f[C]TMPDIR\f[R] environment variable points to) before it is uploaded. Small files will be cached in memory \- see the \-\-jottacloud\-md5\-memory\-limit flag. +When uploading from local disk the source checksum is always available, +so this does not apply. +Starting with rclone version 1.52 the same is true for crypted remotes +(in older versions the crypt backend would not calculate hashes for +uploads from local disk, so the Jottacloud backend had to do it as +described above). .SS Restricted filename characters .PP In addition to the default restricted characters @@ -29569,6 +34961,80 @@ Options: .IP \[bu] 2 \[dq]error\[dq]: return an error based on option value .SH Changelog +.SS v1.53.1 \- 2020\-09\-13 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1) +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting: Remove new line from end of \-\-stats\-one\-line display +(Nick Craig\-Wood) +.IP \[bu] 2 +check +.RS 2 +.IP \[bu] 2 +Add back missing \-\-download flag (Nick Craig\-Wood) +.IP \[bu] 2 +Fix docs (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +docs +.RS 2 +.IP \[bu] 2 +Note \-\-log\-file does append (Nick Craig\-Wood) +.IP \[bu] 2 +Add full stops for consistency in rclone \-\-help (edwardxml) +.IP \[bu] 2 +Add Tencent COS to s3 provider list (wjielai) +.IP \[bu] 2 +Updated mount command to reflect that it requires Go 1.13 or newer (Evan +Harris) +.IP \[bu] 2 +jottacloud: Mention that uploads from local disk will not need to cache +files to disk for md5 calculation (albertony) +.IP \[bu] 2 +Fix formatting of rc docs page (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Include vendor tar ball in release and fix startdev (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \[dq]Illegal instruction\[dq] error for ARMv6 builds (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix architecture name in ARMv7 build (Nick Craig\-Wood) +.RE +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Fix spurious error \[dq]vfs cache: failed to _ensure cache EOF\[dq] +(Nick Craig\-Wood) +.IP \[bu] 2 +Log an ERROR if we fail to set the file to be sparse (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Log an ERROR if we fail to set the file to be sparse (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Re\-adds special oauth help text (Tim Gallant) +.RE +.IP \[bu] 2 +Opendrive +.RS 2 +.IP \[bu] 2 +Do not retry 400 errors (Evan Harris) +.RE .SS v1.53.0 \- 2020\-09\-02 .PP See commits (https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0)