From 6fabf476cff3dd269d23e78cd86f91aa3b24a5a0 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Sat, 26 Oct 2019 11:04:54 +0100 Subject: [PATCH] Version v1.50.0 --- MANUAL.html | 14056 ++++++----- MANUAL.md | 1997 +- MANUAL.txt | 14067 ++++++----- Makefile | 5 + RELEASE.md | 1 + VERSION | 2 +- docs/content/box.md | 24 + docs/content/changelog.md | 115 +- docs/content/chunker.md | 4 +- docs/content/commands/rclone.md | 2 +- docs/content/commands/rclone_about.md | 2 +- docs/content/commands/rclone_authorize.md | 2 +- docs/content/commands/rclone_cachestats.md | 2 +- docs/content/commands/rclone_cat.md | 2 +- docs/content/commands/rclone_check.md | 2 +- docs/content/commands/rclone_cleanup.md | 2 +- docs/content/commands/rclone_config.md | 2 +- docs/content/commands/rclone_config_create.md | 2 +- docs/content/commands/rclone_config_delete.md | 2 +- .../commands/rclone_config_disconnect.md | 2 +- docs/content/commands/rclone_config_dump.md | 2 +- docs/content/commands/rclone_config_edit.md | 2 +- docs/content/commands/rclone_config_file.md | 2 +- .../commands/rclone_config_password.md | 2 +- .../commands/rclone_config_providers.md | 2 +- .../commands/rclone_config_reconnect.md | 2 +- docs/content/commands/rclone_config_show.md | 2 +- docs/content/commands/rclone_config_update.md | 2 +- .../commands/rclone_config_userinfo.md | 2 +- docs/content/commands/rclone_copy.md | 2 +- docs/content/commands/rclone_copyto.md | 2 +- docs/content/commands/rclone_copyurl.md | 4 +- docs/content/commands/rclone_cryptcheck.md | 2 +- docs/content/commands/rclone_cryptdecode.md | 2 +- docs/content/commands/rclone_dbhashsum.md | 2 +- docs/content/commands/rclone_dedupe.md | 2 +- docs/content/commands/rclone_delete.md | 2 +- docs/content/commands/rclone_deletefile.md | 2 +- .../commands/rclone_genautocomplete.md | 2 +- .../commands/rclone_genautocomplete_bash.md | 2 +- .../commands/rclone_genautocomplete_zsh.md | 2 +- docs/content/commands/rclone_gendocs.md | 2 +- docs/content/commands/rclone_hashsum.md | 2 +- docs/content/commands/rclone_link.md | 2 +- docs/content/commands/rclone_listremotes.md | 2 +- docs/content/commands/rclone_ls.md | 2 +- docs/content/commands/rclone_lsd.md | 2 +- docs/content/commands/rclone_lsf.md | 2 +- docs/content/commands/rclone_lsjson.md | 2 +- docs/content/commands/rclone_lsl.md | 2 +- docs/content/commands/rclone_md5sum.md | 2 +- docs/content/commands/rclone_mkdir.md | 2 +- docs/content/commands/rclone_mount.md | 41 +- docs/content/commands/rclone_move.md | 2 +- docs/content/commands/rclone_moveto.md | 2 +- docs/content/commands/rclone_ncdu.md | 2 +- docs/content/commands/rclone_obscure.md | 2 +- docs/content/commands/rclone_purge.md | 2 +- docs/content/commands/rclone_rc.md | 2 +- docs/content/commands/rclone_rcat.md | 2 +- docs/content/commands/rclone_rcd.md | 2 +- docs/content/commands/rclone_rmdir.md | 2 +- docs/content/commands/rclone_rmdirs.md | 2 +- docs/content/commands/rclone_serve.md | 2 +- docs/content/commands/rclone_serve_dlna.md | 3 +- docs/content/commands/rclone_serve_ftp.md | 3 +- docs/content/commands/rclone_serve_http.md | 3 +- docs/content/commands/rclone_serve_restic.md | 2 +- docs/content/commands/rclone_serve_sftp.md | 3 +- docs/content/commands/rclone_serve_webdav.md | 3 +- docs/content/commands/rclone_settier.md | 2 +- docs/content/commands/rclone_sha1sum.md | 2 +- docs/content/commands/rclone_size.md | 2 +- docs/content/commands/rclone_sync.md | 2 +- docs/content/commands/rclone_touch.md | 2 +- docs/content/commands/rclone_tree.md | 2 +- docs/content/commands/rclone_version.md | 2 +- docs/content/drive.md | 28 +- docs/content/flags.md | 32 +- docs/content/ftp.md | 9 + docs/content/http.md | 24 + docs/content/local.md | 6 +- docs/content/mailru.md | 18 +- docs/content/rc.md | 10 +- docs/content/sftp.md | 18 +- docs/layouts/partials/version.html | 2 +- fs/version.go | 2 +- rclone.1 | 20147 ++++++++-------- 88 files changed, 27557 insertions(+), 23192 deletions(-) diff --git a/MANUAL.html b/MANUAL.html index 3539ab34b..c4cf29d31 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Aug 26, 2019

+

Oct 26, 2019

Rclone - rsync for cloud storage

Rclone is a command line program to sync files and directories to and from:

@@ -29,6 +29,7 @@
  • Backblaze B2
  • Box
  • Ceph
    • +
  • Citrix ShareFile
  • C14
  • DigitalOcean Spaces
  • Dreamhost
    • @@ -42,6 +43,7 @@
  • Jottacloud
  • IBM COS S3
  • Koofr
    • +
  • Mail.ru Cloud
  • Memset Memstore
  • Mega
  • Microsoft Azure Blob Storage
    • @@ -77,6 +79,7 @@
  • Can sync to and from network, eg two different cloud accounts
  • Encryption backend
  • Cache backend
    • +
  • Chunking backend
  • Union backend
  • Optional FUSE mount (rclone mount)
  • Multi-threaded downloads to local disk
    • @@ -134,6 +137,49 @@ sudo mv rclone /usr/local/bin/ 
    cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip

    Run rclone config to setup. See rclone config docs for more details.

    rclone config
    +

    Install with docker

    +

    The rclone maintains a docker image for rclone. These images are autobuilt by docker hub from the rclone source based on a minimal Alpine linux image.

    +

    The :latest tag will always point to the latest stable release. You can use the :beta tag to get the latest build from master. You can also use version tags, eg :1.49.1, :1.49 or :1.

    +
    $ docker pull rclone/rclone:latest
+latest: Pulling from rclone/rclone
+Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11
+...
+$ docker run --rm rclone/rclone:latest version
+rclone v1.49.1
+- os/arch: linux/amd64
+- go version: go1.12.9
    +

    There are a few command line options to consider when starting an rclone Docker container from the rclone image.

    + +

    Here are some commands tested on an Ubuntu 18.04.3 host:

    +
    # config on host at ~/.config/rclone/rclone.conf
+# data on host at ~/data
+
+# make sure the config is ok by listing the remotes
+docker run --rm \
+    --volume ~/.config/rclone:/config/rclone \
+    --volume ~/data:/data:shared \
+    --user $(id -u):$(id -g) \
+    rclone/rclone \
+    listremotes
+
+# perform mount inside Docker container, expose result to host
+mkdir -p ~/data/mount
+docker run --rm \
+    --volume ~/.config/rclone:/config/rclone \
+    --volume ~/data:/data:shared \
+    --user $(id -u):$(id -g) \
+    --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \
+    --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \
+    rclone/rclone \
+    mount dropbox:Photos /data/mount &
+ls ~/data/mount
+kill %1

    Install from source

    Make sure you have at least Go 1.7 installed. Download go if necessary. The latest release is recommended. Then

    git clone https://github.com/rclone/rclone.git
@@ -166,6 +212,8 @@ go build
 
  • Backblaze B2
    • 
 
  • Box
    • 
 
  • Cache
    • 
+
  • Chunker - transparently splits large files for other remotes
    • 
+
  • Citrix ShareFile
    • 
 
  • Crypt - to encrypt other remotes
    • 
 
  • DigitalOcean Spaces
    • 
 
  • Dropbox
    • 
@@ -177,6 +225,7 @@ go build
 
  • Hubic
    • 
 
  • Jottacloud
    • 
 
  • Koofr
    • 
+
  • Mail.ru Cloud
    • 
 
  • Mega
    • 
 
  • Microsoft Azure Blob Storage
    • 
 
  • Microsoft OneDrive
    • 
@@ -900,9 +949,11 @@ if src is directory
 
    Copy url content to dest.
    
 
    Synopsis
    
 
    Download urls content and copy it to destination without saving it in tmp storage.
    
+
    Setting –auto-filename flag will cause retrieving file name from url and using it in destination path.
    
 
    rclone copyurl https://example.com dest:path [flags]
    
 
    Options
    
-
      -h, --help   help for copyurl
    
+
      -a, --auto-filename   Get the file name from the url and use it for destination file path
+  -h, --help            help for copyurl
    
 
    See the global flags page for global options not listed here.
    
 
    SEE ALSO
    --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) --volname string Set the volume name (not supported by all OSes). @@ -1593,6 +1645,7 @@ ffmpeg - | rclone rcat remote:path/to/file --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)

    See the global flags page for global options not listed here.

    @@ -1714,6 +1767,7 @@ ffmpeg - | rclone rcat remote:path/to/file --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)

    See the global flags page for global options not listed here.

    @@ -1833,6 +1887,7 @@ htpasswd -B htpasswd anotherUser --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)

    See the global flags page for global options not listed here.

    @@ -2041,6 +2096,7 @@ htpasswd -B htpasswd anotherUser --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)

    See the global flags page for global options not listed here.

    @@ -2189,6 +2245,7 @@ htpasswd -B htpasswd anotherUser --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)

    See the global flags page for global options not listed here.

    @@ -2607,9 +2664,10 @@ rclone sync /path/to/files remote:current-backup

    The default is to run 4 file transfers in parallel.

    -u, –update

    This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file.

    -

    If an existing destination file has a modification time equal (within the computed modify window precision) to the source file’s, it will be updated if the sizes are different.

    -

    On remotes which don’t support mod time directly (or when using --use-server-modtime) the time checked will be the uploaded time. This means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file.

    This can be useful when transferring to a remote which doesn’t support mod times directly (or when using --use-server-modtime to avoid extra API calls) as it is more accurate than a --size-only check and faster than using --checksum.

    +

    If an existing destination file has a modification time equal (within the computed modify window precision) to the source file’s, it will be updated if the sizes are different. If --checksum is set then rclone will update the destination if the checksums differ too.

    +

    If an existing destination file is older than the source file then it will be updated if the size or checksum differs from the source file.

    +

    On remotes which don’t support mod time directly (or when using --use-server-modtime) the time checked will be the uploaded time. This means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file.

    –use-mmap

    If this flag is set then rclone will use anonymous memory allocated by mmap on Unix based platforms and VirtualAlloc on Windows for its transfer buffers (size controlled by --buffer-size). Memory allocated like this does not go on the Go heap and can be returned to the OS immediately when it is finished with.

    If this flag is not set then rclone will allocate and free the buffers using the Go memory allocator which may use more memory as memory pages are returned less aggressively to the OS.

    @@ -3301,12 +3359,16 @@ rclone rc cache/expire remote=/ withData=true

    This takes the following parameters

    See the config create command command for more information on the above.

    Authentication is required for this call.

    config/delete: Delete a remote in the config file. {#config/delete}

    -

    Parameters: - name - name of remote to delete

    +

    Parameters:

    +

    See the config delete command command for more information on the above.

    Authentication is required for this call.

    config/dump: Dumps the config file. {#config/dump}

    @@ -3326,6 +3388,7 @@ rclone rc cache/expire remote=/ withData=true

    This takes the following parameters

    See the config password command command for more information on the above.

    Authentication is required for this call.

    @@ -3337,6 +3400,7 @@ rclone rc cache/expire remote=/ withData=true

    This takes the following parameters

    See the config update command command for more information on the above.

    Authentication is required for this call.

    @@ -3373,59 +3437,62 @@ rclone rc core/bwlimit rate=1M "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/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, “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”: speed in bytes/sec, “speedAvg”: 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-reset: Reset stats. {#core/stats-reset}
-
-This clears counters and errors for all stats or specific stats group if group
-is provided.
-
-Parameters
-- group - name of the stats group (string)
-
+}
    +

    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:

    + +

    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,
+    "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": speed in bytes/sec,
+                "speedAvg": 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-reset: Reset stats. {#core/stats-reset}

    +

    This clears counters and errors 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:
@@ -3435,6233 +3502,6319 @@ This returns stats about completed transfers:
 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 successfull), “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.44” - decomposed - version number as [major, minor, patch, subpatch] - note patch and subpatch will be 999 for a git compiled version - isGit - boolean - true if this was compiled from the git version - os - OS in use as according to Go - arch - cpu architecture in use according to Go - goVersion - version of Go runtime in use

    -

    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)

    -

    operations/about: Return the space used on the remote {#operations/about}

    -

    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 {#operations/cleanup}

    -

    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 {#operations/copyfile}

    -

    This takes the following parameters

    - -

    Authentication is required for this call.

    -

    operations/copyurl: Copy the URL to the object {#operations/copyurl}

    -

    This takes the following parameters

    - -

    See the copyurl command 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

    - -

    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 {#operations/deletefile}

    -

    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 {#operations/fsinfo}

    -

    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 {#operations/list}

    -

    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 {#operations/mkdir}

    -

    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 {#operations/movefile}

    -

    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 {#operations/purge}

    -

    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 {#operations/rmdir}

    -

    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 {#operations/rmdirs}

    -

    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 {#operations/size}

    -

    This takes the following parameters

    - -

    Returns

    - -

    See the size command 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

    - -

    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}}'
    -

    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

    - -

    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 {#sync/move}

    -

    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 {#sync/sync}

    -

    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. {#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
    -

    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.

    -

    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.

    - -

    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"
-}
+
    
+### 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.44"
+- decomposed - version number as [major, minor, patch, subpatch]
+    - note patch and subpatch will be 999 for a git compiled version
+- isGit - boolean - true if this was compiled from the git version
+- os - OS in use as according to Go
+- arch - cpu architecture in use according to Go
+- goVersion - version of Go runtime in use
+
+### 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)
+
+### 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;
 
    
-
    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
      • 
-
    
-
    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-
    DropboxDBHASH †YesYesNo-
    FTP-NoNoNo-
    Google Cloud StorageMD5YesNoNoR/W
    Google DriveMD5YesNoYesR/W
    Google Photos-NoNoYesR
    HTTP-NoNoNoR
    HubicMD5YesNoNoR/W
    JottacloudMD5YesYesNoR/W
    KoofrMD5NoYesNo-
    Mega-NoNoYes-
    Microsoft Azure Blob StorageMD5YesNoNoR/W
    Microsoft OneDriveSHA1 ‡‡YesYesNoR
    OpenDriveMD5YesYesNo-
    Openstack SwiftMD5YesNoNoR/W
    pCloudMD5, SHA1YesNoNoW
    premiumize.me-NoYesNoR
    put.ioCRC-32YesNoYesR
    QingStorMD5NoNoNoR/W
    SFTPMD5, SHA1 ‡YesDependsNo-
    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.
    
-
    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.
    
-
    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 S3NoYesNoNoNoYesYesNo #2178NoNo
    Backblaze B2NoYesNoNoYesYesYesYesNoNo
    BoxYesYesYesYesNo #575NoYesYesNoYes
    DropboxYesYesYesYesNo #575NoYesYesYesYes
    FTPNoNoYesYesNoNoYesNo #2178NoYes
    Google Cloud StorageYesYesNoNoNoYesYesNo #2178NoNo
    Google DriveYesYesYesYesYesYesYesYesYesYes
    Google PhotosNoNoNoNoNoNoNoNoNoNo
    HTTPNoNoNoNoNoNoNoNo #2178NoYes
    HubicYes †YesNoNoNoYesYesNo #2178YesNo
    JottacloudYesYesYesYesNoYesNoYesYesYes
    MegaYesNoYesYesYesNoNoNo #2178YesYes
    Microsoft Azure Blob StorageYesYesNoNoNoYesNoNo #2178NoNo
    Microsoft OneDriveYesYesYesYesNo #575NoNoYesYesYes
    OpenDriveYesYesYesYesNoNoNoNoNoYes
    Openstack SwiftYes †YesNoNoNoYesYesNo #2178YesNo
    pCloudYesYesYesYesYesNoNoNo #2178YesYes
    premiumize.meYesNoYesYesNoNoNoYesYesYes
    put.ioYesNoYesYesYesNoYesNo #2178YesYes
    QingStorNoYesNoNoNoYesNoNo #2178NoNo
    SFTPNoNoYesYesNoNoYesNo #2178YesYes
    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 and Hubic 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.
    
-
    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.
-      --ca-cert string                       CA certificate used to verify servers
-      --cache-dir string                     Directory rclone will use for caching. (default "$HOME/.cache/rclone")
-      --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                  use DIR to server side copy flies from.
-      --config string                        Config file. (default "$HOME/.config/rclone/rclone.conf")
-      --contimeout duration                  Connect timeout (default 1m0s)
-      --copy-dest string                     Compare dest to DIR also.
-      --cpuprofile string                    Write cpu profile to file
-      --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
-      --exclude stringArray                  Exclude files matching pattern
-      --exclude-from stringArray             Read exclude patterns from file
-      --exclude-if-present string            Exclude directories if filename is present
-      --fast-list                            Use recursive list if available. Uses more memory but fewer transactions.
-      --files-from stringArray               Read list of source-file names from file
-  -f, --filter stringArray                   Add a file-filtering rule
-      --filter-from stringArray              Read filtering patterns from a file
-      --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
-      --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-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-gzip-encoding                     Don't set Accept-Encoding: gzip.
-      --no-traverse                          Don't traverse destination file system on copy.
-      --no-update-modtime                    Don't update destination mod-time if files identical.
-  -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-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-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-update                    Update / Force update to latest version of web gui
-      --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
-      --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.49.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                         Amazon Application Client ID.
-      --acd-client-secret string                     Amazon Application Client Secret.
-      --acd-templink-threshold SizeSuffix            Files >= this size will be downloaded via their tempLink. (default 9G)
-      --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-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-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-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-endpoint string                           Endpoint for the service.
-      --b2-hard-delete                               Permanently delete files on remote removal, otherwise hide files.
-      --b2-key string                                Application Key
-      --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-client-id string                         Box App Client Id.
-      --box-client-secret string                     Box App Client Secret
-      --box-commit-retries int                       Max number of times to try committing a multipart file. (default 100)
-      --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 verifications when connecting to the Plex server
-      --cache-plex-password string                   The password of the Plex user
-      --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
-  -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.
-      --crypt-password2 string                       Password or pass phrase for salt. Optional but recommended.
-      --crypt-remote string                          Remote to encrypt/decrypt.
-      --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-alternate-export                       Use alternate export URLs for google documents export.,
-      --drive-auth-owner-only                        Only consider files owned by the authenticated user.
-      --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                   Google Application Client Secret
-      --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 storage quota usage for file size.
-      --drive-skip-checksum-gphotos                  Skip MD5 checksum on Google photos and videos only.
-      --drive-skip-gdocs                             Skip google documents in all listings.
-      --drive-team-drive string                      ID of the Team Drive
-      --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-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-chunk-size SizeSuffix                Upload chunk size. (< 150M). (default 48M)
-      --dropbox-client-id string                     Dropbox App Client Id
-      --dropbox-client-secret string                 Dropbox App Client Secret
-      --dropbox-impersonate string                   Impersonate this user when using a business account.
-      --fichier-api-key string                       Your API Key, get it from https://1fichier.com/console/params.pl
-      --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-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
-      --ftp-port string                              FTP port, leave blank to use default (21)
-      --ftp-tls                                      Use FTP over TLS (Implicit)
-      --ftp-user string                              FTP username, leave blank for current username, $USER
-      --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                         Google Application Client Id
-      --gcs-client-secret string                     Google Application Client Secret
-      --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.
-      --gphotos-client-id string                     Google Application Client Id
-      --gphotos-client-secret string                 Google Application 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.
-      --http-headers CommaSepList                    Set HTTP headers for all transactions
-      --http-no-slash                                Set this if the site doesn't end directories with /
-      --http-url string                              URL of http host to connect to
-      --hubic-chunk-size SizeSuffix                  Above this size files will be chunked into a _segments container. (default 5G)
-      --hubic-client-id string                       Hubic Client Id
-      --hubic-client-secret string                   Hubic Client Secret
-      --hubic-no-chunk                               Don't chunk files during streaming upload.
-      --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-unlink                            Remove existing public link to file/folder with link command rather than creating.
-      --jottacloud-upload-resume-limit SizeSuffix    Files bigger than this can be resumed if the upload fail's. (default 10M)
-      --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)
-      --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-no-check-updated                       Don't check to see if the files change during upload
-      --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
-      --mega-debug                                   Output more debug from Mega.
-      --mega-hard-delete                             Delete files permanently rather than putting them into the trash.
-      --mega-pass string                             Password.
-      --mega-user string                             User name
-  -x, --one-file-system                              Don't cross filesystem boundaries (unix/macOS only).
-      --onedrive-chunk-size SizeSuffix               Chunk size to upload files with - must be multiple of 320k. (default 10M)
-      --onedrive-client-id string                    Microsoft App Client Id
-      --onedrive-client-secret string                Microsoft App 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-expose-onenote-files                Set to make OneNote files show up in directory listings.
-      --opendrive-password string                    Password.
-      --opendrive-username string                    Username
-      --pcloud-client-id string                      Pcloud App Client Id
-      --pcloud-client-secret string                  Pcloud App Client Secret
-      --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-endpoint string                     Enter a 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-disable-checksum                          Don't store MD5 checksum with object metadata
-      --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-location-constraint string                Location constraint - must be set to match the Region.
-      --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-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.
-      --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.
-      --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.
-      --sftp-path-override string                    Override path used by SSH connection.
-      --sftp-port string                             SSH port, leave blank to use default (22)
-      --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-use-insecure-cipher                     Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.
-      --sftp-user string                             SSH username, leave blank for current username, ncw
-      --skip-links                                   Don't warn about skipped symlinks.
-      --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-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).
-      --union-remotes string                         List of space separated remotes.
-      --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.
-      --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-client-id string                      Yandex Client Id
-      --yandex-client-secret string                  Yandex Client Secret
-      --yandex-unlink                                Remove existing public link to file/folder with link command rather than creating.
    
-
    1Fichier
    
-
    This is a backend for the 1ficher 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/ **
+
    { // 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"
+
+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.
+
+### 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}}'
+
+### 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
+
+### 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.
+
+### 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.
+
+<!--- autogenerated stop -->
+
+## 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`
+
+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             | -         |
+| Microsoft Azure Blob Storage | MD5         | Yes     | No               | No              | R/W       |
+| Microsoft OneDrive           | SHA1 ‡‡     | Yes     | Yes              | No              | R         |
+| OpenDrive                    | MD5         | Yes     | Yes              | No              | -         |
+| 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       |
+| SFTP                         | MD5, SHA1 ‡ | Yes     | Depends          | 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.
+
+### 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](/local/#filenames) section for details.
+
+### 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      | No      | 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     | No [#575](https://github.com/rclone/rclone/issues/575) | 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     | No      | 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 |
+| Microsoft Azure Blob Storage | Yes   | Yes  | No   | No      | No      | Yes   | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
+| Microsoft OneDrive           | Yes   | Yes  | Yes  | Yes     | No [#575](https://github.com/rclone/rclone/issues/575) | 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           | No [#2178](https://github.com/rclone/rclone/issues/2178) | 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      | No      | Yes   | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
+| SFTP                         | No    | No   | Yes  | Yes     | No      | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes  | Yes |
+| 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 and Hubic 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.
+
+### 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](/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](/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.
+  --ca-cert string                       CA certificate used to verify servers
+  --cache-dir string                     Directory rclone will use for caching. (default "$HOME/.cache/rclone")
+  --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 use DIR to server side copy flies from. –config string Config file. (default “$HOME/.config/rclone/rclone.conf”) –contimeout duration Connect timeout (default 1m0s) –copy-dest string Compare dest to DIR also. –cpuprofile string Write cpu profile to file –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 –exclude stringArray Exclude files matching pattern –exclude-from stringArray Read exclude patterns from file –exclude-if-present string Exclude directories if filename is present –fast-list Use recursive list if available. Uses more memory but fewer transactions. –files-from stringArray Read list of source-file names from file -f, –filter stringArray Add a file-filtering rule –filter-from stringArray Read filtering patterns from a file –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 –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-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-gzip-encoding Don’t set Accept-Encoding: gzip. –no-traverse Don’t traverse destination file system on copy. –no-update-modtime Don’t update destination mod-time if files identical. -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-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-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-update Update / Force update to latest version of web gui –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 –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.50.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                         Amazon Application Client ID.
+  --acd-client-secret string                     Amazon Application Client Secret.
+  --acd-templink-threshold SizeSuffix            Files >= this size will be downloaded via their tempLink. (default 9G)
+  --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-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-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-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-endpoint string                           Endpoint for the service.
+  --b2-hard-delete                               Permanently delete files on remote removal, otherwise hide files.
+  --b2-key string                                Application Key
+  --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-box-config-file string                   Box App config.json location
+  --box-box-sub-type string                       (default "user")
+  --box-client-id string                         Box App Client Id.
+  --box-client-secret string                     Box App Client Secret
+  --box-commit-retries int                       Max number of times to try committing a multipart file. (default 100)
+  --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 verifications when connecting to the Plex server
+  --cache-plex-password string                   The password of the Plex user
+  --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. –crypt-password2 string Password or pass phrase for salt. Optional but recommended. –crypt-remote string Remote to encrypt/decrypt. –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-alternate-export Use alternate export URLs for google documents export., –drive-auth-owner-only Only consider files owned by the authenticated user. –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 Google Application Client Secret –drive-disable-http2 Disable drive using http2 (default true) –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 storage quota usage for file size. –drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. –drive-skip-gdocs Skip google documents in all listings. –drive-team-drive string ID of the Team Drive –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-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-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) –dropbox-client-id string Dropbox App Client Id –dropbox-client-secret string Dropbox App Client Secret –dropbox-impersonate string Impersonate this user when using a business account. –fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl –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-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 –ftp-port string FTP port, leave blank to use default (21) –ftp-tls Use FTP over TLS (Implicit) –ftp-user string FTP username, leave blank for current username, $USER –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 Google Application Client Id –gcs-client-secret string Google Application Client Secret –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. –gphotos-client-id string Google Application Client Id –gphotos-client-secret string Google Application 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. –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-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) –hubic-client-id string Hubic Client Id –hubic-client-secret string Hubic Client Secret –hubic-no-chunk Don’t chunk files during streaming upload. –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-unlink Remove existing public link to file/folder with link command rather than creating. –jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail’s. (default 10M) –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) –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-no-check-updated Don’t check to see if the files change during upload –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-pass string Password –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-hard-delete Delete files permanently rather than putting them into the trash. –mega-pass string Password. –mega-user string User name -x, –one-file-system Don’t cross filesystem boundaries (unix/macOS only). –onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) –onedrive-client-id string Microsoft App Client Id –onedrive-client-secret string Microsoft App 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-expose-onenote-files Set to make OneNote files show up in directory listings. –opendrive-password string Password. –opendrive-username string Username –pcloud-client-id string Pcloud App Client Id –pcloud-client-secret string Pcloud App Client Secret –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-endpoint string Enter a 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-disable-checksum Don’t store MD5 checksum with object metadata –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-location-constraint string Location constraint - must be set to match the Region. –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-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. –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. –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. –sftp-path-override string Override path used by SSH connection. –sftp-port string SSH port, leave blank to use default (22) –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-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-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. –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-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). –union-remotes string List of space separated remotes. –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. –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-client-id string Yandex Client Id –yandex-client-secret string Yandex Client Secret –yandex-unlink Remove existing public link to file/folder with link command rather than creating.
    
+
    
+1Fichier
+-----------------------------------------
+
+This is a backend for the [1ficher](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](/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 first or last character in the
+name:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| SP        | 0x20  | ␠           |
+
+Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs -->
+### 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
-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.
    
-
    Forbidden characters
    
-
    1Fichier does not support the characters \ < > " ' ` $ and spaces at the beginning of folder names. rclone automatically escapes these to a unicode equivalent. The exception is /, which cannot be escaped and will therefore lead to errors.
    
-
-
    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: ""
      • 
-
    
-
-
    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 a 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 a 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
+- 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:     ""
+
+<!--- autogenerated options stop -->
+
+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 a 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 a 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
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs -->
+### 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".
-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
+- Config:      remote
+- Env Var:     RCLONE_ALIAS_REMOTE
+- Type:        string
+- Default:     ""
+
+<!--- autogenerated options stop -->
+
+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 a third party ouath 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](/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.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/amazonclouddrive/amazonclouddrive.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to amazon cloud drive (Amazon Drive).
+
+#### --acd-client-id
+
+Amazon Application Client ID.
+
+- Config:      client_id
+- Env Var:     RCLONE_ACD_CLIENT_ID
+- Type:        string
+- Default:     ""
+
+#### --acd-client-secret
+
+Amazon Application Client Secret.
+
+- 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-auth-url
+
+Auth server URL.
+Leave blank to use Amazon's.
+
+- Config:      auth_url
+- Env Var:     RCLONE_ACD_AUTH_URL
+- Type:        string
+- Default:     ""
+
+#### --acd-token-url
+
+Token server url.
+leave blank to use Amazon's.
+
+- 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
+
+<!--- autogenerated options stop -->
+
+### 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
+* 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 /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” / South America (Sao Paulo) Region 14 | 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 / 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](/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.
+
+#### Restricted filename characters
+
+S3 allows any valid UTF-8 string as a key.
+
+Invalid UTF-8 bytes will be [replaced](/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).
+
+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.
+
+<!--- 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)).
+
+#### --s3-provider
 
-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 a third party ouath 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.
    
-
    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
    
-
    Amazon Application Client ID.
    
-
      
-
    • Config: client_id
      • 
-
    • Env Var: RCLONE_ACD_CLIENT_ID
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    –acd-client-secret
    
-
    Amazon Application Client Secret.
    
-
      
-
    • 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-auth-url
    
-
    Auth server URL. Leave blank to use Amazon’s.
    
-
      
-
    • Config: auth_url
      • 
-
    • Env Var: RCLONE_ACD_AUTH_URL
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    –acd-token-url
    
-
    Token server url. leave blank to use Amazon’s.
    
-
      
-
    • 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
      • 
-
    
-
-
    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
      • 
-
    • 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 /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.
-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"
-   / South America (Sao Paulo) Region
-14 | 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 / 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.
    
-
    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).
        • 
-
      • 
-
    
-
    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, 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)
          • 
-
        • 
-
      • “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.
          • 
-
        • 
-
      • “sa-east-1”
-
          
-
        • South America (Sao Paulo) Region
          • 
-
        • Needs location constraint sa-east-1.
          • 
-
        • 
-
      • 
-
    
-
    –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-api.us-geo.objectstorage.softlayer.net”
-
          
-
        • US Cross Region Endpoint
          • 
-
        • 
-
      • “s3-api.dal.us-geo.objectstorage.softlayer.net”
-
          
-
        • US Cross Region Dallas Endpoint
          • 
-
        • 
-
      • “s3-api.wdc-us-geo.objectstorage.softlayer.net”
-
          
-
        • US Cross Region Washington DC Endpoint
          • 
-
        • 
-
      • “s3-api.sjc-us-geo.objectstorage.softlayer.net”
-
          
-
        • US Cross Region San Jose Endpoint
          • 
-
        • 
-
      • “s3-api.us-geo.objectstorage.service.networklayer.com”
-
          
-
        • US Cross Region Private Endpoint
          • 
-
        • 
-
      • “s3-api.dal-us-geo.objectstorage.service.networklayer.com”
-
          
-
        • US Cross Region Dallas Private Endpoint
          • 
-
        • 
-
      • “s3-api.wdc-us-geo.objectstorage.service.networklayer.com”
-
          
-
        • US Cross Region Washington DC Private Endpoint
          • 
-
        • 
-
      • “s3-api.sjc-us-geo.objectstorage.service.networklayer.com”
-
          
-
        • US Cross Region San Jose Private Endpoint
          • 
-
        • 
-
      • “s3.us-east.objectstorage.softlayer.net”
-
          
-
        • US Region East Endpoint
          • 
-
        • 
-
      • “s3.us-east.objectstorage.service.networklayer.com”
-
          
-
        • US Region East Private Endpoint
          • 
-
        • 
-
      • “s3.us-south.objectstorage.softlayer.net”
-
          
-
        • US Region South Endpoint
          • 
-
        • 
-
      • “s3.us-south.objectstorage.service.networklayer.com”
-
          
-
        • US Region South Private Endpoint
          • 
-
        • 
-
      • “s3.eu-geo.objectstorage.softlayer.net”
-
          
-
        • EU Cross Region Endpoint
          • 
-
        • 
-
      • “s3.fra-eu-geo.objectstorage.softlayer.net”
-
          
-
        • EU Cross Region Frankfurt Endpoint
          • 
-
        • 
-
      • “s3.mil-eu-geo.objectstorage.softlayer.net”
-
          
-
        • EU Cross Region Milan Endpoint
          • 
-
        • 
-
      • “s3.ams-eu-geo.objectstorage.softlayer.net”
-
          
-
        • EU Cross Region Amsterdam Endpoint
          • 
-
        • 
-
      • “s3.eu-geo.objectstorage.service.networklayer.com”
-
          
-
        • EU Cross Region Private Endpoint
          • 
-
        • 
-
      • “s3.fra-eu-geo.objectstorage.service.networklayer.com”
-
          
-
        • EU Cross Region Frankfurt Private Endpoint
          • 
-
        • 
-
      • “s3.mil-eu-geo.objectstorage.service.networklayer.com”
-
          
-
        • EU Cross Region Milan Private Endpoint
          • 
-
        • 
-
      • “s3.ams-eu-geo.objectstorage.service.networklayer.com”
-
          
-
        • EU Cross Region Amsterdam Private Endpoint
          • 
-
        • 
-
      • “s3.eu-gb.objectstorage.softlayer.net”
-
          
-
        • Great Britain Endpoint
          • 
-
        • 
-
      • “s3.eu-gb.objectstorage.service.networklayer.com”
-
          
-
        • Great Britain Private Endpoint
          • 
-
        • 
-
      • “s3.ap-geo.objectstorage.softlayer.net”
-
          
-
        • APAC Cross Regional Endpoint
          • 
-
        • 
-
      • “s3.tok-ap-geo.objectstorage.softlayer.net”
-
          
-
        • APAC Cross Regional Tokyo Endpoint
          • 
-
        • 
-
      • “s3.hkg-ap-geo.objectstorage.softlayer.net”
-
          
-
        • APAC Cross Regional HongKong Endpoint
          • 
-
        • 
-
      • “s3.seo-ap-geo.objectstorage.softlayer.net”
-
          
-
        • APAC Cross Regional Seoul Endpoint
          • 
-
        • 
-
      • “s3.ap-geo.objectstorage.service.networklayer.com”
-
          
-
        • APAC Cross Regional Private Endpoint
          • 
-
        • 
-
      • “s3.tok-ap-geo.objectstorage.service.networklayer.com”
-
          
-
        • APAC Cross Regional Tokyo Private Endpoint
          • 
-
        • 
-
      • “s3.hkg-ap-geo.objectstorage.service.networklayer.com”
-
          
-
        • APAC Cross Regional HongKong Private Endpoint
          • 
-
        • 
-
      • “s3.seo-ap-geo.objectstorage.service.networklayer.com”
-
          
-
        • APAC Cross Regional Seoul Private Endpoint
          • 
-
        • 
-
      • “s3.mel01.objectstorage.softlayer.net”
-
          
-
        • Melbourne Single Site Endpoint
          • 
-
        • 
-
      • “s3.mel01.objectstorage.service.networklayer.com”
-
          
-
        • Melbourne Single Site Private Endpoint
          • 
-
        • 
-
      • “s3.tor01.objectstorage.softlayer.net”
-
          
-
        • Toronto Single Site Endpoint
          • 
-
        • 
-
      • “s3.tor01.objectstorage.service.networklayer.com”
-
          
-
        • Toronto 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 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)
          • 
-
        • 
-
      • “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:
-
        
-
      • “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.
          • 
-
        • 
-
      • 
-
    
-
    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-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 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.
    
-
      
-
    • Config: chunk_size
      • 
-
    • Env Var: RCLONE_S3_CHUNK_SIZE
      • 
-
    • Type: SizeSuffix
      • 
-
    • Default: 5M
      • 
-
    
-
    –s3-disable-checksum
    
-
    Don’t store MD5 checksum with object metadata
    
-
      
-
    • Config: disable_checksum
      • 
-
    • Env Var: RCLONE_S3_DISABLE_CHECKSUM
      • 
-
    • Type: bool
      • 
-
    • Default: false
      • 
-
    
-
    –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 Aliyun OSS or Netease COS) require this set to false.
    
-
      
-
    • 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
      • 
-
    
-
-
    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 promted 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
+- 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)
+    - "Wasabi"
+        - Wasabi Object Storage
+    - "Other"
+        - Any other S3 compatible provider
 
-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
+#### --s3-env-auth
 
-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
-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
-force_path_style = false
-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
+
+- 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.
-Enter a string value. Press Enter for the default ("").
-access_key_id> accesskeyid
+
+- 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.
-Enter a string value. Press Enter for the default ("").
-secret_access_key> secretaccesskey
+
+- 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.
+    - "sa-east-1"
+        - South America (Sao Paulo) Region
+        - Needs location constraint sa-east-1.
+
+#### --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-api.us-geo.objectstorage.softlayer.net"
+        - US Cross Region Endpoint
+    - "s3-api.dal.us-geo.objectstorage.softlayer.net"
+        - US Cross Region Dallas Endpoint
+    - "s3-api.wdc-us-geo.objectstorage.softlayer.net"
+        - US Cross Region Washington DC Endpoint
+    - "s3-api.sjc-us-geo.objectstorage.softlayer.net"
+        - US Cross Region San Jose Endpoint
+    - "s3-api.us-geo.objectstorage.service.networklayer.com"
+        - US Cross Region Private Endpoint
+    - "s3-api.dal-us-geo.objectstorage.service.networklayer.com"
+        - US Cross Region Dallas Private Endpoint
+    - "s3-api.wdc-us-geo.objectstorage.service.networklayer.com"
+        - US Cross Region Washington DC Private Endpoint
+    - "s3-api.sjc-us-geo.objectstorage.service.networklayer.com"
+        - US Cross Region San Jose Private Endpoint
+    - "s3.us-east.objectstorage.softlayer.net"
+        - US Region East Endpoint
+    - "s3.us-east.objectstorage.service.networklayer.com"
+        - US Region East Private Endpoint
+    - "s3.us-south.objectstorage.softlayer.net"
+        - US Region South Endpoint
+    - "s3.us-south.objectstorage.service.networklayer.com"
+        - US Region South Private Endpoint
+    - "s3.eu-geo.objectstorage.softlayer.net"
+        - EU Cross Region Endpoint
+    - "s3.fra-eu-geo.objectstorage.softlayer.net"
+        - EU Cross Region Frankfurt Endpoint
+    - "s3.mil-eu-geo.objectstorage.softlayer.net"
+        - EU Cross Region Milan Endpoint
+    - "s3.ams-eu-geo.objectstorage.softlayer.net"
+        - EU Cross Region Amsterdam Endpoint
+    - "s3.eu-geo.objectstorage.service.networklayer.com"
+        - EU Cross Region Private Endpoint
+    - "s3.fra-eu-geo.objectstorage.service.networklayer.com"
+        - EU Cross Region Frankfurt Private Endpoint
+    - "s3.mil-eu-geo.objectstorage.service.networklayer.com"
+        - EU Cross Region Milan Private Endpoint
+    - "s3.ams-eu-geo.objectstorage.service.networklayer.com"
+        - EU Cross Region Amsterdam Private Endpoint
+    - "s3.eu-gb.objectstorage.softlayer.net"
+        - Great Britain Endpoint
+    - "s3.eu-gb.objectstorage.service.networklayer.com"
+        - Great Britain Private Endpoint
+    - "s3.ap-geo.objectstorage.softlayer.net"
+        - APAC Cross Regional Endpoint
+    - "s3.tok-ap-geo.objectstorage.softlayer.net"
+        - APAC Cross Regional Tokyo Endpoint
+    - "s3.hkg-ap-geo.objectstorage.softlayer.net"
+        - APAC Cross Regional HongKong Endpoint
+    - "s3.seo-ap-geo.objectstorage.softlayer.net"
+        - APAC Cross Regional Seoul Endpoint
+    - "s3.ap-geo.objectstorage.service.networklayer.com"
+        - APAC Cross Regional Private Endpoint
+    - "s3.tok-ap-geo.objectstorage.service.networklayer.com"
+        - APAC Cross Regional Tokyo Private Endpoint
+    - "s3.hkg-ap-geo.objectstorage.service.networklayer.com"
+        - APAC Cross Regional HongKong Private Endpoint
+    - "s3.seo-ap-geo.objectstorage.service.networklayer.com"
+        - APAC Cross Regional Seoul Private Endpoint
+    - "s3.mel01.objectstorage.softlayer.net"
+        - Melbourne Single Site Endpoint
+    - "s3.mel01.objectstorage.service.networklayer.com"
+        - Melbourne Single Site Private Endpoint
+    - "s3.tor01.objectstorage.softlayer.net"
+        - Toronto Single Site Endpoint
+    - "s3.tor01.objectstorage.service.networklayer.com"
+        - Toronto Single Site Private Endpoint
+
+#### --s3-endpoint
+
 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
+
+- 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 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)
+    - "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.
-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
+
+- 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
+
 The storage class to use when storing new objects in OSS.
-Enter a string value. Press Enter for the default ("").
+
+- 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.
+
+### 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-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 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.
+
+- Config:      chunk_size
+- Env Var:     RCLONE_S3_CHUNK_SIZE
+- Type:        SizeSuffix
+- Default:     5M
+
+#### --s3-disable-checksum
+
+Don't store MD5 checksum with object metadata
+
+- Config:      disable_checksum
+- Env Var:     RCLONE_S3_DISABLE_CHECKSUM
+- Type:        bool
+- Default:     false
+
+#### --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 Aliyun OSS or Netease COS) require this set to false.
+
+- 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
+
+<!--- autogenerated options stop -->
+
+### 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 promted 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> <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.
 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]
+ 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 = 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.
    
-
    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
+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 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 force_path_style = false 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 /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](/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](/overview/#restricted-characters)
+the following characters are also replaced:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| \         | 0x5C  | ＼           |
+
+Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+### 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](/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](/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
    
+
    
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/b2/b2.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to b2 (Backblaze B2).
+
+#### --b2-account
+
 Account ID or Application Key ID
-account> 123456789abc
+
+- Config:      account
+- Env Var:     RCLONE_B2_ACCOUNT
+- Type:        string
+- Default:     ""
+
+#### --b2-key
+
 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 /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.
    
-
    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
+- Config:      key
+- Env Var:     RCLONE_B2_KEY
+- Type:        string
+- Default:     ""
 
-$ 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
+#### --b2-hard-delete
 
-$ rclone -q ls b2:cleanup-test
-        9 one.txt
+Permanently delete files on remote removal, otherwise hide files.
 
-$ 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
+- 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-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
+
+- 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
+
+<!--- autogenerated options stop -->
+
+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:
 
    
-
    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
+
    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 ("“). config_json> ‘enterprise’ or ‘user’ depending on the type of token being requested. Enter a string value. Press Enter for the default (”user“). 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.
 
    
-
-
    Standard Options
    
-
    Here are the standard options specific to b2 (Backblaze B2).
    
-
    –b2-account
    
-
    Account ID or Application Key ID
    
+
    $ 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. 
+
    
 
      
-
    • Config: account
      • 
-
    • Env Var: RCLONE_B2_ACCOUNT
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
+
    • Say Y if not sure
      • 
+
    • Say N if you are working on a remote or headless machine
      • 
 
    
-
    –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-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
    
-
      
-
    • 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
      • 
-
    
-
-
    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 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.
-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> 
-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:
+
      
+
    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 ###
 
-Name                 Type
-====                 ====
-remote               box
+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](/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 last character in the name:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| SP        | 0x20  | ␠           |
+
+Invalid UTF-8 bytes will also be [replaced](/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.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/box/box.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to box (Box).
+
+#### --box-client-id
+
+Box App Client Id.
+Leave blank normally.
+
+- Config:      client_id
+- Env Var:     RCLONE_BOX_CLIENT_ID
+- Type:        string
+- Default:     ""
+
+#### --box-client-secret
+
+Box App 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.
+
+- Config:      box_config_file
+- Env Var:     RCLONE_BOX_BOX_CONFIG_FILE
+- 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-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
+
+<!--- autogenerated options stop -->
+
+### 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`.
+
+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` URL's to ensure certificate validation succeeds.
+These URL's are used by Plex internally to connect to the Plex server securely.
+
+The format for this URL's 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 dependant 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 informations (`--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:
+<span style="color:red">**cloud remote** -> **crypt** -> **cache**</span>
+
+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:
+<span style="color:green">**cloud remote** -> **cache** -> **crypt**</span>
+
+#### 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)_
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/cache/cache.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to cache (Cache a remote).
+
+#### --cache-remote
 
-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.
    
-
    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.
    
-
-
    Standard Options
    
-
    Here are the standard options specific to box (Box).
    
-
    –box-client-id
    
-
    Box App Client Id. Leave blank normally.
    
-
      
-
    • Config: client_id
      • 
-
    • Env Var: RCLONE_BOX_CLIENT_ID
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    –box-client-secret
    
-
    Box App Client Secret Leave blank normally.
    
-
      
-
    • Config: client_secret
      • 
-
    • Env Var: RCLONE_BOX_CLIENT_SECRET
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    Advanced Options
    
-
    Here are the advanced options specific to box (Box).
    
-
    –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
      • 
-
    
-
-
    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.
    
-
    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. 
-
    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 URL’s to ensure certificate validation succeeds. These URL’s are used by Plex internally to connect to the Plex server securely.
    
-
    The format for this URL’s 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 dependant 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 informations (--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
    
-
      
-
    • 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 verifications 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
      • 
-
    
-
-
    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
+
+- 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
+
+- 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 verifications 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
+
+<!--- autogenerated options stop -->
+
+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 a different name
+format using the `--chunker-name-format` 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.
+
+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 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.
+
+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 setings, 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).
+
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/chunker/chunker.go then run make backenddocs -->
+### 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.
+
+<!--- autogenerated options stop -->
+
+## 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](/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 first or last character in the
+name:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| SP        | 0x20  | ␠           |
+| .         | 0x2E  | ．           |
+
+Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/sharefile/sharefile.go then run make backenddocs -->
+### 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:     ""
+
+<!--- autogenerated options stop -->
+
+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.  Note
+that if you reconfigure rclone with the same passwords/passphrases
+elsewhere it will be compatible - all the secrets used are derived
+from those two passwords/passphrases.
+
+Note that rclone does not encrypt
+
+  * file length - this can be calcuated 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.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/crypt/crypt.go then run make backenddocs -->
+### 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).
-remote> remote:path
+
+- Config:      remote
+- Env Var:     RCLONE_CRYPT_REMOTE
+- Type:        string
+- Default:     ""
+
+#### --crypt-filename-encryption
+
 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
+
+- Config:      filename_encryption
+- Env Var:     RCLONE_CRYPT_FILENAME_ENCRYPTION
+- Type:        string
+- Default:     "standard"
+- Examples:
+    - "off"
+        - Don't encrypt the file names.  Adds a ".bin" extension only.
+    - "standard"
+        - Encrypt the filenames see the docs for the details.
+    - "obfuscate"
+        - Very simple filename obfuscation.
+
+#### --crypt-directory-name-encryption
+
 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
+
+- 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.
-y) Yes type in my own password
-g) Generate random password
-y/g> y
-Enter the password:
-password:
-Confirm the password:
-password:
+
+- 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.
-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. Note that if you reconfigure rclone with the same passwords/passphrases elsewhere it will be compatible - all the secrets used are derived from those two passwords/passphrases.
    
-
    Note that rclone does not encrypt
    
-
      
-
    • file length - this can be calcuated 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:
-
        
-
      • “off”
-
          
-
        • Don’t encrypt the file names. Adds a “.bin” extension only.
          • 
-
        • 
-
      • “standard”
-
          
-
        • Encrypt the filenames see the docs for the details.
          • 
-
        • 
-
      • “obfuscate”
-
          
-
        • Very simple filename obfuscation.
          • 
-
        • 
-
      • 
-
    
-
    –crypt-directory-name-encryption
    
-
    Option to either encrypt directory names or leave them intact.
    
-
      
-
    • 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.
    
-
      
-
    • 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.
    
-
      
-
    • 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-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
      • 
-
    
-
-
    Backing up a crypted remote
    
-
    If you wish to backup a crypted remote, it it 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 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.
    
-
-
      
-
    • 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 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.
    
-
-
    Standard Options
    
-
    Here are the standard options specific to dropbox (Dropbox).
    
-
    –dropbox-client-id
    
-
    Dropbox App Client Id Leave blank normally.
    
-
      
-
    • Config: client_id
      • 
-
    • Env Var: RCLONE_DROPBOX_CLIENT_ID
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    –dropbox-client-secret
    
-
    Dropbox App 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-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: ""
      • 
-
    
-
-
    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.
    
-
    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.
    
-
    FTP
    
-
    FTP is the File Transfer Protocol. FTP support is provided using the github.com/jlaffaye/ftp package.
    
-
    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/ **
+
+- 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-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
+
+<!--- autogenerated options stop -->
+
+## Backing up a crypted remote ##
+
+If you wish to backup a crypted remote, it it 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 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 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 last character in the name:
+
+| Character | Value | Replacement |
+| --------- |:-----:|:-----------:|
+| SP        | 0x20  | ␠           |
+
+Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/dropbox/dropbox.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to dropbox (Dropbox).
+
+#### --dropbox-client-id
+
+Dropbox App Client Id
+Leave blank normally.
+
+- Config:      client_id
+- Env Var:     RCLONE_DROPBOX_CLIENT_ID
+- Type:        string
+- Default:     ""
+
+#### --dropbox-client-secret
+
+Dropbox App 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-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:     ""
+
+<!--- autogenerated options stop -->
+
+### 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.
+
+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`.
+
+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.
+
+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> 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 /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.
+
+#### Restricted filename characters
+
+In addition to the [default restricted characters set](/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 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 explictly set in the config for the remote.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/ftp/ftp.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to ftp (FTP Connection).
+
+#### --ftp-host
 
 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> 
-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 /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.
    
-
    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 explictly 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
    
-
      
-
    • Config: pass
      • 
-
    • Env Var: RCLONE_FTP_PASS
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    –ftp-tls
    
-
    Use FTP over TLS (Implicit)
    
-
      
-
    • Config: tls
      • 
-
    • Env Var: RCLONE_FTP_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
      • 
-
    
-
-
    Limitations
    
-
    Note that since FTP isn’t HTTP based the following flags don’t work with it: --dump-headers, --dump-bodies, --dump-auth
    
-
    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 while implicit FTP over TLS is supported, explicit FTP over TLS is not.
    
-
    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 /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.
    
-
    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.
    
-
    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.
    
-
-
    Standard Options
    
-
    Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
    
-
    –gcs-client-id
    
-
    Google Application Client Id Leave blank normally.
    
-
      
-
    • Config: client_id
      • 
-
    • Env Var: RCLONE_GCS_CLIENT_ID
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    –gcs-client-secret
    
-
    Google Application 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.
    
-
      
-
    • 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-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
          • 
-
        • 
-
      • “DURABLE_REDUCED_AVAILABILITY”
-
          
-
        • Durable reduced availability storage class
          • 
-
        • 
-
      • 
-
    
-
-
    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
+- 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
+
+- Config:      pass
+- Env Var:     RCLONE_FTP_PASS
+- Type:        string
+- Default:     ""
+
+#### --ftp-tls
+
+Use FTP over TLS (Implicit)
+
+- Config:      tls
+- Env Var:     RCLONE_FTP_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
+
+<!--- autogenerated options stop -->
+
+### Limitations ###
+
+Note that since FTP isn't HTTP based the following flags don't work
+with it: `--dump-headers`, `--dump-bodies`, `--dump-auth`
+
+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 while implicit FTP over TLS is supported,
+explicit FTP over TLS is not.
+
+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:
 
    
-
    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.
        • 
-
      • 
-
    
-
    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.
    
-
    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.
    
-
    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
    
-
    Google Application Client Secret Setting your own is recommended.
    
-
      
-
    • 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).
    
-
      
-
    • 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.
    
-
      
-
    • Config: service_account_file
      • 
-
    • Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE
      • 
-
    • Type: string
      • 
-
    • Default: ""
      • 
-
    
-
    Advanced Options
    
-
    Here are the advanced options specific to drive (Google Drive).
    
-
    –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 identifed 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-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-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-alternate-export
    
-
    Use alternate export URLs for google documents export.,
    
-
    If this option is set this instructs rclone to use an alternate set of export URLs for drive documents. Users have reported that the official export URLs can’t export large documents, whereas these unofficial ones can.
    
-
    See rclone issue #2243 for background, this google drive issue and this helpful post.
    
-
      
-
    • Config: alternate_export
      • 
-
    • Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT
      • 
-
    • Type: bool
      • 
-
    • Default: false
      • 
-
    
-
    –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 storage quota usage for file size.
    
-
    The storage used by a file is the size of the current version plus any older versions that have been set to keep forever.
    
-
      
-
    • 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 beween any two configurations.
    
-
      
-
    • Config: server_side_across_configs
      • 
-
    • Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS
      • 
-
    • Type: bool
      • 
-
    • Default: false
      • 
-
    
-
-
    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 can’t download Google docs using rclone mount - you will get a 0 sized file. If you try again the doc may gain its correct size and be downloadable.
    
-
    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”, then “OAuth client ID”. It will prompt you to set the OAuth consent screen product name, if you haven’t set one already.
      5. 
-
    5. Choose an application type of “other”, and click “Create”. (the default name is fine)
      6. 
-
    6. 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.
      7. 
+
        
+
      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. 
 
      
-
      (Thanks to @balazer on github for these instructions.)
      
-
      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/ **
+
        
+
      • 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 /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.
+
+### 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](/docs/#fast-list) for more details.
+
+### 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](/overview/#invalid-utf8),
+as they can't be used in JSON strings.
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
+
+#### --gcs-client-id
 
 Google Application Client Id
 Leave blank normally.
-Enter a string value. Press Enter for the default ("").
-client_id> 
+
+- Config:      client_id
+- Env Var:     RCLONE_GCS_CLIENT_ID
+- Type:        string
+- Default:     ""
+
+#### --gcs-client-secret
+
 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
+- Config:      client_secret
+- Env Var:     RCLONE_GCS_CLIENT_SECRET
+- Type:        string
+- Default:     ""
 
-*** 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.
+#### --gcs-project-number
 
---------------------
-[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 /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
      
-
      There are two writable parts of the tree, the upload directory and sub directories of the 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.
      
-
      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 will need to enable this flag otherwise you will not be able to read media off the mount.
      
-
      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
      
-
      Google Application Client Id Leave blank normally.
      
-
        
-
      • Config: client_id
        • 
-
      • Env Var: RCLONE_GPHOTOS_CLIENT_ID
        • 
-
      • Type: string
        • 
-
      • Default: ""
        • 
-
      
-
      –gphotos-client-secret
      
-
      Google Application 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-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
        • 
-
      
-
-
      HTTP
      
+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.
+
+- 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-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
+    - "DURABLE_REDUCED_AVAILABILITY"
+        - Durable reduced availability storage class
+
+<!--- autogenerated options stop -->
+
+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.
+
+### 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](/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](/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.
+
+### 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 |
+
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/drive/drive.go then run make backenddocs -->
+### 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
+
+Google Application Client Secret
+Setting your own is recommended.
+
+- 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.
+
+Note that if this is blank, the first time rclone runs it will fill it
+in with the ID of the root folder.
+
+
+- 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.
+
+- Config:      service_account_file
+- Env Var:     RCLONE_DRIVE_SERVICE_ACCOUNT_FILE
+- Type:        string
+- Default:     ""
+
+### Advanced Options
+
+Here are the advanced options specific to drive (Google Drive).
+
+#### --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 identifed 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-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-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-alternate-export
+
+Use alternate export URLs for google documents export.,
+
+If this option is set this instructs rclone to use an alternate set of
+export URLs for drive documents.  Users have reported that the
+official export URLs can't export large documents, whereas these
+unofficial ones can.
+
+See rclone issue [#2243](https://github.com/rclone/rclone/issues/2243) for background,
+[this google drive issue](https://issuetracker.google.com/issues/36761333) and
+[this helpful post](https://www.labnol.org/internet/direct-links-for-google-drive/28356/).
+
+- Config:      alternate_export
+- Env Var:     RCLONE_DRIVE_ALTERNATE_EXPORT
+- Type:        bool
+- Default:     false
+
+#### --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 storage quota usage for file size.
+
+The storage used by a file is the size of the current version plus any
+older versions that have been set to keep forever.
+
+- 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
+
+<!--- autogenerated options stop -->
+
+### 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. Whther 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", then
+"OAuth client ID".  It will prompt you to set the OAuth consent screen
+product name, if you haven't set one already.
+
+5. Choose an application type of "other", and click "Create". (the
+default name is fine)
+
+6. 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.
+
+(Thanks to @balazer on github for these instructions.)
+
+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.
      
+
+++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      


      [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 /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
      There are two writable parts of the tree, the upload directory and sub directories of the 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
      Google Application Client Id Leave blank normally.
      - Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Default: ""
      #### –gphotos-client-secret
      Google Application 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-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
      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:
      
@@ -9717,7 +9870,7 @@ e/n/d/r/c/s/q> q
    
 
    rclone sync 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.
    
@@ -9725,7 +9878,7 @@ e/n/d/r/c/s/q> q
    
 
    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
    
@@ -9746,7 +9899,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
    
@@ -9771,6 +9924,24 @@ e/n/d/r/c/s/q> q
  • Type: bool
  • Default: false
    • +

    –http-no-head

    +

    Don’t use HEAD requests to find file sizes in dir listing

    +

    If your site is being very slow to load then you can try this option. Normally rclone does a HEAD request for each potential file in a directory listing to:

    + +

    If you set this option, rclone will not do the HEAD request. This will mean

    +

    Hubic

    Paths are specified as remote:path

    @@ -9826,14 +9997,14 @@ 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

    Hubic Client Id Leave blank normally.

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

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to hubic (Hubic).

    –hubic-chunk-size

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

    @@ -9874,7 +10045,7 @@ y/e/d> y
  • Default: false
    • -

    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

    @@ -9957,23 +10128,72 @@ y/e/d> y 
    rclone copy /home/source remote:backup

    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, Sync and Shared mountpoints. In most cases you’ll want to use the Jotta/Archive device/mounpoint however if you want to access files uploaded by the official rclone provides the option to select other devices and mountpoints during config.

    -

    –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.

    -

    Deleting files

    +

    Restricted filename characters

    +

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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    "0x22＂
    *0x2A＊
    :0x3A：
    <0x3C＜
    >0x3E＞
    ?0x3F？
    |0x7C｜
    +

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

    +

    Deleting files

    By default rclone will send all files to the trash when deleting files. Due to a lack of API documentation emptying the trash is currently only possible via the Jottacloud website. If deleting permanently is required then use the --jottacloud-hard-delete flag, or set the equivalent environment variable.

    -

    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.

    Device IDs

    Jottacloud requires each ‘device’ to be registered. Rclone brings such a registration to easily access your account but if you want to use Jottacloud together with rclone on multiple machines you NEED to create a seperate deviceID/deviceSecrect on each machine. You will asked during setting up the remote. Please be aware that this also means that copying the rclone config from one machine to another does NOT work with Jottacloud accounts. You have to create it on each machine.

    -

    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.

    @@ -10008,7 +10228,7 @@ y/e/d> y
  • Default: 10M
    • -

    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.

    @@ -10072,8 +10292,27 @@ 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

    +

    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 XML strings.

    -

    Standard Options

    +

    Standard Options

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

    –koofr-user

    Your Koofr user name

    @@ -10091,7 +10330,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

    @@ -10118,8 +10357,301 @@ y/e/d> y
  • Default: true
    • -

    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)

    +

    Features highlights

    + +

    Configuration

    +

    Here is an example of making a mailru configuration. First create a Mail.ru Cloud account and choose a tariff, then 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.
+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 / Mail.ru Cloud
+   \ "mailru"
+[snip]
+Storage> mailru
+User name (usually email)
+Enter a string value. Press Enter for the default ("").
+user> username@mail.ru
+Password
+y) Yes type in my own password
+g) Generate random password
+y/g> y
+Enter the password:
+password:
+Confirm the password:
+password:
+Skip full upload if there is another file with same data hash.
+This feature is called "speedup" or "put by hash". It is especially efficient
+in case of generally available files like popular books, video or audio clips
+[snip]
+Enter a boolean value (true or false). Press Enter for the default ("true").
+Choose a number from below, or type in your own value
+ 1 / Enable
+   \ "true"
+ 2 / Disable
+   \ "false"
+speedup_enable> 1
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+--------------------
+[remote]
+type = mailru
+user = username@mail.ru
+pass = *** ENCRYPTED ***
+speedup_enable = true
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    +

    Configuration of this backend does not require a local web browser. You can use the configured backend as shown below:

    +

    See top level directories

    +
    rclone lsd remote:
    +

    Make a new directory

    +
    rclone mkdir remote:directory
    +

    List the contents of a directory

    +
    rclone ls remote:directory
    +

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

    +
    rclone sync /home/local/directory remote:directory
    +

    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

    +

    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

    +

    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

    +

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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    "0x22＂
    *0x2A＊
    :0x3A：
    <0x3C＜
    >0x3E＞
    ?0x3F？
    \0x5C＼
    |0x7C｜
    +

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

    +

    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

    +

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

    +

    –mailru-user

    +

    User name (usually email)

    + +

    –mailru-pass

    +

    Password

    + +

    –mailru-speedup-enable

    +

    Skip full upload if there is another file with same data hash. This feature is called “speedup” or “put by hash”. It is especially efficient in case of generally available files like popular books, video or audio clips, because files are searched by hash in all accounts of all mailru users. Please note that rclone may need local memory and disk space to calculate content hash in advance and decide whether full upload is required. Also, if rclone does not know file size in advance (e.g. in case of streaming or partial uploads), it will not even try this optimization.

    + +

    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.

    + +

    –mailru-speedup-max-disk

    +

    This option allows you to disable speedup (put by hash) for large files (because preliminary hashing can exhaust you RAM or disk space)

    + +

    –mailru-speedup-max-memory

    +

    Files larger than the size given below will always be hashed on disk.

    + +

    –mailru-check-hash

    +

    What should copy do if file checksum is mismatched or invalid

    + +

    –mailru-user-agent

    +

    HTTP user agent used internally by client. Defaults to “rclone/VERSION” or “–user-agent” provided on command line.

    + +

    –mailru-quirks

    +

    Comma separated list of internal maintenance flags. This option must not be used by an ordinary user. It is intended only to facilitate remote troubleshooting of backend issues. Strict meaning of flags is not documented and not guaranteed to persist between releases. Quirks will be removed when the backend grows stable. Supported quirks: atomicmkdir binlist gzip insecure retry400

    + +

    Mega

    Mega is a cloud storage and file hosting service known for its security feature where all files are encrypted locally before they are uploaded. This prevents anyone (including employees of Mega) from accessing the files without knowledge of the key used for encryption.

    This is an rclone backend for Mega which supports the file transfer features of Mega using the same client side encryption.

    @@ -10171,9 +10703,32 @@ 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.

    -

    Duplicated files

    +

    Restricted filename characters

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    +

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

    +

    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.

    @@ -10189,7 +10744,7 @@ y/e/d> y

    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

    @@ -10207,7 +10762,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.

    @@ -10228,7 +10783,7 @@ y/e/d> y
  • Default: false
    • -

    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.

    Microsoft Azure Blob Storage

    @@ -10274,10 +10829,51 @@ 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 /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

    +

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

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    /0x2F／
    \0x5C＼
    +

    File names can also not end with the following characters. These only get replaced if they are last character in the name:

    + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    .0x2E．
    +

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

    Hashes

    MD5 hashes are stored with blobs. However blobs that were uploaded in chunks only have an MD5 if the source remote was capable of MD5 hashes, eg the local disk.

    Authenticating with Azure Blob Storage

    @@ -10295,13 +10891,13 @@ y/e/d> y 
    rclone lsd azureblob:
 rclone ls azureblob:othercontainer

    This would be useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment.

    -

    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)

    @@ -10335,7 +10931,7 @@ rclone ls azureblob:othercontainer
  • 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.

    @@ -10382,7 +10978,7 @@ rclone ls azureblob:othercontainer
  • Default: ""
    • -

    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 rlcone 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.

    @@ -10476,22 +11072,129 @@ y/e/d> y

    Getting your own Client ID and Key

    rclone uses a pair of Client ID and Key shared by all rclone users when performing requests by default. If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below:

      -
    1. Open https://apps.dev.microsoft.com/#/appList, then click Add an app (Choose Converged applications if applicable)
      2. -
    2. Enter a name for your app, and click continue. Copy and keep the Application Id under the app name for later use.
      3. -
    3. Under section Application Secrets, click Generate New Password. Copy and keep that password for later use.
      4. -
    4. Under section Platforms, click Add platform, then Web. Enter http://localhost:53682/ in Redirect URLs.
      5. -
    5. Under section Microsoft Graph Permissions, Add these delegated permissions: Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, offline_access, User.Read.
      6. -
    6. Scroll to the bottom and click Save.
      7. +
    7. Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade, then click New registration.
      8. +
    8. Enter a name for your app, choose your account type, select Web in Redirect URI Enter http://localhost:53682/ and click Register. Copy and keep the Application (client) ID under the app name for later use.
      9. +
    9. Under manage select Certificates & secrets, click New client secret. Copy and keep that secret for later use.
      10. +
    10. Under manage select API permissions, click Add a permission and select Microsoft Graph then select delegated permissions.
      11. +
    11. Search and select the follwing permssions: Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, offline_access, User.Read. Once selected click Add permissions at the bottom.

    Now the application is complete. Run rclone config to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps.

    -

    Modified time and hashes

    +

    Modification time and hashes

    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.

    -

    Deleting files

    +

    Restricted filename characters

    +

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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    "0x22＂
    *0x2A＊
    :0x3A：
    <0x3C＜
    >0x3E＞
    ?0x3F？
    \0x5C＼
    |0x7C｜
    #0x23＃
    %0x25％
    +

    File names can also not end with the following characters. These only get replaced if they are last character in the name:

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    SP0x20␠
    .0x2E．
    +

    File names can also not begin with the following characters. These only get replaced if they are first character in the name:

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    SP0x20␠
    ~0x7E～
    +

    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. 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

    Microsoft App Client Id Leave blank normally.

    @@ -10509,11 +11212,11 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

    –onedrive-chunk-size

    -

    Chunk size to upload files with - must be multiple of 320k.

    -

    Above this size files will be chunked - must be multiple of 320k. Note that the chunks will be buffered into memory.

    +

    Chunk size to upload files with - must be multiple of 320k (327,680 bytes).

    +

    Above this size files will be chunked - must be multiple of 320k (327,680 bytes). Note that the chunks will be buffered into memory.

    -

    Limitations

    +

    Limitations

    +

    Naming

    Note that OneDrive 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 OneDrive file names. These can’t occur on Windows platforms, but on non-Windows platforms they are common. Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a ? in it will be mapped to ？ instead.

    +

    File sizes

    The largest allowed file sizes are 15GB for OneDrive for Business and 35GB for OneDrive Personal (Updated 4 Jan 2019).

    +

    Path length

    The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones.

    +

    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.

    Versioning issue

    @@ -10578,11 +11285,19 @@ y/e/d> y
  • Restore the versioning settings after using rclone. (Optional)

    • Troubleshooting

    +

    Unexpected file size/hash differences on Sharepoint

    +

    It is a known issue that Sharepoint (not OneDrive or OneDrive for Business) silently modifies uploaded files, mainly Office files (.docx, .xlsx, etc.), causing file size and hash checks to fail. To use rclone with such affected files on Sharepoint, you may disable these checks with the following command line arguments:

    +
    --ignore-checksum --ignore-size
    +

    Replacing/deleting existing files on Sharepoint gets “item not found”

    +

    It is a known issue that Sharepoint (not OneDrive or OneDrive for Business) may return “item not found” errors when users try to replace or delete uploaded files; this seems to mainly affect Office files (.docx, .xlsx, etc.). As a workaround, you may use the --backup-dir <BACKUP_DIR> command line argument so rclone moves the files to be replaced/deleted into a given backup directory (instead of directly replacing/deleting them). For example, to instruct rclone to move the files into the directory rclone-backup-dir on backend mysharepoint, you may use:

    +
    --backup-dir mysharepoint:rclone-backup-dir
    +

    access_denied (AADSTS65005)

    Error: access_denied
 Code: AADSTS65005
 Description: Using application 'rclone' is currently not supported for your organization [YOUR_ORGANIZATION] because it is in an unmanaged state. An administrator needs to claim ownership of the company by DNS validation of [YOUR_ORGANIZATION] before the application rclone can be provisioned.

    This means that rclone can’t use the OneDrive for Business API with your account. You can’t do much about it, maybe write an email to your admins.

    However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint

    +

    invalid_grant (AADSTS50076)

    Error: invalid_grant
 Code: AADSTS50076
 Description: Due to a configuration change made by your administrator, or because you moved to a new location, you must use multi-factor authentication to access '...'.
    @@ -10630,10 +11345,110 @@ 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

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    "0x22＂
    *0x2A＊
    :0x3A：
    <0x3C＜
    >0x3E＞
    ?0x3F？
    \0x5C＼
    |0x7C｜
    +

    File names can also not begin or end with the following characters. These only get replaced if they are the first or last character in the name:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    SP0x20␠
    HT0x09␉
    LF0x0A␊
    VT0x0B␋
    CR0x0D␍
    +

    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

    @@ -10652,7 +11467,7 @@ y/e/d> y
  • Default: ""
    • -

    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

    @@ -10724,13 +11539,13 @@ 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 /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.

    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

    +

    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.

    @@ -10819,7 +11637,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.

    @@ -11002,13 +11820,13 @@ 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.

    @@ -11223,7 +12041,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.

    @@ -11246,10 +12064,33 @@ rclone lsd myremote:
  • Default: false
    • -

    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 defacto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object.

    -

    Limitations

    +

    Restricted filename characters

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    +

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

    +

    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

    @@ -11312,13 +12153,32 @@ 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.

    -

    Deleting files

    +

    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.

    +

    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.

    -

    Standard Options

    +

    Standard Options

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

    –pcloud-client-id

    Pcloud App Client Id Leave blank normally.

    @@ -11389,10 +12249,34 @@ 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

    +

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

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    \0x5C＼
    "0x22＂
    +

    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.

    @@ -11404,7 +12288,7 @@ y/e/d>
  • Default: ""
    • -

    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.

    @@ -11473,6 +12357,25 @@ 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

    +

    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.

    SFTP

    @@ -11557,12 +12460,12 @@ 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

    @@ -11630,7 +12533,17 @@ y/e/d> y
  • Default: false

    • –sftp-use-insecure-cipher

    -

    Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.

    +

    Enable the use of insecure ciphers and key exchange methods.

    +

    This enables the use of the the following insecure ciphers and key exchange methods:

    + +

    Those algorithms are insecure and may allow plaintext data to be recovered by an attacker.

    -

    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.

    +

    If this is set and no password is supplied then rclone will: - ask for a password - not contact the ssh agent

    -

    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.

    @@ -11780,7 +12694,7 @@ e/n/d/r/c/s/q> q

    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 remotes).

    –union-remotes

    List of space separated remotes. Can be ‘remotea:test/dir remoteb:’, ‘“remotea:test/space dir” remoteb:’, etc. The last remote is used to write to.

    @@ -11861,11 +12775,11 @@ 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

    @@ -11933,7 +12847,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

    @@ -11968,6 +12882,10 @@ url = https://[YOUR-DOMAIN]-my.sharepoint.com/personal/[YOUR-EMAIL]/Documents vendor = other user = YourEmailAddress pass = encryptedpassword +

    Required Flags for SharePoint

    +

    As SharePoint does some special things with uploaded documents, you won’t be able to use the documents size or the documents hash to compare if a file has been changed since the upload / which file is newer.

    +

    For Rclone calls copying files (especially Office files such as .docx, .xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should append these flags to ensure Rclone uses the “Last Modified” datetime property to compare your documents:

    +
    --ignore-size --ignore-checksum --update

    dCache

    dCache is a storage system that supports many protocols and authentication/authorisation schemes. For WebDAV clients, it allows users to authenticate with username and password (BASIC), X.509, Kerberos, and various bearer tokens, including Macaroons and OpenID-Connect access tokens.

    Configure as normal using the other type. Don’t enter a username or password, instead enter your Macaroon as the bearer_token.

    @@ -11998,7 +12916,6 @@ vendor = other bearer_token_command = oidc-token XDC

    Yandex Disk

    Yandex Disk is a cloud storage solution created by Yandex.

    -

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

    Here is an example of making a yandex configuration. First run

    rclone config

    This will guide you through an interactive setup process:

    @@ -12050,7 +12967,8 @@ 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 /home/local/directory remote:directory
    -

    Modified time

    +

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

    +

    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.

    @@ -12058,10 +12976,13 @@ y/e/d> y

    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

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

    -

    Limitations

    +

    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

    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

    Yandex Client Id Leave blank normally.

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

    Advanced Options

    +

    Advanced Options

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

    Remove existing public link to file/folder with link command rather than creating. Default is false, meaning link command will create or retrieve public link.

    @@ -12095,13 +13016,276 @@ y/e/d> y 
    rclone sync /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 are expected to be encoded in UTF-8 on disk. This is the normal case for Windows and OS X.

    +

    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 the unicode replacement character, ‘�’. rclone will emit a debug message in this case (use -v to see), eg

    +

    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

    +

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

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    +

    When running on Windows the following characters are replaced. This list is based on the Windows file naming conventions.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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／
    "0x22＂
    *0x2A＊
    :0x3A：
    <0x3C＜
    >0x3E＞
    ?0x3F？
    \0x5C＼
    |0x7C｜
    +

    File names on Windows can also not end with the following characters. These only get replaced if they are last character in the name:

    + + + + + + + + + + + + + + + + + + + + +
    CharacterValueReplacement
    SP0x20␠
    .0x2E．
    +

    Invalid UTF-8 bytes will also be replaced, as they can’t be converted to UTF-16.

    Long paths on Windows

    Rclone handles long paths automatically, by converting all paths to long UNC paths which allows paths up to 32,767 characters.

    This is why you will see that your paths, for instance c:\files is converted to the UNC path \\?\c:\files in the output, and \\server\share is converted to \\?\UNC\server\share.

    @@ -12198,7 +13382,7 @@ $ tree /tmp/b

    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

    @@ -12215,9 +13399,9 @@ $ 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.

    - +

    –links / -l

    Translate symlinks to/from regular files with a ‘.rclonelink’ extension

    -

    –one-file-system

    +

    –one-file-system / -x

    Don’t cross filesystem boundaries (unix/macOS only).

    Changelog

    +

    v1.50.0 - 2019-10-26

    + +

    v1.49.5 - 2019-10-05

    + +

    v1.49.4 - 2019-09-29

    + +

    v1.49.3 - 2019-09-15

    + +

    v1.49.2 - 2019-09-08

    + +

    v1.49.1 - 2019-08-28

    +

    v1.49.0 - 2019-08-26

    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

    @@ -15226,7 +16648,7 @@ $ tree /tmp/b

    Bucket based remotes (eg S3/GCS/Swift/B2) do not have a concept of directories. Rclone therefore cannot create directories in them which means that empty directories on a bucket based remote will tend to disappear.

    Some software creates empty keys ending in / as directory markers. Rclone doesn’t do this as it potentially creates more objects and costs more. It may do in future (probably with a flag).

    Bugs

    -

    Bugs are stored in rclone’s Github project:

    +

    Bugs are stored in rclone’s GitHub project:

    Contact the rclone project

    Forum

    diff --git a/MANUAL.md b/MANUAL.md index 8f26cf2b6..402fb81b0 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,6 +1,6 @@ % rclone(1) User Manual % Nick Craig-Wood -% Aug 26, 2019 +% Oct 26, 2019 # Rclone - rsync for cloud storage @@ -13,6 +13,7 @@ Rclone is a command line program to sync files and directories to and from: * Backblaze B2 * Box * Ceph +* Citrix ShareFile * C14 * DigitalOcean Spaces * Dreamhost @@ -26,6 +27,7 @@ Rclone is a command line program to sync files and directories to and from: * Jottacloud * IBM COS S3 * Koofr +* Mail.ru Cloud * Memset Memstore * Mega * Microsoft Azure Blob Storage @@ -61,6 +63,7 @@ Features * Can sync to and from network, eg two different cloud accounts * [Encryption](https://rclone.org/crypt/) backend * [Cache](https://rclone.org/cache/) backend + * [Chunking](https://rclone.org/chunker/) backend * [Union](https://rclone.org/union/) backend * Optional FUSE mount ([rclone mount](https://rclone.org/commands/rclone_mount/)) * Multi-threaded downloads to local disk @@ -151,6 +154,78 @@ Run `rclone config` to setup. See [rclone config docs](https://rclone.org/docs/) rclone config +## Install with docker ## + +The rclone maintains a [docker image for rclone](https://hub.docker.com/r/rclone/rclone). +These images are autobuilt by docker hub from the rclone source based +on a minimal Alpine linux image. + +The `:latest` tag will always point to the latest stable release. You +can use the `:beta` tag to get the latest build from master. You can +also use version tags, eg `:1.49.1`, `:1.49` or `:1`. + +``` +$ docker pull rclone/rclone:latest +latest: Pulling from rclone/rclone +Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 +... +$ docker run --rm rclone/rclone:latest version +rclone v1.49.1 +- os/arch: linux/amd64 +- go version: go1.12.9 +``` + +There are a few command line options to consider when starting an rclone Docker container +from the rclone image. + +- You need to mount the host rclone config dir at `/config/rclone` into the Docker + container. Due to the fact that rclone updates tokens inside its config file, and that + the update process involves a file rename, you need to mount the whole host rclone + config dir, not just the single host rclone config file. + +- You need to mount a host data dir at `/data` into the Docker container. + +- By default, the rclone binary inside a Docker container runs with UID=0 (root). + As a result, all files created in a run will have UID=0. If your config and data files + reside on the host with a non-root UID:GID, you need to pass these on the container + start command line. + +- It is possible to use `rclone mount` inside a userspace Docker container, and expose + the resulting fuse mount to the host. The exact `docker run` options to do that might + vary slightly between hosts. See, e.g. the discussion in this + [thread](https://github.com/moby/moby/issues/9448). + + You also need to mount the host `/etc/passwd` and `/etc/group` for fuse to work inside + the container. + +Here are some commands tested on an Ubuntu 18.04.3 host: + +``` +# config on host at ~/.config/rclone/rclone.conf +# data on host at ~/data + +# make sure the config is ok by listing the remotes +docker run --rm \ + --volume ~/.config/rclone:/config/rclone \ + --volume ~/data:/data:shared \ + --user $(id -u):$(id -g) \ + rclone/rclone \ + listremotes + +# perform mount inside Docker container, expose result to host +mkdir -p ~/data/mount +docker run --rm \ + --volume ~/.config/rclone:/config/rclone \ + --volume ~/data:/data:shared \ + --user $(id -u):$(id -g) \ + --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \ + --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \ + rclone/rclone \ + mount dropbox:Photos /data/mount & +ls ~/data/mount +kill %1 +``` + ## Install from source ## Make sure you have at least [Go](https://golang.org/) 1.7 @@ -211,6 +286,8 @@ See the following for detailed instructions for * [Backblaze B2](https://rclone.org/b2/) * [Box](https://rclone.org/box/) * [Cache](https://rclone.org/cache/) + * [Chunker](https://rclone.org/chunker/) - transparently splits large files for other remotes + * [Citrix ShareFile](https://rclone.org/sharefile/) * [Crypt](https://rclone.org/crypt/) - to encrypt other remotes * [DigitalOcean Spaces](/s3/#digitalocean-spaces) * [Dropbox](https://rclone.org/dropbox/) @@ -222,6 +299,7 @@ See the following for detailed instructions for * [Hubic](https://rclone.org/hubic/) * [Jottacloud](https://rclone.org/jottacloud/) * [Koofr](https://rclone.org/koofr/) + * [Mail.ru Cloud](https://rclone.org/mailru/) * [Mega](https://rclone.org/mega/) * [Microsoft Azure Blob Storage](https://rclone.org/azureblob/) * [Microsoft OneDrive](https://rclone.org/onedrive/) @@ -1669,6 +1747,8 @@ Copy url content to dest. Download urls content and copy it to destination without saving it in tmp storage. +Setting --auto-filename flag will cause retrieving file name from url and using it in destination path. + ``` rclone copyurl https://example.com dest:path [flags] @@ -1677,7 +1757,8 @@ rclone copyurl https://example.com dest:path [flags] ### Options ``` - -h, --help help for copyurl + -a, --auto-filename Get the file name from the url and use it for destination file path + -h, --help help for copyurl ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -2639,6 +2720,7 @@ rclone mount remote:path /path/to/mountpoint [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) --volname string Set the volume name (not supported by all OSes). @@ -3181,6 +3263,7 @@ rclone serve dlna remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` @@ -3448,6 +3531,7 @@ rclone serve ftp remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` @@ -3704,6 +3788,7 @@ rclone serve http remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` @@ -4157,6 +4242,7 @@ rclone serve sftp remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` @@ -4490,6 +4576,7 @@ rclone serve webdav remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` @@ -5624,9 +5711,18 @@ The default is to run 4 file transfers in parallel. This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file. +This can be useful when transferring to a remote which doesn't support +mod times directly (or when using `--use-server-modtime` to avoid extra +API calls) as it is more accurate than a `--size-only` check and faster +than using `--checksum`. + If an existing destination file has a modification time equal (within the computed modify window precision) to the source file's, it will be -updated if the sizes are different. +updated if the sizes are different. If `--checksum` is set then +rclone will update the destination if the checksums differ too. + +If an existing destination file is older than the source file then +it will be updated if the size or checksum differs from the source file. On remotes which don't support mod time directly (or when using `--use-server-modtime`) the time checked will be the uploaded time. @@ -5634,11 +5730,6 @@ This means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file. -This can be useful when transferring to a remote which doesn't support -mod times directly (or when using `--use-server-modtime` to avoid extra -API calls) as it is more accurate than a `--size-only` check and faster -than using `--checksum`. - ### --use-mmap ### If this flag is set then rclone will use anonymous memory allocated by @@ -7010,6 +7101,7 @@ Show statistics for the cache remote. This takes the following parameters - name - name of remote +- parameters - a map of \{ "key": "value" \} pairs - type - type of the new remote @@ -7020,6 +7112,7 @@ Authentication is required for this call. ### config/delete: Delete a remote in the config file. {#config/delete} Parameters: + - name - name of remote to delete See the [config delete command](https://rclone.org/commands/rclone_config_delete/) command for more information on the above. @@ -7060,6 +7153,7 @@ Authentication is required for this call. This takes the following parameters - name - name of remote +- parameters - a map of \{ "key": "value" \} pairs See the [config password command](https://rclone.org/commands/rclone_config_password/) command for more information on the above. @@ -7080,6 +7174,7 @@ Authentication is required for this call. This takes the following parameters - name - name of remote +- parameters - a map of \{ "key": "value" \} pairs See the [config update command](https://rclone.org/commands/rclone_config_update/) command for more information on the above. @@ -7138,6 +7233,7 @@ Returns the following values: ... ] } +``` ### core/memstats: Returns the memory statistics {#core/memstats} @@ -7164,6 +7260,11 @@ Returns 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: @@ -7216,6 +7317,7 @@ is provided. Parameters - group - name of the stats group (string) +``` ### core/transferred: Returns stats about completed transfers. {#core/transferred} @@ -7226,6 +7328,8 @@ This returns stats about completed transfers: 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) @@ -7245,6 +7349,7 @@ Returns the following values: } ] } +``` ### core/version: Shows the current version of rclone and the go runtime. {#core/version} @@ -7326,7 +7431,7 @@ 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. @@ -7905,6 +8010,7 @@ Here is an overview of the major features of each cloud storage system. | 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 | @@ -7914,6 +8020,7 @@ Here is an overview of the major features of each cloud storage system. | 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 | - | | Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | | Microsoft OneDrive | SHA1 ‡‡ | Yes | Yes | No | R | @@ -7953,6 +8060,8 @@ or `sha1sum` as well as `echo` are in the remote's PATH. 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 @@ -7993,6 +8102,102 @@ objects with the same name. This confuses rclone greatly when syncing - use the `rclone dedupe` command to rename or remove duplicates. +### 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](/local/#filenames) section for details. + ### MIME Type ### MIME types (also known as media types) classify types of documents @@ -8023,6 +8228,7 @@ operations more efficient. | Amazon S3 | No | Yes | No | No | No | 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 | No [#575](https://github.com/rclone/rclone/issues/575) | 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 | @@ -8031,6 +8237,7 @@ operations more efficient. | 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 | No | 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 | | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | | Microsoft OneDrive | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | Yes | Yes | Yes | @@ -8245,7 +8452,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.49.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.50.0") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -8282,6 +8489,8 @@ and may be set in the config file. --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-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") --box-client-id string Box App Client Id. --box-client-secret string Box App Client Secret --box-commit-retries int Max number of times to try committing a multipart file. (default 100) @@ -8306,6 +8515,13 @@ and may be set in the config file. --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") @@ -8320,6 +8536,7 @@ and may be set in the config file. --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 Google Application Client Secret + --drive-disable-http2 Disable drive using http2 (default true) --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. @@ -8350,6 +8567,7 @@ and may be set in the config file. --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --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-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 @@ -8370,6 +8588,7 @@ and may be set in the config file. --gphotos-read-only Set to make the Google Photos backend read only. --gphotos-read-size Set to read the size of media items. --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-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) @@ -8391,12 +8610,19 @@ and may be set in the config file. --local-no-check-updated Don't check to see if the files change during upload --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-pass string Password + --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-hard-delete Delete files permanently rather than putting them into the trash. --mega-pass string Password. --mega-user string User name -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). - --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k. (default 10M) + --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) --onedrive-client-id string Microsoft App Client Id --onedrive-client-secret string Microsoft App Client Secret --onedrive-drive-id string The ID of the drive to use @@ -8423,6 +8649,7 @@ and may be set in the config file. --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-location-constraint string Location constraint - must be set to match the Region. --s3-provider string Choose your S3 provider. --s3-region string Region to connect to. @@ -8447,8 +8674,12 @@ and may be set in the config file. --sftp-port string SSH port, leave blank to use default (22) --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-use-insecure-cipher Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. + --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-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. --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) @@ -8565,11 +8796,31 @@ normal file system). Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. -### Forbidden characters ### +#### Restricted filename characters -1Fichier does not support the characters ``\ < > " ' ` $`` and spaces at the beginning of folder names. -`rclone` automatically escapes these to a unicode equivalent. The exception is `/`, -which cannot be escaped and will therefore lead to errors. +In addition to the [default restricted characters set](/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 first or last character in the +name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. ### Standard Options @@ -8832,6 +9083,16 @@ 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](/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 @@ -9238,6 +9499,29 @@ side copy to update the modification if the object can be copied in a single par 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. +#### Restricted filename characters + +S3 allows any valid UTF-8 string as a key. + +Invalid UTF-8 bytes will be [replaced](/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 @@ -10056,6 +10340,20 @@ See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/ - 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 + ### Anonymous access to public buckets ### @@ -10803,6 +11101,18 @@ 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](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| \ | 0x5C | ＼ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### SHA1 checksums ### The SHA1 checksums of the files are checked on upload and download and @@ -11152,7 +11462,8 @@ 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 -need to do in your browser. `rclone config` walks you through it. +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: @@ -11177,7 +11488,14 @@ Storage> box Box App Client Id - leave blank normally. client_id> Box App Client Secret - leave blank normally. -client_secret> +client_secret> +Box App config.json location +Leave blank normally. +Enter a string value. Press Enter for the default (""). +config_json> +'enterprise' or 'user' depending on the type of token being requested. +Enter a string value. Press Enter for the default ("user"). +box_sub_type> Remote config Use auto config? * Say Y if not sure @@ -11328,6 +11646,25 @@ not. Box supports SHA1 type hashes, so you can use the `--checksum` flag. +#### Restricted filename characters + +In addition to the [default restricted characters set](/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 last character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | + +Invalid UTF-8 bytes will also be [replaced](/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 @@ -11365,6 +11702,30 @@ Leave blank normally. - Type: string - Default: "" +#### --box-box-config-file + +Box App config.json location +Leave blank normally. + +- Config: box_config_file +- Env Var: RCLONE_BOX_BOX_CONFIG_FILE +- 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). @@ -11998,6 +12359,620 @@ If you set it to 0 then it will wait forever. +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 a different name +format using the `--chunker-name-format` 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. + +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 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. + +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 setings, 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](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](/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 first or last character in the +name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | +| . | 0x2E | ． | + +Invalid UTF-8 bytes will also be [replaced](/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 + +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: "" + + + Crypt ---------------------------------------- @@ -12577,6 +13552,25 @@ 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 last character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Standard Options @@ -12748,6 +13742,25 @@ will be time of upload. FTP does not support any checksums. +#### Restricted filename characters + +In addition to the [default restricted characters set](/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 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 @@ -12829,6 +13842,15 @@ Do not verify the TLS certificate of the server - 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 + ### Limitations ### @@ -13065,6 +14087,18 @@ 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](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Standard Options @@ -13610,6 +14644,14 @@ large folder (10600 directories, 39000 files): Google drive stores modification times accurate to 1 ms. +#### Restricted filename characters + +Only Invalid UTF-8 bytes will be [replaced](/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 @@ -13797,7 +14839,13 @@ Scope that rclone should use when requesting access from drive. ID of the root folder Leave blank normally. -Fill in to access "Computers" folders. (see docs). + +Fill in to access "Computers" folders (see docs), or for rclone to use +a non root folder as its starting point. + +Note that if this is blank, the first time rclone runs it will fill it +in with the ID of the root folder. + - Config: root_folder_id - Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID @@ -14104,7 +15152,7 @@ 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 beween any two +because it isn't easy to tell if it will work between any two configurations. - Config: server_side_across_configs @@ -14112,6 +15160,24 @@ configurations. - 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 + ### Limitations ### @@ -14137,9 +15203,12 @@ 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 can't download -Google docs using `rclone mount` - you will get a 0 sized file. If -you try again the doc may gain its correct size and be downloadable. +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. Whther 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 ### @@ -14439,6 +15508,8 @@ 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). +**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 @@ -14477,13 +15548,14 @@ 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 +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 will need to -enable this flag otherwise you will not be able to read media off the -mount. +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 @@ -14720,6 +15792,30 @@ directories. - Type: bool - Default: false +#### --http-no-head + +Don't use HEAD requests to find file sizes in dir listing + +If your site is being very slow to load then you can try this option. +Normally rclone does a HEAD request for each potential file in a +directory listing to: + +- find its size +- check it really exists +- check to see if it is a directory + +If you set this option, rclone will not do the HEAD request. This will mean + +- directory listings are much quicker +- rclone won't have the times or sizes of any files +- some files that don't exist may be in the listing + + +- Config: no_head +- Env Var: RCLONE_HTTP_NO_HEAD +- Type: bool +- Default: false + Hubic @@ -15020,6 +16116,24 @@ 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 + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| " | 0x22 | ＂ | +| * | 0x2A | ＊ | +| : | 0x3A | ： | +| < | 0x3C | ＜ | +| > | 0x3E | ＞ | +| ? | 0x3F | ？ | +| \| | 0x7C | ｜ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in XML strings. + ### Deleting files ### By default rclone will send all files to the trash when deleting files. @@ -15181,6 +16295,18 @@ To copy a local directory to an Koofr directory called backup rclone copy /home/source remote:backup +#### Restricted filename characters + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| \ | 0x5C | ＼ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in XML strings. + ### Standard Options @@ -15242,6 +16368,304 @@ Does the backend support setting modification time. Set this to false if you use 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](https://cloud.mail.ru/) is a cloud storage provided by a Russian internet company [Mail.Ru Group](https://mail.ru). The official desktop client is [Disk-O:](https://disk-o.cloud/), available only on Windows. (Please note that official sites are in Russian) + +### Features highlights ### + +- Paths may be as deep as required, eg `remote:directory/subdirectory` +- Files have a `last modified time` property, directories don't +- Deleted files are by default moved to the trash +- Files and directories can be shared via public links +- Partial uploads or streaming are not supported, file size must be known before upload +- Maximum file size is limited to 2G for a free acount, unlimited for paid accounts +- Storage keeps hash for all files and performs transparent deduplication, + the hash algorithm is a modified SHA1 +- If a particular file is already present in storage, one can quickly submit file hash + instead of long file upload (this optimization is supported by rclone) + +### Configuration ### + +Here is an example of making a mailru configuration. First create a Mail.ru Cloud +account and choose a tariff, then 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. +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 / Mail.ru Cloud + \ "mailru" +[snip] +Storage> mailru +User name (usually email) +Enter a string value. Press Enter for the default (""). +user> username@mail.ru +Password +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: +password: +Confirm the password: +password: +Skip full upload if there is another file with same data hash. +This feature is called "speedup" or "put by hash". It is especially efficient +in case of generally available files like popular books, video or audio clips +[snip] +Enter a boolean value (true or false). Press Enter for the default ("true"). +Choose a number from below, or type in your own value + 1 / Enable + \ "true" + 2 / Disable + \ "false" +speedup_enable> 1 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +-------------------- +[remote] +type = mailru +user = username@mail.ru +pass = *** ENCRYPTED *** +speedup_enable = true +-------------------- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +``` + +Configuration of this backend does not require a local web browser. +You can use the configured backend as shown below: + +See top level directories + + rclone lsd remote: + +Make a new directory + + rclone mkdir remote:directory + +List the contents of a directory + + rclone ls remote:directory + +Sync `/home/local/directory` to the remote path, deleting any +excess files in the path. + + rclone sync /home/local/directory remote:directory + +### 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 ### + +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 ### + +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 + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| " | 0x22 | ＂ | +| * | 0x2A | ＊ | +| : | 0x3A | ： | +| < | 0x3C | ＜ | +| > | 0x3E | ＞ | +| ? | 0x3F | ？ | +| \ | 0x5C | ＼ | +| \| | 0x7C | ｜ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + +### 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 + +Here are the standard options specific to mailru (Mail.ru Cloud). + +#### --mailru-user + +User name (usually email) + +- Config: user +- Env Var: RCLONE_MAILRU_USER +- Type: string +- Default: "" + +#### --mailru-pass + +Password + +- Config: pass +- Env Var: RCLONE_MAILRU_PASS +- Type: string +- Default: "" + +#### --mailru-speedup-enable + +Skip full upload if there is another file with same data hash. +This feature is called "speedup" or "put by hash". It is especially efficient +in case of generally available files like popular books, video or audio clips, +because files are searched by hash in all accounts of all mailru users. +Please note that rclone may need local memory and disk space to calculate +content hash in advance and decide whether full upload is required. +Also, if rclone does not know file size in advance (e.g. in case of +streaming or partial uploads), it will not even try this optimization. + +- Config: speedup_enable +- Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE +- Type: bool +- Default: true +- Examples: + - "true" + - Enable + - "false" + - Disable + +### 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. + +- Config: speedup_file_patterns +- Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS +- Type: string +- Default: "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf" +- Examples: + - "" + - Empty list completely disables speedup (put by hash). + - "*" + - All files will be attempted for speedup. + - "*.mkv,*.avi,*.mp4,*.mp3" + - Only common audio/video files will be tried for put by hash. + - "*.zip,*.gz,*.rar,*.pdf" + - Only common archives or PDF books will be tried for speedup. + +#### --mailru-speedup-max-disk + +This option allows you to disable speedup (put by hash) for large files +(because preliminary hashing can exhaust you RAM or disk space) + +- Config: speedup_max_disk +- Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK +- Type: SizeSuffix +- Default: 3G +- Examples: + - "0" + - Completely disable speedup (put by hash). + - "1G" + - Files larger than 1Gb will be uploaded directly. + - "3G" + - Choose this option if you have less than 3Gb free on local disk. + +#### --mailru-speedup-max-memory + +Files larger than the size given below will always be hashed on disk. + +- Config: speedup_max_memory +- Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY +- Type: SizeSuffix +- Default: 32M +- Examples: + - "0" + - Preliminary hashing will always be done in a temporary disk location. + - "32M" + - Do not dedicate more than 32Mb RAM for preliminary hashing. + - "256M" + - You have at most 256Mb RAM free for hash calculations. + +#### --mailru-check-hash + +What should copy do if file checksum is mismatched or invalid + +- Config: check_hash +- Env Var: RCLONE_MAILRU_CHECK_HASH +- Type: bool +- Default: true +- Examples: + - "true" + - Fail with error. + - "false" + - Ignore and continue. + +#### --mailru-user-agent + +HTTP user agent used internally by client. +Defaults to "rclone/VERSION" or "--user-agent" provided on command line. + +- Config: user_agent +- Env Var: RCLONE_MAILRU_USER_AGENT +- Type: string +- Default: "" + +#### --mailru-quirks + +Comma separated list of internal maintenance flags. +This option must not be used by an ordinary user. It is intended only to +facilitate remote troubleshooting of backend issues. Strict meaning of +flags is not documented and not guaranteed to persist between releases. +Quirks will be removed when the backend grows stable. +Supported quirks: atomicmkdir binlist gzip insecure retry400 + +- Config: quirks +- Env Var: RCLONE_MAILRU_QUIRKS +- Type: string +- Default: "" + + + Mega ----------------------------------------- @@ -15323,6 +16747,16 @@ To copy a local directory to an Mega directory called backup Mega does not support modification times or hashes yet. +#### Restricted filename characters + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| NUL | 0x00 | ␀ | +| / | 0x2F | ／ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Duplicated files ### Mega can have two files with exactly the same name and path (unlike a @@ -15519,6 +16953,26 @@ 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 + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| / | 0x2F | ／ | +| \ | 0x5C | ＼ | + +File names can also not end with the following characters. +These only get replaced if they are last character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| . | 0x2E | ． | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Hashes ### MD5 hashes are stored with blobs. However blobs that were uploaded in @@ -15823,19 +17277,16 @@ rclone uses a pair of Client ID and Key shared by all rclone users when performi If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below: -1. Open https://apps.dev.microsoft.com/#/appList, then click `Add an app` (Choose `Converged applications` if applicable) -2. Enter a name for your app, and click continue. Copy and keep the `Application Id` under the app name for later use. -3. Under section `Application Secrets`, click `Generate New Password`. Copy and keep that password for later use. -4. Under section `Platforms`, click `Add platform`, then `Web`. Enter `http://localhost:53682/` in -`Redirect URLs`. -5. Under section `Microsoft Graph Permissions`, `Add` these `delegated permissions`: -`Files.Read`, `Files.ReadWrite`, `Files.Read.All`, `Files.ReadWrite.All`, `offline_access`, `User.Read`. -6. Scroll to the bottom and click `Save`. +1. Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade, then click `New registration`. +2. Enter a name for your app, choose your account type, select `Web` in `Redirect URI` Enter `http://localhost:53682/` and click Register. Copy and keep the `Application (client) ID` under the app name for later use. +3. Under `manage` select `Certificates & secrets`, click `New client secret`. Copy and keep that secret for later use. +4. Under `manage` select `API permissions`, click `Add a permission` and select `Microsoft Graph` then select `delegated permissions`. +5. Search and select the follwing permssions: `Files.Read`, `Files.ReadWrite`, `Files.Read.All`, `Files.ReadWrite.All`, `offline_access`, `User.Read`. Once selected click `Add permissions` at the bottom. Now the application is complete. Run `rclone config` to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps. -### Modified time and hashes ### +### Modification time and hashes ### OneDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or @@ -15847,6 +17298,43 @@ Sharepoint Server support For all types of OneDrive you can use the `--checksum` flag. +### Restricted filename characters ### + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| " | 0x22 | ＂ | +| * | 0x2A | ＊ | +| : | 0x3A | ： | +| < | 0x3C | ＜ | +| > | 0x3E | ＞ | +| ? | 0x3F | ？ | +| \ | 0x5C | ＼ | +| \| | 0x7C | ｜ | +| # | 0x23 | ＃ | +| % | 0x25 | ％ | + +File names can also not end with the following characters. +These only get replaced if they are last character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | +| . | 0x2E | ． | + +File names can also not begin with the following characters. +These only get replaced if they are first character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | +| ~ | 0x7E | ～ | + +Invalid UTF-8 bytes will also be [replaced](/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. Microsoft @@ -15885,9 +17373,9 @@ Here are the advanced options specific to onedrive (Microsoft OneDrive). #### --onedrive-chunk-size -Chunk size to upload files with - must be multiple of 320k. +Chunk size to upload files with - must be multiple of 320k (327,680 bytes). -Above this size files will be chunked - must be multiple of 320k. Note +Above this size files will be chunked - must be multiple of 320k (327,680 bytes). Note that the chunks will be buffered into memory. - Config: chunk_size @@ -15932,6 +17420,8 @@ listing, set this option. ### Limitations ### +#### Naming #### + Note that OneDrive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc". @@ -15941,16 +17431,22 @@ 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. +#### File sizes #### + The largest allowed file sizes are 15GB for OneDrive for Business and 35GB for OneDrive Personal (Updated 4 Jan 2019). +#### Path length #### + The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones. +#### 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](https://github.com/rclone/rclone/issues/2707) for more info. -An official document about the limitations for different types of OneDrive can be found [here](https://support.office.com/en-us/article/invalid-file-names-and-file-types-in-onedrive-onedrive-for-business-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa). +An official document about the limitations for different types of OneDrive can be found [here](https://support.office.com/en-us/article/invalid-file-names-and-file-types-in-onedrive-onedrive-for-business-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa). ### Versioning issue ### @@ -15989,6 +17485,36 @@ Note: This will disable the creation of new file versions, but will not remove a ### Troubleshooting ### +#### Unexpected file size/hash differences on Sharepoint #### + +It is a +[known](https://github.com/OneDrive/onedrive-api-docs/issues/935#issuecomment-441741631) +issue that Sharepoint (not OneDrive or OneDrive for Business) silently modifies +uploaded files, mainly Office files (.docx, .xlsx, etc.), causing file size and +hash checks to fail. To use rclone with such affected files on Sharepoint, you +may disable these checks with the following command line arguments: + +``` +--ignore-checksum --ignore-size +``` + +#### Replacing/deleting existing files on Sharepoint gets "item not found" #### + +It is a [known](https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue +that Sharepoint (not OneDrive or OneDrive for Business) may return "item not +found" errors when users try to replace or delete uploaded files; this seems to +mainly affect Office files (.docx, .xlsx, etc.). As a workaround, you may use +the `--backup-dir ` command line argument so rclone moves the +files to be replaced/deleted into a given backup directory (instead of directly +replacing/deleting them). For example, to instruct rclone to move the files into +the directory `rclone-backup-dir` on backend `mysharepoint`, you may use: + +``` +--backup-dir mysharepoint:rclone-backup-dir +``` + +#### access\_denied (AADSTS65005) #### + ``` Error: access_denied Code: AADSTS65005 @@ -15999,6 +17525,7 @@ This means that rclone can't use the OneDrive for Business API with your account However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint +#### invalid\_grant (AADSTS50076) #### ``` Error: invalid_grant @@ -16073,6 +17600,36 @@ 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 + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| NUL | 0x00 | ␀ | +| / | 0x2F | ／ | +| " | 0x22 | ＂ | +| * | 0x2A | ＊ | +| : | 0x3A | ： | +| < | 0x3C | ＜ | +| > | 0x3E | ＞ | +| ? | 0x3F | ？ | +| \ | 0x5C | ＼ | +| \| | 0x7C | ｜ | + +File names can also not begin or end with the following characters. +These only get replaced if they are the first or last character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | +| HT | 0x09 | ␉ | +| LF | 0x0A | ␊ | +| VT | 0x0B | ␋ | +| CR | 0x0D | ␍ | + + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Standard Options @@ -16231,6 +17788,15 @@ credentials. In order of precedence: - Access Key ID: `QS_ACCESS_KEY_ID` or `QS_ACCESS_KEY` - Secret Access Key: `QS_SECRET_ACCESS_KEY` or `QS_SECRET_KEY` +### Restricted filename characters + +The control characters 0x00-0x1F and / are replaced as in the [default +restricted characters set](/overview/#restricted-characters). Note +that 0x7F is not replaced. + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Standard Options @@ -16832,6 +18398,16 @@ ns. This is a defacto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object. +### Restricted filename characters + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| NUL | 0x00 | ␀ | +| / | 0x2F | ／ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Limitations ### The Swift API doesn't return a correct MD5SUM for segmented files @@ -16947,6 +18523,18 @@ be re-uploaded. pCloud supports MD5 and SHA1 type hashes, so you can use the `--checksum` flag. +#### Restricted filename characters + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| \ | 0x5C | ＼ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Deleting files ### Deleted files will be moved to the trash. Your subscription level @@ -17064,6 +18652,19 @@ 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 + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| \ | 0x5C | ＼ | +| " | 0x22 | ＂ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Standard Options @@ -17186,6 +18787,18 @@ To copy a local directory to a put.io directory called backup rclone copy /home/source remote:backup +#### Restricted filename characters + +In addition to the [default restricted characters set](/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| \ | 0x5C | ＼ | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + @@ -17407,7 +19020,18 @@ when the ssh-agent contains many keys. #### --sftp-use-insecure-cipher -Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. +Enable the use of insecure ciphers and key exchange methods. + +This enables the use of the the following insecure ciphers and key exchange methods: + +- aes128-cbc +- aes192-cbc +- aes256-cbc +- 3des-cbc +- diffie-hellman-group-exchange-sha256 +- diffie-hellman-group-exchange-sha1 + +Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. - Config: use_insecure_cipher - Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER @@ -17437,6 +19061,11 @@ Here are the advanced options specific to sftp (SSH/SFTP Connection). Allow asking for SFTP password when needed. +If this is set and no password is supplied then rclone will: +- ask for a password +- not contact the ssh agent + + - Config: ask_password - Env Var: RCLONE_SFTP_ASK_PASSWORD - Type: bool @@ -17890,6 +19519,15 @@ user = YourEmailAddress pass = encryptedpassword ``` +#### Required Flags for SharePoint #### +As SharePoint does some special things with uploaded documents, you won't be able to use the documents size or the documents hash to compare if a file has been changed since the upload / which file is newer. + +For Rclone calls copying files (especially Office files such as .docx, .xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should append these flags to ensure Rclone uses the "Last Modified" datetime property to compare your documents: + +``` +--ignore-size --ignore-checksum --update +``` + ### dCache ### dCache is a storage system that supports many protocols and @@ -17972,8 +19610,6 @@ Yandex Disk [Yandex Disk](https://disk.yandex.com) is a cloud storage solution created by [Yandex](https://yandex.com). -Yandex paths may be as deep as required, eg `remote:directory/subdirectory`. - Here is an example of making a yandex configuration. First run rclone config @@ -18048,6 +19684,8 @@ excess files in the path. rclone sync /home/local/directory remote:directory +Yandex paths may be as deep as required, eg `remote:directory/subdirectory`. + ### Modified time ### Modified times are supported and are stored accurate to 1 ns in custom @@ -18068,6 +19706,14 @@ does not take any path arguments. 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 + +The [default restricted characters set](/overview/#restricted-characters) +are replaced. + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in JSON strings. + ### Limitations ### When uploading very large files (bigger than about 5GB) you will need @@ -18142,8 +19788,8 @@ on OS X. ### Filenames ### -Filenames are expected to be encoded in UTF-8 on disk. This is the -normal case for Windows and OS X. +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 @@ -18152,13 +19798,82 @@ 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 the unicode replacement character, '�'. `rclone` -will emit a debug message in this case (use `-v` to see), eg +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 + +On non Windows platforms the following characters are replaced when +handling file names. + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| NUL | 0x00 | ␀ | +| / | 0x2F | ／ | + +When running on Windows the following characters are replaced. This +list is based on the [Windows file naming conventions](https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions). + +| 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 | ／ | +| " | 0x22 | ＂ | +| * | 0x2A | ＊ | +| : | 0x3A | ： | +| < | 0x3C | ＜ | +| > | 0x3E | ＞ | +| ? | 0x3F | ？ | +| \ | 0x5C | ＼ | +| \| | 0x7C | ｜ | + +File names on Windows can also not end with the following characters. +These only get replaced if they are last character in the name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | +| . | 0x2E | ． | + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be converted to UTF-16. + ### Long paths on Windows ### Rclone handles long paths automatically, by converting all paths to long @@ -18368,7 +20083,7 @@ Disable UNC (long path names) conversion on Windows Here are the advanced options specific to local (Local Disk). -#### --copy-links +#### --copy-links / -L Follow symlinks and copy the pointed to item. @@ -18377,7 +20092,7 @@ Follow symlinks and copy the pointed to item. - Type: bool - Default: false -#### --links +#### --links / -l Translate symlinks to/from regular files with a '.rclonelink' extension @@ -18427,7 +20142,7 @@ check can be disabled with this flag. - Type: bool - Default: false -#### --one-file-system +#### --one-file-system / -x Don't cross filesystem boundaries (unix/macOS only). @@ -18466,6 +20181,160 @@ to override the default choice. # Changelog +## v1.50.0 - 2019-10-26 + +* New backends + * [Citrix Sharefile](/sharefile) (Nick Craig-Wood) + * [Chunker](/chunker) - an overlay backend to split files into smaller parts (Ivan Andreev) + * [Mail.ru Cloud](/mailru) (Ivan Andreev) +* New Features + * encodings (Fabian Möller & Nick Craig-Wood) + * All backends now use file name encoding to ensure any file name can be written to any backend. + * See the [restricted file name docs](/overview/#restricted-filenames) for more info and the [local backend docs](/local/#filenames). + * Some file names may look different in rclone if you are using any control characters in names or [unicode FULLWIDTH symbols](https://en.wikipedia.org/wiki/Halfwidth_and_Fullwidth_Forms_(Unicode_block)). + * build + * Update to use go1.13 for the build (Nick Craig-Wood) + * Drop support for go1.9 (Nick Craig-Wood) + * Build rclone with GitHub actions (Nick Craig-Wood) + * Convert python scripts to python3 (Nick Craig-Wood) + * Swap Azure/go-ansiterm for mattn/go-colorable (Nick Craig-Wood) + * Dockerfile fixes (Matei David) + * Add [plugin support](https://github.com/rclone/rclone/blob/master/CONTRIBUTING.md#writing-a-plugin) for backends and commands (Richard Patel) + * config + * Use alternating Red/Green in config to make more obvious (Nick Craig-Wood) + * contrib + * Add sample DLNA server Docker Compose manifest. (pataquets) + * Add sample WebDAV server Docker Compose manifest. (pataquets) + * copyurl + * Add `--auto-filename` flag for using file name from URL in destination path (Denis) + * serve dlna: + * Many compatability improvements (Dan Walters) + * Support for external srt subtitles (Dan Walters) + * rc + * Added command core/quit (Saksham Khanna) +* Bug Fixes + * sync + * Make `--update`/`-u` not transfer files that haven't changed (Nick Craig-Wood) + * Free objects after they come out of the transfer pipe to save memory (Nick Craig-Wood) + * Fix `--files-from without --no-traverse` doing a recursive scan (Nick Craig-Wood) + * operations + * Fix accounting for server side copies (Nick Craig-Wood) + * Display 'All duplicates removed' only if dedupe successful (Sezal Agrawal) + * Display 'Deleted X extra copies' only if dedupe successful (Sezal Agrawal) + * accounting + * Only allow up to 100 completed transfers in the accounting list to save memory (Nick Craig-Wood) + * Cull the old time ranges when possible to save memory (Nick Craig-Wood) + * Fix panic due to server-side copy fallback (Ivan Andreev) + * Fix memory leak noticeable for transfers of large numbers of objects (Nick Craig-Wood) + * Fix total duration calculation (Nick Craig-Wood) + * cmd + * Fix environment variables not setting command line flags (Nick Craig-Wood) + * Make autocomplete compatible with bash's posix mode for macOS (Danil Semelenov) + * Make `--progress` work in git bash on Windows (Nick Craig-Wood) + * Fix 'compopt: command not found' on autocomplete on macOS (Danil Semelenov) + * config + * Fix setting of non top level flags from environment variables (Nick Craig-Wood) + * Check config names more carefully and report errors (Nick Craig-Wood) + * Remove error: can't use `--size-only` and `--ignore-size` together. (Nick Craig-Wood) + * filter: Prevent mixing options when `--files-from` is in use (Michele Caci) + * serve sftp: Fix crash on unsupported operations (eg Readlink) (Nick Craig-Wood) +* Mount + * Allow files of unkown size to be read properly (Nick Craig-Wood) + * Skip tests on <= 2 CPUs to avoid lockup (Nick Craig-Wood) + * Fix panic on File.Open (Nick Craig-Wood) + * Fix "mount_fusefs: -o timeout=: option not supported" on FreeBSD (Nick Craig-Wood) + * Don't pass huge filenames (>4k) to FUSE as it can't cope (Nick Craig-Wood) +* VFS + * Add flag `--vfs-case-insensitive` for windows/macOS mounts (Ivan Andreev) + * Make objects of unknown size readable through the VFS (Nick Craig-Wood) + * Move writeback of dirty data out of close() method into its own method (FlushWrites) and remove close() call from Flush() (Brett Dutro) + * Stop empty dirs disappearing when renamed on bucket based remotes (Nick Craig-Wood) + * Stop change notify polling clearing so much of the directory cache (Nick Craig-Wood) +* Azure Blob + * Disable logging to the Windows event log (Nick Craig-Wood) +* B2 + * Remove `unverified:` prefix on sha1 to improve interop (eg with CyberDuck) (Nick Craig-Wood) +* Box + * Add options to get access token via JWT auth (David) +* Drive + * Disable HTTP/2 by default to work around INTERNAL_ERROR problems (Nick Craig-Wood) + * Make sure that drive root ID is always canonical (Nick Craig-Wood) + * Fix `--drive-shared-with-me` from the root with lsand `--fast-list` (Nick Craig-Wood) + * Fix ChangeNotify polling for shared drives (Nick Craig-Wood) + * Fix change notify polling when using appDataFolder (Nick Craig-Wood) +* Dropbox + * Make disallowed filenames errors not retry (Nick Craig-Wood) + * Fix nil pointer exception on restricted files (Nick Craig-Wood) +* Fichier + * Fix accessing files > 2GB on 32 bit systems (Nick Craig-Wood) +* FTP + * Allow disabling EPSV mode (Jon Fautley) +* HTTP + * HEAD directory entries in parallel to speedup (Nick Craig-Wood) + * Add `--http-no-head` to stop rclone doing HEAD in listings (Nick Craig-Wood) +* Putio + * Add ability to resume uploads (Cenk Alti) +* S3 + * Fix signature v2_auth headers (Anthony Rusdi) + * Fix encoding for control characters (Nick Craig-Wood) + * Only ask for URL encoded directory listings if we need them on Ceph (Nick Craig-Wood) + * Add option for multipart failiure behaviour (Aleksandar Jankovic) + * Support for multipart copy (庄天翼) + * Fix nil pointer reference if no metadata returned for object (Nick Craig-Wood) +* SFTP + * Fix `--sftp-ask-password` trying to contact the ssh agent (Nick Craig-Wood) + * Fix hashes of files with backslashes (Nick Craig-Wood) + * Include more ciphers with `--sftp-use-insecure-cipher` (Carlos Ferreyra) +* WebDAV + * Parse and return Sharepoint error response (Henning Surmeier) + +## v1.49.5 - 2019-10-05 + +* Bug Fixes + * Revert back to go1.12.x for the v1.49.x builds as go1.13.x was causing issues (Nick Craig-Wood) + * Fix rpm packages by using master builds of nfpm (Nick Craig-Wood) + * Fix macOS build after brew changes (Nick Craig-Wood) + +## v1.49.4 - 2019-09-29 + +* Bug Fixes + * cmd/rcd: Address ZipSlip vulnerability (Richard Patel) + * accounting: Fix file handle leak on errors (Nick Craig-Wood) + * oauthutil: Fix security problem when running with two users on the same machine (Nick Craig-Wood) +* FTP + * Fix listing of an empty root returning: error dir not found (Nick Craig-Wood) +* S3 + * Fix SetModTime on GLACIER/ARCHIVE objects and implement set/get tier (Nick Craig-Wood) + +## v1.49.3 - 2019-09-15 + +* Bug Fixes + * accounting + * Fix total duration calculation (Aleksandar Jankovic) + * Fix "file already closed" on transfer retries (Nick Craig-Wood) + +## v1.49.2 - 2019-09-08 + +* New Features + * build: Add Docker workflow support (Alfonso Montero) +* Bug Fixes + * accounting: Fix locking in Transfer to avoid deadlock with `--progress` (Nick Craig-Wood) + * docs: Fix template argument for mktemp in install.sh (Cnly) + * operations: Fix `-u`/`--update` with google photos / files of unknown size (Nick Craig-Wood) + * rc: Fix docs for config/create /update /password (Nick Craig-Wood) +* Google Cloud Storage + * Fix need for elevated permissions on SetModTime (Nick Craig-Wood) + +## v1.49.1 - 2019-08-28 + +* Bug Fixes + * config: Fix generated passwords being stored as empty password (Nick Craig-Wood) + * rcd: Added missing parameter for web-gui info logs. (Chaitanya) +* Googlephotos + * Fix crash on error response (Nick Craig-Wood) +* Onedrive + * Fix crash on error response (Nick Craig-Wood) + ## v1.49.0 - 2019-08-26 * New backends @@ -18477,8 +20346,10 @@ to override the default choice. * Experimental [web GUI](https://rclone.org/gui/) (Chaitanya Bankanhal) * Implement `--compare-dest` & `--copy-dest` (yparitcher) * Implement `--suffix` without `--backup-dir` for backup to current dir (yparitcher) + * `config reconnect` to re-login (re-run the oauth login) for the backend. (Nick Craig-Wood) + * `config userinfo` to discover which user you are logged in as. (Nick Craig-Wood) + * `config disconnect` to disconnect you (log out) from the backend. (Nick Craig-Wood) * Add `--use-json-log` for JSON logging (justinalin) - * Add `config reconnect`, `config userinfo` and `config disconnect` subcommands. (Nick Craig-Wood) * Add context propagation to rclone (Aleksandar Jankovic) * Reworking internal statistics interfaces so they work with rc jobs (Aleksandar Jankovic) * Add Higher units for ETA (AbelThar) @@ -20480,7 +22351,7 @@ costs more. It may do in future (probably with a flag). ## Bugs -Bugs are stored in rclone's Github project: +Bugs are stored in rclone's GitHub project: * [Reported bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug) * [Known issues](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+milestone%3A%22Known+Problem%22) @@ -20690,7 +22561,7 @@ work harder, reducing memory size at the expense of CPU usage. The most common cause of rclone using lots of memory is a single directory with thousands or millions of files in. Rclone has to load -this entirely into memory as rclone objects. Each Rclone object takes +this entirely into memory as rclone objects. Each rclone object takes 0.5k-1k of memory. License @@ -21001,6 +22872,28 @@ Contributors * Patrick Wang * Cenk Alti * Andreas Chlupka + * Alfonso Montero + * Ivan Andreev + * David Baumgold + * Lars Lehtonen + * Matei David + * David + * Anthony Rusdi <33247310+antrusd@users.noreply.github.com> + * Richard Patel + * 庄天翼 + * SwitchJS + * Raphael + * Sezal Agrawal + * Tyler + * Brett Dutro + * Vighnesh SK + * Arijit Biswas + * Michele Caci + * AlexandrBoltris + * Bryce Larson + * Carlos Ferreyra + * Saksham Khanna + * dausruddin <5763466+dausruddin@users.noreply.github.com> # Contact the rclone project # diff --git a/MANUAL.txt b/MANUAL.txt index 84ead92d9..bdfcd5269 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ rclone(1) User Manual Nick Craig-Wood -Aug 26, 2019 +Oct 26, 2019 @@ -17,6 +17,7 @@ from: - Backblaze B2 - Box - Ceph +- Citrix ShareFile - C14 - DigitalOcean Spaces - Dreamhost @@ -30,6 +31,7 @@ from: - Jottacloud - IBM COS S3 - Koofr +- Mail.ru Cloud - Memset Memstore - Mega - Microsoft Azure Blob Storage @@ -65,6 +67,7 @@ Features - Can sync to and from network, eg two different cloud accounts - Encryption backend - Cache backend +- Chunking backend - Union backend - Optional FUSE mount (rclone mount) - Multi-threaded downloads to local disk @@ -164,6 +167,78 @@ Run rclone config to setup. See rclone config docs for more details. rclone config +Install with docker + +The rclone maintains a docker image for rclone. These images are +autobuilt by docker hub from the rclone source based on a minimal Alpine +linux image. + +The :latest tag will always point to the latest stable release. You can +use the :beta tag to get the latest build from master. You can also use +version tags, eg :1.49.1, :1.49 or :1. + + $ docker pull rclone/rclone:latest + latest: Pulling from rclone/rclone + Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 + ... + $ docker run --rm rclone/rclone:latest version + rclone v1.49.1 + - os/arch: linux/amd64 + - go version: go1.12.9 + +There are a few command line options to consider when starting an rclone +Docker container from the rclone image. + +- You need to mount the host rclone config dir at /config/rclone into + the Docker container. Due to the fact that rclone updates tokens + inside its config file, and that the update process involves a file + rename, you need to mount the whole host rclone config dir, not just + the single host rclone config file. + +- You need to mount a host data dir at /data into the Docker + container. + +- By default, the rclone binary inside a Docker container runs with + UID=0 (root). As a result, all files created in a run will have + UID=0. If your config and data files reside on the host with a + non-root UID:GID, you need to pass these on the container start + command line. + +- It is possible to use rclone mount inside a userspace Docker + container, and expose the resulting fuse mount to the host. The + exact docker run options to do that might vary slightly between + hosts. See, e.g. the discussion in this thread. + + You also need to mount the host /etc/passwd and /etc/group for fuse + to work inside the container. + +Here are some commands tested on an Ubuntu 18.04.3 host: + + # config on host at ~/.config/rclone/rclone.conf + # data on host at ~/data + + # make sure the config is ok by listing the remotes + docker run --rm \ + --volume ~/.config/rclone:/config/rclone \ + --volume ~/data:/data:shared \ + --user $(id -u):$(id -g) \ + rclone/rclone \ + listremotes + + # perform mount inside Docker container, expose result to host + mkdir -p ~/data/mount + docker run --rm \ + --volume ~/.config/rclone:/config/rclone \ + --volume ~/data:/data:shared \ + --user $(id -u):$(id -g) \ + --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro \ + --device /dev/fuse --cap-add SYS_ADMIN --security-opt apparmor:unconfined \ + rclone/rclone \ + mount dropbox:Photos /data/mount & + ls ~/data/mount + kill %1 + + Install from source Make sure you have at least Go 1.7 installed. Download go if necessary. @@ -221,6 +296,8 @@ See the following for detailed instructions for - Backblaze B2 - Box - Cache +- Chunker - transparently splits large files for other remotes +- Citrix ShareFile - Crypt - to encrypt other remotes - DigitalOcean Spaces - Dropbox @@ -232,6 +309,7 @@ See the following for detailed instructions for - Hubic - Jottacloud - Koofr +- Mail.ru Cloud - Mega - Microsoft Azure Blob Storage - Microsoft OneDrive @@ -1529,11 +1607,15 @@ Synopsis Download urls content and copy it to destination without saving it in tmp storage. +Setting –auto-filename flag will cause retrieving file name from url and +using it in destination path. + rclone copyurl https://example.com dest:path [flags] Options - -h, --help help for copyurl + -a, --auto-filename Get the file name from the url and use it for destination file path + -h, --help help for copyurl See the global flags page for global options not listed here. @@ -2415,6 +2497,7 @@ Options --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) --volname string Set the volume name (not supported by all OSes). @@ -2910,6 +2993,7 @@ Options --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) @@ -3162,6 +3246,7 @@ Options --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) @@ -3410,6 +3495,7 @@ Options --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) @@ -3839,6 +3925,7 @@ Options --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) @@ -4154,6 +4241,7 @@ Options --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) @@ -5262,9 +5350,18 @@ The default is to run 4 file transfers in parallel. This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file. +This can be useful when transferring to a remote which doesn’t support +mod times directly (or when using --use-server-modtime to avoid extra +API calls) as it is more accurate than a --size-only check and faster +than using --checksum. + If an existing destination file has a modification time equal (within the computed modify window precision) to the source file’s, it will be -updated if the sizes are different. +updated if the sizes are different. If --checksum is set then rclone +will update the destination if the checksums differ too. + +If an existing destination file is older than the source file then it +will be updated if the size or checksum differs from the source file. On remotes which don’t support mod time directly (or when using --use-server-modtime) the time checked will be the uploaded time. This @@ -5272,11 +5369,6 @@ means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file. -This can be useful when transferring to a remote which doesn’t support -mod times directly (or when using --use-server-modtime to avoid extra -API calls) as it is more accurate than a --size-only check and faster -than using --checksum. - –use-mmap If this flag is set then rclone will use anonymous memory allocated by @@ -6650,6 +6742,7 @@ config/create: create the config for a remote. {#config/create} This takes the following parameters - name - name of remote +- parameters - a map of { “key”: “value” } pairs - type - type of the new remote See the config create command command for more information on the above. @@ -6658,7 +6751,9 @@ Authentication is required for this call. config/delete: Delete a remote in the config file. {#config/delete} -Parameters: - name - name of remote to delete +Parameters: + +- name - name of remote to delete See the config delete command command for more information on the above. @@ -6695,6 +6790,7 @@ config/password: password the config for a remote. {#config/password} This takes the following parameters - name - name of remote +- parameters - a map of { “key”: “value” } pairs See the config password command command for more information on the above. @@ -6715,6 +6811,7 @@ config/update: update the config for a remote. {#config/update} This takes the following parameters - name - name of remote +- parameters - a map of { “key”: “value” } pairs See the config update command command for more information on the above. @@ -6772,71 +6869,87 @@ Returns the following values: ] } - ### core/memstats: Returns the memory statistics {#core/memstats} +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} +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} +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/stats: Returns stats about current transfers. {#core/stats} +core/quit: Terminates the app. {#core/quit} - This returns all available stats: +(optional) Pass an exit code to be used for terminating the app: - +exitCode - int - rclone rc core/stats +core/stats: Returns stats about current transfers. {#core/stats} - If group is not provided then summed up stats for all groups will be - returned. +This returns all available stats: - Parameters - - group - name of the stats group (string) + rclone rc core/stats - Returns the following values: +If group is not provided then summed up stats for all groups will be +returned. -{ “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, -“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”: speed in bytes/sec, “speedAvg”: 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 -[] } +Parameters - group - name of the stats group (string) - 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. +Returns the following values: - ### core/stats-reset: Reset stats. {#core/stats-reset} + { + "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, + "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": speed in bytes/sec, + "speedAvg": 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 + [] + } - This clears counters and errors for all stats or specific stats group if group - is provided. +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-reset: Reset stats. {#core/stats-reset} + +This clears counters and errors for all stats or specific stats group if +group is provided. + +Parameters - group - name of the stats group (string) - Parameters - - group - name of the stats group (string) ### core/transferred: Returns stats about completed transfers. {#core/transferred} @@ -6847,6 +6960,8 @@ bytes } ], “checking”: an array of names of currently active file checks 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) @@ -6860,7223 +6975,7240 @@ representing millisecond unix epoch, “error”: string description of the error (empty if successfull), “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.44” - decomposed - version number as [major, -minor, patch, subpatch] - note patch and subpatch will be 999 for a git -compiled version - isGit - boolean - true if this was compiled from the -git version - os - OS in use as according to Go - arch - cpu -architecture in use according to Go - goVersion - version of Go runtime -in use + ### core/version: Shows the current version of rclone and the go runtime. {#core/version} -job/list: Lists the IDs of the running jobs {#job/list} + This shows the current version of go and the go runtime + - version - rclone version, eg "v1.44" + - decomposed - version number as [major, minor, patch, subpatch] + - note patch and subpatch will be 999 for a git compiled version + - isGit - boolean - true if this was compiled from the git version + - os - OS in use as according to Go + - arch - cpu architecture in use according to Go + - goVersion - version of Go runtime in use -Parameters - None + ### job/list: Lists the IDs of the running jobs {#job/list} -Results - jobids - array of integer job ids + Parameters - None -job/status: Reads the status of the job ID {#job/status} + Results + - jobids - array of integer job ids -Parameters - jobid - id of the job (integer) + ### job/status: Reads the status of the job ID {#job/status} -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 + Parameters + - jobid - id of the job (integer) -job/stop: Stop the running job {#job/stop} + 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 -Parameters - jobid - id of the job (integer) + ### job/stop: Stop the running job {#job/stop} -operations/about: Return the space used on the remote {#operations/about} + Parameters + - jobid - id of the job (integer) -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 {#operations/cleanup} + 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 {#operations/copyfile} + 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 {#operations/copyurl} + 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 + This takes the following parameters -See the copyurl command command for more information on the above. + - 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. + Authentication is required for this call. -operations/delete: Remove files in the path {#operations/delete} + ### operations/delete: Remove files in the path {#operations/delete} -This takes the following parameters + This takes the following parameters -- fs - a remote name string eg “drive:” + - fs - a remote name string eg "drive:" -See the delete command command for more information on the above. + See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above. -Authentication is required for this call. + Authentication is required for this call. -operations/deletefile: Remove the single file pointed to {#operations/deletefile} + ### operations/deletefile: Remove the single file pointed to {#operations/deletefile} -This takes the following parameters + This takes the following parameters -- fs - a remote name string eg “drive:” -- remote - a path within that remote eg “dir” + - fs - a remote name string eg "drive:" + - remote - a path within that remote eg "dir" -See the deletefile command command for more information on the above. + See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. -Authentication is required for this call. + Authentication is required for this call. -operations/fsinfo: Return information about the remote {#operations/fsinfo} + ### operations/fsinfo: Return information about the remote {#operations/fsinfo} -This takes the following parameters + This takes the following parameters -- fs - a remote name string eg “drive:” + - fs - a remote name string eg "drive:" -This returns info about the remote passed in; + 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 - } +{ // 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: + This command does not have a command line equivalent so use this instead: -operations/list: List the given remote and path in JSON format {#operations/list} + rclone rc --loopback operations/fsinfo fs=remote: -This takes the following parameters + ### operations/list: List the given remote and path in JSON format {#operations/list} -- 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 + This takes the following parameters -The result is + - 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 -- list - - This is an array of objects as described in the lsjson command + The result is -See the lsjson command for more information on the above and examples. + - list + - This is an array of objects as described in the lsjson command -Authentication is required for this call. + See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. -operations/mkdir: Make a destination directory or container {#operations/mkdir} + Authentication is required for this call. -This takes the following parameters + ### operations/mkdir: Make a destination directory or container {#operations/mkdir} -- fs - a remote name string eg “drive:” -- remote - a path within that remote eg “dir” + This takes the following parameters -See the mkdir 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 [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. -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/movefile: Move a file from source remote to destination remote {#operations/movefile} -- 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/publiclink: Create or retrieve a public link to the given file or folder. {#operations/publiclink} + 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. {#operations/publiclink} -- fs - a remote name string eg “drive:” -- remote - a path within that remote eg “dir” + This takes the following parameters -Returns + - fs - a remote name string eg "drive:" + - remote - a path within that remote eg "dir" -- url - URL of the resource + Returns -See the link command command for more information on the above. + - url - URL of the resource -Authentication is required for this call. + See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above. -operations/purge: Remove a directory or container and all of its contents {#operations/purge} + Authentication is required for this call. -This takes the following parameters + ### operations/purge: Remove a directory or container and all of its contents {#operations/purge} -- fs - a remote name string eg “drive:” -- remote - a path within that remote eg “dir” + This takes the following parameters -See the purge 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 [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. -operations/rmdir: Remove an empty directory or container {#operations/rmdir} + Authentication is required for this call. -This takes the following parameters + ### operations/rmdir: Remove an empty directory or container {#operations/rmdir} -- fs - a remote name string eg “drive:” -- remote - a path within that remote eg “dir” + This takes the following parameters -See the rmdir 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 [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. -operations/rmdirs: Remove all the empty directories in the path {#operations/rmdirs} + Authentication is required for this call. -This takes the following parameters + ### operations/rmdirs: Remove all the empty directories in the path {#operations/rmdirs} -- 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 + This takes the following parameters -See the rmdirs command command for more information on the above. + - 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 -Authentication is required for this call. + See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. -operations/size: Count the number of bytes and files in remote {#operations/size} + Authentication is required for this call. -This takes the following parameters + ### operations/size: Count the number of bytes and files in remote {#operations/size} -- fs - a remote name string eg “drive:path/to/dir” + This takes the following parameters -Returns + - fs - a remote name string eg "drive:path/to/dir" -- count - number of files -- bytes - number of bytes in those files + Returns -See the size command command for more information on the above. + - count - number of files + - bytes - number of bytes in those files -Authentication is required for this call. + See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above. -options/blocks: List all the option blocks {#options/blocks} + Authentication is required for this call. -Returns - options - a list of the options block names + ### options/blocks: List all the option blocks {#options/blocks} -options/get: Get all the options {#options/get} + Returns + - options - a list of the options block names -Returns an object where keys are option block names and values are an -object with the current option values in. + ### options/get: Get all the options {#options/get} -This shows the internal names of the option within rclone which should -map to the external options very easily with a few exceptions. + Returns an object where keys are option block names and values are an + object with the current option values in. -options/set: Set an option {#options/set} + This shows the internal names of the option within rclone which should + map to the external options very easily with a few exceptions. -Parameters + ### options/set: Set an option {#options/set} -- option block name containing an object with - - key: value + Parameters -Repeated as often as required. + - option block name containing an object with + - key: value -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. + Repeated as often as required. -For example: + 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. -This sets DEBUG level logs (-vv) + For example: - rclone rc options/set --json '{"main": {"LogLevel": 8}}' + This sets DEBUG level logs (-vv) -And this sets INFO level logs (-v) + rclone rc options/set --json '{"main": {"LogLevel": 8}}' - rclone rc options/set --json '{"main": {"LogLevel": 7}}' + And this sets INFO level logs (-v) -And this sets NOTICE level logs (normal without -v) + rclone rc options/set --json '{"main": {"LogLevel": 7}}' - rclone rc options/set --json '{"main": {"LogLevel": 6}}' + And this sets NOTICE level logs (normal without -v) -rc/error: This returns an error {#rc/error} + rclone rc options/set --json '{"main": {"LogLevel": 6}}' -This returns an error with the input as part of its error string. Useful -for testing error handling. + ### rc/error: This returns an error {#rc/error} -rc/list: List all the registered remote control commands {#rc/list} + This returns an error with the input as part of its error string. + Useful for testing error handling. -This lists all the registered remote control commands as a JSON map in -the commands response. + ### rc/list: List all the registered remote control commands {#rc/list} -rc/noop: Echo the input to the output parameters {#rc/noop} + This lists all the registered remote control commands as a JSON map in + the commands response. -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/noop: Echo the input to the output parameters {#rc/noop} -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. -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} -Authentication is required for this call. + 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. -sync/copy: copy a directory from source remote to destination remote {#sync/copy} + Authentication is required for this call. -This takes the following parameters + ### sync/copy: copy a directory from source remote to destination remote {#sync/copy} -- srcFs - a remote name string eg “drive:src” for the source -- dstFs - a remote name string eg “drive:dst” for the destination + This takes the following parameters -See the copy command 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 -Authentication is required for this call. -sync/move: move a directory from source remote to destination remote {#sync/move} + See the [copy command](https://rclone.org/commands/rclone_copy/) 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 -- deleteEmptySrcDirs - delete empty src directories if set + ### sync/move: move a directory from source remote to destination remote {#sync/move} -See the move 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 + - deleteEmptySrcDirs - delete empty src directories if set -sync/sync: sync a directory from source remote to destination remote {#sync/sync} -This takes the following parameters + See the [move command](https://rclone.org/commands/rclone_move/) 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 + Authentication is required for this call. -See the sync command command for more information on the above. + ### sync/sync: sync a directory from source remote to destination remote {#sync/sync} -Authentication is required for this call. + This takes the following parameters -vfs/forget: Forget files or directories in the directory cache. {#vfs/forget} + - srcFs - a remote name string eg "drive:src" for the source + - dstFs - a remote name string eg "drive:dst" for the destination -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. + See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. - rclone rc vfs/forget + Authentication is required for this call. -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/forget: Forget files or directories in the directory cache. {#vfs/forget} - rclone rc vfs/forget file=hello file2=goodbye dir=home/junk + This forgets the paths in the directory cache causing them to be + re-read from the remote when needed. -vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs/poll-interval} + If no paths are passed in then it will forget all the paths in the + directory cache. -Without any parameter given this returns the current status of the -poll-interval setting. + rclone rc vfs/forget -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. + 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/poll-interval interval=5m + rclone rc vfs/forget file=hello file2=goodbye dir=home/junk -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. -vfs/refresh: Refresh the directory cache. {#vfs/refresh} + rclone rc vfs/poll-interval interval=5m -This reads the directories for the specified paths and freshens 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. -If no paths are passed in then it will refresh the root directory. + The new poll-interval value will only be active when the timeout is + not reached. - rclone rc vfs/refresh + If poll-interval is updated or disabled temporarily, some changes + might not get picked up by the polling function, depending on the + used remote. -Otherwise pass directories in as dir=path. Any parameter key starting -with dir will refresh that directory, eg + ### vfs/refresh: Refresh the directory cache. {#vfs/refresh} - rclone rc vfs/refresh dir=home/junk dir2=data/misc + This reads the directories for the specified paths and freshens the + directory cache. -If the parameter recursive=true is given the whole directory tree will -get refreshed. This refresh will use –fast-list if enabled. + If no paths are passed in then it will refresh the root directory. + rclone rc vfs/refresh -Accessing the remote control via HTTP + Otherwise pass directories in as dir=path. Any parameter key + starting with dir will refresh that directory, eg -Rclone implements a simple HTTP based protocol. + rclone rc vfs/refresh dir=home/junk dir2=data/misc -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. + If the parameter recursive=true is given the whole directory tree + will get refreshed. This refresh will use --fast-list if enabled. -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. + ## Accessing the remote control via HTTP -The response will be a JSON blob in the body of the response. This is -formatted to be reasonably human readable. + Rclone implements a simple HTTP based protocol. -Error returns + 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. -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 + All calls must made using POST. - { - "error": "Expecting string value for key \"remote\" (was float64)", - "input": { - "fs": "/tmp", - "remote": 3 - }, - "status": 400 - "path": "operations/rmdir", - } + 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 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 + The response will be a JSON blob in the body of the response. This is + formatted to be reasonably human readable. -CORS + ### Error returns -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. + 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 -Using POST with URL parameters only +{ “error”: “Expecting string value for key "remote" (was float64)”, +“input”: { “fs”: “/tmp”, “remote”: 3 }, “status”: 400 “path”: +“operations/rmdir”, } - curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' -Response + 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 - { - "potato": "1", - "sausage": "2" - } + ### CORS -Here is what an error response looks like: + 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. - curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' + ### Using POST with URL parameters only - { - "error": "arbitrary error on input map[potato:1 sausage:2]", - "input": { - "potato": "1", - "sausage": "2" - } - } +curl -X POST ‘http://localhost:5572/rc/noop?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 + Response -Using POST with a form +{ “potato”: “1”, “sausage”: “2” } - curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop -Response + Here is what an error response looks like: - { - "potato": "1", - "sausage": "2" - } +curl -X POST ‘http://localhost:5572/rc/error?potato=1&sausage=2’ -Note that you can combine these with URL parameters too with the POST -parameters taking precedence. +{ “error”: “arbitrary error on input map[potato:1 sausage:2]”, “input”: +{ “potato”: “1”, “sausage”: “2” } } - curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4" -Response + Note that curl doesn't return errors to the shell unless you use the `-f` option - { - "potato": "1", - "rutabaga": "3", - "sausage": "4" - } +$ 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 JSON blob - curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop + ### Using POST with a form -response +curl –data “potato=1” –data “sausage=2” http://localhost:5572/rc/noop - { - "password": "xyz", - "username": "xyz" - } -This can be combined with URL parameters too if required. The JSON blob -takes precedence. + Response - curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4' +{ “potato”: “1”, “sausage”: “2” } - { - "potato": 2, - "rutabaga": "3", - "sausage": 1 - } + Note that you can combine these with URL parameters too with the POST + parameters taking precedence. -Debugging rclone with pprof +curl –data “potato=1” –data “sausage=2” +“http://localhost:5572/rc/noop?rutabaga=3&sausage=4” -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. + Response -Debugging memory use +{ “potato”: “1”, “rutabaga”: “3”, “sausage”: “4” } -To profile rclone’s memory use you can run: - go tool pprof -web http://localhost:5572/debug/pprof/heap + ### Using POST with a JSON blob -This should open a page in your browser showing what is using what -memory. +curl -H “Content-Type: application/json” -X POST -d +‘{“potato”:2,“sausage”:1}’ http://localhost:5572/rc/noop -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 + response -Debugging go routine leaks +{ “password”: “xyz”, “username”: “xyz” } -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 + This can be combined with URL parameters too if required. The JSON + blob takes precedence. - curl http://localhost:5572/debug/pprof/goroutine?debug=1 +curl -H “Content-Type: application/json” -X POST -d +‘{“potato”:2,“sausage”:1}’ +‘http://localhost:5572/rc/noop?rutabaga=3&potato=4’ -Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your -browser. +{ “potato”: 2, “rutabaga”: “3”, “sausage”: 1 } -Other profiles to look at -You can see a summary of profiles available at -http://localhost:5572/debug/pprof/ + ## Debugging rclone with pprof ## -Here is how to use some of them: + If you use the `--rc` flag this will also enable the use of the go + profiling tools on the same port. -- 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 + To use these, first [install go](https://golang.org/doc/install). -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. + ### Debugging memory use -The profiling hook is zero overhead unless it is used. + 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. -OVERVIEW OF CLOUD STORAGE SYSTEMS + 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 -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 -Features + Memory leaks are most often caused by go routine leaks keeping memory + alive which should have been garbage collected. -Here is an overview of the major features of each cloud storage system. + See all active go routines using - 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 - - 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 - - Mega - No No Yes - - Microsoft Azure Blob Storage MD5 Yes No No R/W - Microsoft OneDrive SHA1 ‡‡ Yes Yes No R - OpenDrive MD5 Yes Yes No - - 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 - SFTP MD5, SHA1 ‡ Yes Depends No - - WebDAV MD5, SHA1 †† Yes ††† Depends No - - Yandex Disk MD5 Yes No No R/W - The local filesystem All Yes Depends No - + curl http://localhost:5572/debug/pprof/goroutine?debug=1 -Hash + Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. -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. + ### Other profiles to look at -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. + You can see a summary of profiles available at http://localhost:5572/debug/pprof/ -†† WebDAV supports hashes when used with Owncloud and Nextcloud only. + Here is how to use some of them: -††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. + * 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` -‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive -for business and SharePoint server support Microsoft’s own QuickXorHash. + 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). -ModTime + The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). -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. + # Overview of cloud storage systems # -All cloud storage systems support some kind of date on the object and -these will be set when transferring from the cloud storage system. + Each cloud storage system is slightly different. Rclone attempts to + provide a unified interface to them, but some underlying differences + show through. -Case Insensitive + ## Features ## -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. + Here is an overview of the major features of each cloud storage system. -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. + | 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 | - | + | Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | + | Microsoft OneDrive | SHA1 ‡‡ | Yes | Yes | No | R | + | OpenDrive | MD5 | Yes | Yes | No | - | + | 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 | + | SFTP | MD5, SHA1 ‡ | Yes | Depends | No | - | + | WebDAV | MD5, SHA1 ††| Yes ††† | Depends | No | - | + | Yandex Disk | MD5 | Yes | No | No | R/W | + | The local filesystem | All | Yes | Depends | No | - | -The local filesystem and SFTP may or may not be case sensitive depending -on OS. + ### Hash ### -- 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) + 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. -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. + 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. + + ### 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](/local/#filenames) section for details. + + ### 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 | No | 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 | No [#575](https://github.com/rclone/rclone/issues/575) | 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 | No | 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 | + | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | + | Microsoft OneDrive | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | 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 | No [#2178](https://github.com/rclone/rclone/issues/2178) | 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 | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | + | SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | + | 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 and Hubic 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. + + ### 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](/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](/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. + --ca-cert string CA certificate used to verify servers + --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") + --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 use DIR to server side copy flies from. –config +string Config file. (default “$HOME/.config/rclone/rclone.conf”) +–contimeout duration Connect timeout (default 1m0s) –copy-dest string +Compare dest to DIR also. –cpuprofile string Write cpu profile to file +–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 –exclude +stringArray Exclude files matching pattern –exclude-from stringArray +Read exclude patterns from file –exclude-if-present string Exclude +directories if filename is present –fast-list Use recursive list if +available. Uses more memory but fewer transactions. –files-from +stringArray Read list of source-file names from file -f, –filter +stringArray Add a file-filtering rule –filter-from stringArray Read +filtering patterns from a file –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 +–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-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-gzip-encoding Don’t set Accept-Encoding: +gzip. –no-traverse Don’t traverse destination file system on copy. +–no-update-modtime Don’t update destination mod-time if files identical. +-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-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-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-update Update / Force +update to latest version of web gui –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 –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.50.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 Amazon Application Client ID. + --acd-client-secret string Amazon Application Client Secret. + --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + --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-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-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-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-endpoint string Endpoint for the service. + --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. + --b2-key string Application Key + --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-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") + --box-client-id string Box App Client Id. + --box-client-secret string Box App Client Secret + --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --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 verifications when connecting to the Plex server + --cache-plex-password string The password of the Plex user + --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. +–crypt-password2 string Password or pass phrase for salt. Optional but +recommended. –crypt-remote string Remote to encrypt/decrypt. +–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-alternate-export Use alternate +export URLs for google documents export., –drive-auth-owner-only Only +consider files owned by the authenticated user. –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 Google Application Client Secret +–drive-disable-http2 Disable drive using http2 (default true) +–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 storage quota usage for file size. +–drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and +videos only. –drive-skip-gdocs Skip google documents in all listings. +–drive-team-drive string ID of the Team Drive –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-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-chunk-size SizeSuffix +Upload chunk size. (< 150M). (default 48M) –dropbox-client-id string +Dropbox App Client Id –dropbox-client-secret string Dropbox App Client +Secret –dropbox-impersonate string Impersonate this user when using a +business account. –fichier-api-key string Your API Key, get it from +https://1fichier.com/console/params.pl –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-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 –ftp-port string FTP port, leave +blank to use default (21) –ftp-tls Use FTP over TLS (Implicit) –ftp-user +string FTP username, leave blank for current username, $USER +–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 Google Application Client Id +–gcs-client-secret string Google Application Client Secret –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. –gphotos-client-id string +Google Application Client Id –gphotos-client-secret string Google +Application 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. –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-chunk-size +SizeSuffix Above this size files will be chunked into a _segments +container. (default 5G) –hubic-client-id string Hubic Client Id +–hubic-client-secret string Hubic Client Secret –hubic-no-chunk Don’t +chunk files during streaming upload. –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-unlink Remove existing public link to file/folder with link +command rather than creating. –jottacloud-upload-resume-limit SizeSuffix +Files bigger than this can be resumed if the upload fail’s. (default +10M) –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) –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-no-check-updated Don’t check to see if the +files change during upload –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-pass string Password +–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-hard-delete Delete files permanently rather than putting them into +the trash. –mega-pass string Password. –mega-user string User name -x, +–one-file-system Don’t cross filesystem boundaries (unix/macOS only). +–onedrive-chunk-size SizeSuffix Chunk size to upload files with - must +be multiple of 320k (327,680 bytes). (default 10M) –onedrive-client-id +string Microsoft App Client Id –onedrive-client-secret string Microsoft +App 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-expose-onenote-files Set to make OneNote +files show up in directory listings. –opendrive-password string +Password. –opendrive-username string Username –pcloud-client-id string +Pcloud App Client Id –pcloud-client-secret string Pcloud App Client +Secret –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-endpoint string Enter a 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-disable-checksum Don’t store MD5 checksum with object metadata +–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-location-constraint string Location constraint - must be set to +match the Region. –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-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. +–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. –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. –sftp-path-override string Override path +used by SSH connection. –sftp-port string SSH port, leave blank to use +default (22) –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-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-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. +–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-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). –union-remotes string List of +space separated remotes. –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. +–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-client-id string Yandex Client Id +–yandex-client-secret string Yandex Client Secret –yandex-unlink Remove +existing public link to file/folder with link command rather than +creating. + + + 1Fichier + ----------------------------------------- + + This is a backend for the [1ficher](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 ### -Duplicate files + 1Fichier can have two files with exactly the same name and path (unlike a + normal file system). -If a cloud storage system allows duplicate files then it can have two -objects with the same name. + Duplicated files cause problems with the syncing and you will see + messages in the log about duplicates. -This confuses rclone greatly when syncing - use the rclone dedupe -command to rename or remove duplicates. + #### Restricted filename characters -MIME Type + In addition to the [default restricted characters set](/overview/#restricted-characters) + the following characters are also replaced: -MIME types (also known as media types) classify types of documents using -a simple text classification, eg text/html or application/pdf. + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | \ | 0x5C | ＼ | + | < | 0x3C | ＜ | + | > | 0x3E | ＞ | + | " | 0x22 | ＂ | + | $ | 0x24 | ＄ | + | ` | 0x60 | ｀ | + | ' | 0x27 | ＇ | -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. + File names can also not start or end with the following characters. + These only get replaced if they are first or last character in the + name: -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. + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | SP | 0x20 | ␠ | + Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), + as they can't be used in JSON strings. -Optional Features + + ### Standard Options -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. + Here are the standard options specific to fichier (1Fichier). - 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 No Yes Yes No #2178 No No - Backblaze B2 No Yes No No Yes Yes Yes Yes No No - Box Yes Yes Yes Yes No #575 No Yes Yes 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 No Yes No Yes Yes Yes - Mega Yes No Yes Yes Yes No No No #2178 Yes Yes - Microsoft Azure Blob Storage Yes Yes No No No Yes No No #2178 No No - Microsoft OneDrive Yes Yes Yes Yes No #575 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 No #2178 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 No Yes No No #2178 No No - SFTP No No Yes Yes No No Yes No #2178 Yes Yes - 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 - -Purge - -This deletes a directory quicker than just deleting all the files in the -directory. - -† Note Swift and Hubic 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. - -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. - --ca-cert string CA certificate used to verify servers - --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") - --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 use DIR to server side copy flies from. - --config string Config file. (default "$HOME/.config/rclone/rclone.conf") - --contimeout duration Connect timeout (default 1m0s) - --copy-dest string Compare dest to DIR also. - --cpuprofile string Write cpu profile to file - --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 - --exclude stringArray Exclude files matching pattern - --exclude-from stringArray Read exclude patterns from file - --exclude-if-present string Exclude directories if filename is present - --fast-list Use recursive list if available. Uses more memory but fewer transactions. - --files-from stringArray Read list of source-file names from file - -f, --filter stringArray Add a file-filtering rule - --filter-from stringArray Read filtering patterns from a file - --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 - --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-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-gzip-encoding Don't set Accept-Encoding: gzip. - --no-traverse Don't traverse destination file system on copy. - --no-update-modtime Don't update destination mod-time if files identical. - -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-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-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-update Update / Force update to latest version of web gui - --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 - --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.49.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 Amazon Application Client ID. - --acd-client-secret string Amazon Application Client Secret. - --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - --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-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-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-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-endpoint string Endpoint for the service. - --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. - --b2-key string Application Key - --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-client-id string Box App Client Id. - --box-client-secret string Box App Client Secret - --box-commit-retries int Max number of times to try committing a multipart file. (default 100) - --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 verifications when connecting to the Plex server - --cache-plex-password string The password of the Plex user - --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 - -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. - --crypt-password2 string Password or pass phrase for salt. Optional but recommended. - --crypt-remote string Remote to encrypt/decrypt. - --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-alternate-export Use alternate export URLs for google documents export., - --drive-auth-owner-only Only consider files owned by the authenticated user. - --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 Google Application Client Secret - --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 storage quota usage for file size. - --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. - --drive-skip-gdocs Skip google documents in all listings. - --drive-team-drive string ID of the Team Drive - --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-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-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) - --dropbox-client-id string Dropbox App Client Id - --dropbox-client-secret string Dropbox App Client Secret - --dropbox-impersonate string Impersonate this user when using a business account. - --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl - --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-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 - --ftp-port string FTP port, leave blank to use default (21) - --ftp-tls Use FTP over TLS (Implicit) - --ftp-user string FTP username, leave blank for current username, $USER - --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 Google Application Client Id - --gcs-client-secret string Google Application Client Secret - --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. - --gphotos-client-id string Google Application Client Id - --gphotos-client-secret string Google Application 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. - --http-headers CommaSepList Set HTTP headers for all transactions - --http-no-slash Set this if the site doesn't end directories with / - --http-url string URL of http host to connect to - --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) - --hubic-client-id string Hubic Client Id - --hubic-client-secret string Hubic Client Secret - --hubic-no-chunk Don't chunk files during streaming upload. - --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-unlink Remove existing public link to file/folder with link command rather than creating. - --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) - --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) - --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-no-check-updated Don't check to see if the files change during upload - --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 - --mega-debug Output more debug from Mega. - --mega-hard-delete Delete files permanently rather than putting them into the trash. - --mega-pass string Password. - --mega-user string User name - -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). - --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k. (default 10M) - --onedrive-client-id string Microsoft App Client Id - --onedrive-client-secret string Microsoft App 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-expose-onenote-files Set to make OneNote files show up in directory listings. - --opendrive-password string Password. - --opendrive-username string Username - --pcloud-client-id string Pcloud App Client Id - --pcloud-client-secret string Pcloud App Client Secret - --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-endpoint string Enter a 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-disable-checksum Don't store MD5 checksum with object metadata - --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-location-constraint string Location constraint - must be set to match the Region. - --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-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. - --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. - --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. - --sftp-path-override string Override path used by SSH connection. - --sftp-port string SSH port, leave blank to use default (22) - --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-use-insecure-cipher Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. - --sftp-user string SSH username, leave blank for current username, ncw - --skip-links Don't warn about skipped symlinks. - --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-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). - --union-remotes string List of space separated remotes. - --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. - --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-client-id string Yandex Client Id - --yandex-client-secret string Yandex Client Secret - --yandex-unlink Remove existing public link to file/folder with link command rather than creating. - - -1Fichier - -This is a backend for the 1ficher 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/ ** + #### --fichier-api-key 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 + - Config: api_key + - Env Var: RCLONE_FICHIER_API_KEY + - Type: string + - Default: "" -Once configured you can then use rclone like this, + ### Advanced Options -List directories in top level of your 1Fichier account + Here are the advanced options specific to fichier (1Fichier). - rclone lsd remote: + #### --fichier-shared-folder -List all the files in your 1Fichier account + If you want to download a shared folder, add this parameter - rclone ls remote: + - Config: shared_folder + - Env Var: RCLONE_FICHIER_SHARED_FOLDER + - Type: string + - Default: "" -To copy a local directory to a 1Fichier directory called backup + - rclone copy /home/source remote:backup + Alias + ----------------------------------------- -Modified time and hashes + The `alias` remote provides a new name for another remote. -1Fichier does not support modification times. It supports the Whirlpool -hash algorithm. + Paths may be as deep as required or a local path, + eg `remote:directory/subdirectory` or `/directory/subdirectory`. -Duplicated files + 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. -1Fichier can have two files with exactly the same name and path (unlike -a normal file system). + Subfolders can be used in target remote. Assume a 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`. -Duplicated files cause problems with the syncing and you will see -messages in the log about duplicates. + 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. -Forbidden characters + Here is an example of how to make a alias called `remote` for local folder. + First run: -1Fichier does not support the characters \ < > " ' ` $ and spaces at the -beginning of folder names. rclone automatically escapes these to a -unicode equivalent. The exception is /, which cannot be escaped and will -therefore lead to errors. + rclone config -Standard Options + This will guide you through an interactive setup process: -Here are the standard options specific to fichier (1Fichier). +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: -–fichier-api-key +Name Type ==== ==== remote alias -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: "" +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 -Alias + Once configured you can then use `rclone` like this, -The alias remote provides a new name for another remote. + List directories in top level in `/mnt/storage/backup` -Paths may be as deep as required or a local path, eg -remote:directory/subdirectory or /directory/subdirectory. + rclone lsd 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. + List all the files in `/mnt/storage/backup` -Subfolders can be used in target remote. Assume a 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. + rclone ls remote: -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. + Copy another local directory to the alias directory called source -Here is an example of how to make a alias called remote for local -folder. First run: + rclone copy /home/source remote:source - rclone config + + ### Standard Options -This will guide you through an interactive setup process: + Here are the standard options specific to alias (Alias for an existing remote). + + #### --alias-remote - 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 + - Config: remote + - Env Var: RCLONE_ALIAS_REMOTE + - Type: string + - Default: "" - 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 a third party ouath 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 a third party ouath 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 -Deleting files + rclone copy /home/source remote:backup -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. + ### Modified time and MD5SUMs ### -Using with non .com Amazon accounts + Amazon Drive doesn't allow modification times to be changed via + the API so these won't be accurate or used for syncing. -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. + It does store MD5SUMs so for a more accurate sync, you can use the + `--checksum` flag. -Standard Options + #### Restricted filename characters -Here are the standard options specific to amazon cloud drive (Amazon -Drive). + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | NUL | 0x00 | ␀ | + | / | 0x2F | ／ | -–acd-client-id + Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), + as they can't be used in JSON strings. -Amazon Application Client ID. + ### Deleting files ### -- Config: client_id -- Env Var: RCLONE_ACD_CLIENT_ID -- Type: string -- Default: "" + 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-secret + ### Using with non `.com` Amazon accounts ### -Amazon Application Client Secret. + 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_secret -- Env Var: RCLONE_ACD_CLIENT_SECRET -- Type: string -- Default: "" + + ### Standard Options -Advanced Options + Here are the standard options specific to amazon cloud drive (Amazon Drive). -Here are the advanced options specific to amazon cloud drive (Amazon -Drive). + #### --acd-client-id -–acd-auth-url + Amazon Application Client ID. -Auth server URL. Leave blank to use Amazon’s. + - Config: client_id + - Env Var: RCLONE_ACD_CLIENT_ID + - Type: string + - Default: "" -- Config: auth_url -- Env Var: RCLONE_ACD_AUTH_URL -- Type: string -- Default: "" + #### --acd-client-secret -–acd-token-url + Amazon Application Client Secret. -Token server url. leave blank to use Amazon’s. + - Config: client_secret + - Env Var: RCLONE_ACD_CLIENT_SECRET + - Type: string + - Default: "" -- Config: token_url -- Env Var: RCLONE_ACD_TOKEN_URL -- Type: string -- Default: "" + ### Advanced Options -–acd-checkpoint + Here are the advanced options specific to amazon cloud drive (Amazon Drive). -Checkpoint for internal polling (debug). + #### --acd-auth-url -- Config: checkpoint -- Env Var: RCLONE_ACD_CHECKPOINT -- Type: string -- Default: "" + Auth server URL. + Leave blank to use Amazon's. -–acd-upload-wait-per-gb + - Config: auth_url + - Env Var: RCLONE_ACD_AUTH_URL + - Type: string + - Default: "" -Additional time per GB to wait after a failed complete upload to see if -it appears. + #### --acd-token-url -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. + Token server url. + leave blank to use Amazon's. -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. + - Config: token_url + - Env Var: RCLONE_ACD_TOKEN_URL + - Type: string + - Default: "" -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. + #### --acd-checkpoint -These values were determined empirically by observing lots of uploads of -big files for a range of file sizes. + Checkpoint for internal polling (debug). -Upload with the “-v” flag to see more info about what rclone is doing in -this situation. + - Config: checkpoint + - Env Var: RCLONE_ACD_CHECKPOINT + - Type: string + - Default: "" -- Config: upload_wait_per_gb -- Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB -- Type: Duration -- Default: 3m0s + #### --acd-upload-wait-per-gb -–acd-templink-threshold + Additional time per GB to wait after a failed complete upload to see if it appears. -Files >= this size will be downloaded via their tempLink. + 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. -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. + 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. -To download files above this threshold, rclone requests a “tempLink” -which downloads the file through a temporary URL directly from the -underlying S3 storage. + 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: templink_threshold -- Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD -- Type: SizeSuffix -- Default: 9G + These values were determined empirically by observing lots of uploads + of big files for a range of file sizes. -Limitations + Upload with the "-v" flag to see more info about what rclone is doing + in this situation. -Note that Amazon Drive is case insensitive so you can’t have a file -called “Hello.doc” and one called “hello.doc”. + - Config: upload_wait_per_gb + - Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB + - Type: Duration + - Default: 3m0s -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. + #### --acd-templink-threshold -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. + Files >= this size will be downloaded via their tempLink. -At the time of writing (Jan 2016) is in the area of 50GB per file. This -means that larger files are likely to fail. + 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. -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 -- 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 /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. - 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" - / South America (Sao Paulo) Region - 14 | 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 / 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. - -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). - -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, 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) - - “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. - - “sa-east-1” - - South America (Sao Paulo) Region - - Needs location constraint sa-east-1. - -–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-api.us-geo.objectstorage.softlayer.net” - - US Cross Region Endpoint - - “s3-api.dal.us-geo.objectstorage.softlayer.net” - - US Cross Region Dallas Endpoint - - “s3-api.wdc-us-geo.objectstorage.softlayer.net” - - US Cross Region Washington DC Endpoint - - “s3-api.sjc-us-geo.objectstorage.softlayer.net” - - US Cross Region San Jose Endpoint - - “s3-api.us-geo.objectstorage.service.networklayer.com” - - US Cross Region Private Endpoint - - “s3-api.dal-us-geo.objectstorage.service.networklayer.com” - - US Cross Region Dallas Private Endpoint - - “s3-api.wdc-us-geo.objectstorage.service.networklayer.com” - - US Cross Region Washington DC Private Endpoint - - “s3-api.sjc-us-geo.objectstorage.service.networklayer.com” - - US Cross Region San Jose Private Endpoint - - “s3.us-east.objectstorage.softlayer.net” - - US Region East Endpoint - - “s3.us-east.objectstorage.service.networklayer.com” - - US Region East Private Endpoint - - “s3.us-south.objectstorage.softlayer.net” - - US Region South Endpoint - - “s3.us-south.objectstorage.service.networklayer.com” - - US Region South Private Endpoint - - “s3.eu-geo.objectstorage.softlayer.net” - - EU Cross Region Endpoint - - “s3.fra-eu-geo.objectstorage.softlayer.net” - - EU Cross Region Frankfurt Endpoint - - “s3.mil-eu-geo.objectstorage.softlayer.net” - - EU Cross Region Milan Endpoint - - “s3.ams-eu-geo.objectstorage.softlayer.net” - - EU Cross Region Amsterdam Endpoint - - “s3.eu-geo.objectstorage.service.networklayer.com” - - EU Cross Region Private Endpoint - - “s3.fra-eu-geo.objectstorage.service.networklayer.com” - - EU Cross Region Frankfurt Private Endpoint - - “s3.mil-eu-geo.objectstorage.service.networklayer.com” - - EU Cross Region Milan Private Endpoint - - “s3.ams-eu-geo.objectstorage.service.networklayer.com” - - EU Cross Region Amsterdam Private Endpoint - - “s3.eu-gb.objectstorage.softlayer.net” - - Great Britain Endpoint - - “s3.eu-gb.objectstorage.service.networklayer.com” - - Great Britain Private Endpoint - - “s3.ap-geo.objectstorage.softlayer.net” - - APAC Cross Regional Endpoint - - “s3.tok-ap-geo.objectstorage.softlayer.net” - - APAC Cross Regional Tokyo Endpoint - - “s3.hkg-ap-geo.objectstorage.softlayer.net” - - APAC Cross Regional HongKong Endpoint - - “s3.seo-ap-geo.objectstorage.softlayer.net” - - APAC Cross Regional Seoul Endpoint - - “s3.ap-geo.objectstorage.service.networklayer.com” - - APAC Cross Regional Private Endpoint - - “s3.tok-ap-geo.objectstorage.service.networklayer.com” - - APAC Cross Regional Tokyo Private Endpoint - - “s3.hkg-ap-geo.objectstorage.service.networklayer.com” - - APAC Cross Regional HongKong Private Endpoint - - “s3.seo-ap-geo.objectstorage.service.networklayer.com” - - APAC Cross Regional Seoul Private Endpoint - - “s3.mel01.objectstorage.softlayer.net” - - Melbourne Single Site Endpoint - - “s3.mel01.objectstorage.service.networklayer.com” - - Melbourne Single Site Private Endpoint - - “s3.tor01.objectstorage.softlayer.net” - - Toronto Single Site Endpoint - - “s3.tor01.objectstorage.service.networklayer.com” - - Toronto 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 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) - - “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 + 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 + + + + ### 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 + * 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 /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” / South America (Sao Paulo) Region 14 | 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 / 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](/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. + + #### Restricted filename characters + + S3 allows any valid UTF-8 string as a key. + + Invalid UTF-8 bytes will be [replaced](/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`. -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 - -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. - -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. + Multipart uploads will use `--transfers` * `--s3-upload-concurrency` * + `--s3-chunk-size` extra memory. Single part uploads to not use extra + memory. -–s3-upload-cutoff + 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. -Cutoff for switching to chunked upload + 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. -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 + ### Buckets and Regions ### -–s3-chunk-size + 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`. -Chunk size to use for uploading. + ### Authentication ### -When uploading files larger than upload_cutoff they will be uploaded as -multipart uploads using this chunk size. + There are a number of ways to supply `rclone` with a set of AWS + credentials, with and without using the environment. -Note that “–s3-upload-concurrency” chunks of this size are buffered in -memory per transfer. + The different authentication methods are tried in this order: -If you are transferring large files over high speed links and you have -enough memory, then increasing this will speed up the transfers. + - 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). -- Config: chunk_size -- Env Var: RCLONE_S3_CHUNK_SIZE -- Type: SizeSuffix -- Default: 5M + If none of these option actually end up providing `rclone` with AWS + credentials then S3 interaction will be non-authenticated (see below). -–s3-disable-checksum + ### S3 Permissions ### -Don’t store MD5 checksum with object metadata + When using the `sync` subcommand of `rclone` the following minimum + permissions are required to be available on the bucket being written to: -- Config: disable_checksum -- Env Var: RCLONE_S3_DISABLE_CHECKSUM -- Type: bool -- Default: false + * `ListBucket` + * `DeleteObject` + * `GetObject` + * `PutObject` + * `PutObjectACL` -–s3-session-token + When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required. -An AWS session token + Example policy: -- Config: session_token -- Env Var: RCLONE_S3_SESSION_TOKEN -- Type: string -- Default: "" +{ “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:::*" } +] } -–s3-upload-concurrency -Concurrency for multipart uploads. + Notes on above: -This is the number of chunks of the same file that are uploaded -concurrently. + 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. -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. + 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`. -- Config: upload_concurrency -- Env Var: RCLONE_S3_UPLOAD_CONCURRENCY -- Type: int -- Default: 4 + ### Key Management System (KMS) ### -–s3-force-path-style + 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. -If true use path style access if false use virtual hosted style. + A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824). -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. + ### Glacier and Glacier Deep Archive ### -Some providers (eg Aliyun OSS or Netease COS) require this set to false. + 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. -- Config: force_path_style -- Env Var: RCLONE_S3_FORCE_PATH_STYLE -- Type: bool -- Default: true + 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file -–s3-v2-auth + 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. -If true use v2 authentication. + Note that rclone only speaks the S3 API it does not speak the Glacier + Vault API, so rclone cannot directly access Glacier Vaults. -If this is false (the default) then rclone will use v4 authentication. -If it is set then rclone will use v2 authentication. + + ### Standard Options -Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH. + Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). -- Config: v2_auth -- Env Var: RCLONE_S3_V2_AUTH -- Type: bool -- Default: false + #### --s3-provider -–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 - -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 promted 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 - 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 - force_path_style = false - 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 + + - 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) + - "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. - 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 + + - 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. - Enter a string value. Press Enter for the default (""). - access_key_id> accesskeyid + + - 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. - Enter a string value. Press Enter for the default (""). - secret_access_key> secretaccesskey + + - 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. + - "sa-east-1" + - South America (Sao Paulo) Region + - Needs location constraint sa-east-1. + + #### --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-api.us-geo.objectstorage.softlayer.net" + - US Cross Region Endpoint + - "s3-api.dal.us-geo.objectstorage.softlayer.net" + - US Cross Region Dallas Endpoint + - "s3-api.wdc-us-geo.objectstorage.softlayer.net" + - US Cross Region Washington DC Endpoint + - "s3-api.sjc-us-geo.objectstorage.softlayer.net" + - US Cross Region San Jose Endpoint + - "s3-api.us-geo.objectstorage.service.networklayer.com" + - US Cross Region Private Endpoint + - "s3-api.dal-us-geo.objectstorage.service.networklayer.com" + - US Cross Region Dallas Private Endpoint + - "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" + - US Cross Region Washington DC Private Endpoint + - "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" + - US Cross Region San Jose Private Endpoint + - "s3.us-east.objectstorage.softlayer.net" + - US Region East Endpoint + - "s3.us-east.objectstorage.service.networklayer.com" + - US Region East Private Endpoint + - "s3.us-south.objectstorage.softlayer.net" + - US Region South Endpoint + - "s3.us-south.objectstorage.service.networklayer.com" + - US Region South Private Endpoint + - "s3.eu-geo.objectstorage.softlayer.net" + - EU Cross Region Endpoint + - "s3.fra-eu-geo.objectstorage.softlayer.net" + - EU Cross Region Frankfurt Endpoint + - "s3.mil-eu-geo.objectstorage.softlayer.net" + - EU Cross Region Milan Endpoint + - "s3.ams-eu-geo.objectstorage.softlayer.net" + - EU Cross Region Amsterdam Endpoint + - "s3.eu-geo.objectstorage.service.networklayer.com" + - EU Cross Region Private Endpoint + - "s3.fra-eu-geo.objectstorage.service.networklayer.com" + - EU Cross Region Frankfurt Private Endpoint + - "s3.mil-eu-geo.objectstorage.service.networklayer.com" + - EU Cross Region Milan Private Endpoint + - "s3.ams-eu-geo.objectstorage.service.networklayer.com" + - EU Cross Region Amsterdam Private Endpoint + - "s3.eu-gb.objectstorage.softlayer.net" + - Great Britain Endpoint + - "s3.eu-gb.objectstorage.service.networklayer.com" + - Great Britain Private Endpoint + - "s3.ap-geo.objectstorage.softlayer.net" + - APAC Cross Regional Endpoint + - "s3.tok-ap-geo.objectstorage.softlayer.net" + - APAC Cross Regional Tokyo Endpoint + - "s3.hkg-ap-geo.objectstorage.softlayer.net" + - APAC Cross Regional HongKong Endpoint + - "s3.seo-ap-geo.objectstorage.softlayer.net" + - APAC Cross Regional Seoul Endpoint + - "s3.ap-geo.objectstorage.service.networklayer.com" + - APAC Cross Regional Private Endpoint + - "s3.tok-ap-geo.objectstorage.service.networklayer.com" + - APAC Cross Regional Tokyo Private Endpoint + - "s3.hkg-ap-geo.objectstorage.service.networklayer.com" + - APAC Cross Regional HongKong Private Endpoint + - "s3.seo-ap-geo.objectstorage.service.networklayer.com" + - APAC Cross Regional Seoul Private Endpoint + - "s3.mel01.objectstorage.softlayer.net" + - Melbourne Single Site Endpoint + - "s3.mel01.objectstorage.service.networklayer.com" + - Melbourne Single Site Private Endpoint + - "s3.tor01.objectstorage.softlayer.net" + - Toronto Single Site Endpoint + - "s3.tor01.objectstorage.service.networklayer.com" + - Toronto Single Site Private Endpoint + + #### --s3-endpoint + 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 + + - 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 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) + - "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. - 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 + + - 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 + 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. - -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 /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. + - 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. -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. + ### Advanced Options -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. + Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). -–fast-list + #### --s3-bucket-acl -This remote supports --fast-list which allows you to use fewer -transactions in exchange for more memory. See the rclone docs for more -details. + Canned ACL used when creating buckets. -Modified time + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -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. + Note that this ACL is applied when only when creating buckets. If it + isn't set then "acl" is used instead. -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. + - 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. -SHA1 checksums + #### --s3-upload-cutoff -The SHA1 checksums of the files are checked on upload and download and -will be used in the syncing process. + Cutoff for switching to chunked upload -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. + Any files larger than this will be uploaded in chunks of chunk_size. + The minimum is 0 and the maximum is 5GB. -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. + - Config: upload_cutoff + - Env Var: RCLONE_S3_UPLOAD_CUTOFF + - Type: SizeSuffix + - Default: 200M -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). + #### --s3-chunk-size -Files sizes below --b2-upload-cutoff will always have an SHA1 regardless -of the source. + Chunk size to use for uploading. -Transfers + When uploading files larger than upload_cutoff they will be uploaded + as multipart uploads using this chunk size. -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 "--s3-upload-concurrency" chunks of this size are buffered + in memory per transfer. -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. + If you are transferring large files over high speed links and you have + enough memory, then increasing this will speed up the transfers. -Versions + - Config: chunk_size + - Env Var: RCLONE_S3_CHUNK_SIZE + - Type: SizeSuffix + - Default: 5M -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. + #### --s3-disable-checksum -Old versions of files, where available, are visible using the ---b2-versions flag. + Don't store MD5 checksum with object metadata -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. + - Config: disable_checksum + - Env Var: RCLONE_S3_DISABLE_CHECKSUM + - Type: bool + - Default: false -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. + #### --s3-session-token -Note that cleanup will remove partially uploaded files from the bucket -if they are more than a day old. + An AWS session token -When you purge a bucket, the current and the old versions will be -deleted then the bucket will be deleted. + - Config: session_token + - Env Var: RCLONE_S3_SESSION_TOKEN + - Type: string + - Default: "" -However delete will cause the current versions of the files to become -hidden old versions. + #### --s3-upload-concurrency -Here is a session showing the listing and retrieval of an old version -followed by a cleanup of the old versions. + Concurrency for multipart uploads. -Show current version and all the versions with --b2-versions flag. + This is the number of chunks of the same file that are uploaded + concurrently. - $ rclone -q ls b2:cleanup-test - 9 one.txt + 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. - $ 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 + - Config: upload_concurrency + - Env Var: RCLONE_S3_UPLOAD_CONCURRENCY + - Type: int + - Default: 4 -Retrieve an old version + #### --s3-force-path-style - $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp + If true use path style access if false use virtual hosted style. - $ 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 + 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. -Clean up all the old versions and show that they’ve gone. + Some providers (eg Aliyun OSS or Netease COS) require this set to false. - $ rclone -q cleanup b2:cleanup-test + - Config: force_path_style + - Env Var: RCLONE_S3_FORCE_PATH_STYLE + - Type: bool + - Default: true - $ rclone -q ls b2:cleanup-test - 9 one.txt + #### --s3-v2-auth - $ rclone -q --b2-versions ls b2:cleanup-test - 9 one.txt + If true use v2 authentication. -Data usage + If this is false (the default) then rclone will use v4 authentication. + If it is set then rclone will use v2 authentication. -It is useful to know how many requests are sent to the server in -different scenarios. + Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. -All copy commands send the following 4 requests: + - Config: v2_auth + - Env Var: RCLONE_S3_V2_AUTH + - Type: bool + - Default: false - /b2api/v1/b2_authorize_account - /b2api/v1/b2_create_bucket - /b2api/v1/b2_list_buckets - /b2api/v1/b2_list_file_names + #### --s3-use-accelerate-endpoint -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. + If true use the AWS S3 accelerated endpoint. -Uploading files that do not require chunking, will send 2 requests per -file upload: + See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) - /b2api/v1/b2_get_upload_url - /b2api/v1/b2_upload_file/ + - Config: use_accelerate_endpoint + - Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT + - Type: bool + - Default: false -Uploading files requiring chunking, will send 2 requests (one each to -start and finish the upload) and another 2 requests for each chunk: + #### --s3-leave-parts-on-error - /b2api/v1/b2_start_large_file - /b2api/v1/b2_get_upload_part_url - /b2api/v1/b2_upload_part/ - /b2api/v1/b2_finish_large_file + If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. -Versions + It should be set to true for resuming uploads across different sessions. -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 + WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. -Listing without --b2-versions - $ rclone -q ls b2:cleanup-test - 9 one.txt + - Config: leave_parts_on_error + - Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR + - Type: bool + - Default: false -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 + ### Anonymous access to public buckets ### -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. + 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: -Note that when using --b2-versions no file write operations are -permitted, so you can’t upload files or delete them. +[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 = -B2 and rclone link -Rclone supports generating file share links for private B2 buckets. They -can either be for a file for example: + Then use it as normal with the name of the public bucket, eg - ./rclone link B2:bucket/path/to/file.txt - https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx + rclone lsd anons3:1000genomes -or if run on a directory you will get: + You will be able to list and copy data but not upload it. - ./rclone link B2:bucket/path - https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx + ### Ceph ### -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: + [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. - 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 + 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: -Standard Options +[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 = -Here are the standard options specific to b2 (Backblaze B2). -–b2-account + 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. -Account ID or Application Key ID + 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. -- Config: account -- Env Var: RCLONE_B2_ACCOUNT -- Type: string -- Default: "" + Eg the dump from Ceph looks something like this (irrelevant keys + removed). -–b2-key +{ “user_id”: “xxx”, “display_name”: “xxxx”, “keys”: [ { “user”: “xxx”, +“access_key”: “xxxxxx”, “secret_key”: “xxxxxx/xxxx” } ], } -Application Key -- Config: key -- Env Var: RCLONE_B2_KEY -- Type: string -- Default: "" + 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. -–b2-hard-delete + ### Dreamhost ### -Permanently delete files on remote removal, otherwise hide files. + Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is + an object storage system based on CEPH. -- Config: hard_delete -- Env Var: RCLONE_B2_HARD_DELETE -- Type: bool -- Default: false + 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: -Advanced Options +[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 = -Here are the advanced options specific to b2 (Backblaze B2). -–b2-endpoint + ### DigitalOcean Spaces ### -Endpoint for the service. Leave blank normally. + [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. -- Config: endpoint -- Env Var: RCLONE_B2_ENDPOINT -- Type: string -- Default: "" + 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 promted by `rclone config` for your `access_key_id` and `secret_access_key`. -–b2-test-mode + 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. -A flag string for X-Bz-Test-Mode header for debugging. + Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below: -This is for debugging purposes only. Setting it to one of the strings -below will cause b2 to return specific errors: +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> -- “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. + The resulting configuration file should look like: -- Config: test_mode -- Env Var: RCLONE_B2_TEST_MODE -- Type: string -- Default: "" +[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 = -–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. + Once configured, you can create a new Space and begin copying files. For example: -- Config: versions -- Env Var: RCLONE_B2_VERSIONS -- Type: bool -- Default: false +rclone mkdir spaces:my-new-space rclone copy /path/to/files +spaces:my-new-space -–b2-upload-cutoff -Cutoff for switching to chunked upload. + ### IBM COS (S3) ### -Files above this size will be uploaded in chunks of “–b2-chunk-size”. + 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) -This value should be set no larger than 4.657GiB (== 5GB). + To configure access to IBM COS S3, follow the steps below: -- Config: upload_cutoff -- Env Var: RCLONE_B2_UPLOAD_CUTOFF -- Type: SizeSuffix -- Default: 200M - -–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 - -- 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 - - -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 -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. 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 - name> remote - Type of storage to configure. + + + 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 - [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> - 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 + 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 -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. - -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. - -Standard Options - -Here are the standard options specific to box (Box). - -–box-client-id - -Box App Client Id. Leave blank normally. - -- Config: client_id -- Env Var: RCLONE_BOX_CLIENT_ID -- Type: string -- Default: "" - -–box-client-secret - -Box App Client Secret Leave blank normally. - -- Config: client_secret -- Env Var: RCLONE_BOX_CLIENT_SECRET -- Type: string -- Default: "" - -Advanced Options - -Here are the advanced options specific to box (Box). - -–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 - -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. +[snip] 34 / Toronto Single Site Private Endpoint + “s3.tor01.objectstorage.service.networklayer.com” endpoint>1 -Cache (BETA) -The cache remote wraps another existing remote and stores file structure -and its data for long running tasks like rclone mount. + 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 -To get started you just need to have an existing remote which can be -configured with cache. + 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" -Here is an example of how to make a remote called test-cache. First run: +[snip] 32 / Toronto Flex  “tor01-flex” location_constraint>1 - rclone config -This will guide you through an interactive setup process: + 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 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 force_path_style = false +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 /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](/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](/overview/#restricted-characters) + the following characters are also replaced: + + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | \ | 0x5C | ＼ | + + Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), + as they can't be used in JSON strings. + + ### 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](/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](/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-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 + + - 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 + + + + 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 ("“). config_json> +‘enterprise’ or ‘user’ depending on the type of token being requested. +Enter a string value. Press Enter for the default (”user“). +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”} + ——————– +a) Yes this is OK +b) Edit this remote +c) 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](/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 last character in the name: + + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | SP | 0x20 | ␠ | + + Invalid UTF-8 bytes will also be [replaced](/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. + + + ### Standard Options + + Here are the standard options specific to box (Box). + + #### --box-client-id + + Box App Client Id. + Leave blank normally. + + - Config: client_id + - Env Var: RCLONE_BOX_CLIENT_ID + - Type: string + - Default: "" + + #### --box-client-secret + + Box App 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. + + - Config: box_config_file + - Env Var: RCLONE_BOX_BOX_CONFIG_FILE + - 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-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 + + + + ### 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`. + + 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` URL's to ensure certificate validation succeeds. + These URL's are used by Plex internally to connect to the Plex server securely. + + The format for this URL's 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 dependant 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 informations (`--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 - 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. + - Config: remote + - Env Var: RCLONE_CACHE_REMOTE + - Type: string + - Default: "" -Plex Integration + #### --cache-plex-url -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. + The URL of the Plex server -Scans will have a minimum amount of workers (1) while in a confirmed -playback cache will deploy the configured number of workers. + - Config: plex_url + - Env Var: RCLONE_CACHE_PLEX_URL + - Type: string + - Default: "" -This integration opens the doorway to additional performance -improvements which will be explored in the near future. + #### --cache-plex-username -NOTE: If Plex options are not configured, cache will function with its -configured options without adapting any of its settings. + The username of the Plex user -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. + - Config: plex_username + - Env Var: RCLONE_CACHE_PLEX_USERNAME + - Type: string + - Default: "" -Affected settings: - cache-workers: _Configured value_ during confirmed -playback or _1_ all the other times + #### --cache-plex-password -Certificate Validation + The password of the Plex user -When the Plex server is configured to only accept secure connections, it -is possible to use .plex.direct URL’s to ensure certificate validation -succeeds. These URL’s 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 this URL’s 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 dependant -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 verifications when connecting to the Plex server -Some recommendations: - don’t use a very small interval for entry -informations (--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. -- Config: plex_password -- Env Var: RCLONE_CACHE_PLEX_PASSWORD -- Type: string -- Default: "" + 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). -–cache-chunk-size + 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. -The size of a chunk (partial file data). + - Config: chunk_no_memory + - Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY + - Type: bool + - Default: false -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. + #### --cache-rps -- Config: chunk_size -- Env Var: RCLONE_CACHE_CHUNK_SIZE -- Type: SizeSuffix -- Default: 5M -- Examples: - - “1m” - - 1MB - - “5M” - - 5 MB - - “10M” - - 10 MB + Limits the number of requests per second to the source FS (-1 to disable) -–cache-info-age + 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. -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. + 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. -- Config: info_age -- Env Var: RCLONE_CACHE_INFO_AGE -- Type: Duration -- Default: 6h0m0s -- Examples: - - “1h” - - 1 hour - - “24h” - - 24 hours - - “48h” - - 48 hours + A good balance of all the other settings should make this setting + useless but it is available to set for more special cases. -–cache-chunk-total-size + **NOTE**: This will limit the number of requests during streams but + other API calls to the cloud provider like directory listings will + still pass. -The total size that the chunks can take up on the local disk. + - Config: rps + - Env Var: RCLONE_CACHE_RPS + - Type: int + - Default: -1 -If the cache exceeds this value then it will start to delete the oldest -chunks until it goes under this value. + #### --cache-writes -- 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 + Cache file data on writes through the FS -Advanced Options + 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. -Here are the advanced options specific to cache (Cache a remote). + - Config: writes + - Env Var: RCLONE_CACHE_WRITES + - Type: bool + - Default: false -–cache-plex-token + #### --cache-tmp-upload-path -The plex token for authentication - auto set normally + Directory to keep temporary files until they are uploaded. -- Config: plex_token -- Env Var: RCLONE_CACHE_PLEX_TOKEN -- Type: string -- Default: "" + This is the path where cache will use as a temporary storage for new + files that need to be uploaded to the cloud provider. -–cache-plex-insecure + Specifying a value will enable this feature. Without it, it is + completely disabled and files will be uploaded directly to the cloud + provider -Skip all certificate verifications when connecting to the Plex server + - Config: tmp_upload_path + - Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH + - Type: string + - Default: "" -- Config: plex_insecure -- Env Var: RCLONE_CACHE_PLEX_INSECURE -- Type: string -- Default: "" + #### --cache-tmp-wait-time -–cache-db-path + How long should files be stored in local cache before being uploaded -Directory to store file structure metadata DB. The remote name is used -as the DB file name. + This is the duration that a file must wait in the temporary location + _cache-tmp-upload-path_ before it is selected for upload. -- Config: db_path -- Env Var: RCLONE_CACHE_DB_PATH -- Type: string -- Default: “$HOME/.cache/rclone/cache-backend” + 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. -–cache-chunk-path + - Config: tmp_wait_time + - Env Var: RCLONE_CACHE_TMP_WAIT_TIME + - Type: Duration + - Default: 15s -Directory to cache chunk files. + #### --cache-db-wait-time -Path to where partial file data (chunks) are stored locally. The remote -name is appended to the final path. + How long to wait for the DB to be available - 0 is unlimited -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”. + 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. -- Config: chunk_path -- Env Var: RCLONE_CACHE_CHUNK_PATH -- Type: string -- Default: “$HOME/.cache/rclone/cache-backend” + If you set it to 0 then it will wait forever. -–cache-db-purge + - Config: db_wait_time + - Env Var: RCLONE_CACHE_DB_WAIT_TIME + - Type: Duration + - Default: 1s + + + + 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 a different name + format using the `--chunker-name-format` 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. + + 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 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. + + 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 setings, 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 -Clear all the cached data for this remote on start. + Minimum valid chunk number. Usually 0 or 1. + By default chunk numbers start from 1. -- Config: db_purge -- Env Var: RCLONE_CACHE_DB_PURGE -- Type: bool -- Default: false + - Config: start_from + - Env Var: RCLONE_CHUNKER_START_FROM + - Type: int + - Default: 1 -–cache-chunk-clean-interval + #### --chunker-meta-format -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. + Format of the metadata object or "none". By default "simplejson". + Metadata is a small JSON file named after the composite file. -- Config: chunk_clean_interval -- Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL -- Type: Duration -- Default: 1m0s + - 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. -–cache-read-retries + #### --chunker-fail-hard -How many times to retry a read from a cache storage. + Choose how chunker should handle files with missing or invalid chunks. -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. + - 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. -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 + ## Citrix ShareFile -–cache-workers + [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. -How many workers should run in parallel to download chunks. + 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. -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. + Here is an example of how to make a remote called `remote`. First run: -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. + rclone config -- Config: workers -- Env Var: RCLONE_CACHE_WORKERS -- Type: int -- Default: 4 + This will guide you through an interactive setup process: -–cache-chunk-no-memory +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/ ** -Disable the in-memory cache for storing chunks during streaming. +ID of the root folder -By default, cache will keep file data during streaming in RAM as well to -provide it to readers as fast as possible. +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 -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. + See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a + machine with no Internet browser available. -- Config: chunk_no_memory -- Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY -- Type: bool -- Default: false + 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. -–cache-rps + Once configured you can then use `rclone` like this, -Limits the number of requests per second to the source FS (-1 to -disable) + List directories in top level of your ShareFile -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. + rclone lsd 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. + List all the files in your ShareFile -A good balance of all the other settings should make this setting -useless but it is available to set for more special cases. + rclone ls remote: -NOTE: This will limit the number of requests during streams but other -API calls to the cloud provider like directory listings will still pass. + To copy a local directory to an ShareFile directory called backup -- Config: rps -- Env Var: RCLONE_CACHE_RPS -- Type: int -- Default: -1 + rclone copy /home/source remote:backup -–cache-writes + Paths may be as deep as required, eg `remote:directory/subdirectory`. -Cache file data on writes through the FS + ### Modified time and hashes ### -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. + 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. -- Config: writes -- Env Var: RCLONE_CACHE_WRITES -- Type: bool -- Default: false + ShareFile supports MD5 type hashes, so you can use the `--checksum` + flag. -–cache-tmp-upload-path + ### Transfers ### -Directory to keep temporary files until they are uploaded. + 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. -This is the path where cache will use as a temporary storage for new -files that need to be uploaded to the cloud provider. + ### Limitations ### -Specifying a value will enable this feature. Without it, it is -completely disabled and files will be uploaded directly to the cloud -provider + Note that ShareFile is case insensitive so you can't have a file called + "Hello.doc" and one called "hello.doc". -- Config: tmp_upload_path -- Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH -- Type: string -- Default: "" + ShareFile only supports filenames up to 256 characters in length. -–cache-tmp-wait-time + #### Restricted filename characters -How long should files be stored in local cache before being uploaded + In addition to the [default restricted characters set](/overview/#restricted-characters) + the following characters are also replaced: -This is the duration that a file must wait in the temporary location -_cache-tmp-upload-path_ before it is selected for upload. + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | \\ | 0x5C | ＼ | + | * | 0x2A | ＊ | + | < | 0x3C | ＜ | + | > | 0x3E | ＞ | + | ? | 0x3F | ？ | + | : | 0x3A | ： | + | \| | 0x7C | ｜ | + | " | 0x22 | ＂ | -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. + File names can also not start or end with the following characters. + These only get replaced if they are first or last character in the + name: -- Config: tmp_wait_time -- Env Var: RCLONE_CACHE_TMP_WAIT_TIME -- Type: Duration -- Default: 15s + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | SP | 0x20 | ␠ | + | . | 0x2E | ． | -–cache-db-wait-time + Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), + as they can't be used in JSON strings. -How long to wait for the DB to be available - 0 is unlimited + + ### Standard Options -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. + Here are the standard options specific to sharefile (Citrix Sharefile). -If you set it to 0 then it will wait forever. + #### --sharefile-root-folder-id -- Config: db_wait_time -- Env Var: RCLONE_CACHE_DB_WAIT_TIME -- Type: Duration -- Default: 1s + 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). -Crypt + - 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. -The crypt remote encrypts and decrypts another remote. + ### Advanced Options -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. + Here are the advanced options specific to sharefile (Citrix Sharefile). -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. + #### --sharefile-upload-cutoff -Now configure crypt using rclone config. We will call this one secret to -differentiate it from the remote. + 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: "" + + + + 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. Note + that if you reconfigure rclone with the same passwords/passphrases + elsewhere it will be compatible - all the secrets used are derived + from those two passwords/passphrases. + + Note that rclone does not encrypt + + * file length - this can be calcuated 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 - 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 + + - Config: remote + - Env Var: RCLONE_CRYPT_REMOTE + - Type: string + - Default: "" + + #### --crypt-filename-encryption + 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 + + - Config: filename_encryption + - Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION + - Type: string + - Default: "standard" + - Examples: + - "off" + - Don't encrypt the file names. Adds a ".bin" extension only. + - "standard" + - Encrypt the filenames see the docs for the details. + - "obfuscate" + - Very simple filename obfuscation. + + #### --crypt-directory-name-encryption + 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 + + - 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. - y) Yes type in my own password - g) Generate random password - y/g> y - Enter the password: - password: - Confirm the password: - password: + + - 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. - 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. Note that -if you reconfigure rclone with the same passwords/passphrases elsewhere -it will be compatible - all the secrets used are derived from those two -passwords/passphrases. - -Note that rclone does not encrypt - -- file length - this can be calcuated 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 + - Config: password2 + - Env Var: RCLONE_CRYPT_PASSWORD2 + - Type: string + - Default: "" -File name encryption modes + ### Advanced Options -Here are some of the features of the file name encryption modes + Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). -Off + #### --crypt-show-mapping -- doesn’t hide file names or directory structure -- allows for longer file names (~246 characters) -- can use sub paths and copy single files + For all files listed show how the names encrypt. -Standard + 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. -- 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 + 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. -Obfuscation + - Config: show_mapping + - Env Var: RCLONE_CRYPT_SHOW_MAPPING + - Type: bool + - Default: false -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. + ## Backing up a crypted remote ## -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. + If you wish to backup a crypted remote, it it recommended that you use + `rclone sync` on the encrypted files, and make sure the passwords are + the same in the new encrypted remote. -- 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 + This will have the following advantages -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. + * `rclone sync` will check the checksums while copying + * you can use `rclone check` between the encrypted remotes + * you don't decrypt and encrypt unnecessarily -There may be an even more secure file name encryption mode in the future -which will address the long file name problem. + 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:`. -Directory name encryption + To sync the two remotes you would do -Crypt offers the option of encrypting dir names or leaving them intact. -There are two options: + rclone sync remote:crypt remote2:crypt -True + And to check the integrity you would do -Encrypts the whole file path including directory names Example: -1/12/123.txt is encrypted to -p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0 + rclone check remote:crypt remote2:crypt -False + ## File formats ## -Only encrypts file names, skips directory names Example: 1/12/123.txt is -encrypted to 1/12/qgm4avr35m5loi1th53ato71v0 + ### File encryption ### -Modified time and hashes + Files are encrypted 1:1 source file to destination object. The file + has a header and is divided into chunks. -Crypt stores modification times using the underlying remote so support -depends on that. + #### Header #### -Hashes are not stored for crypt. However the data integrity is protected -by an extremely strong crypto authenticator. + * 8 bytes magic string `RCLONE\x00\x00` + * 24 bytes Nonce (IV) -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. + 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. -Standard Options + #### Chunk #### -Here are the standard options specific to crypt (Encrypt/Decrypt a -remote). + 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-remote + Each chunk contains: -Remote to encrypt/decrypt. Normally should contain a ‘:’ and a path, eg -“myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not -recommended). + * 16 Bytes of Poly1305 authenticator + * 1 - 65536 bytes XSalsa20 encrypted data -- Config: remote -- Env Var: RCLONE_CRYPT_REMOTE -- Type: string -- Default: "" + 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. -–crypt-filename-encryption + This uses a 32 byte (256 bit key) key derived from the user password. -How to encrypt the filenames. + #### Examples #### -- Config: filename_encryption -- Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION -- Type: string -- Default: “standard” -- Examples: - - “off” - - Don’t encrypt the file names. Adds a “.bin” extension only. - - “standard” - - Encrypt the filenames see the docs for the details. - - “obfuscate” - - Very simple filename obfuscation. + 1 byte file will encrypt to -–crypt-directory-name-encryption + * 32 bytes header + * 17 bytes data chunk -Option to either encrypt directory names or leave them intact. + 49 bytes total -- 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. + 1MB (1048576 bytes) file will encrypt to -–crypt-password + * 32 bytes header + * 16 chunks of 65568 bytes -Password or pass phrase for encryption. + 1049120 bytes total (a 0.05% overhead). This is the overhead for big + files. -- Config: password -- Env Var: RCLONE_CRYPT_PASSWORD -- Type: string -- Default: "" + ### Name encryption ### -–crypt-password2 + File names are encrypted segment by segment - the path is broken up + into `/` separated strings and these are encrypted individually. -Password or pass phrase for salt. Optional but recommended. Should be -different to the previous password. + File segments are padded using using PKCS#7 to a multiple of 16 bytes + before encryption. -- Config: password2 -- Env Var: RCLONE_CRYPT_PASSWORD2 -- Type: string -- Default: "" + 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. -Advanced Options + 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. -Here are the advanced options specific to crypt (Encrypt/Decrypt a -remote). + This means that -–crypt-show-mapping + * filenames with the same name will encrypt the same + * filenames which start the same won't have a common prefix -For all files listed show how the names encrypt. + This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of + which are derived from the user password. -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. + 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: -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. + * it becomes lower case (no-one likes upper case filenames!) + * we strip the padding character `=` -- Config: show_mapping -- Env Var: RCLONE_CRYPT_SHOW_MAPPING -- Type: bool -- Default: false + `base32` is used rather than the more efficient `base64` so rclone can be + used on case insensitive remotes (eg Windows, Amazon Drive). + ### Key derivation ### -Backing up a crypted remote + 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. -If you wish to backup a crypted remote, it it recommended that you use -rclone sync on the encrypted files, and make sure the passwords are the -same in the new encrypted remote. + `scrypt` makes it impractical to mount a dictionary attack on rclone + encrypted data. For full protection against this you should always use + a salt. -This will have the following advantages + Dropbox + --------------------------------- -- rclone sync will check the checksums while copying -- you can use rclone check between the encrypted remotes -- you don’t decrypt and encrypt unnecessarily + Paths are specified as `remote:path` -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:. + Dropbox paths may be as deep as required, eg + `remote:directory/subdirectory`. -To sync the two remotes you would do + 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. - rclone sync remote:crypt remote2:crypt + Here is an example of how to make a remote called `remote`. First run: -And to check the integrity you would do + rclone config - rclone check remote:crypt remote2:crypt + This will guide you through an interactive setup process: - -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 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: +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: 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. - -Standard Options - -Here are the standard options specific to dropbox (Dropbox). - -–dropbox-client-id - -Dropbox App Client Id Leave blank normally. - -- Config: client_id -- Env Var: RCLONE_DROPBOX_CLIENT_ID -- Type: string -- Default: "" - -–dropbox-client-secret - -Dropbox App 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-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: "" - -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. - -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. + 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 -FTP + You can then use it like this, -FTP is the File Transfer Protocol. FTP support is provided using the -github.com/jlaffaye/ftp package. + List directories in top level of your dropbox -Here is an example of making an FTP configuration. First run + rclone lsd remote: - rclone config + List all the files in your dropbox -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. + rclone ls remote: - 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/ ** + 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 last character in the name: + + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | SP | 0x20 | ␠ | + + Invalid UTF-8 bytes will also be [replaced](/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 + + Dropbox App Client Id + Leave blank normally. + + - Config: client_id + - Env Var: RCLONE_DROPBOX_CLIENT_ID + - Type: string + - Default: "" + + #### --dropbox-client-secret + + Dropbox App 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-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: "" + + + + ### 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. + + 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`. + + 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. + + 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> 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 /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. + + #### Restricted filename characters + + In addition to the [default restricted characters set](/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 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 explictly 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 - 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> + + - 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) - Enter a string value. Press Enter for the default (""). - port> + + - Config: port + - Env Var: RCLONE_FTP_PORT + - Type: string + - Default: "" + + #### --ftp-pass + FTP password - y) Yes type in my own password - g) Generate random password - y/g> y - Enter the password: - password: - Confirm the password: - password: + + - Config: pass + - Env Var: RCLONE_FTP_PASS + - Type: string + - Default: "" + + #### --ftp-tls + Use FTP over TLS (Implicit) - Enter a boolean value (true or false). Press Enter for the default ("false"). - 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 + - Config: tls + - Env Var: RCLONE_FTP_TLS + - Type: bool + - Default: false -See all directories in the home directory + ### Advanced Options - rclone lsd remote: + Here are the advanced options specific to ftp (FTP Connection). -Make a new directory + #### --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 + + + + ### Limitations ### + + Note that since FTP isn't HTTP based the following flags don't work + with it: `--dump-headers`, `--dump-bodies`, `--dump-auth` + + 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 while implicit FTP over TLS is supported, + explicit FTP over TLS is not. + + Google Cloud Storage + ------------------------------------------------- - rclone mkdir remote:path/to/directory + Paths are specified as `remote:bucket` (or `remote:` for the `lsd` + command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. -List the contents of a directory + 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 ls remote:path/to/directory + Here is an example of how to make a remote called `remote`. First run: -Sync /home/local/directory to the remote directory, deleting any excess -files in the directory. + rclone config - rclone sync /home/local/directory remote:directory + This will guide you through an interactive setup process: -Modified time +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 + ——————– +a) Yes this is OK +b) Edit this remote +c) 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 /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. + + ### 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](/docs/#fast-list) for more details. + + ### Modified time ### -FTP does not support modified times. Any times you see on the server -will be time of upload. + 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. -Checksums + #### Restricted filename characters -FTP does not support any checksums. + | Character | Value | Replacement | + | --------- |:-----:|:-----------:| + | NUL | 0x00 | ␀ | + | LF | 0x0A | ␊ | + | CR | 0x0D | ␍ | + | / | 0x2F | ／ | -Implicit TLS + Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), + as they can't be used in JSON strings. -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 explictly set in the config for the -remote. + + ### Standard Options -Standard Options + Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). -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 - -- Config: pass -- Env Var: RCLONE_FTP_PASS -- Type: string -- Default: "" - -–ftp-tls - -Use FTP over TLS (Implicit) - -- Config: tls -- Env Var: RCLONE_FTP_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 - -Limitations - -Note that since FTP isn’t HTTP based the following flags don’t work with -it: --dump-headers, --dump-bodies, --dump-auth - -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 while implicit FTP over TLS is supported, explicit FTP over -TLS is not. - - -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 /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. - -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. - -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. - -Standard Options - -Here are the standard options specific to google cloud storage (Google -Cloud Storage (this is not Google Drive)). - -–gcs-client-id - -Google Application Client Id Leave blank normally. - -- Config: client_id -- Env Var: RCLONE_GCS_CLIENT_ID -- Type: string -- Default: "" - -–gcs-client-secret - -Google Application 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. - -- 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-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 - - “DURABLE_REDUCED_AVAILABILITY” - - Durable reduced availability storage class - - -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. - -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. - -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. - -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 - -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 - -Google Application Client Secret Setting your own is recommended. - -- 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). - -- 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. - -- Config: service_account_file -- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE -- Type: string -- Default: "" - -Advanced Options - -Here are the advanced options specific to drive (Google Drive). - -–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 identifed 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-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-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-alternate-export - -Use alternate export URLs for google documents export., - -If this option is set this instructs rclone to use an alternate set of -export URLs for drive documents. Users have reported that the official -export URLs can’t export large documents, whereas these unofficial ones -can. - -See rclone issue #2243 for background, this google drive issue and this -helpful post. - -- Config: alternate_export -- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT -- Type: bool -- Default: false - -–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 storage quota usage for file size. - -The storage used by a file is the size of the current version plus any -older versions that have been set to keep forever. - -- 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 beween any two configurations. - -- Config: server_side_across_configs -- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS -- Type: bool -- Default: false - -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 can’t download -Google docs using rclone mount - you will get a 0 sized file. If you try -again the doc may gain its correct size and be downloadable. - -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. 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”, - then “OAuth client ID”. It will prompt you to set the OAuth consent - screen product name, if you haven’t set one already. - -5. Choose an application type of “other”, and click “Create”. (the - default name is fine) - -6. 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. - -(Thanks to @balazer on github for these instructions.) - - -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/ ** + #### --gcs-client-id Google Application Client Id Leave blank normally. - Enter a string value. Press Enter for the default (""). - client_id> + + - Config: client_id + - Env Var: RCLONE_GCS_CLIENT_ID + - Type: string + - Default: "" + + #### --gcs-client-secret + 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 /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 - -There are two writable parts of the tree, the upload directory and sub -directories of the 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 + - Config: client_secret + - Env Var: RCLONE_GCS_CLIENT_SECRET + - Type: string + - Default: "" -- 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. - -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. + #### --gcs-project-number -Duplicates + Project number. + Optional - needed only for list/create/delete buckets - see your developer console. -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!). + - 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. + + - 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-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 + - "DURABLE_REDUCED_AVAILABILITY" + - Durable reduced availability storage class + + + + 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. -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. + You can then use it like this, -Modified time + List directories in top level of your drive -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. + rclone lsd remote: -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. + List all the files in your drive -Size + rclone ls remote: -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. + To copy a local directory to a drive directory called backup -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. + rclone copy /home/source remote:backup -If you want to use the backend with rclone mount you will need to enable -this flag otherwise you will not be able to read media off the mount. + ### Scopes ### -Albums + 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). -Rclone can only upload files to albums it created. This is a limitation -of the Google Photos API. + The scope are -Rclone can remove files it uploaded from albums it created only. + #### drive #### -Deleting files + This is the default scope and allows full access to all files, except + for the Application Data Folder (see below). -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. + Choose this one if you aren't sure. -Rclone cannot delete files anywhere except under album. + #### drive.readonly #### -Deleting albums + This allows read only access to all files. Files may be listed and + downloaded but not uploaded, renamed or deleted. -The Google Photos API does not support deleting albums - see bug -#135714733. + #### drive.file #### -Standard Options + With this scope rclone can read/view/modify only those files and + folders it creates. -Here are the standard options specific to google photos (Google Photos). + So if you uploaded files to drive via the web interface (or any other + means) they will not be visible to rclone. -–gphotos-client-id + 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. -Google Application Client Id Leave blank normally. + Files created with this scope are visible in the web interface. -- Config: client_id -- Env Var: RCLONE_GPHOTOS_CLIENT_ID -- Type: string -- Default: "" + #### drive.appfolder #### -–gphotos-client-secret + 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. -Google Application Client Secret Leave blank normally. + #### 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: client_secret -- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET -- Type: string -- Default: "" + 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. -–gphotos-read-only + 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. -Set to make the Google Photos backend read only. + **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. + + ### 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](/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](/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. + + ### 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 + + 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 + + Google Application Client Secret + Setting your own is recommended. + + - 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. + + Note that if this is blank, the first time rclone runs it will fill it + in with the ID of the root folder. + + + - 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. + + - Config: service_account_file + - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE + - Type: string + - Default: "" + + ### Advanced Options + + Here are the advanced options specific to drive (Google Drive). + + #### --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 identifed 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-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-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-alternate-export + + Use alternate export URLs for google documents export., + + If this option is set this instructs rclone to use an alternate set of + export URLs for drive documents. Users have reported that the + official export URLs can't export large documents, whereas these + unofficial ones can. + + See rclone issue [#2243](https://github.com/rclone/rclone/issues/2243) for background, + [this google drive issue](https://issuetracker.google.com/issues/36761333) and + [this helpful post](https://www.labnol.org/internet/direct-links-for-google-drive/28356/). + + - Config: alternate_export + - Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT + - Type: bool + - Default: false + + #### --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 storage quota usage for file size. + + The storage used by a file is the size of the current version plus any + older versions that have been set to keep forever. + + - 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 + + + + ### 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. Whther 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", then + "OAuth client ID". It will prompt you to set the OAuth consent screen + product name, if you haven't set one already. + + 5. Choose an application type of "other", and click "Create". (the + default name is fine) + + 6. 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. + + (Thanks to @balazer on github for these instructions.) + + 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. +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 -- Config: read_only -- Env Var: RCLONE_GPHOTOS_READ_ONLY -- Type: bool -- Default: false +*** 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. -Advanced Options + --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + [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 ``` -Here are the advanced options specific to google photos (Google Photos). + 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. -–gphotos-read-size + This remote is called remote and can now be used like this -Set to read the size of media items. + See all the albums in your photos -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. + rclone lsd remote:album -- Config: read_size -- Env Var: RCLONE_GPHOTOS_READ_SIZE -- Type: bool -- Default: false + Make a new album + rclone mkdir remote:album/newAlbum -HTTP + 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 /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 + + There are two writable parts of the tree, the upload directory and sub directories of the 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 + + Google Application Client Id Leave blank normally. + + - Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Default: "" + + #### –gphotos-client-secret + + Google Application 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-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 + + 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 @@ -14231,6 +14363,30 @@ directories. - Type: bool - Default: false +–http-no-head + +Don’t use HEAD requests to find file sizes in dir listing + +If your site is being very slow to load then you can try this option. +Normally rclone does a HEAD request for each potential file in a +directory listing to: + +- find its size +- check it really exists +- check to see if it is a directory + +If you set this option, rclone will not do the HEAD request. This will +mean + +- directory listings are much quicker +- rclone won’t have the times or sizes of any files +- some files that don’t exist may be in the listing + +- Config: no_head +- Env Var: RCLONE_HTTP_NO_HEAD +- Type: bool +- Default: false + Hubic @@ -14525,6 +14681,24 @@ 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 + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + " 0x22 ＂ + * 0x2A ＊ + : 0x3A ： + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + | 0x7C ｜ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in XML +strings. + Deleting files By default rclone will send all files to the trash when deleting files. @@ -14697,6 +14871,18 @@ To copy a local directory to an Koofr directory called backup rclone copy /home/source remote:backup +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 XML +strings. + Standard Options Here are the standard options specific to koofr (Koofr). @@ -14758,6 +14944,309 @@ 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) + +Features highlights + +- Paths may be as deep as required, eg remote:directory/subdirectory +- Files have a last modified time property, directories don’t +- Deleted files are by default moved to the trash +- Files and directories can be shared via public links +- Partial uploads or streaming are not supported, file size must be + known before upload +- Maximum file size is limited to 2G for a free acount, unlimited for + paid accounts +- Storage keeps hash for all files and performs transparent + deduplication, the hash algorithm is a modified SHA1 +- If a particular file is already present in storage, one can quickly + submit file hash instead of long file upload (this optimization is + supported by rclone) + +Configuration + +Here is an example of making a mailru configuration. First create a +Mail.ru Cloud account and choose a tariff, then 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. + 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 / Mail.ru Cloud + \ "mailru" + [snip] + Storage> mailru + User name (usually email) + Enter a string value. Press Enter for the default (""). + user> username@mail.ru + Password + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: + Skip full upload if there is another file with same data hash. + This feature is called "speedup" or "put by hash". It is especially efficient + in case of generally available files like popular books, video or audio clips + [snip] + Enter a boolean value (true or false). Press Enter for the default ("true"). + Choose a number from below, or type in your own value + 1 / Enable + \ "true" + 2 / Disable + \ "false" + speedup_enable> 1 + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + -------------------- + [remote] + type = mailru + user = username@mail.ru + pass = *** ENCRYPTED *** + speedup_enable = true + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Configuration of this backend does not require a local web browser. You +can use the configured backend as shown below: + +See top level directories + + rclone lsd remote: + +Make a new directory + + rclone mkdir remote:directory + +List the contents of a directory + + rclone ls remote:directory + +Sync /home/local/directory to the remote path, deleting any excess files +in the path. + + rclone sync /home/local/directory remote:directory + +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 + +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 + +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 + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + " 0x22 ＂ + * 0x2A ＊ + : 0x3A ： + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + \ 0x5C ＼ + | 0x7C ｜ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + +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 + +Here are the standard options specific to mailru (Mail.ru Cloud). + +–mailru-user + +User name (usually email) + +- Config: user +- Env Var: RCLONE_MAILRU_USER +- Type: string +- Default: "" + +–mailru-pass + +Password + +- Config: pass +- Env Var: RCLONE_MAILRU_PASS +- Type: string +- Default: "" + +–mailru-speedup-enable + +Skip full upload if there is another file with same data hash. This +feature is called “speedup” or “put by hash”. It is especially efficient +in case of generally available files like popular books, video or audio +clips, because files are searched by hash in all accounts of all mailru +users. Please note that rclone may need local memory and disk space to +calculate content hash in advance and decide whether full upload is +required. Also, if rclone does not know file size in advance (e.g. in +case of streaming or partial uploads), it will not even try this +optimization. + +- Config: speedup_enable +- Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE +- Type: bool +- Default: true +- Examples: + - “true” + - Enable + - “false” + - Disable + +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. + +- Config: speedup_file_patterns +- Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS +- Type: string +- Default: “_.mkv,_.avi,_.mp4,_.mp3,_.zip,_.gz,_.rar,_.pdf” +- Examples: + - "" + - Empty list completely disables speedup (put by hash). + - "*" + - All files will be attempted for speedup. + - “_.mkv,_.avi,_.mp4,_.mp3” + - Only common audio/video files will be tried for put by hash. + - “_.zip,_.gz,_.rar,_.pdf” + - Only common archives or PDF books will be tried for speedup. + +–mailru-speedup-max-disk + +This option allows you to disable speedup (put by hash) for large files +(because preliminary hashing can exhaust you RAM or disk space) + +- Config: speedup_max_disk +- Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK +- Type: SizeSuffix +- Default: 3G +- Examples: + - “0” + - Completely disable speedup (put by hash). + - “1G” + - Files larger than 1Gb will be uploaded directly. + - “3G” + - Choose this option if you have less than 3Gb free on local + disk. + +–mailru-speedup-max-memory + +Files larger than the size given below will always be hashed on disk. + +- Config: speedup_max_memory +- Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY +- Type: SizeSuffix +- Default: 32M +- Examples: + - “0” + - Preliminary hashing will always be done in a temporary disk + location. + - “32M” + - Do not dedicate more than 32Mb RAM for preliminary hashing. + - “256M” + - You have at most 256Mb RAM free for hash calculations. + +–mailru-check-hash + +What should copy do if file checksum is mismatched or invalid + +- Config: check_hash +- Env Var: RCLONE_MAILRU_CHECK_HASH +- Type: bool +- Default: true +- Examples: + - “true” + - Fail with error. + - “false” + - Ignore and continue. + +–mailru-user-agent + +HTTP user agent used internally by client. Defaults to “rclone/VERSION” +or “–user-agent” provided on command line. + +- Config: user_agent +- Env Var: RCLONE_MAILRU_USER_AGENT +- Type: string +- Default: "" + +–mailru-quirks + +Comma separated list of internal maintenance flags. This option must not +be used by an ordinary user. It is intended only to facilitate remote +troubleshooting of backend issues. Strict meaning of flags is not +documented and not guaranteed to persist between releases. Quirks will +be removed when the backend grows stable. Supported quirks: atomicmkdir +binlist gzip insecure retry400 + +- Config: quirks +- Env Var: RCLONE_MAILRU_QUIRKS +- Type: string +- Default: "" + + Mega Mega is a cloud storage and file hosting service known for its security @@ -14836,6 +15325,16 @@ Modified time and hashes Mega does not support modification times or hashes yet. +Restricted filename characters + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + Duplicated files Mega can have two files with exactly the same name and path (unlike a @@ -15027,6 +15526,26 @@ 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 + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + / 0x2F ／ + \ 0x5C ＼ + +File names can also not end with the following characters. These only +get replaced if they are last character in the name: + + Character Value Replacement + ----------- ------- ------------- + . 0x2E ． + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + Hashes MD5 hashes are stored with blobs. However blobs that were uploaded in @@ -15334,24 +15853,27 @@ performing requests by default. If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below: -1. Open https://apps.dev.microsoft.com/#/appList, then click Add an app - (Choose Converged applications if applicable) -2. Enter a name for your app, and click continue. Copy and keep the - Application Id under the app name for later use. -3. Under section Application Secrets, click Generate New Password. Copy - and keep that password for later use. -4. Under section Platforms, click Add platform, then Web. Enter - http://localhost:53682/ in Redirect URLs. -5. Under section Microsoft Graph Permissions, Add these - delegated permissions: Files.Read, Files.ReadWrite, Files.Read.All, - Files.ReadWrite.All, offline_access, User.Read. -6. Scroll to the bottom and click Save. +1. Open + https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade, + then click New registration. +2. Enter a name for your app, choose your account type, select Web in + Redirect URI Enter http://localhost:53682/ and click Register. Copy + and keep the Application (client) ID under the app name for later + use. +3. Under manage select Certificates & secrets, click New client secret. + Copy and keep that secret for later use. +4. Under manage select API permissions, click Add a permission and + select Microsoft Graph then select delegated permissions. +5. Search and select the follwing permssions: Files.Read, + Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, + offline_access, User.Read. Once selected click Add permissions at + the bottom. Now the application is complete. Run rclone config to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps. -Modified time and hashes +Modification time and hashes OneDrive allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or @@ -15362,6 +15884,43 @@ Sharepoint Server support QuickXorHash. For all types of OneDrive you can use the --checksum flag. +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + " 0x22 ＂ + * 0x2A ＊ + : 0x3A ： + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + \ 0x5C ＼ + | 0x7C ｜ + # 0x23 ＃ + % 0x25 ％ + +File names can also not end with the following characters. These only +get replaced if they are last character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + . 0x2E ． + +File names can also not begin with the following characters. These only +get replaced if they are first character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + ~ 0x7E ～ + +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. Microsoft @@ -15397,10 +15956,11 @@ Here are the advanced options specific to onedrive (Microsoft OneDrive). –onedrive-chunk-size -Chunk size to upload files with - must be multiple of 320k. +Chunk size to upload files with - must be multiple of 320k (327,680 +bytes). -Above this size files will be chunked - must be multiple of 320k. Note -that the chunks will be buffered into memory. +Above this size files will be chunked - must be multiple of 320k +(327,680 bytes). Note that the chunks will be buffered into memory. - Config: chunk_size - Env Var: RCLONE_ONEDRIVE_CHUNK_SIZE @@ -15442,6 +16002,8 @@ set this option. Limitations +Naming + Note that OneDrive is case insensitive so you can’t have a file called “Hello.doc” and one called “hello.doc”. @@ -15451,15 +16013,21 @@ 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. +File sizes + The largest allowed file sizes are 15GB for OneDrive for Business and 35GB for OneDrive Personal (Updated 4 Jan 2019). +Path length + The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones. +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. @@ -15515,6 +16083,32 @@ User Weropol has found a method to disable versioning on OneDrive Troubleshooting +Unexpected file size/hash differences on Sharepoint + +It is a known issue that Sharepoint (not OneDrive or OneDrive for +Business) silently modifies uploaded files, mainly Office files (.docx, +.xlsx, etc.), causing file size and hash checks to fail. To use rclone +with such affected files on Sharepoint, you may disable these checks +with the following command line arguments: + + --ignore-checksum --ignore-size + +Replacing/deleting existing files on Sharepoint gets “item not found” + +It is a known issue that Sharepoint (not OneDrive or OneDrive for +Business) may return “item not found” errors when users try to replace +or delete uploaded files; this seems to mainly affect Office files +(.docx, .xlsx, etc.). As a workaround, you may use the +--backup-dir command line argument so rclone moves the +files to be replaced/deleted into a given backup directory (instead of +directly replacing/deleting them). For example, to instruct rclone to +move the files into the directory rclone-backup-dir on backend +mysharepoint, you may use: + + --backup-dir mysharepoint:rclone-backup-dir + +access_denied (AADSTS65005) + Error: access_denied Code: AADSTS65005 Description: Using application 'rclone' is currently not supported for your organization [YOUR_ORGANIZATION] because it is in an unmanaged state. An administrator needs to claim ownership of the company by DNS validation of [YOUR_ORGANIZATION] before the application rclone can be provisioned. @@ -15526,6 +16120,8 @@ admins. However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint +invalid_grant (AADSTS50076) + Error: invalid_grant Code: AADSTS50076 Description: Due to a configuration change made by your administrator, or because you moved to a new location, you must use multi-factor authentication to access '...'. @@ -15602,6 +16198,36 @@ 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 + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + " 0x22 ＂ + * 0x2A ＊ + : 0x3A ： + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + \ 0x5C ＼ + | 0x7C ｜ + +File names can also not begin or end with the following characters. +These only get replaced if they are the first or last character in the +name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + HT 0x09 ␉ + LF 0x0A ␊ + VT 0x0B ␋ + CR 0x0D ␍ + +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 opendrive (OpenDrive). @@ -15756,6 +16382,14 @@ In order of precedence: - Access Key ID: QS_ACCESS_KEY_ID or QS_ACCESS_KEY - Secret Access Key: QS_SECRET_ACCESS_KEY or QS_SECRET_KEY +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 Here are the standard options specific to qingstor (QingCloud Object @@ -16353,6 +16987,16 @@ X-Object-Meta-Mtime as floating point since the epoch accurate to 1 ns. This is a defacto standard (used in the official python-swiftclient amongst others) for storing the modification time for an object. +Restricted filename characters + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + Limitations The Swift API doesn’t return a correct MD5SUM for segmented files @@ -16466,6 +17110,18 @@ re-uploaded. pCloud supports MD5 and 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: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + Deleting files Deleted files will be moved to the trash. Your subscription level will @@ -16577,6 +17233,19 @@ 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 + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + " 0x22 ＂ + +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 premiumizeme (premiumize.me). @@ -16692,6 +17361,18 @@ To copy a local directory to a put.io directory called backup rclone copy /home/source remote:backup +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. + SFTP @@ -16913,10 +17594,20 @@ when the ssh-agent contains many keys. –sftp-use-insecure-cipher -Enable the use of the aes128-cbc cipher and -diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 -key exchange. Those algorithms are insecure and may allow plaintext data -to be recovered by an attacker. +Enable the use of insecure ciphers and key exchange methods. + +This enables the use of the the following insecure ciphers and key +exchange methods: + +- aes128-cbc +- aes192-cbc +- aes256-cbc +- 3des-cbc +- diffie-hellman-group-exchange-sha256 +- diffie-hellman-group-exchange-sha1 + +Those algorithms are insecure and may allow plaintext data to be +recovered by an attacker. - Config: use_insecure_cipher - Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER @@ -16949,6 +17640,9 @@ Here are the advanced options specific to sftp (SSH/SFTP Connection). Allow asking for SFTP password when needed. +If this is set and no password is supplied then rclone will: - ask for a +password - not contact the ssh agent + - Config: ask_password - Env Var: RCLONE_SFTP_ASK_PASSWORD - Type: bool @@ -17390,6 +18084,19 @@ Your config file should look like this: user = YourEmailAddress pass = encryptedpassword +Required Flags for SharePoint + +As SharePoint does some special things with uploaded documents, you +won’t be able to use the documents size or the documents hash to compare +if a file has been changed since the upload / which file is newer. + +For Rclone calls copying files (especially Office files such as .docx, +.xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should +append these flags to ensure Rclone uses the “Last Modified” datetime +property to compare your documents: + + --ignore-size --ignore-checksum --update + dCache dCache is a storage system that supports many protocols and @@ -17462,9 +18169,6 @@ Yandex Disk Yandex Disk is a cloud storage solution created by Yandex. -Yandex paths may be as deep as required, eg -remote:directory/subdirectory. - Here is an example of making a yandex configuration. First run rclone config @@ -17537,6 +18241,9 @@ in the path. rclone sync /home/local/directory remote:directory +Yandex paths may be as deep as required, eg +remote:directory/subdirectory. + Modified time Modified times are supported and are stored accurate to 1 ns in custom @@ -17557,6 +18264,13 @@ 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 + +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 When uploading very large files (bigger than about 5GB) you will need to @@ -17627,8 +18341,8 @@ on OS X. Filenames -Filenames are expected to be encoded in UTF-8 on disk. This is the -normal case for Windows and OS X. +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 @@ -17637,11 +18351,80 @@ 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 the unicode replacement character, ‘�’. rclone will -emit a debug message in this case (use -v to see), eg +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 + +On non Windows platforms the following characters are replaced when +handling file names. + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + +When running on Windows the following characters are replaced. This list +is based on the Windows file naming conventions. + + 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 ／ + " 0x22 ＂ + * 0x2A ＊ + : 0x3A ： + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + \ 0x5C ＼ + | 0x7C ｜ + +File names on Windows can also not end with the following characters. +These only get replaced if they are last character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + . 0x2E ． + +Invalid UTF-8 bytes will also be replaced, as they can’t be converted to +UTF-16. + Long paths on Windows Rclone handles long paths automatically, by converting all paths to long @@ -17825,7 +18608,7 @@ Advanced Options Here are the advanced options specific to local (Local Disk). -–copy-links +–copy-links / -L Follow symlinks and copy the pointed to item. @@ -17834,7 +18617,7 @@ Follow symlinks and copy the pointed to item. - Type: bool - Default: false -–links +–links / -l Translate symlinks to/from regular files with a ‘.rclonelink’ extension @@ -17883,7 +18666,7 @@ Glusterfs #2206) so this check can be disabled with this flag. - Type: bool - Default: false -–one-file-system +–one-file-system / -x Don’t cross filesystem boundaries (unix/macOS only). @@ -17923,6 +18706,222 @@ override the default choice. CHANGELOG +v1.50.0 - 2019-10-26 + +- New backends + - Citrix Sharefile (Nick Craig-Wood) + - Chunker - an overlay backend to split files into smaller parts + (Ivan Andreev) + - Mail.ru Cloud (Ivan Andreev) +- New Features + - encodings (Fabian Möller & Nick Craig-Wood) + - All backends now use file name encoding to ensure any file + name can be written to any backend. + - See the restricted file name docs for more info and the + local backend docs. + - Some file names may look different in rclone if you are + using any control characters in names or unicode FULLWIDTH + symbols. + - build + - Update to use go1.13 for the build (Nick Craig-Wood) + - Drop support for go1.9 (Nick Craig-Wood) + - Build rclone with GitHub actions (Nick Craig-Wood) + - Convert python scripts to python3 (Nick Craig-Wood) + - Swap Azure/go-ansiterm for mattn/go-colorable (Nick + Craig-Wood) + - Dockerfile fixes (Matei David) + - Add plugin support for backends and commands (Richard Patel) + - config + - Use alternating Red/Green in config to make more obvious + (Nick Craig-Wood) + - contrib + - Add sample DLNA server Docker Compose manifest. (pataquets) + - Add sample WebDAV server Docker Compose manifest. + (pataquets) + - copyurl + - Add --auto-filename flag for using file name from URL in + destination path (Denis) + - serve dlna: + - Many compatability improvements (Dan Walters) + - Support for external srt subtitles (Dan Walters) + - rc + - Added command core/quit (Saksham Khanna) +- Bug Fixes + - sync + - Make --update/-u not transfer files that haven’t changed + (Nick Craig-Wood) + - Free objects after they come out of the transfer pipe to + save memory (Nick Craig-Wood) + - Fix --files-from without --no-traverse doing a recursive + scan (Nick Craig-Wood) + - operations + - Fix accounting for server side copies (Nick Craig-Wood) + - Display ‘All duplicates removed’ only if dedupe successful + (Sezal Agrawal) + - Display ‘Deleted X extra copies’ only if dedupe successful + (Sezal Agrawal) + - accounting + - Only allow up to 100 completed transfers in the accounting + list to save memory (Nick Craig-Wood) + - Cull the old time ranges when possible to save memory (Nick + Craig-Wood) + - Fix panic due to server-side copy fallback (Ivan Andreev) + - Fix memory leak noticeable for transfers of large numbers of + objects (Nick Craig-Wood) + - Fix total duration calculation (Nick Craig-Wood) + - cmd + - Fix environment variables not setting command line flags + (Nick Craig-Wood) + - Make autocomplete compatible with bash’s posix mode for + macOS (Danil Semelenov) + - Make --progress work in git bash on Windows (Nick + Craig-Wood) + - Fix ‘compopt: command not found’ on autocomplete on macOS + (Danil Semelenov) + - config + - Fix setting of non top level flags from environment + variables (Nick Craig-Wood) + - Check config names more carefully and report errors (Nick + Craig-Wood) + - Remove error: can’t use --size-only and --ignore-size + together. (Nick Craig-Wood) + - filter: Prevent mixing options when --files-from is in use + (Michele Caci) + - serve sftp: Fix crash on unsupported operations (eg Readlink) + (Nick Craig-Wood) +- Mount + - Allow files of unkown size to be read properly (Nick Craig-Wood) + - Skip tests on <= 2 CPUs to avoid lockup (Nick Craig-Wood) + - Fix panic on File.Open (Nick Craig-Wood) + - Fix “mount_fusefs: -o timeout=: option not supported” on FreeBSD + (Nick Craig-Wood) + - Don’t pass huge filenames (>4k) to FUSE as it can’t cope (Nick + Craig-Wood) +- VFS + - Add flag --vfs-case-insensitive for windows/macOS mounts (Ivan + Andreev) + - Make objects of unknown size readable through the VFS (Nick + Craig-Wood) + - Move writeback of dirty data out of close() method into its own + method (FlushWrites) and remove close() call from Flush() (Brett + Dutro) + - Stop empty dirs disappearing when renamed on bucket based + remotes (Nick Craig-Wood) + - Stop change notify polling clearing so much of the directory + cache (Nick Craig-Wood) +- Azure Blob + - Disable logging to the Windows event log (Nick Craig-Wood) +- B2 + - Remove unverified: prefix on sha1 to improve interop (eg with + CyberDuck) (Nick Craig-Wood) +- Box + - Add options to get access token via JWT auth (David) +- Drive + - Disable HTTP/2 by default to work around INTERNAL_ERROR problems + (Nick Craig-Wood) + - Make sure that drive root ID is always canonical (Nick + Craig-Wood) + - Fix --drive-shared-with-me from the root with lsand --fast-list + (Nick Craig-Wood) + - Fix ChangeNotify polling for shared drives (Nick Craig-Wood) + - Fix change notify polling when using appDataFolder (Nick + Craig-Wood) +- Dropbox + - Make disallowed filenames errors not retry (Nick Craig-Wood) + - Fix nil pointer exception on restricted files (Nick Craig-Wood) +- Fichier + - Fix accessing files > 2GB on 32 bit systems (Nick Craig-Wood) +- FTP + - Allow disabling EPSV mode (Jon Fautley) +- HTTP + - HEAD directory entries in parallel to speedup (Nick Craig-Wood) + - Add --http-no-head to stop rclone doing HEAD in listings (Nick + Craig-Wood) +- Putio + - Add ability to resume uploads (Cenk Alti) +- S3 + - Fix signature v2_auth headers (Anthony Rusdi) + - Fix encoding for control characters (Nick Craig-Wood) + - Only ask for URL encoded directory listings if we need them on + Ceph (Nick Craig-Wood) + - Add option for multipart failiure behaviour (Aleksandar + Jankovic) + - Support for multipart copy (庄天翼) + - Fix nil pointer reference if no metadata returned for object + (Nick Craig-Wood) +- SFTP + - Fix --sftp-ask-password trying to contact the ssh agent (Nick + Craig-Wood) + - Fix hashes of files with backslashes (Nick Craig-Wood) + - Include more ciphers with --sftp-use-insecure-cipher (Carlos + Ferreyra) +- WebDAV + - Parse and return Sharepoint error response (Henning Surmeier) + + +v1.49.5 - 2019-10-05 + +- Bug Fixes + - Revert back to go1.12.x for the v1.49.x builds as go1.13.x was + causing issues (Nick Craig-Wood) + - Fix rpm packages by using master builds of nfpm (Nick + Craig-Wood) + - Fix macOS build after brew changes (Nick Craig-Wood) + + +v1.49.4 - 2019-09-29 + +- Bug Fixes + - cmd/rcd: Address ZipSlip vulnerability (Richard Patel) + - accounting: Fix file handle leak on errors (Nick Craig-Wood) + - oauthutil: Fix security problem when running with two users on + the same machine (Nick Craig-Wood) +- FTP + - Fix listing of an empty root returning: error dir not found + (Nick Craig-Wood) +- S3 + - Fix SetModTime on GLACIER/ARCHIVE objects and implement set/get + tier (Nick Craig-Wood) + + +v1.49.3 - 2019-09-15 + +- Bug Fixes + - accounting + - Fix total duration calculation (Aleksandar Jankovic) + - Fix “file already closed” on transfer retries (Nick + Craig-Wood) + + +v1.49.2 - 2019-09-08 + +- New Features + - build: Add Docker workflow support (Alfonso Montero) +- Bug Fixes + - accounting: Fix locking in Transfer to avoid deadlock with + --progress (Nick Craig-Wood) + - docs: Fix template argument for mktemp in install.sh (Cnly) + - operations: Fix -u/--update with google photos / files of + unknown size (Nick Craig-Wood) + - rc: Fix docs for config/create /update /password (Nick + Craig-Wood) +- Google Cloud Storage + - Fix need for elevated permissions on SetModTime (Nick + Craig-Wood) + + +v1.49.1 - 2019-08-28 + +- Bug Fixes + - config: Fix generated passwords being stored as empty password + (Nick Craig-Wood) + - rcd: Added missing parameter for web-gui info logs. (Chaitanya) +- Googlephotos + - Fix crash on error response (Nick Craig-Wood) +- Onedrive + - Fix crash on error response (Nick Craig-Wood) + + v1.49.0 - 2019-08-26 - New backends @@ -17935,9 +18934,13 @@ v1.49.0 - 2019-08-26 - Implement --compare-dest & --copy-dest (yparitcher) - Implement --suffix without --backup-dir for backup to current dir (yparitcher) + - config reconnect to re-login (re-run the oauth login) for the + backend. (Nick Craig-Wood) + - config userinfo to discover which user you are logged in as. + (Nick Craig-Wood) + - config disconnect to disconnect you (log out) from the backend. + (Nick Craig-Wood) - Add --use-json-log for JSON logging (justinalin) - - Add config reconnect, config userinfo and config disconnect - subcommands. (Nick Craig-Wood) - Add context propagation to rclone (Aleksandar Jankovic) - Reworking internal statistics interfaces so they work with rc jobs (Aleksandar Jankovic) @@ -20431,7 +21434,7 @@ more. It may do in future (probably with a flag). Bugs -Bugs are stored in rclone’s Github project: +Bugs are stored in rclone’s GitHub project: - Reported bugs - Known issues @@ -20632,7 +21635,7 @@ CPU usage. The most common cause of rclone using lots of memory is a single directory with thousands or millions of files in. Rclone has to load -this entirely into memory as rclone objects. Each Rclone object takes +this entirely into memory as rclone objects. Each rclone object takes 0.5k-1k of memory. @@ -20945,6 +21948,28 @@ Contributors - Patrick Wang mail6543210@yahoo.com.tw - Cenk Alti cenkalti@gmail.com - Andreas Chlupka andy@chlupka.com +- Alfonso Montero amontero@tinet.org +- Ivan Andreev ivandeex@gmail.com +- David Baumgold david@davidbaumgold.com +- Lars Lehtonen lars.lehtonen@gmail.com +- Matei David matei.david@gmail.com +- David david.bramwell@endemolshine.com +- Anthony Rusdi 33247310+antrusd@users.noreply.github.com +- Richard Patel me@terorie.dev +- 庄天翼 zty0826@gmail.com +- SwitchJS dev@switchjs.com +- Raphael PowershellNinja@users.noreply.github.com +- Sezal Agrawal sezalagrawal@gmail.com +- Tyler TylerNakamura@users.noreply.github.com +- Brett Dutro brett.dutro@gmail.com +- Vighnesh SK booterror99@gmail.com +- Arijit Biswas dibbyo456@gmail.com +- Michele Caci michele.caci@gmail.com +- AlexandrBoltris ua2fgb@gmail.com +- Bryce Larson blarson@saltstack.com +- Carlos Ferreyra crypticmind@gmail.com +- Saksham Khanna sakshamkhanna@outlook.com +- dausruddin 5763466+dausruddin@users.noreply.github.com diff --git a/Makefile b/Makefile index 354915faa..929623287 100644 --- a/Makefile +++ b/Makefile @@ -96,6 +96,11 @@ update: GO111MODULE=on go mod tidy GO111MODULE=on go mod vendor +# Tidy the module dependencies +tidy: + GO111MODULE=on go mod tidy + GO111MODULE=on go mod vendor + doc: rclone.1 MANUAL.html MANUAL.txt rcdocs commanddocs rclone.1: MANUAL.md diff --git a/RELEASE.md b/RELEASE.md index c8045f645..5683ffae5 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -15,6 +15,7 @@ This file describes how to make the various kinds of releases * make test # see integration test server or run locally * make tag * edit docs/content/changelog.md + * make tidy * make doc * git status - to check for new man pages - git add them * git commit -a -v -m "Version v1.XX.0" diff --git a/VERSION b/VERSION index 1914b8511..b742c38a6 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v1.49.5 +v1.50.0 diff --git a/docs/content/box.md b/docs/content/box.md index 768b20df3..25a25a097 100644 --- a/docs/content/box.md +++ b/docs/content/box.md @@ -252,6 +252,30 @@ Leave blank normally. - Type: string - Default: "" +#### --box-box-config-file + +Box App config.json location +Leave blank normally. + +- Config: box_config_file +- Env Var: RCLONE_BOX_BOX_CONFIG_FILE +- 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). diff --git a/docs/content/changelog.md b/docs/content/changelog.md index dc9f52333..2da178ae3 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -1,11 +1,118 @@ --- title: "Documentation" description: "Rclone Changelog" -date: "2019-10-05" +date: "2019-10-26" --- # Changelog +## v1.50.0 - 2019-10-26 + +* New backends + * [Citrix Sharefile](/sharefile) (Nick Craig-Wood) + * [Chunker](/chunker) - an overlay backend to split files into smaller parts (Ivan Andreev) + * [Mail.ru Cloud](/mailru) (Ivan Andreev) +* New Features + * encodings (Fabian Möller & Nick Craig-Wood) + * All backends now use file name encoding to ensure any file name can be written to any backend. + * See the [restricted file name docs](/overview/#restricted-filenames) for more info and the [local backend docs](/local/#filenames). + * Some file names may look different in rclone if you are using any control characters in names or [unicode FULLWIDTH symbols](https://en.wikipedia.org/wiki/Halfwidth_and_Fullwidth_Forms_(Unicode_block)). + * build + * Update to use go1.13 for the build (Nick Craig-Wood) + * Drop support for go1.9 (Nick Craig-Wood) + * Build rclone with GitHub actions (Nick Craig-Wood) + * Convert python scripts to python3 (Nick Craig-Wood) + * Swap Azure/go-ansiterm for mattn/go-colorable (Nick Craig-Wood) + * Dockerfile fixes (Matei David) + * Add [plugin support](https://github.com/rclone/rclone/blob/master/CONTRIBUTING.md#writing-a-plugin) for backends and commands (Richard Patel) + * config + * Use alternating Red/Green in config to make more obvious (Nick Craig-Wood) + * contrib + * Add sample DLNA server Docker Compose manifest. (pataquets) + * Add sample WebDAV server Docker Compose manifest. (pataquets) + * copyurl + * Add `--auto-filename` flag for using file name from URL in destination path (Denis) + * serve dlna: + * Many compatability improvements (Dan Walters) + * Support for external srt subtitles (Dan Walters) + * rc + * Added command core/quit (Saksham Khanna) +* Bug Fixes + * sync + * Make `--update`/`-u` not transfer files that haven't changed (Nick Craig-Wood) + * Free objects after they come out of the transfer pipe to save memory (Nick Craig-Wood) + * Fix `--files-from without --no-traverse` doing a recursive scan (Nick Craig-Wood) + * operations + * Fix accounting for server side copies (Nick Craig-Wood) + * Display 'All duplicates removed' only if dedupe successful (Sezal Agrawal) + * Display 'Deleted X extra copies' only if dedupe successful (Sezal Agrawal) + * accounting + * Only allow up to 100 completed transfers in the accounting list to save memory (Nick Craig-Wood) + * Cull the old time ranges when possible to save memory (Nick Craig-Wood) + * Fix panic due to server-side copy fallback (Ivan Andreev) + * Fix memory leak noticeable for transfers of large numbers of objects (Nick Craig-Wood) + * Fix total duration calculation (Nick Craig-Wood) + * cmd + * Fix environment variables not setting command line flags (Nick Craig-Wood) + * Make autocomplete compatible with bash's posix mode for macOS (Danil Semelenov) + * Make `--progress` work in git bash on Windows (Nick Craig-Wood) + * Fix 'compopt: command not found' on autocomplete on macOS (Danil Semelenov) + * config + * Fix setting of non top level flags from environment variables (Nick Craig-Wood) + * Check config names more carefully and report errors (Nick Craig-Wood) + * Remove error: can't use `--size-only` and `--ignore-size` together. (Nick Craig-Wood) + * filter: Prevent mixing options when `--files-from` is in use (Michele Caci) + * serve sftp: Fix crash on unsupported operations (eg Readlink) (Nick Craig-Wood) +* Mount + * Allow files of unkown size to be read properly (Nick Craig-Wood) + * Skip tests on <= 2 CPUs to avoid lockup (Nick Craig-Wood) + * Fix panic on File.Open (Nick Craig-Wood) + * Fix "mount_fusefs: -o timeout=: option not supported" on FreeBSD (Nick Craig-Wood) + * Don't pass huge filenames (>4k) to FUSE as it can't cope (Nick Craig-Wood) +* VFS + * Add flag `--vfs-case-insensitive` for windows/macOS mounts (Ivan Andreev) + * Make objects of unknown size readable through the VFS (Nick Craig-Wood) + * Move writeback of dirty data out of close() method into its own method (FlushWrites) and remove close() call from Flush() (Brett Dutro) + * Stop empty dirs disappearing when renamed on bucket based remotes (Nick Craig-Wood) + * Stop change notify polling clearing so much of the directory cache (Nick Craig-Wood) +* Azure Blob + * Disable logging to the Windows event log (Nick Craig-Wood) +* B2 + * Remove `unverified:` prefix on sha1 to improve interop (eg with CyberDuck) (Nick Craig-Wood) +* Box + * Add options to get access token via JWT auth (David) +* Drive + * Disable HTTP/2 by default to work around INTERNAL_ERROR problems (Nick Craig-Wood) + * Make sure that drive root ID is always canonical (Nick Craig-Wood) + * Fix `--drive-shared-with-me` from the root with lsand `--fast-list` (Nick Craig-Wood) + * Fix ChangeNotify polling for shared drives (Nick Craig-Wood) + * Fix change notify polling when using appDataFolder (Nick Craig-Wood) +* Dropbox + * Make disallowed filenames errors not retry (Nick Craig-Wood) + * Fix nil pointer exception on restricted files (Nick Craig-Wood) +* Fichier + * Fix accessing files > 2GB on 32 bit systems (Nick Craig-Wood) +* FTP + * Allow disabling EPSV mode (Jon Fautley) +* HTTP + * HEAD directory entries in parallel to speedup (Nick Craig-Wood) + * Add `--http-no-head` to stop rclone doing HEAD in listings (Nick Craig-Wood) +* Putio + * Add ability to resume uploads (Cenk Alti) +* S3 + * Fix signature v2_auth headers (Anthony Rusdi) + * Fix encoding for control characters (Nick Craig-Wood) + * Only ask for URL encoded directory listings if we need them on Ceph (Nick Craig-Wood) + * Add option for multipart failiure behaviour (Aleksandar Jankovic) + * Support for multipart copy (庄天翼) + * Fix nil pointer reference if no metadata returned for object (Nick Craig-Wood) +* SFTP + * Fix `--sftp-ask-password` trying to contact the ssh agent (Nick Craig-Wood) + * Fix hashes of files with backslashes (Nick Craig-Wood) + * Include more ciphers with `--sftp-use-insecure-cipher` (Carlos Ferreyra) +* WebDAV + * Parse and return Sharepoint error response (Henning Surmeier) + ## v1.49.5 - 2019-10-05 * Bug Fixes @@ -36,17 +143,15 @@ date: "2019-10-05" * New Features * build: Add Docker workflow support (Alfonso Montero) * Bug Fixes - * accounting: Fix locking in Transfer to avoid deadlock with --progress (Nick Craig-Wood) + * accounting: Fix locking in Transfer to avoid deadlock with `--progress` (Nick Craig-Wood) * docs: Fix template argument for mktemp in install.sh (Cnly) - * operations: Fix -u/--update with google photos / files of unknown size (Nick Craig-Wood) + * operations: Fix `-u`/`--update` with google photos / files of unknown size (Nick Craig-Wood) * rc: Fix docs for config/create /update /password (Nick Craig-Wood) * Google Cloud Storage * Fix need for elevated permissions on SetModTime (Nick Craig-Wood) ## v1.49.1 - 2019-08-28 -Point release to fix config bug and google photos backend. - * Bug Fixes * config: Fix generated passwords being stored as empty password (Nick Craig-Wood) * rcd: Added missing parameter for web-gui info logs. (Chaitanya) diff --git a/docs/content/chunker.md b/docs/content/chunker.md index ae0eb73d5..8f362acfc 100644 --- a/docs/content/chunker.md +++ b/docs/content/chunker.md @@ -293,7 +293,7 @@ in the same directory). ### Standard Options -Here are the standard options specific to chunker. +Here are the standard options specific to chunker (Transparently chunk/split large files). #### --chunker-remote @@ -341,7 +341,7 @@ Choose how chunker handles hash sums. All modes but "none" require metadata. ### Advanced Options -Here are the advanced options specific to chunker. +Here are the advanced options specific to chunker (Transparently chunk/split large files). #### --chunker-name-format diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index c02a0feec..570568657 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone" slug: rclone url: /commands/rclone/ diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md index 3eadee23d..3cd97b9a4 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone about" slug: rclone_about url: /commands/rclone_about/ diff --git a/docs/content/commands/rclone_authorize.md b/docs/content/commands/rclone_authorize.md index a0f6e18b1..f57e3f342 100644 --- a/docs/content/commands/rclone_authorize.md +++ b/docs/content/commands/rclone_authorize.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone authorize" slug: rclone_authorize url: /commands/rclone_authorize/ diff --git a/docs/content/commands/rclone_cachestats.md b/docs/content/commands/rclone_cachestats.md index e8da13137..381191804 100644 --- a/docs/content/commands/rclone_cachestats.md +++ b/docs/content/commands/rclone_cachestats.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone cachestats" slug: rclone_cachestats url: /commands/rclone_cachestats/ diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index 5d555602a..1e769f732 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone cat" slug: rclone_cat url: /commands/rclone_cat/ diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index f6792ce41..23f04825e 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone check" slug: rclone_check url: /commands/rclone_check/ diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index c8d76bc26..023ef8809 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone cleanup" slug: rclone_cleanup url: /commands/rclone_cleanup/ diff --git a/docs/content/commands/rclone_config.md b/docs/content/commands/rclone_config.md index 485746e8e..1f752474f 100644 --- a/docs/content/commands/rclone_config.md +++ b/docs/content/commands/rclone_config.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config" slug: rclone_config url: /commands/rclone_config/ diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md index 23517655c..f28498473 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config create" slug: rclone_config_create url: /commands/rclone_config_create/ diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md index 4955c7a54..677d8c463 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config delete" slug: rclone_config_delete url: /commands/rclone_config_delete/ diff --git a/docs/content/commands/rclone_config_disconnect.md b/docs/content/commands/rclone_config_disconnect.md index 6a7d424ac..47a699d8d 100644 --- a/docs/content/commands/rclone_config_disconnect.md +++ b/docs/content/commands/rclone_config_disconnect.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config disconnect" slug: rclone_config_disconnect url: /commands/rclone_config_disconnect/ diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md index e22214a38..cec291bd6 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config dump" slug: rclone_config_dump url: /commands/rclone_config_dump/ diff --git a/docs/content/commands/rclone_config_edit.md b/docs/content/commands/rclone_config_edit.md index 44c5210ec..7477be12c 100644 --- a/docs/content/commands/rclone_config_edit.md +++ b/docs/content/commands/rclone_config_edit.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config edit" slug: rclone_config_edit url: /commands/rclone_config_edit/ diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md index 1b53f5903..238da3f6a 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config file" slug: rclone_config_file url: /commands/rclone_config_file/ diff --git a/docs/content/commands/rclone_config_password.md b/docs/content/commands/rclone_config_password.md index ee3496439..1a9f92c3a 100644 --- a/docs/content/commands/rclone_config_password.md +++ b/docs/content/commands/rclone_config_password.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config password" slug: rclone_config_password url: /commands/rclone_config_password/ diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md index 7a59a70e7..01629fbb3 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config providers" slug: rclone_config_providers url: /commands/rclone_config_providers/ diff --git a/docs/content/commands/rclone_config_reconnect.md b/docs/content/commands/rclone_config_reconnect.md index c0b7a043f..ee14fbe72 100644 --- a/docs/content/commands/rclone_config_reconnect.md +++ b/docs/content/commands/rclone_config_reconnect.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config reconnect" slug: rclone_config_reconnect url: /commands/rclone_config_reconnect/ diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md index 1d829d6f0..3f8efbf3a 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config show" slug: rclone_config_show url: /commands/rclone_config_show/ diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index 872901f24..798e39d40 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config update" slug: rclone_config_update url: /commands/rclone_config_update/ diff --git a/docs/content/commands/rclone_config_userinfo.md b/docs/content/commands/rclone_config_userinfo.md index 7ec95532f..44eae7397 100644 --- a/docs/content/commands/rclone_config_userinfo.md +++ b/docs/content/commands/rclone_config_userinfo.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone config userinfo" slug: rclone_config_userinfo url: /commands/rclone_config_userinfo/ diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index 7b305dbb0..62d9a158a 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone copy" slug: rclone_copy url: /commands/rclone_copy/ diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index 820a7ff10..e19b4d892 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone copyto" slug: rclone_copyto url: /commands/rclone_copyto/ diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md index e549dee65..05a1833b6 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone copyurl" slug: rclone_copyurl url: /commands/rclone_copyurl/ @@ -14,6 +14,8 @@ Copy url content to dest. Download urls content and copy it to destination without saving it in tmp storage. +Setting --auto-filename flag will cause retrieving file name from url and using it in destination path. + ``` rclone copyurl https://example.com dest:path [flags] diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index 72cd87110..c2113c494 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone cryptcheck" slug: rclone_cryptcheck url: /commands/rclone_cryptcheck/ diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md index 8c0e4c934..2b63f25f6 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone cryptdecode" slug: rclone_cryptdecode url: /commands/rclone_cryptdecode/ diff --git a/docs/content/commands/rclone_dbhashsum.md b/docs/content/commands/rclone_dbhashsum.md index 79917a0c6..262ae2165 100644 --- a/docs/content/commands/rclone_dbhashsum.md +++ b/docs/content/commands/rclone_dbhashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone dbhashsum" slug: rclone_dbhashsum url: /commands/rclone_dbhashsum/ diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md index 819d1cbc6..7e036bac6 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone dedupe" slug: rclone_dedupe url: /commands/rclone_dedupe/ diff --git a/docs/content/commands/rclone_delete.md b/docs/content/commands/rclone_delete.md index 71d8607ce..f94f376d3 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone delete" slug: rclone_delete url: /commands/rclone_delete/ diff --git a/docs/content/commands/rclone_deletefile.md b/docs/content/commands/rclone_deletefile.md index 7b7552689..c0851f647 100644 --- a/docs/content/commands/rclone_deletefile.md +++ b/docs/content/commands/rclone_deletefile.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone deletefile" slug: rclone_deletefile url: /commands/rclone_deletefile/ diff --git a/docs/content/commands/rclone_genautocomplete.md b/docs/content/commands/rclone_genautocomplete.md index 9ef697f79..d6d6a4d3b 100644 --- a/docs/content/commands/rclone_genautocomplete.md +++ b/docs/content/commands/rclone_genautocomplete.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone genautocomplete" slug: rclone_genautocomplete url: /commands/rclone_genautocomplete/ diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md index 5e00bb061..6d2cb5198 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone genautocomplete bash" slug: rclone_genautocomplete_bash url: /commands/rclone_genautocomplete_bash/ diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md index 67a5cfba0..2706343f7 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone genautocomplete zsh" slug: rclone_genautocomplete_zsh url: /commands/rclone_genautocomplete_zsh/ diff --git a/docs/content/commands/rclone_gendocs.md b/docs/content/commands/rclone_gendocs.md index a69018fc5..fdbf565b3 100644 --- a/docs/content/commands/rclone_gendocs.md +++ b/docs/content/commands/rclone_gendocs.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone gendocs" slug: rclone_gendocs url: /commands/rclone_gendocs/ diff --git a/docs/content/commands/rclone_hashsum.md b/docs/content/commands/rclone_hashsum.md index 087e75779..cb06e1d12 100644 --- a/docs/content/commands/rclone_hashsum.md +++ b/docs/content/commands/rclone_hashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone hashsum" slug: rclone_hashsum url: /commands/rclone_hashsum/ diff --git a/docs/content/commands/rclone_link.md b/docs/content/commands/rclone_link.md index 8dc633839..5c2e97bf6 100644 --- a/docs/content/commands/rclone_link.md +++ b/docs/content/commands/rclone_link.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone link" slug: rclone_link url: /commands/rclone_link/ diff --git a/docs/content/commands/rclone_listremotes.md b/docs/content/commands/rclone_listremotes.md index 4f8ce6eb3..1407bd593 100644 --- a/docs/content/commands/rclone_listremotes.md +++ b/docs/content/commands/rclone_listremotes.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone listremotes" slug: rclone_listremotes url: /commands/rclone_listremotes/ diff --git a/docs/content/commands/rclone_ls.md b/docs/content/commands/rclone_ls.md index c3b83d360..ab57f0de3 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone ls" slug: rclone_ls url: /commands/rclone_ls/ diff --git a/docs/content/commands/rclone_lsd.md b/docs/content/commands/rclone_lsd.md index fd7dc50f1..1af49af5c 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone lsd" slug: rclone_lsd url: /commands/rclone_lsd/ diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index 93215f9b4..dd263eda5 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone lsf" slug: rclone_lsf url: /commands/rclone_lsf/ diff --git a/docs/content/commands/rclone_lsjson.md b/docs/content/commands/rclone_lsjson.md index 150ef017c..33db69ea5 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone lsjson" slug: rclone_lsjson url: /commands/rclone_lsjson/ diff --git a/docs/content/commands/rclone_lsl.md b/docs/content/commands/rclone_lsl.md index 99842acfe..6e647d516 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone lsl" slug: rclone_lsl url: /commands/rclone_lsl/ diff --git a/docs/content/commands/rclone_md5sum.md b/docs/content/commands/rclone_md5sum.md index 219f4910e..daaf6a27a 100644 --- a/docs/content/commands/rclone_md5sum.md +++ b/docs/content/commands/rclone_md5sum.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone md5sum" slug: rclone_md5sum url: /commands/rclone_md5sum/ diff --git a/docs/content/commands/rclone_mkdir.md b/docs/content/commands/rclone_mkdir.md index dd49266ef..aa9cdd091 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone mkdir" slug: rclone_mkdir url: /commands/rclone_mkdir/ diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index 80c7ada11..925ac7136 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone mount" slug: rclone_mount url: /commands/rclone_mount/ @@ -287,46 +287,11 @@ This mode should support all normal file system operations. If an upload or download fails it will be retried up to --low-level-retries times. + ``` rclone mount remote:path /path/to/mountpoint [flags] ``` -### Case Sensitivity - -Linux file systems are case-sensitive: two files can differ only -by case, and the exact case must be used when opening a file. - -Windows is not like most other operating systems supported by rclone. -File systems in modern Windows are case-insensitive but case-preserving: -although existing files can be opened using any case, the exact case used -to create the file is preserved and available for programs to query. -It is not allowed for two files in the same directory to differ only by case. - -Usually file systems on MacOS are case-insensitive. It is possible to make MacOS -file systems case-sensitive but that is not the default - -The `--vfs-case-insensitive` mount flag controls how rclone handles these -two cases. If its value is `false`, rclone passes file names to the mounted -file system as is. If the flag is `true` (or appears without a value on -command line), rclone may perform a "fixup" as explained below. - -The user may specify a file name to open/delete/rename/etc with a case -different than what is stored on mounted file system. If an argument refers -to an existing file with exactly the same name, then the case of the existing -file on the disk will be used. However, if a file name with exactly the same -name is not found but a name differing only by case exists, rclone will -transparently fixup the name. This fixup happens only when an existing file -is requested. Case sensitivity of file names created anew by rclone is -controlled by an underlying mounted file system. - -Note that case sensitivity of the operating system running rclone (the target) -may differ from case sensitivity of a file system mounted by rclone (the source). -The flag controls whether "fixup" is performed to satisfy the target. - -If the flag is not provided on command line, then its default value depends -on the operating system where rclone runs: `true` on Windows and MacOS, `false` -otherwise. If the flag is provided without a value, then it is `true`. - ### Options ``` @@ -357,7 +322,7 @@ otherwise. If the flag is provided without a value, then it is `true`. --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) - --vfs-case-insensitive [bool] Case insensitive mount true|false (default depends on operating system) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) --volname string Set the volume name (not supported by all OSes). diff --git a/docs/content/commands/rclone_move.md b/docs/content/commands/rclone_move.md index fa52dbb06..5426d3968 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone move" slug: rclone_move url: /commands/rclone_move/ diff --git a/docs/content/commands/rclone_moveto.md b/docs/content/commands/rclone_moveto.md index 3793848ad..d6c262c63 100644 --- a/docs/content/commands/rclone_moveto.md +++ b/docs/content/commands/rclone_moveto.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone moveto" slug: rclone_moveto url: /commands/rclone_moveto/ diff --git a/docs/content/commands/rclone_ncdu.md b/docs/content/commands/rclone_ncdu.md index d2f927250..f96d84d0c 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone ncdu" slug: rclone_ncdu url: /commands/rclone_ncdu/ diff --git a/docs/content/commands/rclone_obscure.md b/docs/content/commands/rclone_obscure.md index 0cd6621a6..ab570feee 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone obscure" slug: rclone_obscure url: /commands/rclone_obscure/ diff --git a/docs/content/commands/rclone_purge.md b/docs/content/commands/rclone_purge.md index 31d97647d..a0b381eaf 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone purge" slug: rclone_purge url: /commands/rclone_purge/ diff --git a/docs/content/commands/rclone_rc.md b/docs/content/commands/rclone_rc.md index a42e14e59..7f4bcc3f2 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone rc" slug: rclone_rc url: /commands/rclone_rc/ diff --git a/docs/content/commands/rclone_rcat.md b/docs/content/commands/rclone_rcat.md index b56b02e4c..b580c60a2 100644 --- a/docs/content/commands/rclone_rcat.md +++ b/docs/content/commands/rclone_rcat.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone rcat" slug: rclone_rcat url: /commands/rclone_rcat/ diff --git a/docs/content/commands/rclone_rcd.md b/docs/content/commands/rclone_rcd.md index 358d72e28..b8b971ce5 100644 --- a/docs/content/commands/rclone_rcd.md +++ b/docs/content/commands/rclone_rcd.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone rcd" slug: rclone_rcd url: /commands/rclone_rcd/ diff --git a/docs/content/commands/rclone_rmdir.md b/docs/content/commands/rclone_rmdir.md index c63bc110f..7550a4199 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone rmdir" slug: rclone_rmdir url: /commands/rclone_rmdir/ diff --git a/docs/content/commands/rclone_rmdirs.md b/docs/content/commands/rclone_rmdirs.md index 895bf3770..21dba3ecd 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone rmdirs" slug: rclone_rmdirs url: /commands/rclone_rmdirs/ diff --git a/docs/content/commands/rclone_serve.md b/docs/content/commands/rclone_serve.md index 61284beee..e7b59ac58 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve" slug: rclone_serve url: /commands/rclone_serve/ diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index da866a92e..9b18b3578 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve dlna" slug: rclone_serve_dlna url: /commands/rclone_serve_dlna/ @@ -193,6 +193,7 @@ rclone serve dlna remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index 027b2dc9b..ba87a8f07 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve ftp" slug: rclone_serve_ftp url: /commands/rclone_serve_ftp/ @@ -261,6 +261,7 @@ rclone serve ftp remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 4d75268bf..6d5413a65 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve http" slug: rclone_serve_http url: /commands/rclone_serve_http/ @@ -250,6 +250,7 @@ rclone serve http remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md index dc54635c5..9097fa251 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve restic" slug: rclone_serve_restic url: /commands/rclone_serve_restic/ diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index 191c8338d..d4b9164c2 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve sftp" slug: rclone_serve_sftp url: /commands/rclone_serve_sftp/ @@ -273,6 +273,7 @@ rclone serve sftp remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index cd0750b54..468d736c8 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone serve webdav" slug: rclone_serve_webdav url: /commands/rclone_serve_webdav/ @@ -327,6 +327,7 @@ rclone serve webdav remote:path [flags] --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off) --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s) + --vfs-case-insensitive If a file name not found, find a case insensitive match. --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M) --vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off) ``` diff --git a/docs/content/commands/rclone_settier.md b/docs/content/commands/rclone_settier.md index b43ab5546..7aac26674 100644 --- a/docs/content/commands/rclone_settier.md +++ b/docs/content/commands/rclone_settier.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone settier" slug: rclone_settier url: /commands/rclone_settier/ diff --git a/docs/content/commands/rclone_sha1sum.md b/docs/content/commands/rclone_sha1sum.md index 2fd097475..04db4c119 100644 --- a/docs/content/commands/rclone_sha1sum.md +++ b/docs/content/commands/rclone_sha1sum.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone sha1sum" slug: rclone_sha1sum url: /commands/rclone_sha1sum/ diff --git a/docs/content/commands/rclone_size.md b/docs/content/commands/rclone_size.md index a5ffb10c0..a2c85e944 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone size" slug: rclone_size url: /commands/rclone_size/ diff --git a/docs/content/commands/rclone_sync.md b/docs/content/commands/rclone_sync.md index cd2d5d1e1..c1088174c 100644 --- a/docs/content/commands/rclone_sync.md +++ b/docs/content/commands/rclone_sync.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone sync" slug: rclone_sync url: /commands/rclone_sync/ diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md index 3ebf60ac0..4f08cad26 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone touch" slug: rclone_touch url: /commands/rclone_touch/ diff --git a/docs/content/commands/rclone_tree.md b/docs/content/commands/rclone_tree.md index 34d4357cb..2305c7404 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone tree" slug: rclone_tree url: /commands/rclone_tree/ diff --git a/docs/content/commands/rclone_version.md b/docs/content/commands/rclone_version.md index 64886a042..2537edd8a 100644 --- a/docs/content/commands/rclone_version.md +++ b/docs/content/commands/rclone_version.md @@ -1,5 +1,5 @@ --- -date: 2019-08-26T15:19:45+01:00 +date: 2019-10-26T11:04:03+01:00 title: "rclone version" slug: rclone_version url: /commands/rclone_version/ diff --git a/docs/content/drive.md b/docs/content/drive.md index c9c1d082e..2eb64bbbc 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -550,7 +550,13 @@ Scope that rclone should use when requesting access from drive. ID of the root folder Leave blank normally. -Fill in to access "Computers" folders. (see docs). + +Fill in to access "Computers" folders (see docs), or for rclone to use +a non root folder as its starting point. + +Note that if this is blank, the first time rclone runs it will fill it +in with the ID of the root folder. + - Config: root_folder_id - Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID @@ -857,7 +863,7 @@ 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 beween any two +because it isn't easy to tell if it will work between any two configurations. - Config: server_side_across_configs @@ -865,6 +871,24 @@ configurations. - 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 + ### Limitations ### diff --git a/docs/content/flags.md b/docs/content/flags.md index 73bdfb58c..c996a033b 100755 --- a/docs/content/flags.md +++ b/docs/content/flags.md @@ -1,7 +1,7 @@ --- title: "Global Flags" description: "Rclone Global Flags" -date: "2019-08-26T15:19:45+01:00" +date: "2019-10-26T11:04:03+01:00" --- # Global Flags @@ -127,7 +127,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.49.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.50.0") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -164,6 +164,8 @@ and may be set in the config file. --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-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") --box-client-id string Box App Client Id. --box-client-secret string Box App Client Secret --box-commit-retries int Max number of times to try committing a multipart file. (default 100) @@ -188,6 +190,13 @@ and may be set in the config file. --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") @@ -202,6 +211,7 @@ and may be set in the config file. --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 Google Application Client Secret + --drive-disable-http2 Disable drive using http2 (default true) --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. @@ -232,6 +242,7 @@ and may be set in the config file. --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --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-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 @@ -252,6 +263,7 @@ and may be set in the config file. --gphotos-read-only Set to make the Google Photos backend read only. --gphotos-read-size Set to read the size of media items. --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-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) @@ -273,12 +285,19 @@ and may be set in the config file. --local-no-check-updated Don't check to see if the files change during upload --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-pass string Password + --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-hard-delete Delete files permanently rather than putting them into the trash. --mega-pass string Password. --mega-user string User name -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). - --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k. (default 10M) + --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) --onedrive-client-id string Microsoft App Client Id --onedrive-client-secret string Microsoft App Client Secret --onedrive-drive-id string The ID of the drive to use @@ -305,6 +324,7 @@ and may be set in the config file. --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-location-constraint string Location constraint - must be set to match the Region. --s3-provider string Choose your S3 provider. --s3-region string Region to connect to. @@ -329,8 +349,12 @@ and may be set in the config file. --sftp-port string SSH port, leave blank to use default (22) --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-use-insecure-cipher Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. + --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-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. --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) diff --git a/docs/content/ftp.md b/docs/content/ftp.md index 8c644004d..80d1a59c4 100644 --- a/docs/content/ftp.md +++ b/docs/content/ftp.md @@ -203,6 +203,15 @@ Do not verify the TLS certificate of the server - 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 + ### Limitations ### diff --git a/docs/content/http.md b/docs/content/http.md index 5d212a82b..d4081fd0b 100644 --- a/docs/content/http.md +++ b/docs/content/http.md @@ -162,4 +162,28 @@ directories. - Type: bool - Default: false +#### --http-no-head + +Don't use HEAD requests to find file sizes in dir listing + +If your site is being very slow to load then you can try this option. +Normally rclone does a HEAD request for each potential file in a +directory listing to: + +- find its size +- check it really exists +- check to see if it is a directory + +If you set this option, rclone will not do the HEAD request. This will mean + +- directory listings are much quicker +- rclone won't have the times or sizes of any files +- some files that don't exist may be in the listing + + +- Config: no_head +- Env Var: RCLONE_HTTP_NO_HEAD +- Type: bool +- Default: false + diff --git a/docs/content/local.md b/docs/content/local.md index 599bcca1a..2ba67f627 100644 --- a/docs/content/local.md +++ b/docs/content/local.md @@ -319,7 +319,7 @@ Disable UNC (long path names) conversion on Windows Here are the advanced options specific to local (Local Disk). -#### --copy-links +#### --copy-links / -L Follow symlinks and copy the pointed to item. @@ -328,7 +328,7 @@ Follow symlinks and copy the pointed to item. - Type: bool - Default: false -#### --links +#### --links / -l Translate symlinks to/from regular files with a '.rclonelink' extension @@ -378,7 +378,7 @@ check can be disabled with this flag. - Type: bool - Default: false -#### --one-file-system +#### --one-file-system / -x Don't cross filesystem boundaries (unix/macOS only). diff --git a/docs/content/mailru.md b/docs/content/mailru.md index a90f4f23f..32fcbcf80 100644 --- a/docs/content/mailru.md +++ b/docs/content/mailru.md @@ -213,20 +213,20 @@ 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. +Patterns are case insensitive and can contain '*' or '?' meta characters. - Config: speedup_file_patterns - Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS - Type: string - Default: "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf" - Examples: - - `""` + - "" - Empty list completely disables speedup (put by hash). - - `"*"` + - "*" - All files will be attempted for speedup. - - `"*.mkv,*.avi,*.mp4,*.mp3"` + - "*.mkv,*.avi,*.mp4,*.mp3" - Only common audio/video files will be tried for put by hash. - - `"*.zip,*.gz,*.rar,*.pdf"` + - "*.zip,*.gz,*.rar,*.pdf" - Only common archives or PDF books will be tried for speedup. #### --mailru-speedup-max-disk @@ -288,8 +288,12 @@ Defaults to "rclone/VERSION" or "--user-agent" provided on command line. #### --mailru-quirks -Comma separated list of internal maintenance flags. This option is intended -for development purposes. Should not be used by an ordinary user. +Comma separated list of internal maintenance flags. +This option must not be used by an ordinary user. It is intended only to +facilitate remote troubleshooting of backend issues. Strict meaning of +flags is not documented and not guaranteed to persist between releases. +Quirks will be removed when the backend grows stable. +Supported quirks: atomicmkdir binlist gzip insecure retry400 - Config: quirks - Env Var: RCLONE_MAILRU_QUIRKS diff --git a/docs/content/rc.md b/docs/content/rc.md index 3067c3405..a11070798 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -467,6 +467,11 @@ Returns 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: @@ -519,6 +524,7 @@ is provided. Parameters - group - name of the stats group (string) +``` ### core/transferred: Returns stats about completed transfers. {#core/transferred} @@ -529,6 +535,8 @@ This returns stats about completed transfers: 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) @@ -630,7 +638,7 @@ 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](/commands/rclone_copyurl/) command for more information on the above. Authentication is required for this call. diff --git a/docs/content/sftp.md b/docs/content/sftp.md index e7c09e477..724ecd3ca 100644 --- a/docs/content/sftp.md +++ b/docs/content/sftp.md @@ -222,7 +222,18 @@ when the ssh-agent contains many keys. #### --sftp-use-insecure-cipher -Enable the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange. Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. +Enable the use of insecure ciphers and key exchange methods. + +This enables the use of the the following insecure ciphers and key exchange methods: + +- aes128-cbc +- aes192-cbc +- aes256-cbc +- 3des-cbc +- diffie-hellman-group-exchange-sha256 +- diffie-hellman-group-exchange-sha1 + +Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. - Config: use_insecure_cipher - Env Var: RCLONE_SFTP_USE_INSECURE_CIPHER @@ -252,6 +263,11 @@ Here are the advanced options specific to sftp (SSH/SFTP Connection). Allow asking for SFTP password when needed. +If this is set and no password is supplied then rclone will: +- ask for a password +- not contact the ssh agent + + - Config: ask_password - Env Var: RCLONE_SFTP_ASK_PASSWORD - Type: bool diff --git a/docs/layouts/partials/version.html b/docs/layouts/partials/version.html index f67c24e26..60c34d970 100644 --- a/docs/layouts/partials/version.html +++ b/docs/layouts/partials/version.html @@ -1 +1 @@ -v1.49.0 \ No newline at end of file +v1.50.0 \ No newline at end of file diff --git a/fs/version.go b/fs/version.go index b29befc6f..229fe14a4 100644 --- a/fs/version.go +++ b/fs/version.go @@ -1,4 +1,4 @@ package fs // Version of rclone -var Version = "v1.49.5-DEV" +var Version = "v1.50.0" diff --git a/rclone.1 b/rclone.1 index 26ccf166b..6747b4c08 100644 --- a/rclone.1 +++ b/rclone.1 @@ -1,7 +1,7 @@ .\"t .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "rclone" "1" "Aug 26, 2019" "User Manual" "" +.TH "rclone" "1" "Oct 26, 2019" "User Manual" "" .hy .SH Rclone \- rsync for cloud storage .PP @@ -22,6 +22,8 @@ Box .IP \[bu] 2 Ceph .IP \[bu] 2 +Citrix ShareFile +.IP \[bu] 2 C14 .IP \[bu] 2 DigitalOcean Spaces @@ -48,6 +50,8 @@ IBM COS S3 .IP \[bu] 2 Koofr .IP \[bu] 2 +Mail.ru Cloud +.IP \[bu] 2 Memset Memstore .IP \[bu] 2 Mega @@ -117,6 +121,8 @@ Encryption (https://rclone.org/crypt/) backend .IP \[bu] 2 Cache (https://rclone.org/cache/) backend .IP \[bu] 2 +Chunking (https://rclone.org/chunker/) backend +.IP \[bu] 2 Union (https://rclone.org/union/) backend .IP \[bu] 2 Optional FUSE mount (rclone @@ -264,6 +270,91 @@ See rclone config docs (https://rclone.org/docs/) for more details. rclone\ config \f[] .fi +.SS Install with docker +.PP +The rclone maintains a docker image for +rclone (https://hub.docker.com/r/rclone/rclone). +These images are autobuilt by docker hub from the rclone source based on +a minimal Alpine linux image. +.PP +The \f[C]:latest\f[] tag will always point to the latest stable release. +You can use the \f[C]:beta\f[] tag to get the latest build from master. +You can also use version tags, eg \f[C]:1.49.1\f[], \f[C]:1.49\f[] or +\f[C]:1\f[]. +.IP +.nf +\f[C] +$\ docker\ pull\ rclone/rclone:latest +latest:\ Pulling\ from\ rclone/rclone +Digest:\ sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 +\&... +$\ docker\ run\ \-\-rm\ rclone/rclone:latest\ version +rclone\ v1.49.1 +\-\ os/arch:\ linux/amd64 +\-\ go\ version:\ go1.12.9 +\f[] +.fi +.PP +There are a few command line options to consider when starting an rclone +Docker container from the rclone image. +.IP \[bu] 2 +You need to mount the host rclone config dir at \f[C]/config/rclone\f[] +into the Docker container. +Due to the fact that rclone updates tokens inside its config file, and +that the update process involves a file rename, you need to mount the +whole host rclone config dir, not just the single host rclone config +file. +.IP \[bu] 2 +You need to mount a host data dir at \f[C]/data\f[] into the Docker +container. +.IP \[bu] 2 +By default, the rclone binary inside a Docker container runs with UID=0 +(root). +As a result, all files created in a run will have UID=0. +If your config and data files reside on the host with a non\-root +UID:GID, you need to pass these on the container start command line. +.IP \[bu] 2 +It is possible to use \f[C]rclone\ mount\f[] inside a userspace Docker +container, and expose the resulting fuse mount to the host. +The exact \f[C]docker\ run\f[] options to do that might vary slightly +between hosts. +See, e.g.\ the discussion in this +thread (https://github.com/moby/moby/issues/9448). +.RS 2 +.PP +You also need to mount the host \f[C]/etc/passwd\f[] and +\f[C]/etc/group\f[] for fuse to work inside the container. +.RE +.PP +Here are some commands tested on an Ubuntu 18.04.3 host: +.IP +.nf +\f[C] +#\ config\ on\ host\ at\ ~/.config/rclone/rclone.conf +#\ data\ on\ host\ at\ ~/data + +#\ make\ sure\ the\ config\ is\ ok\ by\ listing\ the\ remotes +docker\ run\ \-\-rm\ \\ +\ \ \ \ \-\-volume\ ~/.config/rclone:/config/rclone\ \\ +\ \ \ \ \-\-volume\ ~/data:/data:shared\ \\ +\ \ \ \ \-\-user\ $(id\ \-u):$(id\ \-g)\ \\ +\ \ \ \ rclone/rclone\ \\ +\ \ \ \ listremotes + +#\ perform\ mount\ inside\ Docker\ container,\ expose\ result\ to\ host +mkdir\ \-p\ ~/data/mount +docker\ run\ \-\-rm\ \\ +\ \ \ \ \-\-volume\ ~/.config/rclone:/config/rclone\ \\ +\ \ \ \ \-\-volume\ ~/data:/data:shared\ \\ +\ \ \ \ \-\-user\ $(id\ \-u):$(id\ \-g)\ \\ +\ \ \ \ \-\-volume\ /etc/passwd:/etc/passwd:ro\ \-\-volume\ /etc/group:/etc/group:ro\ \\ +\ \ \ \ \-\-device\ /dev/fuse\ \-\-cap\-add\ SYS_ADMIN\ \-\-security\-opt\ apparmor:unconfined\ \\ +\ \ \ \ rclone/rclone\ \\ +\ \ \ \ mount\ dropbox:Photos\ /data/mount\ & +ls\ ~/data/mount +kill\ %1 +\f[] +.fi .SS Install from source .PP Make sure you have at least Go (https://golang.org/) 1.7 installed. @@ -346,6 +437,11 @@ Box (https://rclone.org/box/) .IP \[bu] 2 Cache (https://rclone.org/cache/) .IP \[bu] 2 +Chunker (https://rclone.org/chunker/) \- transparently splits large +files for other remotes +.IP \[bu] 2 +Citrix ShareFile (https://rclone.org/sharefile/) +.IP \[bu] 2 Crypt (https://rclone.org/crypt/) \- to encrypt other remotes .IP \[bu] 2 DigitalOcean Spaces (/s3/#digitalocean-spaces) @@ -368,6 +464,8 @@ Jottacloud (https://rclone.org/jottacloud/) .IP \[bu] 2 Koofr (https://rclone.org/koofr/) .IP \[bu] 2 +Mail.ru Cloud (https://rclone.org/mailru/) +.IP \[bu] 2 Mega (https://rclone.org/mega/) .IP \[bu] 2 Microsoft Azure Blob Storage (https://rclone.org/azureblob/) @@ -2064,6 +2162,9 @@ Copy url content to dest. .PP Download urls content and copy it to destination without saving it in tmp storage. +.PP +Setting \[en]auto\-filename flag will cause retrieving file name from +url and using it in destination path. .IP .nf \f[C] @@ -2074,7 +2175,8 @@ rclone\ copyurl\ https://example.com\ dest:path\ [flags] .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ copyurl +\ \ \-a,\ \-\-auto\-filename\ \ \ Get\ the\ file\ name\ from\ the\ url\ and\ use\ it\ for\ destination\ file\ path +\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ help\ for\ copyurl \f[] .fi .PP @@ -3180,6 +3282,7 @@ rclone\ mount\ remote:path\ /path/to/mountpoint\ [flags] \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \ \ \ \ \ \ \-\-volname\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Set\ the\ volume\ name\ (not\ supported\ by\ all\ OSes). @@ -3803,6 +3906,7 @@ rclone\ serve\ dlna\ remote:path\ [flags] \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] @@ -4105,6 +4209,7 @@ rclone\ serve\ ftp\ remote:path\ [flags] \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] @@ -4397,6 +4502,7 @@ rclone\ serve\ http\ remote:path\ [flags] \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] @@ -4904,6 +5010,7 @@ rclone\ serve\ sftp\ remote:path\ [flags] \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] @@ -5275,6 +5382,7 @@ rclone\ serve\ webdav\ remote:path\ [flags] \ \ \ \ \ \ \-\-vfs\-cache\-max\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) \ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) +\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) \ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) \f[] @@ -6553,22 +6661,27 @@ The default is to run 4 file transfers in parallel. This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file. .PP -If an existing destination file has a modification time equal (within -the computed modify window precision) to the source file's, it will be -updated if the sizes are different. -.PP -On remotes which don't support mod time directly (or when using -\f[C]\-\-use\-server\-mod\-time\f[]) the time checked will be the -uploaded time. -This means that if uploading to one of these remotes, rclone will skip -any files which exist on the destination and have an uploaded time that -is newer than the modification time of the source file. -.PP This can be useful when transferring to a remote which doesn't support -mod times directly (or when using \f[C]\-\-use\-server\-mod\-time\f[] to +mod times directly (or when using \f[C]\-\-use\-server\-modtime\f[] to avoid extra API calls) as it is more accurate than a \f[C]\-\-size\-only\f[] check and faster than using \f[C]\-\-checksum\f[]. +.PP +If an existing destination file has a modification time equal (within +the computed modify window precision) to the source file's, it will be +updated if the sizes are different. +If \f[C]\-\-checksum\f[] is set then rclone will update the destination +if the checksums differ too. +.PP +If an existing destination file is older than the source file then it +will be updated if the size or checksum differs from the source file. +.PP +On remotes which don't support mod time directly (or when using +\f[C]\-\-use\-server\-modtime\f[]) the time checked will be the uploaded +time. +This means that if uploading to one of these remotes, rclone will skip +any files which exist on the destination and have an uploaded time that +is newer than the modification time of the source file. .SS \[en]use\-mmap .PP If this flag is set then rclone will use anonymous memory allocated by @@ -8181,6 +8294,8 @@ This takes the following parameters .IP \[bu] 2 name \- name of remote .IP \[bu] 2 +parameters \- a map of { \[lq]key\[rq]: \[lq]value\[rq] } pairs +.IP \[bu] 2 type \- type of the new remote .PP See the config create @@ -8190,7 +8305,9 @@ more information on the above. Authentication is required for this call. .SS config/delete: Delete a remote in the config file. {#config/delete} .PP -Parameters: \- name \- name of remote to delete +Parameters: +.IP \[bu] 2 +name \- name of remote to delete .PP See the config delete command (https://rclone.org/commands/rclone_config_delete/) command for @@ -8233,6 +8350,8 @@ Authentication is required for this call. This takes the following parameters .IP \[bu] 2 name \- name of remote +.IP \[bu] 2 +parameters \- a map of { \[lq]key\[rq]: \[lq]value\[rq] } pairs .PP See the config password command (https://rclone.org/commands/rclone_config_password/) command @@ -8254,6 +8373,8 @@ Authentication is required for this call. This takes the following parameters .IP \[bu] 2 name \- name of remote +.IP \[bu] 2 +parameters \- a map of { \[lq]key\[rq]: \[lq]value\[rq] } pairs .PP See the config update command (https://rclone.org/commands/rclone_config_update/) command for @@ -8319,78 +8440,99 @@ Returns the following values: \ \ \ \ \ \ \ \ \ \ \ \ ... \ \ \ \ \ \ \ \ ] } - -###\ 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/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: \f[] .fi +.SS core/memstats: Returns the memory statistics {#core/memstats} .PP -{ \[lq]speed\[rq]: average speed in bytes/sec since start of the -process, \[lq]bytes\[rq]: total transferred bytes since the start of the -process, \[lq]errors\[rq]: number of errors, \[lq]fatalError\[rq]: -whether there has been at least one FatalError, \[lq]retryError\[rq]: -whether there has been at least one non\-NoRetryError, \[lq]checks\[rq]: -number of checked files, \[lq]transfers\[rq]: number of transferred -files, \[lq]deletes\[rq] : number of deleted files, -\[lq]elapsedTime\[rq]: time in seconds since the start of the process, -\[lq]lastError\[rq]: last occurred error, \[lq]transferring\[rq]: an -array of currently active file transfers: [ { \[lq]bytes\[rq]: total -transferred bytes for this file, \[lq]eta\[rq]: estimated time in -seconds until file transfer completion \[lq]name\[rq]: name of the file, -\[lq]percentage\[rq]: progress of the file transfer in percent, -\[lq]speed\[rq]: speed in bytes/sec, \[lq]speedAvg\[rq]: speed in -bytes/sec as an exponentially weighted moving average, \[lq]size\[rq]: -size of the file in bytes } ], \[lq]checking\[rq]: an array of names of -currently active file checks [] } +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: +.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. {#core/obscure} +.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 {#core/pid} +.PP +This returns PID of current process. +Useful for stopping rclone process. +.SS core/quit: Terminates the app. {#core/quit} +.PP +(optional) Pass an exit code to be used for terminating the app: \- +exitCode \- int +.SS core/stats: Returns stats about current transfers. {#core/stats} +.PP +This returns all available stats: +.IP +.nf +\f[C] +rclone\ rc\ core/stats +\f[] +.fi +.PP +If group is not provided then summed up stats for all groups will be +returned. +.PP +Parameters \- group \- name of the stats group (string) +.PP +Returns the following values: +.IP +.nf +\f[C] +{ +\ \ \ \ "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, +\ \ \ \ "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":\ speed\ in\ bytes/sec, +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "speedAvg":\ 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 +\ \ \ \ \ \ \ \ [] +} +\f[] +.fi +.PP +Values for \[lq]transferring\[rq], \[lq]checking\[rq] and +\[lq]lastError\[rq] are only assigned if data is available. +The value for \[lq]eta\[rq] is null if an eta cannot be determined. +.SS core/stats\-reset: Reset stats. {#core/stats\-reset} +.PP +This clears counters and errors for all stats or specific stats group if +group is provided. +.PP +Parameters \- group \- name of the stats group (string) .IP .nf \f[C] -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\-reset:\ Reset\ stats.\ {#core/stats\-reset} - -This\ clears\ counters\ and\ errors\ 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} @@ -8401,6 +8543,8 @@ This\ returns\ stats\ about\ completed\ transfers: 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) @@ -8416,10146 +8560,7770 @@ deleted), \[lq]timestamp\[rq]: integer representing millisecond unix epoch, \[lq]error\[rq]: string description of the error (empty if successfull), \[lq]jobid\[rq]: id of the job that this transfer belongs to } ] } -.SS core/version: Shows the current version of rclone and the go -runtime. {#core/version} -.PP -This shows the current version of go and the go runtime \- version \- -rclone version, eg \[lq]v1.44\[rq] \- decomposed \- version number as -[major, minor, patch, subpatch] \- note patch and subpatch will be 999 -for a git compiled version \- isGit \- boolean \- true if this was -compiled from the git version \- os \- OS in use as according to Go \- -arch \- cpu architecture in use according to Go \- goVersion \- version -of Go runtime in use -.SS job/list: Lists the IDs of the running jobs {#job/list} -.PP -Parameters \- None -.PP -Results \- jobids \- array of integer job ids -.SS job/status: Reads the status of the job ID {#job/status} -.PP -Parameters \- 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 -\[lq]2018\-10\-26T18:50:20.528746884+01:00\[rq]) \- 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 \[lq]2018\-10\-26T18:50:20.528336039+01:00\[rq]) \- -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 -.SS job/stop: Stop the running job {#job/stop} -.PP -Parameters \- jobid \- id of the job (integer) -.SS operations/about: Return the space used on the remote -{#operations/about} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.PP -The result is as returned from rclone about \[en]json -.PP -See the about command (https://rclone.org/commands/rclone_size/) command -for more information on the above. -.PP -Authentication is required for this call. -.SS operations/cleanup: Remove trashed files in the remote or path -{#operations/cleanup} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.PP -See the cleanup command (https://rclone.org/commands/rclone_cleanup/) -command for more information on the above. -.PP -Authentication is required for this call. -.SS operations/copyfile: Copy a file from source remote to destination -remote {#operations/copyfile} -.PP -This takes the following parameters -.IP \[bu] 2 -srcFs \- a remote name string eg \[lq]drive:\[rq] for the source -.IP \[bu] 2 -srcRemote \- a path within that remote eg \[lq]file.txt\[rq] for the -source -.IP \[bu] 2 -dstFs \- a remote name string eg \[lq]drive2:\[rq] for the destination -.IP \[bu] 2 -dstRemote \- a path within that remote eg \[lq]file2.txt\[rq] for the -destination -.PP -Authentication is required for this call. -.SS operations/copyurl: Copy the URL to the object {#operations/copyurl} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.IP \[bu] 2 -url \- string, URL to read from -.PP -See the copyurl command (https://rclone.org/commands/rclone_copyurl/) -command for more information on the above. -.PP -Authentication is required for this call. -.SS operations/delete: Remove files in the path {#operations/delete} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.PP -See the delete command (https://rclone.org/commands/rclone_delete/) -command for more information on the above. -.PP -Authentication is required for this call. -.SS operations/deletefile: Remove the single file pointed to -{#operations/deletefile} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.PP -See the deletefile -command (https://rclone.org/commands/rclone_deletefile/) command for -more information on the above. -.PP -Authentication is required for this call. -.SS operations/fsinfo: Return information about the remote -{#operations/fsinfo} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.PP -This returns info about the remote passed in; .IP .nf \f[C] -{ -\ \ \ \ //\ 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 -} -\f[] -.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[] -.fi -.SS operations/list: List the given remote and path in JSON format -{#operations/list} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.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 -.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 -Authentication is required for this call. -.SS operations/mkdir: Make a destination directory or container -{#operations/mkdir} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.PP -See the mkdir command (https://rclone.org/commands/rclone_mkdir/) -command for more information on the above. -.PP -Authentication is required for this call. -.SS operations/movefile: Move a file from source remote to destination -remote {#operations/movefile} -.PP -This takes the following parameters -.IP \[bu] 2 -srcFs \- a remote name string eg \[lq]drive:\[rq] for the source -.IP \[bu] 2 -srcRemote \- a path within that remote eg \[lq]file.txt\[rq] for the -source -.IP \[bu] 2 -dstFs \- a remote name string eg \[lq]drive2:\[rq] for the destination -.IP \[bu] 2 -dstRemote \- a path within that remote eg \[lq]file2.txt\[rq] for the -destination -.PP -Authentication is required for this call. -.SS operations/publiclink: Create or retrieve a public link to the given -file or folder. {#operations/publiclink} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.PP -Returns -.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 -Authentication is required for this call. -.SS operations/purge: Remove a directory or container and all of its -contents {#operations/purge} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.PP -See the purge command (https://rclone.org/commands/rclone_purge/) -command for more information on the above. -.PP -Authentication is required for this call. -.SS operations/rmdir: Remove an empty directory or container -{#operations/rmdir} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.PP -See the rmdir command (https://rclone.org/commands/rclone_rmdir/) -command for more information on the above. -.PP -Authentication is required for this call. -.SS operations/rmdirs: Remove all the empty directories in the path -{#operations/rmdirs} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:\[rq] -.IP \[bu] 2 -remote \- a path within that remote eg \[lq]dir\[rq] -.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 -Authentication is required for this call. -.SS operations/size: Count the number of bytes and files in remote -{#operations/size} -.PP -This takes the following parameters -.IP \[bu] 2 -fs \- a remote name string eg \[lq]drive:path/to/dir\[rq] -.PP -Returns -.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 -Authentication is required for this call. -.SS options/blocks: List all the option blocks {#options/blocks} -.PP -Returns \- options \- a list of the options block names -.SS options/get: Get all the options {#options/get} -.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. -.SS options/set: Set an option {#options/set} -.PP + +###\ 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.44" +\-\ decomposed\ \-\ version\ number\ as\ [major,\ minor,\ patch,\ subpatch] +\ \ \ \ \-\ note\ patch\ and\ subpatch\ will\ be\ 999\ for\ a\ git\ compiled\ version +\-\ isGit\ \-\ boolean\ \-\ true\ if\ this\ was\ compiled\ from\ the\ git\ version +\-\ os\ \-\ OS\ in\ use\ as\ according\ to\ Go +\-\ arch\ \-\ cpu\ architecture\ in\ use\ according\ to\ Go +\-\ goVersion\ \-\ version\ of\ Go\ runtime\ in\ use + +###\ 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 -.IP \[bu] 2 -option block name containing an object with -.RS 2 -.IP \[bu] 2 -key: value -.RE -.PP -Repeated as often as required. -.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) -.IP -.nf -\f[C] -rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 8}}\[aq] +\-\ 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) + +###\ 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; \f[] .fi .PP -And this sets INFO level logs (\-v) +{ // optional features and whether they are available or not +\[lq]Features\[rq]: { \[lq]About\[rq]: true, \[lq]BucketBased\[rq]: +false, \[lq]CanHaveEmptyDirectories\[rq]: true, +\[lq]CaseInsensitive\[rq]: false, \[lq]ChangeNotify\[rq]: false, +\[lq]CleanUp\[rq]: false, \[lq]Copy\[rq]: false, +\[lq]DirCacheFlush\[rq]: false, \[lq]DirMove\[rq]: true, +\[lq]DuplicateFiles\[rq]: false, \[lq]GetTier\[rq]: false, +\[lq]ListR\[rq]: false, \[lq]MergeDirs\[rq]: false, \[lq]Move\[rq]: +true, \[lq]OpenWriterAt\[rq]: true, \[lq]PublicLink\[rq]: false, +\[lq]Purge\[rq]: true, \[lq]PutStream\[rq]: true, +\[lq]PutUnchecked\[rq]: false, \[lq]ReadMimeType\[rq]: false, +\[lq]ServerSideAcrossConfigs\[rq]: false, \[lq]SetTier\[rq]: false, +\[lq]SetWrapper\[rq]: false, \[lq]UnWrap\[rq]: false, \[lq]WrapFs\[rq]: +false, \[lq]WriteMimeType\[rq]: false }, // Names of hashes available +\[lq]Hashes\[rq]: [ \[lq]MD5\[rq], \[lq]SHA\-1\[rq], +\[lq]DropboxHash\[rq], \[lq]QuickXorHash\[rq] ], \[lq]Name\[rq]: +\[lq]local\[rq], // Name as created \[lq]Precision\[rq]: 1, // Precision +of timestamps in ns \[lq]Root\[rq]: \[lq]/\[rq], // Path as created +\[lq]String\[rq]: \[lq]Local file system at /\[rq] // how the remote +will appear in logs } .IP .nf \f[C] -rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 7}}\[aq] + +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" + +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. + +###\ 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\ \[aq]{"main":\ {"LogLevel":\ 8}}\[aq] + +And\ this\ sets\ INFO\ level\ logs\ (\-v) + +\ \ \ \ rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 7}}\[aq] + +And\ this\ sets\ NOTICE\ level\ logs\ (normal\ without\ \-v) + +\ \ \ \ rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 6}}\[aq] + +###\ 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 + +###\ 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. + +###\ 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. + + + +##\ 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 \f[] .fi .PP -And this sets NOTICE level logs (normal without \-v) +{ \[lq]error\[rq]: \[lq]Expecting string value for key "remote" (was +float64)\[rq], \[lq]input\[rq]: { \[lq]fs\[rq]: \[lq]/tmp\[rq], +\[lq]remote\[rq]: 3 }, \[lq]status\[rq]: 400 \[lq]path\[rq]: +\[lq]operations/rmdir\[rq], } .IP .nf \f[C] -rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 6}}\[aq] + +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 \f[] .fi -.SS rc/error: This returns an error {#rc/error} .PP -This returns an error with the input as part of its error string. -Useful for testing error handling. -.SS rc/list: List all the registered remote control commands {#rc/list} -.PP -This lists all the registered remote control commands as a JSON map in -the commands response. -.SS rc/noop: Echo the input to the output parameters {#rc/noop} -.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. -.SS rc/noopauth: Echo the input to the output parameters requiring auth -{#rc/noopauth} -.PP -This echoes the input parameters to the output parameters for testing -purposes. -It can be used to check that rclone is still alive and to check that -parameter passing is working properly. -.PP -Authentication is required for this call. -.SS sync/copy: copy a directory from source remote to destination remote -{#sync/copy} -.PP -This takes the following parameters -.IP \[bu] 2 -srcFs \- a remote name string eg \[lq]drive:src\[rq] for the source -.IP \[bu] 2 -dstFs \- a remote name string eg \[lq]drive:dst\[rq] for the destination -.PP -See the copy command (https://rclone.org/commands/rclone_copy/) command -for more information on the above. -.PP -Authentication is required for this call. -.SS sync/move: move a directory from source remote to destination remote -{#sync/move} -.PP -This takes the following parameters -.IP \[bu] 2 -srcFs \- a remote name string eg \[lq]drive:src\[rq] for the source -.IP \[bu] 2 -dstFs \- a remote name string eg \[lq]drive:dst\[rq] 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 -Authentication is required for this call. -.SS sync/sync: sync a directory from source remote to destination remote -{#sync/sync} -.PP -This takes the following parameters -.IP \[bu] 2 -srcFs \- a remote name string eg \[lq]drive:src\[rq] for the source -.IP \[bu] 2 -dstFs \- a remote name string eg \[lq]drive:dst\[rq] for the destination -.PP -See the sync command (https://rclone.org/commands/rclone_sync/) command -for more information on the above. -.PP -Authentication is required for this call. -.SS vfs/forget: Forget files or directories in the directory cache. -{#vfs/forget} -.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. +curl \-X POST `http://localhost:5572/rc/noop?potato=1&sausage=2' .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] -.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 -.IP -.nf -\f[C] -rclone\ rc\ vfs/forget\ file=hello\ file2=goodbye\ dir=home/junk -\f[] -.fi -.SS vfs/poll\-interval: Get the status or update the value of the -poll\-interval option. {#vfs/poll\-interval} -.PP -Without any parameter given this returns the current status of the -poll\-interval setting. -.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. -.IP -.nf -\f[C] -rclone\ rc\ vfs/poll\-interval\ interval=5m -\f[] -.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. -.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. -.SS vfs/refresh: Refresh the directory cache. {#vfs/refresh} -.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. -.IP -.nf -\f[C] -rclone\ rc\ vfs/refresh -\f[] -.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[] -.fi -.PP -If the parameter recursive=true is given the whole directory tree will -get refreshed. -This refresh will use \[en]fast\-list if enabled. -.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. -.PP -All calls must made using POST. -.PP -The input objects can be supplied using URL parameters, POST parameters -or by supplying \[lq]Content\-Type: application/json\[rq] and a JSON -blob in the body. -There are examples of these below using \f[C]curl\f[]. -.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] -{ -\ \ \ \ "error":\ "Expecting\ string\ value\ for\ key\ \\"remote\\"\ (was\ float64)", -\ \ \ \ "input":\ { -\ \ \ \ \ \ \ \ "fs":\ "/tmp", -\ \ \ \ \ \ \ \ "remote":\ 3 -\ \ \ \ }, -\ \ \ \ "status":\ 400 -\ \ \ \ "path":\ "operations/rmdir", -} -\f[] -.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 -\[lq]Access\-Control\-Request\-Headers\[rq] 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] -\f[] -.fi -.PP + Response -.IP -.nf -\f[C] -{ -\ \ \ \ "potato":\ "1", -\ \ \ \ "sausage":\ "2" -} \f[] .fi .PP -Here is what an error response looks like: +{ \[lq]potato\[rq]: \[lq]1\[rq], \[lq]sausage\[rq]: \[lq]2\[rq] } .IP .nf \f[C] -curl\ \-X\ POST\ \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] -\f[] -.fi -.IP -.nf -\f[C] -{ -\ \ \ \ "error":\ "arbitrary\ error\ on\ input\ map[potato:1\ sausage:2]", -\ \ \ \ "input":\ { -\ \ \ \ \ \ \ \ "potato":\ "1", -\ \ \ \ \ \ \ \ "sausage":\ "2" -\ \ \ \ } -} + +Here\ is\ what\ an\ error\ response\ looks\ like: \f[] .fi .PP -Note that curl doesn't return errors to the shell unless you use the -\f[C]\-f\f[] option +curl \-X POST `http://localhost:5572/rc/error?potato=1&sausage=2' .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\ $? +\f[] +.fi +.PP +{ \[lq]error\[rq]: \[lq]arbitrary error on input map[potato:1 +sausage:2]\[rq], \[lq]input\[rq]: { \[lq]potato\[rq]: \[lq]1\[rq], +\[lq]sausage\[rq]: \[lq]2\[rq] } } +.IP +.nf +\f[C] + +Note\ that\ curl\ doesn\[aq]t\ return\ errors\ to\ the\ shell\ unless\ you\ use\ the\ `\-f`\ option +\f[] +.fi +.PP +$ 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 -\f[] -.fi -.SS Using POST with a form .IP .nf \f[C] -curl\ \-\-data\ "potato=1"\ \-\-data\ "sausage=2"\ http://localhost:5572/rc/noop + +###\ Using\ POST\ with\ a\ form \f[] .fi .PP +curl \[en]data \[lq]potato=1\[rq] \[en]data \[lq]sausage=2\[rq] +http://localhost:5572/rc/noop +.IP +.nf +\f[C] + Response -.IP -.nf -\f[C] -{ -\ \ \ \ "potato":\ "1", -\ \ \ \ "sausage":\ "2" -} \f[] .fi .PP -Note that you can combine these with URL parameters too with the POST -parameters taking precedence. +{ \[lq]potato\[rq]: \[lq]1\[rq], \[lq]sausage\[rq]: \[lq]2\[rq] } .IP .nf \f[C] -curl\ \-\-data\ "potato=1"\ \-\-data\ "sausage=2"\ "http://localhost:5572/rc/noop?rutabaga=3&sausage=4" + +Note\ that\ you\ can\ combine\ these\ with\ URL\ parameters\ too\ with\ the\ POST +parameters\ taking\ precedence. \f[] .fi .PP +curl \[en]data \[lq]potato=1\[rq] \[en]data \[lq]sausage=2\[rq] +\[lq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[rq] +.IP +.nf +\f[C] + Response -.IP -.nf -\f[C] -{ -\ \ \ \ "potato":\ "1", -\ \ \ \ "rutabaga":\ "3", -\ \ \ \ "sausage":\ "4" -} -\f[] -.fi -.SS Using POST with a JSON blob -.IP -.nf -\f[C] -curl\ \-H\ "Content\-Type:\ application/json"\ \-X\ POST\ \-d\ \[aq]{"potato":2,"sausage":1}\[aq]\ http://localhost:5572/rc/noop \f[] .fi .PP +{ \[lq]potato\[rq]: \[lq]1\[rq], \[lq]rutabaga\[rq]: \[lq]3\[rq], +\[lq]sausage\[rq]: \[lq]4\[rq] } +.IP +.nf +\f[C] + +###\ Using\ POST\ with\ a\ JSON\ blob +\f[] +.fi +.PP +curl \-H \[lq]Content\-Type: application/json\[rq] \-X POST \-d +`{\[lq]potato\[rq]:2,\[lq]sausage\[rq]:1}' http://localhost:5572/rc/noop +.IP +.nf +\f[C] + response -.IP -.nf -\f[C] -{ -\ \ \ \ "password":\ "xyz", -\ \ \ \ "username":\ "xyz" -} \f[] .fi .PP -This can be combined with URL parameters too if required. -The JSON blob takes precedence. +{ \[lq]password\[rq]: \[lq]xyz\[rq], \[lq]username\[rq]: \[lq]xyz\[rq] } .IP .nf \f[C] -curl\ \-H\ "Content\-Type:\ application/json"\ \-X\ POST\ \-d\ \[aq]{"potato":2,"sausage":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. \f[] .fi +.PP +curl \-H \[lq]Content\-Type: application/json\[rq] \-X POST \-d +`{\[lq]potato\[rq]:2,\[lq]sausage\[rq]:1}' +`http://localhost:5572/rc/noop?rutabaga=3&potato=4' .IP .nf \f[C] -{ -\ \ \ \ "potato":\ 2, -\ \ \ \ "rutabaga":\ "3", -\ \ \ \ "sausage":\ 1 -} \f[] .fi -.SS Debugging rclone with pprof .PP -If you use the \f[C]\-\-rc\f[] 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's memory use you can run: +{ \[lq]potato\[rq]: 2, \[lq]rutabaga\[rq]: \[lq]3\[rq], +\[lq]sausage\[rq]: 1 } .IP .nf \f[C] -go\ tool\ pprof\ \-web\ http://localhost:5572/debug/pprof/heap -\f[] -.fi -.PP -This should open a page in your browser showing what is using what + +##\ 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\[aq]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. -.PP -You can also use the \f[C]\-text\f[] flag to produce a textual summary -.IP -.nf -\f[C] -$\ 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[] -.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 -.IP -.nf -\f[C] -curl\ http://localhost:5572/debug/pprof/goroutine?debug=1 + +You\ can\ also\ use\ the\ `\-text`\ flag\ to\ produce\ a\ textual\ summary \f[] .fi .PP -Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your -browser. -.SS Other profiles to look at +$ 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[]conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main +.IP +.nf +\f[C] + +###\ 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` + +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\ ## + +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\ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | +|\ Microsoft\ Azure\ Blob\ Storage\ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | +|\ Microsoft\ OneDrive\ \ \ \ \ \ \ \ \ \ \ |\ SHA1\ ‡‡\ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | +|\ OpenDrive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | +|\ 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\ \ \ \ \ \ \ | +|\ SFTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5,\ SHA1\ ‡\ |\ Yes\ \ \ \ \ |\ Depends\ \ \ \ \ \ \ \ \ \ |\ 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\[aq]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\[aq]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\[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) + +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\ ### + +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. + +###\ 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](/local/#filenames)\ section\ for\ details. + +###\ 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\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ 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\ \ \ \ \ |\ No\ [#575](https://github.com/rclone/rclone/issues/575)\ |\ 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\ \ \ \ \ |\ No\ \ \ \ \ \ |\ 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\ | +|\ Microsoft\ Azure\ Blob\ Storage\ |\ Yes\ \ \ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ No\ | +|\ Microsoft\ OneDrive\ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ [#575](https://github.com/rclone/rclone/issues/575)\ |\ 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\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ 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\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ No\ | +|\ SFTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ \ |\ Yes\ | +|\ 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\ and\ Hubic\ 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. + +‡\ 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\[aq]t\ support\ `Move`\ directly. + +If\ the\ server\ doesn\[aq]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\[aq]t\ support\ `DirMove`. + +If\ the\ server\ isn\[aq]t\ capable\ of\ `Move`\ then\ rclone\ simulates\ it\ with +`Copy`\ then\ delete.\ \ If\ the\ server\ doesn\[aq]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\[aq]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\[aq]t\ do\ `CleanUp`\ then\ `rclone\ cleanup`\ will\ return\ an +error. + +###\ 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](/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\[aq]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\[aq]t\ do\ `About`\ then\ `rclone\ about`\ will\ return\ an +error. + +###\ EmptyDir\ ### + +The\ remote\ supports\ empty\ directories.\ See\ [Limitations](/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. +\f[] +.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. +\ \ \-\-ca\-cert\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ CA\ certificate\ used\ to\ verify\ servers +\ \ \-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching.\ (default\ "$HOME/.cache/rclone") +\ \ \-\-checkers\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Number\ of\ checkers\ to\ run\ in\ parallel.\ (default\ 8) +\f[] +.fi .PP -You can see a summary of profiles available at -http://localhost:5572/debug/pprof/ +\-c, \[en]checksum Skip based on checksum (if available) & size, not +mod\-time & size \[en]client\-cert string Client SSL certificate (PEM) +for mutual TLS auth \[en]client\-key string Client SSL private key (PEM) +for mutual TLS auth \[en]compare\-dest string use DIR to server side +copy flies from. +\[en]config string Config file. +(default \[lq]$HOME/.config/rclone/rclone.conf\[rq]) \[en]contimeout +duration Connect timeout (default 1m0s) \[en]copy\-dest string Compare +dest to DIR also. +\[en]cpuprofile string Write cpu profile to file \[en]delete\-after When +synchronizing, delete files on destination after transferring (default) +\[en]delete\-before When synchronizing, delete files on destination +before transferring \[en]delete\-during When synchronizing, delete files +during transfer \[en]delete\-excluded Delete files on dest excluded from +sync \[en]disable string Disable a comma separated list of features. +Use help to see a list. +\-n, \[en]dry\-run Do a trial run with no permanent changes \[en]dump +DumpFlags List of items to dump from: +headers,bodies,requests,responses,auth,filters,goroutines,openfiles +\[en]dump\-bodies Dump HTTP headers and bodies \- may contain sensitive +info \[en]dump\-headers Dump HTTP headers \- may contain sensitive info +\[en]exclude stringArray Exclude files matching pattern +\[en]exclude\-from stringArray Read exclude patterns from file +\[en]exclude\-if\-present string Exclude directories if filename is +present \[en]fast\-list Use recursive list if available. +Uses more memory but fewer transactions. +\[en]files\-from stringArray Read list of source\-file names from file +\-f, \[en]filter stringArray Add a file\-filtering rule +\[en]filter\-from stringArray Read filtering patterns from a file +\[en]ignore\-case Ignore case in filters (case insensitive) +\[en]ignore\-case\-sync Ignore case when synchronizing +\[en]ignore\-checksum Skip post copy check of checksums. +\[en]ignore\-errors delete even if there are I/O errors +\[en]ignore\-existing Skip all files that exist on destination +\[en]ignore\-size Ignore size when skipping use mod\-time or checksum. +\-I, \[en]ignore\-times Don't skip files that match size and time \- +transfer all files \[en]immutable Do not modify files. +Fail if existing files have been modified. +\[en]include stringArray Include files matching pattern +\[en]include\-from stringArray Read include patterns from file +\[en]log\-file string Log everything to this file \[en]log\-format +string Comma separated list of log format options (default +\[lq]date,time\[rq]) \[en]log\-level string Log level +DEBUG|INFO|NOTICE|ERROR (default \[lq]NOTICE\[rq]) +\[en]low\-level\-retries int Number of low level retries to do. +(default 10) \[en]max\-age Duration Only transfer files younger than +this in s or suffix ms|s|m|h|d|w|M|y (default off) \[en]max\-backlog int +Maximum number of objects in sync or check backlog. +(default 10000) \[en]max\-delete int When synchronizing, limit the +number of deletes (default \-1) \[en]max\-depth int If set limits the +recursion depth to this. +(default \-1) \[en]max\-size SizeSuffix Only transfer files smaller than +this in k or suffix b|k|M|G (default off) \[en]max\-stats\-groups int +Maximum number of stats groups to keep in memory. +On max oldest is discarded. +(default 1000) \[en]max\-transfer SizeSuffix Maximum size of data to +transfer. +(default off) \[en]memprofile string Write memory profile to file +\[en]min\-age Duration Only transfer files older than this in s or +suffix ms|s|m|h|d|w|M|y (default off) \[en]min\-size SizeSuffix Only +transfer files bigger than this in k or suffix b|k|M|G (default off) +\[en]modify\-window duration Max time diff to be considered the same +(default 1ns) \[en]multi\-thread\-cutoff SizeSuffix Use multi\-thread +downloads for files above this size. +(default 250M) \[en]multi\-thread\-streams int Max number of streams to +use for multi\-thread downloads. +(default 4) \[en]no\-check\-certificate Do not verify the server SSL +certificate. +Insecure. +\[en]no\-gzip\-encoding Don't set Accept\-Encoding: gzip. +\[en]no\-traverse Don't traverse destination file system on copy. +\[en]no\-update\-modtime Don't update destination mod\-time if files +identical. +\-P, \[en]progress Show progress during transfer. +\-q, \[en]quiet Print as little stuff as possible \[en]rc Enable the +remote control server. +\[en]rc\-addr string IPaddress:Port or :Port to bind server to. +(default \[lq]localhost:5572\[rq]) \[en]rc\-allow\-origin string Set the +allowed origin for CORS. +\[en]rc\-baseurl string Prefix for URLs \- leave blank for root. +\[en]rc\-cert string SSL PEM key (concatenation of certificate and CA +certificate) \[en]rc\-client\-ca string Client certificate authority to +verify clients with \[en]rc\-files string Path to local files to serve +on the HTTP server. +\[en]rc\-htpasswd string htpasswd file \- if not provided no +authentication is done \[en]rc\-job\-expire\-duration duration expire +finished async jobs older than this value (default 1m0s) +\[en]rc\-job\-expire\-interval duration interval to check for expired +async jobs (default 10s) \[en]rc\-key string SSL PEM Private key +\[en]rc\-max\-header\-bytes int Maximum size of request header (default +4096) \[en]rc\-no\-auth Don't require auth for certain methods. +\[en]rc\-pass string Password for authentication. +\[en]rc\-realm string realm for authentication (default +\[lq]rclone\[rq]) \[en]rc\-serve Enable the serving of remote objects. +\[en]rc\-server\-read\-timeout duration Timeout for server reading data +(default 1h0m0s) \[en]rc\-server\-write\-timeout duration Timeout for +server writing data (default 1h0m0s) \[en]rc\-user string User name for +authentication. +\[en]rc\-web\-fetch\-url string URL to fetch the releases for webgui. +(default +\[lq]https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest\[rq]) +\[en]rc\-web\-gui Launch WebGUI on localhost \[en]rc\-web\-gui\-update +Update / Force update to latest version of web gui \[en]retries int +Retry operations this many times if they fail (default 3) +\[en]retries\-sleep duration Interval between retrying operations if +they fail, e.g 500ms, 60s, 5m. +(0 to disable) \[en]size\-only Skip based on size only, not mod\-time or +checksum \[en]stats duration Interval between printing stats, e.g 500ms, +60s, 5m. +(0 to disable) (default 1m0s) \[en]stats\-file\-name\-length int Max +file name length in stats. +0 for no limit (default 45) \[en]stats\-log\-level string Log level to +show \[en]stats output DEBUG|INFO|NOTICE|ERROR (default \[lq]INFO\[rq]) +\[en]stats\-one\-line Make the stats fit on one line. +\[en]stats\-one\-line\-date Enables \[en]stats\-one\-line and add +current date/time prefix. +\[en]stats\-one\-line\-date\-format string Enables +\[en]stats\-one\-line\-date and uses custom formatted date. +Enclose date string in double quotes (\[lq]). See +https://golang.org/pkg/time/#Time.Format \[en]stats\-unit string Show +data rate in stats as either `bits' or `bytes'/s +(default\[rq]bytes\[lq]) \[en]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) +\[en]suffix string Suffix to add to changed files. +\[en]suffix\-keep\-extension Preserve the extension when using +\[en]suffix. \[en]syslog Use Syslog for logging \[en]syslog\-facility +string Facility for syslog, eg KERN,USER,\&... (default\[rq]DAEMON\[lq]) +\[en]timeout duration IO idle timeout (default 5m0s) \[en]tpslimit float +Limit HTTP transactions per second to this. \[en]tpslimit\-burst int Max +burst of transactions for \[en]tpslimit. (default 1) \[en]track\-renames +When synchronizing, track file renames and do a server side move if +possible \[en]transfers int Number of file transfers to run in parallel. +(default 4) \-u, \[en]update Skip files that are newer on the +destination. \[en]use\-cookies Enable session cookiejar. +\[en]use\-json\-log Use json log format. \[en]use\-mmap Use mmap +allocator (see docs). \[en]use\-server\-modtime Use server modified time +instead of object metadata \[en]user\-agent string Set the user\-agent +to a specified string. The default is rclone/ version +(default\[rq]rclone/v1.50.0") \-v, \[en]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[] +.fi +.IP +.nf +\f[C] +\ \ \-\-acd\-auth\-url\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Auth\ server\ URL. +\ \ \-\-acd\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Amazon\ Application\ Client\ ID. +\ \ \-\-acd\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Amazon\ Application\ Client\ Secret. +\ \ \-\-acd\-templink\-threshold\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ Files\ >=\ this\ size\ will\ be\ downloaded\ via\ their\ tempLink.\ (default\ 9G) +\ \ \-\-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\-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\-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\-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\-endpoint\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Endpoint\ for\ the\ service. +\ \ \-\-b2\-hard\-delete\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Permanently\ delete\ files\ on\ remote\ removal,\ otherwise\ hide\ files. +\ \ \-\-b2\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Application\ Key +\ \ \-\-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\-box\-config\-file\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ config.json\ location +\ \ \-\-box\-box\-sub\-type\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ (default\ "user") +\ \ \-\-box\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ Client\ Id. +\ \ \-\-box\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ Client\ Secret +\ \ \-\-box\-commit\-retries\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Max\ number\ of\ times\ to\ try\ committing\ a\ multipart\ file.\ (default\ 100) +\ \ \-\-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\ verifications\ when\ connecting\ to\ the\ Plex\ server +\ \ \-\-cache\-plex\-password\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ password\ of\ the\ Plex\ user +\ \ \-\-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) +\f[] +.fi .PP -Here is how to use some of them: -.IP \[bu] 2 -Memory: \f[C]go\ tool\ pprof\ http://localhost:5572/debug/pprof/heap\f[] -.IP \[bu] 2 -Go routines: -\f[C]curl\ http://localhost:5572/debug/pprof/goroutine?debug=1\f[] -.IP \[bu] 2 -30\-second CPU profile: -\f[C]go\ tool\ pprof\ http://localhost:5572/debug/pprof/profile\f[] -.IP \[bu] 2 -5\-second execution trace: -\f[C]wget\ http://localhost:5572/debug/pprof/trace?seconds=5\f[] -.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'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. -.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{ +\-L, \[en]copy\-links Follow symlinks and copy the pointed to item. +\[en]crypt\-directory\-name\-encryption Option to either encrypt +directory names or leave them intact. +(default true) \[en]crypt\-filename\-encryption string How to encrypt +the filenames. +(default \[lq]standard\[rq]) \[en]crypt\-password string Password or +pass phrase for encryption. +\[en]crypt\-password2 string Password or pass phrase for salt. +Optional but recommended. +\[en]crypt\-remote string Remote to encrypt/decrypt. +\[en]crypt\-show\-mapping For all files listed show how the names +encrypt. +\[en]drive\-acknowledge\-abuse Set to allow files which return +cannotDownloadAbusiveFile to be downloaded. +\[en]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. +\[en]drive\-alternate\-export Use alternate export URLs for google +documents export., \[en]drive\-auth\-owner\-only Only consider files +owned by the authenticated user. +\[en]drive\-chunk\-size SizeSuffix Upload chunk size. +Must a power of 2 >= 256k. +(default 8M) \[en]drive\-client\-id string Google Application Client Id +\[en]drive\-client\-secret string Google Application Client Secret +\[en]drive\-disable\-http2 Disable drive using http2 (default true) +\[en]drive\-export\-formats string Comma separated list of preferred +formats for downloading Google docs. +(default \[lq]docx,xlsx,pptx,svg\[rq]) \[en]drive\-formats string +Deprecated: see export_formats \[en]drive\-impersonate string +Impersonate this user when using a service account. +\[en]drive\-import\-formats string Comma separated list of preferred +formats for uploading Google docs. +\[en]drive\-keep\-revision\-forever Keep new head revision of each file +forever. +\[en]drive\-list\-chunk int Size of listing chunk 100\-1000. +0 to disable. +(default 1000) \[en]drive\-pacer\-burst int Number of API calls to allow +without sleeping. +(default 100) \[en]drive\-pacer\-min\-sleep Duration Minimum time to +sleep between API calls. +(default 100ms) \[en]drive\-root\-folder\-id string ID of the root +folder \[en]drive\-scope string Scope that rclone should use when +requesting access from drive. +\[en]drive\-server\-side\-across\-configs Allow server side operations +(eg copy) to work across different drive configs. +\[en]drive\-service\-account\-credentials string Service Account +Credentials JSON blob \[en]drive\-service\-account\-file string Service +Account Credentials JSON file path \[en]drive\-shared\-with\-me Only +show files that are shared with me. +\[en]drive\-size\-as\-quota Show storage quota usage for file size. +\[en]drive\-skip\-checksum\-gphotos Skip MD5 checksum on Google photos +and videos only. +\[en]drive\-skip\-gdocs Skip google documents in all listings. +\[en]drive\-team\-drive string ID of the Team Drive +\[en]drive\-trashed\-only Only show files that are in the trash. +\[en]drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked +upload (default 8M) \[en]drive\-use\-created\-date Use file created date +instead of modified date., \[en]drive\-use\-trash Send files to the +trash instead of deleting permanently. +(default true) \[en]drive\-v2\-download\-min\-size SizeSuffix If +Object's are greater, use drive v2 API to download. +(default off) \[en]dropbox\-chunk\-size SizeSuffix Upload chunk size. +(< 150M). +(default 48M) \[en]dropbox\-client\-id string Dropbox App Client Id +\[en]dropbox\-client\-secret string Dropbox App Client Secret +\[en]dropbox\-impersonate string Impersonate this user when using a +business account. +\[en]fichier\-api\-key string Your API Key, get it from +https://1fichier.com/console/params.pl \[en]fichier\-shared\-folder +string If you want to download a shared folder, add this parameter +\[en]ftp\-concurrency int Maximum number of FTP simultaneous +connections, 0 for unlimited \[en]ftp\-disable\-epsv Disable using EPSV +even if server advertises support \[en]ftp\-host string FTP host to +connect to \[en]ftp\-no\-check\-certificate Do not verify the TLS +certificate of the server \[en]ftp\-pass string FTP password +\[en]ftp\-port string FTP port, leave blank to use default (21) +\[en]ftp\-tls Use FTP over TLS (Implicit) \[en]ftp\-user string FTP +username, leave blank for current username, $USER \[en]gcs\-bucket\-acl +string Access Control List for new buckets. +\[en]gcs\-bucket\-policy\-only Access checks should use bucket\-level +IAM policies. +\[en]gcs\-client\-id string Google Application Client Id +\[en]gcs\-client\-secret string Google Application Client Secret +\[en]gcs\-location string Location for the newly created buckets. +\[en]gcs\-object\-acl string Access Control List for new objects. +\[en]gcs\-project\-number string Project number. +\[en]gcs\-service\-account\-file string Service Account Credentials JSON +file path \[en]gcs\-storage\-class string The storage class to use when +storing objects in Google Cloud Storage. +\[en]gphotos\-client\-id string Google Application Client Id +\[en]gphotos\-client\-secret string Google Application Client Secret +\[en]gphotos\-read\-only Set to make the Google Photos backend read +only. +\[en]gphotos\-read\-size Set to read the size of media items. +\[en]http\-headers CommaSepList Set HTTP headers for all transactions +\[en]http\-no\-head Don't use HEAD requests to find file sizes in dir +listing \[en]http\-no\-slash Set this if the site doesn't end +directories with / \[en]http\-url string URL of http host to connect to +\[en]hubic\-chunk\-size SizeSuffix Above this size files will be chunked +into a _segments container. +(default 5G) \[en]hubic\-client\-id string Hubic Client Id +\[en]hubic\-client\-secret string Hubic Client Secret +\[en]hubic\-no\-chunk Don't chunk files during streaming upload. +\[en]jottacloud\-hard\-delete Delete files permanently rather than +putting them into the trash. +\[en]jottacloud\-md5\-memory\-limit SizeSuffix Files bigger than this +will be cached on disk to calculate the MD5 if required. +(default 10M) \[en]jottacloud\-unlink Remove existing public link to +file/folder with link command rather than creating. +\[en]jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this +can be resumed if the upload fail's. +(default 10M) \[en]koofr\-endpoint string The Koofr API endpoint to use +(default \[lq]https://app.koofr.net\[rq]) \[en]koofr\-mountid string +Mount ID of the mount to use. +If omitted, the primary mount is used. +\[en]koofr\-password string Your Koofr password for rclone (generate one +at https://app.koofr.net/app/admin/preferences/password) +\[en]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) \[en]koofr\-user string Your Koofr user name \-l, +\[en]links Translate symlinks to/from regular files with a `.rclonelink' +extension \[en]local\-case\-insensitive Force the filesystem to report +itself as case insensitive \[en]local\-case\-sensitive Force the +filesystem to report itself as case sensitive. +\[en]local\-no\-check\-updated Don't check to see if the files change +during upload \[en]local\-no\-unicode\-normalization Don't apply unicode +normalization to paths and filenames (Deprecated) \[en]local\-nounc +string Disable UNC (long path names) conversion on Windows +\[en]mailru\-check\-hash What should copy do if file checksum is +mismatched or invalid (default true) \[en]mailru\-pass string Password +\[en]mailru\-speedup\-enable Skip full upload if there is another file +with same data hash. +(default true) \[en]mailru\-speedup\-file\-patterns string Comma +separated list of file name patterns eligible for speedup (put by hash). +(default +\[lq]\f[I].mkv,\f[].avi,\f[I].mp4,\f[].mp3,\f[I].zip,\f[].gz,\f[I].rar,\f[].pdf\[rq]) +\[en]mailru\-speedup\-max\-disk SizeSuffix This option allows you to +disable speedup (put by hash) for large files (default 3G) +\[en]mailru\-speedup\-max\-memory SizeSuffix Files larger than the size +given below will always be hashed on disk. +(default 32M) \[en]mailru\-user string User name (usually email) +\[en]mega\-debug Output more debug from Mega. +\[en]mega\-hard\-delete Delete files permanently rather than putting +them into the trash. +\[en]mega\-pass string Password. +\[en]mega\-user string User name \-x, \[en]one\-file\-system Don't cross +filesystem boundaries (unix/macOS only). +\[en]onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- +must be multiple of 320k (327,680 bytes). +(default 10M) \[en]onedrive\-client\-id string Microsoft App Client Id +\[en]onedrive\-client\-secret string Microsoft App Client Secret +\[en]onedrive\-drive\-id string The ID of the drive to use +\[en]onedrive\-drive\-type string The type of the drive ( personal | +business | documentLibrary ) \[en]onedrive\-expose\-onenote\-files Set +to make OneNote files show up in directory listings. +\[en]opendrive\-password string Password. +\[en]opendrive\-username string Username \[en]pcloud\-client\-id string +Pcloud App Client Id \[en]pcloud\-client\-secret string Pcloud App +Client Secret \[en]qingstor\-access\-key\-id string QingStor Access Key +ID \[en]qingstor\-chunk\-size SizeSuffix Chunk size to use for +uploading. +(default 4M) \[en]qingstor\-connection\-retries int Number of connection +retries. +(default 3) \[en]qingstor\-endpoint string Enter a endpoint URL to +connection QingStor API. +\[en]qingstor\-env\-auth Get QingStor credentials from runtime. +Only applies if access_key_id and secret_access_key is blank. +\[en]qingstor\-secret\-access\-key string QingStor Secret Access Key +(password) \[en]qingstor\-upload\-concurrency int Concurrency for +multipart uploads. +(default 1) \[en]qingstor\-upload\-cutoff SizeSuffix Cutoff for +switching to chunked upload (default 200M) \[en]qingstor\-zone string +Zone to connect to. +\[en]s3\-access\-key\-id string AWS Access Key ID. +\[en]s3\-acl string Canned ACL used when creating buckets and storing or +copying objects. +\[en]s3\-bucket\-acl string Canned ACL used when creating buckets. +\[en]s3\-chunk\-size SizeSuffix Chunk size to use for uploading. +(default 5M) \[en]s3\-disable\-checksum Don't store MD5 checksum with +object metadata \[en]s3\-endpoint string Endpoint for S3 API. +\[en]s3\-env\-auth Get AWS credentials from runtime (environment +variables or EC2/ECS meta data if no env vars). +\[en]s3\-force\-path\-style If true use path style access if false use +virtual hosted style. +(default true) \[en]s3\-leave\-parts\-on\-error If true avoid calling +abort upload on a failure, leaving all successfully uploaded parts on S3 +for manual recovery. +\[en]s3\-location\-constraint string Location constraint \- must be set +to match the Region. +\[en]s3\-provider string Choose your S3 provider. +\[en]s3\-region string Region to connect to. +\[en]s3\-secret\-access\-key string AWS Secret Access Key (password) +\[en]s3\-server\-side\-encryption string The server\-side encryption +algorithm used when storing this object in S3. +\[en]s3\-session\-token string An AWS session token +\[en]s3\-sse\-kms\-key\-id string If using KMS ID you must provide the +ARN of Key. +\[en]s3\-storage\-class string The storage class to use when storing new +objects in S3. +\[en]s3\-upload\-concurrency int Concurrency for multipart uploads. +(default 4) \[en]s3\-upload\-cutoff SizeSuffix Cutoff for switching to +chunked upload (default 200M) \[en]s3\-use\-accelerate\-endpoint If true +use the AWS S3 accelerated endpoint. +\[en]s3\-v2\-auth If true use v2 authentication. +\[en]sftp\-ask\-password Allow asking for SFTP password when needed. +\[en]sftp\-disable\-hashcheck Disable the execution of SSH commands to +determine if remote file hashing is available. +\[en]sftp\-host string SSH host to connect to \[en]sftp\-key\-file +string Path to PEM\-encoded private key file, leave blank or set +key\-use\-agent to use ssh\-agent. +\[en]sftp\-key\-file\-pass string The passphrase to decrypt the +PEM\-encoded private key file. +\[en]sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. +\[en]sftp\-md5sum\-command string The command used to read md5 hashes. +Leave blank for autodetect. +\[en]sftp\-pass string SSH password, leave blank to use ssh\-agent. +\[en]sftp\-path\-override string Override path used by SSH connection. +\[en]sftp\-port string SSH port, leave blank to use default (22) +\[en]sftp\-set\-modtime Set the modified time on the remote if set. +(default true) \[en]sftp\-sha1sum\-command string The command used to +read sha1 hashes. +Leave blank for autodetect. +\[en]sftp\-use\-insecure\-cipher Enable the use of insecure ciphers and +key exchange methods. +\[en]sftp\-user string SSH username, leave blank for current username, +ncw \[en]sharefile\-chunk\-size SizeSuffix Upload chunk size. +Must a power of 2 >= 256k. +(default 64M) \[en]sharefile\-endpoint string Endpoint for API calls. +\[en]sharefile\-root\-folder\-id string ID of the root folder +\[en]sharefile\-upload\-cutoff SizeSuffix Cutoff for switching to +multipart upload. +(default 128M) \[en]skip\-links Don't warn about skipped symlinks. +\[en]swift\-application\-credential\-id string Application Credential ID +(OS_APPLICATION_CREDENTIAL_ID) \[en]swift\-application\-credential\-name +string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) +\[en]swift\-application\-credential\-secret string Application +Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) \[en]swift\-auth +string Authentication URL for server (OS_AUTH_URL). +\[en]swift\-auth\-token string Auth Token from alternate authentication +\- optional (OS_AUTH_TOKEN) \[en]swift\-auth\-version int AuthVersion \- +optional \- set to (1,2,3) if your auth URL has no version +(ST_AUTH_VERSION) \[en]swift\-chunk\-size SizeSuffix Above this size +files will be chunked into a _segments container. +(default 5G) \[en]swift\-domain string User domain \- optional (v3 auth) +(OS_USER_DOMAIN_NAME) \[en]swift\-endpoint\-type string Endpoint type to +choose from the service catalogue (OS_ENDPOINT_TYPE) (default +\[lq]public\[rq]) \[en]swift\-env\-auth Get swift credentials from +environment variables in standard OpenStack form. +\[en]swift\-key string API key or password (OS_PASSWORD). +\[en]swift\-no\-chunk Don't chunk files during streaming upload. +\[en]swift\-region string Region name \- optional (OS_REGION_NAME) +\[en]swift\-storage\-policy string The storage policy to use when +creating a new container \[en]swift\-storage\-url string Storage URL \- +optional (OS_STORAGE_URL) \[en]swift\-tenant string Tenant name \- +optional for v1 auth, this or tenant_id required otherwise +(OS_TENANT_NAME or OS_PROJECT_NAME) \[en]swift\-tenant\-domain string +Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) +\[en]swift\-tenant\-id string Tenant ID \- optional for v1 auth, this or +tenant required otherwise (OS_TENANT_ID) \[en]swift\-user string User +name to log in (OS_USERNAME). +\[en]swift\-user\-id string User ID to log in \- optional \- most swift +systems use user and leave this blank (v3 auth) (OS_USER_ID). +\[en]union\-remotes string List of space separated remotes. +\[en]webdav\-bearer\-token string Bearer token instead of user/pass (eg +a Macaroon) \[en]webdav\-bearer\-token\-command string Command to run to +get a bearer token \[en]webdav\-pass string Password. +\[en]webdav\-url string URL of http host to connect to \[en]webdav\-user +string User name \[en]webdav\-vendor string Name of the Webdav +site/service/software you are using \[en]yandex\-client\-id string +Yandex Client Id \[en]yandex\-client\-secret string Yandex Client Secret +\[en]yandex\-unlink Remove existing public link to file/folder with link +command rather than creating. +.IP +.nf +\f[C] + 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{ -Dropbox -T}@T{ -DBHASH † -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{ -Mega -T}@T{ -\- -T}@T{ -No -T}@T{ -No -T}@T{ -Yes -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 ‡‡ -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{ -No -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{ -SFTP -T}@T{ -MD5, SHA1 ‡ -T}@T{ -Yes -T}@T{ -Depends -T}@T{ -No -T}@T{ -\- -T} -T{ -WebDAV -T}@T{ -MD5, SHA1 †† -T}@T{ -Yes ††† -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 \f[C]\-\-checksum\f[] flag in syncs and in -the \f[C]check\f[] command. -.PP -To use the verify checksums when transferring between cloud storage -systems they must support a common hash type. -.PP -† 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. -.PP -‡ SFTP supports checksums if the same login has shell access and -\f[C]md5sum\f[] or \f[C]sha1sum\f[] as well as \f[C]echo\f[] are in the -remote's PATH. -.PP -†† WebDAV supports hashes when used with Owncloud and Nextcloud only. -.PP -††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. -.PP -‡‡ 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). -.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[] 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. -.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[] and -\f[C]FILE.txt\f[]. -If a cloud storage system is case insensitive then that isn'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't cause any problems as people tend to avoid -files whose name differs only by case even on case sensitive systems. -.SS Duplicate files -.PP -If a cloud storage system allows duplicate files then it can have two -objects with the same name. -.PP -This confuses rclone greatly when syncing \- use the -\f[C]rclone\ dedupe\f[] command to rename or remove duplicates. -.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[] or -\f[C]application/pdf\f[]. -.PP -Some cloud storage systems support reading (\f[C]R\f[]) the MIME type of -objects and some support writing (\f[C]W\f[]) 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[]) to -a remote which supports writing (\f[C]W\f[]) 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. -.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{ -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{ -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{ -No #575 (https://github.com/rclone/rclone/issues/575) -T}@T{ -No -T}@T{ -Yes -T}@T{ -Yes -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 † -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{ -No -T}@T{ -Yes -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{ -Microsoft Azure Blob Storage -T}@T{ -Yes -T}@T{ -Yes -T}@T{ -No -T}@T{ -No -T}@T{ -No -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{ -Microsoft OneDrive -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{ -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 † -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{ -No #2178 (https://github.com/rclone/rclone/issues/2178) -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{ -No -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{ -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{ -WebDAV -T}@T{ -Yes -T}@T{ -Yes -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{ -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 -† Note Swift and Hubic 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. -.PP -‡ StreamUpload is not supported with Nextcloud -.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[] or \f[C]rclone\ move\f[] if -the remote doesn't support \f[C]Move\f[] directly. -.PP -If the server doesn't support \f[C]Copy\f[] 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[] if the server doesn't support -\f[C]DirMove\f[]. -.PP -If the server isn't capable of \f[C]Move\f[] then rclone simulates it -with \f[C]Copy\f[] then delete. -If the server doesn't support \f[C]Copy\f[] then rclone will download -the file and re\-upload it. -.SS DirMove -.PP -This is used to implement \f[C]rclone\ move\f[] to move a directory if -possible. -If it isn't then it will use \f[C]Move\f[] on each file (which falls -back to \f[C]Copy\f[] then download and upload \- see \f[C]Move\f[] -section). -.SS CleanUp -.PP -This is used for emptying the trash for a remote by -\f[C]rclone\ cleanup\f[]. -.PP -If the server can't do \f[C]CleanUp\f[] then \f[C]rclone\ cleanup\f[] -will return an error. -.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[] flag to work. -See the rclone docs (/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[]. -.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'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. -.PP -This is also used to return the space used, available for -\f[C]rclone\ mount\f[]. -.PP -If the server can't do \f[C]About\f[] then \f[C]rclone\ about\f[] will -return an error. -.SS EmptyDir -.PP -The remote supports empty directories. -See Limitations (/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. -.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. -\ \ \ \ \ \ \-\-ca\-cert\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ CA\ certificate\ used\ to\ verify\ servers -\ \ \ \ \ \ \-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching.\ (default\ "$HOME/.cache/rclone") -\ \ \ \ \ \ \-\-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\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ use\ DIR\ to\ server\ side\ copy\ flies\ from. -\ \ \ \ \ \ \-\-config\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Config\ file.\ (default\ "$HOME/.config/rclone/rclone.conf") -\ \ \ \ \ \ \-\-contimeout\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Connect\ timeout\ (default\ 1m0s) -\ \ \ \ \ \ \-\-copy\-dest\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Compare\ dest\ to\ DIR\ also. -\ \ \ \ \ \ \-\-cpuprofile\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Write\ cpu\ profile\ to\ file -\ \ \ \ \ \ \-\-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 -\ \ \ \ \ \ \-\-exclude\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Exclude\ files\ matching\ pattern -\ \ \ \ \ \ \-\-exclude\-from\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ Read\ exclude\ patterns\ from\ file -\ \ \ \ \ \ \-\-exclude\-if\-present\ string\ \ \ \ \ \ \ \ \ \ \ \ Exclude\ directories\ if\ filename\ is\ present -\ \ \ \ \ \ \-\-fast\-list\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ recursive\ list\ if\ available.\ Uses\ more\ memory\ but\ fewer\ transactions. -\ \ \ \ \ \ \-\-files\-from\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Read\ list\ of\ source\-file\ names\ from\ file -\ \ \-f,\ \-\-filter\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Add\ a\ file\-filtering\ rule -\ \ \ \ \ \ \-\-filter\-from\ stringArray\ \ \ \ \ \ \ \ \ \ \ \ \ \ Read\ filtering\ patterns\ from\ a\ file -\ \ \ \ \ \ \-\-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 -\ \ \ \ \ \ \-\-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\-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\-gzip\-encoding\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ set\ Accept\-Encoding:\ gzip. -\ \ \ \ \ \ \-\-no\-traverse\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ traverse\ destination\ file\ system\ on\ copy. -\ \ \ \ \ \ \-\-no\-update\-modtime\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ update\ destination\ mod\-time\ if\ files\ identical. -\ \ \-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\-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\ "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\-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\-update\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Update\ /\ Force\ update\ to\ latest\ version\ of\ web\ gui -\ \ \ \ \ \ \-\-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\ \[aq]bits\[aq]\ or\ \[aq]bytes\[aq]/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 -\ \ \ \ \ \ \-\-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.49.0") -\ \ \-v,\ \-\-verbose\ count\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Print\ lots\ more\ stuff\ (repeat\ for\ more) -\f[] -.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\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Amazon\ Application\ Client\ ID. -\ \ \ \ \ \ \-\-acd\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Amazon\ Application\ Client\ Secret. -\ \ \ \ \ \ \-\-acd\-templink\-threshold\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ Files\ >=\ this\ size\ will\ be\ downloaded\ via\ their\ tempLink.\ (default\ 9G) -\ \ \ \ \ \ \-\-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\-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\-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\-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\-endpoint\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Endpoint\ for\ the\ service. -\ \ \ \ \ \ \-\-b2\-hard\-delete\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Permanently\ delete\ files\ on\ remote\ removal,\ otherwise\ hide\ files. -\ \ \ \ \ \ \-\-b2\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Application\ Key -\ \ \ \ \ \ \-\-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\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ Client\ Id. -\ \ \ \ \ \ \-\-box\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ Client\ Secret -\ \ \ \ \ \ \-\-box\-commit\-retries\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Max\ number\ of\ times\ to\ try\ committing\ a\ multipart\ file.\ (default\ 100) -\ \ \ \ \ \ \-\-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\ verifications\ when\ connecting\ to\ the\ Plex\ server -\ \ \ \ \ \ \-\-cache\-plex\-password\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ password\ of\ the\ Plex\ user -\ \ \ \ \ \ \-\-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 -\ \ \-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. -\ \ \ \ \ \ \-\-crypt\-password2\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password\ or\ pass\ phrase\ for\ salt.\ Optional\ but\ recommended. -\ \ \ \ \ \ \-\-crypt\-remote\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Remote\ to\ encrypt/decrypt. -\ \ \ \ \ \ \-\-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\-alternate\-export\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ alternate\ export\ URLs\ for\ google\ documents\ export., -\ \ \ \ \ \ \-\-drive\-auth\-owner\-only\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Only\ consider\ files\ owned\ by\ the\ authenticated\ user. -\ \ \ \ \ \ \-\-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\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Google\ Application\ Client\ Secret -\ \ \ \ \ \ \-\-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\ storage\ quota\ usage\ for\ file\ size. -\ \ \ \ \ \ \-\-drive\-skip\-checksum\-gphotos\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Skip\ MD5\ checksum\ on\ Google\ photos\ and\ videos\ only. -\ \ \ \ \ \ \-\-drive\-skip\-gdocs\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Skip\ google\ documents\ in\ all\ listings. -\ \ \ \ \ \ \-\-drive\-team\-drive\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ID\ of\ the\ Team\ Drive -\ \ \ \ \ \ \-\-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\-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\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Upload\ chunk\ size.\ (<\ 150M).\ (default\ 48M) -\ \ \ \ \ \ \-\-dropbox\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Dropbox\ App\ Client\ Id -\ \ \ \ \ \ \-\-dropbox\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Dropbox\ App\ Client\ Secret -\ \ \ \ \ \ \-\-dropbox\-impersonate\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Impersonate\ this\ user\ when\ using\ a\ business\ account. -\ \ \ \ \ \ \-\-fichier\-api\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Your\ API\ Key,\ get\ it\ from\ https://1fichier.com/console/params.pl -\ \ \ \ \ \ \-\-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\-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 -\ \ \ \ \ \ \-\-ftp\-port\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ FTP\ port,\ leave\ blank\ to\ use\ default\ (21) -\ \ \ \ \ \ \-\-ftp\-tls\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Use\ FTP\ over\ TLS\ (Implicit) -\ \ \ \ \ \ \-\-ftp\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ FTP\ username,\ leave\ blank\ for\ current\ username,\ $USER -\ \ \ \ \ \ \-\-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\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Google\ Application\ Client\ Id -\ \ \ \ \ \ \-\-gcs\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Google\ Application\ Client\ Secret -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-gphotos\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Google\ Application\ Client\ Id -\ \ \ \ \ \ \-\-gphotos\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Google\ Application\ 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. -\ \ \ \ \ \ \-\-http\-headers\ CommaSepList\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Set\ HTTP\ headers\ for\ all\ transactions -\ \ \ \ \ \ \-\-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\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Above\ this\ size\ files\ will\ be\ chunked\ into\ a\ _segments\ container.\ (default\ 5G) -\ \ \ \ \ \ \-\-hubic\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Hubic\ Client\ Id -\ \ \ \ \ \ \-\-hubic\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Hubic\ Client\ Secret -\ \ \ \ \ \ \-\-hubic\-no\-chunk\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ chunk\ files\ during\ streaming\ upload. -\ \ \ \ \ \ \-\-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\-unlink\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Remove\ existing\ public\ link\ to\ file/folder\ with\ link\ command\ rather\ than\ creating. -\ \ \ \ \ \ \-\-jottacloud\-upload\-resume\-limit\ SizeSuffix\ \ \ \ Files\ bigger\ than\ this\ can\ be\ resumed\ if\ the\ upload\ fail\[aq]s.\ (default\ 10M) -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-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\-no\-check\-updated\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ check\ to\ see\ if\ the\ files\ change\ during\ upload -\ \ \ \ \ \ \-\-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 -\ \ \ \ \ \ \-\-mega\-debug\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Output\ more\ debug\ from\ Mega. -\ \ \ \ \ \ \-\-mega\-hard\-delete\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Delete\ files\ permanently\ rather\ than\ putting\ them\ into\ the\ trash. -\ \ \ \ \ \ \-\-mega\-pass\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password. -\ \ \ \ \ \ \-\-mega\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name -\ \ \-x,\ \-\-one\-file\-system\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ cross\ filesystem\ boundaries\ (unix/macOS\ only). -\ \ \ \ \ \ \-\-onedrive\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Chunk\ size\ to\ upload\ files\ with\ \-\ must\ be\ multiple\ of\ 320k.\ (default\ 10M) -\ \ \ \ \ \ \-\-onedrive\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Microsoft\ App\ Client\ Id -\ \ \ \ \ \ \-\-onedrive\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Microsoft\ App\ 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\-expose\-onenote\-files\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Set\ to\ make\ OneNote\ files\ show\ up\ in\ directory\ listings. -\ \ \ \ \ \ \-\-opendrive\-password\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password. -\ \ \ \ \ \ \-\-opendrive\-username\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Username -\ \ \ \ \ \ \-\-pcloud\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Pcloud\ App\ Client\ Id -\ \ \ \ \ \ \-\-pcloud\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Pcloud\ App\ Client\ Secret -\ \ \ \ \ \ \-\-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\-endpoint\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Enter\ a\ 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\-disable\-checksum\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ store\ MD5\ checksum\ with\ object\ metadata -\ \ \ \ \ \ \-\-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\-location\-constraint\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Location\ constraint\ \-\ must\ be\ set\ to\ match\ the\ Region. -\ \ \ \ \ \ \-\-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\-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. -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-sftp\-path\-override\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ path\ used\ by\ SSH\ connection. -\ \ \ \ \ \ \-\-sftp\-port\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSH\ port,\ leave\ blank\ to\ use\ default\ (22) -\ \ \ \ \ \ \-\-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\-use\-insecure\-cipher\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Enable\ the\ use\ of\ the\ aes128\-cbc\ cipher\ and\ diffie\-hellman\-group\-exchange\-sha256,\ diffie\-hellman\-group\-exchange\-sha1\ key\ exchange.\ Those\ algorithms\ are\ insecure\ and\ may\ allow\ plaintext\ data\ to\ be\ recovered\ by\ an\ attacker. -\ \ \ \ \ \ \-\-sftp\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSH\ username,\ leave\ blank\ for\ current\ username,\ ncw -\ \ \ \ \ \ \-\-skip\-links\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Don\[aq]t\ warn\ about\ skipped\ symlinks. -\ \ \ \ \ \ \-\-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\-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\[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). -\ \ \ \ \ \ \-\-union\-remotes\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ List\ of\ space\ separated\ remotes. -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Yandex\ Client\ Id -\ \ \ \ \ \ \-\-yandex\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Yandex\ Client\ Secret -\ \ \ \ \ \ \-\-yandex\-unlink\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Remove\ existing\ public\ link\ to\ file/folder\ with\ link\ command\ rather\ than\ creating. -\f[] -.fi -.SS 1Fichier -.PP -This is a backend for the 1ficher (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[] -.PP -Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. -.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[]. -First run: -.IP -.nf -\f[C] -\ rclone\ config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + +This\ is\ a\ backend\ for\ the\ [1ficher](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: \f[] .fi .PP -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 ("\[lq]). Choose a number from below, or +type in your own value [snip] XX / 1Fichier \ \[rq]fichier" [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 (""). +api_key> example_key +.PP +Edit advanced config? +(y/n) y) Yes n) No y/n> Remote config +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = fichier api_key = +example_key \[em]\[em]\[em]\[em]\[em]\[em]\[en] 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\ (""). -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/\ ** + +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](/overview/#restricted\-characters) +the\ following\ characters\ are\ also\ replaced: + +|\ Character\ |\ Value\ |\ Replacement\ | +|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| +|\ \\\ \ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | +|\ <\ \ \ \ \ \ \ \ \ |\ 0x3C\ \ |\ ＜\ \ \ \ \ \ \ \ \ \ \ | +|\ >\ \ \ \ \ \ \ \ \ |\ 0x3E\ \ |\ ＞\ \ \ \ \ \ \ \ \ \ \ | +|\ "\ \ \ \ \ \ \ \ \ |\ 0x22\ \ |\ ＂\ \ \ \ \ \ \ \ \ \ \ | +|\ $\ \ \ \ \ \ \ \ \ |\ 0x24\ \ |\ ＄\ \ \ \ \ \ \ \ \ \ \ | +|\ `\ \ \ \ \ \ \ \ \ |\ 0x60\ \ |\ ｀\ \ \ \ \ \ \ \ \ \ \ | +|\ \[aq]\ \ \ \ \ \ \ \ \ |\ 0x27\ \ |\ ＇\ \ \ \ \ \ \ \ \ \ \ | + +File\ names\ can\ also\ not\ start\ or\ end\ with\ the\ following\ characters. +These\ only\ get\ replaced\ if\ they\ are\ first\ or\ last\ character\ in\ the +name: + +|\ Character\ |\ Value\ |\ Replacement\ | +|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| +|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | + +Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), +as\ they\ can\[aq]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 -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 -\f[] -.fi -.PP -Once configured you can then use \f[C]rclone\f[] like this, -.PP -List directories in top level of your 1Fichier account -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -List all the files in your 1Fichier account -.IP -.nf -\f[C] -rclone\ ls\ remote: -\f[] -.fi -.PP -To copy a local directory to a 1Fichier directory called backup -.IP -.nf -\f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] -.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. -.SS Forbidden characters -.PP -1Fichier does not support the characters -\f[C]\\\ <\ >\ "\ \[aq]\ `\ $\f[] and spaces at the beginning of folder -names. -\f[C]rclone\f[] automatically escapes these to a unicode equivalent. -The exception is \f[C]/\f[], which cannot be escaped and will therefore -lead to errors. -.SS Standard Options -.PP -Here are the standard options specific to fichier (1Fichier). -.SS \[en]fichier\-api\-key -.PP -Your API Key, get it from https://1fichier.com/console/params.pl -.IP \[bu] 2 -Config: api_key -.IP \[bu] 2 -Env Var: RCLONE_FICHIER_API_KEY -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS Advanced Options -.PP -Here are the advanced options specific to fichier (1Fichier). -.SS \[en]fichier\-shared\-folder -.PP -If you want to download a shared folder, add this parameter -.IP \[bu] 2 -Config: shared_folder -.IP \[bu] 2 -Env Var: RCLONE_FICHIER_SHARED_FOLDER -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS Alias -.PP -The \f[C]alias\f[] 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[] or -\f[C]/directory/subdirectory\f[]. -.PP -During the initial setup with \f[C]rclone\ config\f[] 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 a alias remote named \f[C]backup\f[] with the target -\f[C]mydrive:private/backup\f[]. -Invoking \f[C]rclone\ mkdir\ backup:desktop\f[] is exactly the same as -invoking \f[C]rclone\ mkdir\ mydrive:private/backup/desktop\f[]. -.PP -There will be no special handling of paths containing \f[C]\&..\f[] -segments. -Invoking \f[C]rclone\ mkdir\ backup:../desktop\f[] is exactly the same -as invoking \f[C]rclone\ mkdir\ mydrive:private/backup/../desktop\f[]. -The empty path is not allowed as a remote. -To alias the current directory use \f[C]\&.\f[] instead. -.PP -Here is an example of how to make a alias called \f[C]remote\f[] for -local folder. -First run: -.IP -.nf -\f[C] -\ rclone\ config -\f[] -.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 -\ \ \ \\\ "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:\ \ \ \ \ \ api_key +\-\ Env\ Var:\ \ \ \ \ RCLONE_FICHIER_API_KEY +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" -Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Type -====\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ==== -remote\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ alias +###\ Advanced\ Options -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 +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:\ \ \ \ \ "" + + + +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\ a\ 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\ a\ alias\ called\ `remote`\ for\ local\ folder. +First\ run: + +\ \ \ \ \ rclone\ config + +This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: \f[] .fi .PP -Once configured you can then use \f[C]rclone\f[] like this, -.PP -List directories in top level in \f[C]/mnt/storage/backup\f[] -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -List all the files in \f[C]/mnt/storage/backup\f[] -.IP -.nf -\f[C] -rclone\ ls\ remote: -\f[] -.fi -.PP -Copy another local directory to the alias directory called source -.IP -.nf -\f[C] -rclone\ copy\ /home/source\ remote:source -\f[] -.fi -.SS Standard Options -.PP -Here are the standard options specific to alias (Alias for an existing -remote). -.SS \[en]alias\-remote -.PP -Remote or path to alias. +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 \ \[lq]alias\[rq] [snip] Storage> alias Remote or +path to alias. Can be \[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq], \[lq]myremote:\[rq] or \[lq]/local/path\[rq]. -.IP \[bu] 2 -Config: remote -.IP \[bu] 2 -Env Var: RCLONE_ALIAS_REMOTE -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS Amazon Drive +remote> /mnt/storage/backup Remote config +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] remote = +/mnt/storage/backup \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is +OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes: .PP -Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage -service run by Amazon for consumers. -.SS Status -.PP -\f[B]Important:\f[] 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. -.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[] 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's very secure App Engine environment and -doesn't store any credentials which pass through it. -.PP -Since rclone doesn't currently have its own Amazon Drive credentials so -you will either need to have your own \f[C]client_id\f[] and -\f[C]client_secret\f[] with Amazon Drive, or use a a third party ouath -proxy in which case you will need to enter \f[C]client_id\f[], -\f[C]client_secret\f[], \f[C]auth_url\f[] and \f[C]token_url\f[]. -.PP -Note also if you are not using Amazon's \f[C]auth_url\f[] and -\f[C]token_url\f[], (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[] will not work. -.PP -Here is an example of how to make a remote called \f[C]remote\f[]. -First run: +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] -\ rclone\ config + +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](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.\ \ `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\[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\ `client_id`\ and +`client_secret`\ with\ Amazon\ Drive,\ or\ use\ a\ a\ third\ party\ ouath\ 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\[aq]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: \f[] .fi .PP -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 \ \[lq]amazon cloud drive\[rq] [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 \[lq]http://127.0.0.1:53682/\[rq] 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 +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [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 = +{\[lq]access_token\[rq]:\[lq]xxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]xxxxxxxxxxxxxxxxxx\[rq],\[lq]expiry\[rq]:\[lq]2015\-09\-06T16:07:39.658438471+01:00\[rq]} +\[em]\[em]\[em]\[em]\[em]\[em]\[en] 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 -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\[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\ "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\[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\ =\ {"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\[aq]t\ allow\ modification\ times\ to\ be\ changed\ via +the\ API\ so\ these\ won\[aq]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](/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\ `.com`\ Amazon\ accounts\ ### + +Let\[aq]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 + +Amazon\ Application\ Client\ ID. + +\-\ Config:\ \ \ \ \ \ client_id +\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_CLIENT_ID +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-acd\-client\-secret + +Amazon\ Application\ Client\ Secret. + +\-\ 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\-auth\-url + +Auth\ server\ URL. +Leave\ blank\ to\ use\ Amazon\[aq]s. + +\-\ Config:\ \ \ \ \ \ auth_url +\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_AUTH_URL +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-acd\-token\-url + +Token\ server\ url. +leave\ blank\ to\ use\ Amazon\[aq]s. + +\-\ 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\[aq]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 + + + +###\ Limitations\ ### + +Note\ that\ Amazon\ Drive\ is\ case\ insensitive\ so\ you\ can\[aq]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 +*\ 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\ /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[] .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 \f[C]http://127.0.0.1:53682/\f[] 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[] like this, -.PP -List directories in top level of your Amazon Drive +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) +\ \[lq]s3\[rq] [snip] Storage> s3 Choose your S3 provider. +Choose a number from below, or type in your own value 1 / Amazon Web +Services (AWS) S3 \ \[lq]AWS\[rq] 2 / Ceph Object Storage +\ \[lq]Ceph\[rq] 3 / Digital Ocean Spaces \ \[lq]DigitalOcean\[rq] 4 / +Dreamhost DreamObjects \ \[lq]Dreamhost\[rq] 5 / IBM COS S3 +\ \[lq]IBMCOS\[rq] 6 / Minio Object Storage \ \[lq]Minio\[rq] 7 / Wasabi +Object Storage \ \[lq]Wasabi\[rq] 8 / Any other S3 compatible provider +\ \[lq]Other\[rq] 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 \ \[lq]false\[rq] 2 / Get AWS credentials +from the environment (env vars or IAM) \ \[lq]true\[rq] 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. +\ \[lq]us\-east\-1\[rq] / US East (Ohio) Region 2 | Needs location +constraint us\-east\-2. +\ \[lq]us\-east\-2\[rq] / US West (Oregon) Region 3 | Needs location +constraint us\-west\-2. +\ \[lq]us\-west\-2\[rq] / US West (Northern California) Region 4 | Needs +location constraint us\-west\-1. +\ \[lq]us\-west\-1\[rq] / Canada (Central) Region 5 | Needs location +constraint ca\-central\-1. +\ \[lq]ca\-central\-1\[rq] / EU (Ireland) Region 6 | Needs location +constraint EU or eu\-west\-1. +\ \[lq]eu\-west\-1\[rq] / EU (London) Region 7 | Needs location +constraint eu\-west\-2. +\ \[lq]eu\-west\-2\[rq] / EU (Frankfurt) Region 8 | Needs location +constraint eu\-central\-1. +\ \[lq]eu\-central\-1\[rq] / Asia Pacific (Singapore) Region 9 | Needs +location constraint ap\-southeast\-1. +\ \[lq]ap\-southeast\-1\[rq] / Asia Pacific (Sydney) Region 10 | Needs +location constraint ap\-southeast\-2. +\ \[lq]ap\-southeast\-2\[rq] / Asia Pacific (Tokyo) Region 11 | Needs +location constraint ap\-northeast\-1. +\ \[lq]ap\-northeast\-1\[rq] / Asia Pacific (Seoul) 12 | Needs location +constraint ap\-northeast\-2. +\ \[lq]ap\-northeast\-2\[rq] / Asia Pacific (Mumbai) 13 | Needs location +constraint ap\-south\-1. +\ \[lq]ap\-south\-1\[rq] / South America (Sao Paulo) Region 14 | Needs +location constraint sa\-east\-1. +\ \[lq]sa\-east\-1\[rq] 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. +\ \[lq]us\-east\-2\[rq] 3 / US West (Oregon) Region. +\ \[lq]us\-west\-2\[rq] 4 / US West (Northern California) Region. +\ \[lq]us\-west\-1\[rq] 5 / Canada (Central) Region. +\ \[lq]ca\-central\-1\[rq] 6 / EU (Ireland) Region. +\ \[lq]eu\-west\-1\[rq] 7 / EU (London) Region. +\ \[lq]eu\-west\-2\[rq] 8 / EU Region. +\ \[lq]EU\[rq] 9 / Asia Pacific (Singapore) Region. +\ \[lq]ap\-southeast\-1\[rq] 10 / Asia Pacific (Sydney) Region. +\ \[lq]ap\-southeast\-2\[rq] 11 / Asia Pacific (Tokyo) Region. +\ \[lq]ap\-northeast\-1\[rq] 12 / Asia Pacific (Seoul) +\ \[lq]ap\-northeast\-2\[rq] 13 / Asia Pacific (Mumbai) +\ \[lq]ap\-south\-1\[rq] 14 / South America (Sao Paulo) Region. +\ \[lq]sa\-east\-1\[rq] 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). +\ \[lq]private\[rq] 2 / Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +\ \[lq]public\-read\[rq] / Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +3 | Granting this on a bucket is generally not recommended. +\ \[lq]public\-read\-write\[rq] 4 / Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +\ \[lq]authenticated\-read\[rq] / 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. +\ \[lq]bucket\-owner\-read\[rq] / 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. +\ \[lq]bucket\-owner\-full\-control\[rq] 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 \ \[lq]AES256\[rq] 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 \ \[lq]STANDARD\[rq] 3 / Reduced redundancy +storage class \ \[lq]REDUCED_REDUNDANCY\[rq] 4 / Standard Infrequent +Access storage class \ \[lq]STANDARD_IA\[rq] 5 / One Zone Infrequent +Access storage class \ \[lq]ONEZONE_IA\[rq] 6 / Glacier storage class +\ \[lq]GLACIER\[rq] 7 / Glacier Deep Archive storage class +\ \[lq]DEEP_ARCHIVE\[rq] 8 / Intelligent\-Tiering storage class +\ \[lq]INTELLIGENT_TIERING\[rq] storage_class> 1 Remote config +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [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 = +\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this +remote d) Delete this remote y/e/d> .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -List all the files in your Amazon Drive -.IP -.nf -\f[C] -rclone\ ls\ remote: -\f[] -.fi -.PP -To copy a local directory to an Amazon Drive directory called backup -.IP -.nf -\f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] -.fi -.SS Modified time and MD5SUMs -.PP -Amazon Drive doesn't allow modification times to be changed via the API -so these won't be accurate or used for syncing. -.PP -It does store MD5SUMs so for a more accurate sync, you can use the -\f[C]\-\-checksum\f[] flag. -.SS Deleting files -.PP -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. -.SS Using with non \f[C]\&.com\f[] Amazon accounts -.PP -Let's say you usually use \f[C]amazon.co.uk\f[]. -When you authenticate with rclone it will take you to an -\f[C]amazon.com\f[] page to log in. -Your \f[C]amazon.co.uk\f[] 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 \[en]acd\-client\-id -.PP -Amazon Application Client ID. -.IP \[bu] 2 -Config: client_id -.IP \[bu] 2 -Env Var: RCLONE_ACD_CLIENT_ID -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]acd\-client\-secret -.PP -Amazon Application Client Secret. -.IP \[bu] 2 -Config: client_secret -.IP \[bu] 2 -Env Var: RCLONE_ACD_CLIENT_SECRET -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS Advanced Options -.PP -Here are the advanced options specific to amazon cloud drive (Amazon -Drive). -.SS \[en]acd\-auth\-url -.PP -Auth server URL. -Leave blank to use Amazon's. -.IP \[bu] 2 -Config: auth_url -.IP \[bu] 2 -Env Var: RCLONE_ACD_AUTH_URL -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]acd\-token\-url -.PP -Token server url. -leave blank to use Amazon's. -.IP \[bu] 2 -Config: token_url -.IP \[bu] 2 -Env Var: RCLONE_ACD_TOKEN_URL -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]acd\-checkpoint -.PP -Checkpoint for internal polling (debug). -.IP \[bu] 2 -Config: checkpoint -.IP \[bu] 2 -Env Var: RCLONE_ACD_CHECKPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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. -.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 \[lq]\-v\[rq] 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 \[en]acd\-templink\-threshold -.PP -Files >= this size will be downloaded via their tempLink. -.PP -Files this size or more will be downloaded via their \[lq]tempLink\[rq]. -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. -.PP -To download files above this threshold, rclone requests a -\[lq]tempLink\[rq] 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 Limitations -.PP -Note that Amazon Drive is case insensitive so you can't have a file -called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. -.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[] 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 \f[C]\-\-max\-size\ 50000M\f[] option to -limit the maximum size of uploaded files. -Note that \f[C]\-\-max\-size\f[] 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: -.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 -Wasabi -.PP -Paths are specified as \f[C]remote:bucket\f[] (or \f[C]remote:\f[] for -the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:bucket/path/to/dir\f[]. -.PP -Once you have made a remote (see the provider specific section above) -you can use it like this: -.PP -See all buckets -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -Make a new bucket -.IP -.nf -\f[C] -rclone\ mkdir\ remote:bucket -\f[] -.fi -.PP -List the contents of a bucket -.IP -.nf -\f[C] -rclone\ ls\ remote:bucket -\f[] -.fi -.PP -Sync \f[C]/home/local/directory\f[] to the remote bucket, deleting any -excess files in the bucket. -.IP -.nf -\f[C] -rclone\ sync\ /home/local/directory\ remote:bucket -\f[] -.fi -.SS AWS S3 -.PP -Here is an example of making an s3 configuration. -First run -.IP -.nf -\f[C] -rclone\ config -\f[] -.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) -\ \ \ \\\ "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" -\ \ \ /\ South\ America\ (Sao\ Paulo)\ Region -14\ |\ 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\ /\ 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>\ -\f[] -.fi -.SS \[en]fast\-list -.PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use -fewer transactions in exchange for more memory. -See the rclone docs (/docs/#fast-list) for more details. -.SS \[en]update and \[en]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 + +###\ \-\-fast\-list\ ### + +This\ remote\ supports\ `\-\-fast\-list`\ which\ allows\ you\ to\ use\ fewer +transactions\ in\ exchange\ for\ more\ memory.\ See\ the\ [rclone +docs](/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. + +####\ Restricted\ filename\ characters + +S3\ allows\ any\ valid\ UTF\-8\ string\ as\ a\ key. + +Invalid\ UTF\-8\ bytes\ will\ be\ [replaced](/overview/#invalid\-utf8),\ as +they\ can\[aq]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\[aq]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\ \[aq]XXX\[aq] +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). + +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: +\f[] +.fi .PP -For many operations, the time the object was last uploaded to the remote -is sufficient to determine if it is \[lq]dirty\[rq]. -By using \f[C]\-\-update\f[] along with -\f[C]\-\-use\-server\-modtime\f[], 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 -\f[C]X\-Amz\-Meta\-Mtime\f[] 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. +{ \[lq]Version\[rq]: \[lq]2012\-10\-17\[rq], \[lq]Statement\[rq]: [ { +\[lq]Effect\[rq]: \[lq]Allow\[rq], \[lq]Principal\[rq]: { \[lq]AWS\[rq]: +\[lq]arn:aws:iam::USER_SID:user/USER_NAME\[rq] }, \[lq]Action\[rq]: [ +\[lq]s3:ListBucket\[rq], \[lq]s3:DeleteObject\[rq], +\[lq]s3:GetObject\[rq], \[lq]s3:PutObject\[rq], +\[lq]s3:PutObjectAcl\[rq] ], \[lq]Resource\[rq]: [ +"arn:aws:s3:::BUCKET_NAME/*\[lq],\[rq]arn:aws:s3:::BUCKET_NAME" ] }, { +\[lq]Effect\[rq]: \[lq]Allow\[rq], \[lq]Action\[rq]: +\[lq]s3:ListAllMyBuckets\[rq], \[lq]Resource\[rq]: "arn:aws:s3:::*" } .PD 0 .P .PD -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 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[] with multipart upload -\f[I]and\f[] through crypt remotes do not have MD5 sums. -.PP -rclone switches from single part uploads to multipart uploads at the -point specified by \f[C]\-\-s3\-upload\-cutoff\f[]. -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 -\f[C]\-\-s3\-chunk\-size\f[] and the number of chunks uploaded -concurrently is specified by \f[C]\-\-s3\-upload\-concurrency\f[]. -.PP -Multipart uploads will use \f[C]\-\-transfers\f[] * -\f[C]\-\-s3\-upload\-concurrency\f[] * \f[C]\-\-s3\-chunk\-size\f[] -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. -.PP -Increasing \f[C]\-\-s3\-upload\-concurrency\f[] will increase throughput -(8 would be a sensible value) and increasing -\f[C]\-\-s3\-chunk\-size\f[] 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[]) 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[]. -.SS Authentication -.PP -There are a number of ways to supply \f[C]rclone\f[] 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[] -in the config file): -.RS 2 -.IP \[bu] 2 -\f[C]access_key_id\f[] and \f[C]secret_access_key\f[] are required. -.IP \[bu] 2 -\f[C]session_token\f[] can be optionally set when using AWS STS. -.RE -.IP \[bu] 2 -Runtime configuration (\f[C]env_auth\ =\ true\f[] in the config file): -.RS 2 -.IP \[bu] 2 -Export the following environment variables before running -\f[C]rclone\f[]: -.RS 2 -.IP \[bu] 2 -Access Key ID: \f[C]AWS_ACCESS_KEY_ID\f[] or \f[C]AWS_ACCESS_KEY\f[] -.IP \[bu] 2 -Secret Access Key: \f[C]AWS_SECRET_ACCESS_KEY\f[] or -\f[C]AWS_SECRET_KEY\f[] -.IP \[bu] 2 -Session Token: \f[C]AWS_SESSION_TOKEN\f[] (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]~/.aws/credentials\f[] on unix based systems) file and the -\[lq]default\[rq] profile, to change set these environment variables: -.RS 2 -.IP \[bu] 2 -\f[C]AWS_SHARED_CREDENTIALS_FILE\f[] to control which file. -.IP \[bu] 2 -\f[C]AWS_PROFILE\f[] to control which profile to use. -.RE -.RE -.IP \[bu] 2 -Or, run \f[C]rclone\f[] in an ECS task with an IAM role (AWS only). -.IP \[bu] 2 -Or, run \f[C]rclone\f[] on an EC2 instance with an IAM role (AWS only). -.RE -.PP -If none of these option actually end up providing \f[C]rclone\f[] with -AWS credentials then S3 interaction will be non\-authenticated (see -below). -.SS S3 Permissions -.PP -When using the \f[C]sync\f[] subcommand of \f[C]rclone\f[] the following -minimum permissions are required to be available on the bucket being -written to: -.IP \[bu] 2 -\f[C]ListBucket\f[] -.IP \[bu] 2 -\f[C]DeleteObject\f[] -.IP \[bu] 2 -\f[C]GetObject\f[] -.IP \[bu] 2 -\f[C]PutObject\f[] -.IP \[bu] 2 -\f[C]PutObjectACL\f[] -.PP -When using the \f[C]lsd\f[] subcommand, the \f[C]ListAllMyBuckets\f[] -permission is required. -.PP -Example policy: +] } .IP .nf \f[C] -{ -\ \ \ \ "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:::*" -\ \ \ \ \ \ \ \ }\ \ \ -\ \ \ \ ] -} -\f[] -.fi -.PP -Notes on above: -.IP "1." 3 -This is a policy that can be used when creating bucket. -It assumes that \f[C]USER_NAME\f[] 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's objects. -.PP -For reference, here'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[]. -.SS Key Management System (KMS) -.PP -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 \f[C]\-\-ignore\-checksum\f[] 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. -.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[] -.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. -.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, etc)). -.SS \[en]s3\-provider -.PP -Choose your S3 provider. -.IP \[bu] 2 -Config: provider -.IP \[bu] 2 -Env Var: RCLONE_S3_PROVIDER -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]AWS\[rq] -.RS 2 -.IP \[bu] 2 -Amazon Web Services (AWS) S3 -.RE -.IP \[bu] 2 -\[lq]Alibaba\[rq] -.RS 2 -.IP \[bu] 2 -Alibaba Cloud Object Storage System (OSS) formerly Aliyun -.RE -.IP \[bu] 2 -\[lq]Ceph\[rq] -.RS 2 -.IP \[bu] 2 -Ceph Object Storage -.RE -.IP \[bu] 2 -\[lq]DigitalOcean\[rq] -.RS 2 -.IP \[bu] 2 -Digital Ocean Spaces -.RE -.IP \[bu] 2 -\[lq]Dreamhost\[rq] -.RS 2 -.IP \[bu] 2 -Dreamhost DreamObjects -.RE -.IP \[bu] 2 -\[lq]IBMCOS\[rq] -.RS 2 -.IP \[bu] 2 -IBM COS S3 -.RE -.IP \[bu] 2 -\[lq]Minio\[rq] -.RS 2 -.IP \[bu] 2 -Minio Object Storage -.RE -.IP \[bu] 2 -\[lq]Netease\[rq] -.RS 2 -.IP \[bu] 2 -Netease Object Storage (NOS) -.RE -.IP \[bu] 2 -\[lq]Wasabi\[rq] -.RS 2 -.IP \[bu] 2 -Wasabi Object Storage -.RE -.IP \[bu] 2 -\[lq]Other\[rq] -.RS 2 -.IP \[bu] 2 -Any other S3 compatible provider -.RE -.RE -.SS \[en]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. -.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 -\[lq]false\[rq] -.RS 2 -.IP \[bu] 2 -Enter AWS credentials in the next step -.RE -.IP \[bu] 2 -\[lq]true\[rq] -.RS 2 -.IP \[bu] 2 -Get AWS credentials from the environment (env vars or IAM) -.RE -.RE -.SS \[en]s3\-access\-key\-id -.PP -AWS Access Key ID. -Leave blank for anonymous access or runtime credentials. -.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: "" -.SS \[en]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: "" -.SS \[en]s3\-region -.PP -Region to connect to. -.IP \[bu] 2 -Config: region -.IP \[bu] 2 -Env Var: RCLONE_S3_REGION -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]us\-east\-1\[rq] -.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 -\[lq]us\-east\-2\[rq] -.RS 2 -.IP \[bu] 2 -US East (Ohio) Region -.IP \[bu] 2 -Needs location constraint us\-east\-2. -.RE -.IP \[bu] 2 -\[lq]us\-west\-2\[rq] -.RS 2 -.IP \[bu] 2 -US West (Oregon) Region -.IP \[bu] 2 -Needs location constraint us\-west\-2. -.RE -.IP \[bu] 2 -\[lq]us\-west\-1\[rq] -.RS 2 -.IP \[bu] 2 -US West (Northern California) Region -.IP \[bu] 2 -Needs location constraint us\-west\-1. -.RE -.IP \[bu] 2 -\[lq]ca\-central\-1\[rq] -.RS 2 -.IP \[bu] 2 -Canada (Central) Region -.IP \[bu] 2 -Needs location constraint ca\-central\-1. -.RE -.IP \[bu] 2 -\[lq]eu\-west\-1\[rq] -.RS 2 -.IP \[bu] 2 -EU (Ireland) Region -.IP \[bu] 2 -Needs location constraint EU or eu\-west\-1. -.RE -.IP \[bu] 2 -\[lq]eu\-west\-2\[rq] -.RS 2 -.IP \[bu] 2 -EU (London) Region -.IP \[bu] 2 -Needs location constraint eu\-west\-2. -.RE -.IP \[bu] 2 -\[lq]eu\-north\-1\[rq] -.RS 2 -.IP \[bu] 2 -EU (Stockholm) Region -.IP \[bu] 2 -Needs location constraint eu\-north\-1. -.RE -.IP \[bu] 2 -\[lq]eu\-central\-1\[rq] -.RS 2 -.IP \[bu] 2 -EU (Frankfurt) Region -.IP \[bu] 2 -Needs location constraint eu\-central\-1. -.RE -.IP \[bu] 2 -\[lq]ap\-southeast\-1\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Singapore) Region -.IP \[bu] 2 -Needs location constraint ap\-southeast\-1. -.RE -.IP \[bu] 2 -\[lq]ap\-southeast\-2\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Sydney) Region -.IP \[bu] 2 -Needs location constraint ap\-southeast\-2. -.RE -.IP \[bu] 2 -\[lq]ap\-northeast\-1\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Tokyo) Region -.IP \[bu] 2 -Needs location constraint ap\-northeast\-1. -.RE -.IP \[bu] 2 -\[lq]ap\-northeast\-2\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Seoul) -.IP \[bu] 2 -Needs location constraint ap\-northeast\-2. -.RE -.IP \[bu] 2 -\[lq]ap\-south\-1\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Mumbai) -.IP \[bu] 2 -Needs location constraint ap\-south\-1. -.RE -.IP \[bu] 2 -\[lq]sa\-east\-1\[rq] -.RS 2 -.IP \[bu] 2 -South America (Sao Paulo) Region -.IP \[bu] 2 -Needs location constraint sa\-east\-1. -.RE -.RE -.SS \[en]s3\-region -.PP -Region to connect to. -Leave blank if you are using an S3 clone and you don'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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -Use this if unsure. -Will use v4 signatures and an empty region. -.RE -.IP \[bu] 2 -\[lq]other\-v2\-signature\[rq] -.RS 2 -.IP \[bu] 2 -Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. -.RE -.RE -.SS \[en]s3\-endpoint -.PP -Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -.IP \[bu] 2 -Config: endpoint -.IP \[bu] 2 -Env Var: RCLONE_S3_ENDPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]s3\-endpoint -.PP -Endpoint for IBM COS S3 API. -Specify if using an IBM COS On Premise. -.IP \[bu] 2 -Config: endpoint -.IP \[bu] 2 -Env Var: RCLONE_S3_ENDPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]s3\-api.us\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Dallas Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Washington DC Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region San Jose Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Dallas Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Washington DC Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region San Jose Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.us\-east.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -US Region East Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.us\-east.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -US Region East Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.us\-south.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -US Region South Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.us\-south.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -US Region South Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.eu\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.fra\-eu\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Frankfurt Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.mil\-eu\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Milan Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.ams\-eu\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Amsterdam Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.eu\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.fra\-eu\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Frankfurt Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.mil\-eu\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Milan Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.ams\-eu\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Amsterdam Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.eu\-gb.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -Great Britain Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.eu\-gb.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -Great Britain Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.ap\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.tok\-ap\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional Tokyo Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.hkg\-ap\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional HongKong Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.seo\-ap\-geo.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional Seoul Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.ap\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.tok\-ap\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional Tokyo Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.hkg\-ap\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional HongKong Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.seo\-ap\-geo.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cross Regional Seoul Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.mel01.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -Melbourne Single Site Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.mel01.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -Melbourne Single Site Private Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.tor01.objectstorage.softlayer.net\[rq] -.RS 2 -.IP \[bu] 2 -Toronto Single Site Endpoint -.RE -.IP \[bu] 2 -\[lq]s3.tor01.objectstorage.service.networklayer.com\[rq] -.RS 2 -.IP \[bu] 2 -Toronto Single Site Private Endpoint -.RE -.RE -.SS \[en]s3\-endpoint -.PP -Endpoint for OSS API. -.IP \[bu] 2 -Config: endpoint -.IP \[bu] 2 -Env Var: RCLONE_S3_ENDPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]oss\-cn\-hangzhou.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -East China 1 (Hangzhou) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-shanghai.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -East China 2 (Shanghai) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-qingdao.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -North China 1 (Qingdao) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-beijing.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -North China 2 (Beijing) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-zhangjiakou.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -North China 3 (Zhangjiakou) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-huhehaote.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -North China 5 (Huhehaote) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-shenzhen.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -South China 1 (Shenzhen) -.RE -.IP \[bu] 2 -\[lq]oss\-cn\-hongkong.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Hong Kong (Hong Kong) -.RE -.IP \[bu] 2 -\[lq]oss\-us\-west\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -US West 1 (Silicon Valley) -.RE -.IP \[bu] 2 -\[lq]oss\-us\-east\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -US East 1 (Virginia) -.RE -.IP \[bu] 2 -\[lq]oss\-ap\-southeast\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Southeast Asia Southeast 1 (Singapore) -.RE -.IP \[bu] 2 -\[lq]oss\-ap\-southeast\-2.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific Southeast 2 (Sydney) -.RE -.IP \[bu] 2 -\[lq]oss\-ap\-southeast\-3.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Southeast Asia Southeast 3 (Kuala Lumpur) -.RE -.IP \[bu] 2 -\[lq]oss\-ap\-southeast\-5.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific Southeast 5 (Jakarta) -.RE -.IP \[bu] 2 -\[lq]oss\-ap\-northeast\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific Northeast 1 (Japan) -.RE -.IP \[bu] 2 -\[lq]oss\-ap\-south\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific South 1 (Mumbai) -.RE -.IP \[bu] 2 -\[lq]oss\-eu\-central\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Central Europe 1 (Frankfurt) -.RE -.IP \[bu] 2 -\[lq]oss\-eu\-west\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -West Europe (London) -.RE -.IP \[bu] 2 -\[lq]oss\-me\-east\-1.aliyuncs.com\[rq] -.RS 2 -.IP \[bu] 2 -Middle East 1 (Dubai) -.RE -.RE -.SS \[en]s3\-endpoint -.PP -Endpoint for S3 API. -Required when using an S3 clone. -.IP \[bu] 2 -Config: endpoint -.IP \[bu] 2 -Env Var: RCLONE_S3_ENDPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]objects\-us\-east\-1.dream.io\[rq] -.RS 2 -.IP \[bu] 2 -Dream Objects endpoint -.RE -.IP \[bu] 2 -\[lq]nyc3.digitaloceanspaces.com\[rq] -.RS 2 -.IP \[bu] 2 -Digital Ocean Spaces New York 3 -.RE -.IP \[bu] 2 -\[lq]ams3.digitaloceanspaces.com\[rq] -.RS 2 -.IP \[bu] 2 -Digital Ocean Spaces Amsterdam 3 -.RE -.IP \[bu] 2 -\[lq]sgp1.digitaloceanspaces.com\[rq] -.RS 2 -.IP \[bu] 2 -Digital Ocean Spaces Singapore 1 -.RE -.IP \[bu] 2 -\[lq]s3.wasabisys.com\[rq] -.RS 2 -.IP \[bu] 2 -Wasabi US East endpoint -.RE -.IP \[bu] 2 -\[lq]s3.us\-west\-1.wasabisys.com\[rq] -.RS 2 -.IP \[bu] 2 -Wasabi US West endpoint -.RE -.IP \[bu] 2 -\[lq]s3.eu\-central\-1.wasabisys.com\[rq] -.RS 2 -.IP \[bu] 2 -Wasabi EU Central endpoint -.RE -.RE -.SS \[en]s3\-location\-constraint -.PP -Location constraint \- must be set to match the Region. -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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -Empty for US Region, Northern Virginia or Pacific Northwest. -.RE -.IP \[bu] 2 -\[lq]us\-east\-2\[rq] -.RS 2 -.IP \[bu] 2 -US East (Ohio) Region. -.RE -.IP \[bu] 2 -\[lq]us\-west\-2\[rq] -.RS 2 -.IP \[bu] 2 -US West (Oregon) Region. -.RE -.IP \[bu] 2 -\[lq]us\-west\-1\[rq] -.RS 2 -.IP \[bu] 2 -US West (Northern California) Region. -.RE -.IP \[bu] 2 -\[lq]ca\-central\-1\[rq] -.RS 2 -.IP \[bu] 2 -Canada (Central) Region. -.RE -.IP \[bu] 2 -\[lq]eu\-west\-1\[rq] -.RS 2 -.IP \[bu] 2 -EU (Ireland) Region. -.RE -.IP \[bu] 2 -\[lq]eu\-west\-2\[rq] -.RS 2 -.IP \[bu] 2 -EU (London) Region. -.RE -.IP \[bu] 2 -\[lq]eu\-north\-1\[rq] -.RS 2 -.IP \[bu] 2 -EU (Stockholm) Region. -.RE -.IP \[bu] 2 -\[lq]EU\[rq] -.RS 2 -.IP \[bu] 2 -EU Region. -.RE -.IP \[bu] 2 -\[lq]ap\-southeast\-1\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Singapore) Region. -.RE -.IP \[bu] 2 -\[lq]ap\-southeast\-2\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Sydney) Region. -.RE -.IP \[bu] 2 -\[lq]ap\-northeast\-1\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Tokyo) Region. -.RE -.IP \[bu] 2 -\[lq]ap\-northeast\-2\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Seoul) -.RE -.IP \[bu] 2 -\[lq]ap\-south\-1\[rq] -.RS 2 -.IP \[bu] 2 -Asia Pacific (Mumbai) -.RE -.IP \[bu] 2 -\[lq]sa\-east\-1\[rq] -.RS 2 -.IP \[bu] 2 -South America (Sao Paulo) Region. -.RE -.RE -.SS \[en]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 -.IP \[bu] 2 -Config: location_constraint -.IP \[bu] 2 -Env Var: RCLONE_S3_LOCATION_CONSTRAINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]us\-standard\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Standard -.RE -.IP \[bu] 2 -\[lq]us\-vault\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Vault -.RE -.IP \[bu] 2 -\[lq]us\-cold\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Cold -.RE -.IP \[bu] 2 -\[lq]us\-flex\[rq] -.RS 2 -.IP \[bu] 2 -US Cross Region Flex -.RE -.IP \[bu] 2 -\[lq]us\-east\-standard\[rq] -.RS 2 -.IP \[bu] 2 -US East Region Standard -.RE -.IP \[bu] 2 -\[lq]us\-east\-vault\[rq] -.RS 2 -.IP \[bu] 2 -US East Region Vault -.RE -.IP \[bu] 2 -\[lq]us\-east\-cold\[rq] -.RS 2 -.IP \[bu] 2 -US East Region Cold -.RE -.IP \[bu] 2 -\[lq]us\-east\-flex\[rq] -.RS 2 -.IP \[bu] 2 -US East Region Flex -.RE -.IP \[bu] 2 -\[lq]us\-south\-standard\[rq] -.RS 2 -.IP \[bu] 2 -US South Region Standard -.RE -.IP \[bu] 2 -\[lq]us\-south\-vault\[rq] -.RS 2 -.IP \[bu] 2 -US South Region Vault -.RE -.IP \[bu] 2 -\[lq]us\-south\-cold\[rq] -.RS 2 -.IP \[bu] 2 -US South Region Cold -.RE -.IP \[bu] 2 -\[lq]us\-south\-flex\[rq] -.RS 2 -.IP \[bu] 2 -US South Region Flex -.RE -.IP \[bu] 2 -\[lq]eu\-standard\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Standard -.RE -.IP \[bu] 2 -\[lq]eu\-vault\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Vault -.RE -.IP \[bu] 2 -\[lq]eu\-cold\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Cold -.RE -.IP \[bu] 2 -\[lq]eu\-flex\[rq] -.RS 2 -.IP \[bu] 2 -EU Cross Region Flex -.RE -.IP \[bu] 2 -\[lq]eu\-gb\-standard\[rq] -.RS 2 -.IP \[bu] 2 -Great Britain Standard -.RE -.IP \[bu] 2 -\[lq]eu\-gb\-vault\[rq] -.RS 2 -.IP \[bu] 2 -Great Britain Vault -.RE -.IP \[bu] 2 -\[lq]eu\-gb\-cold\[rq] -.RS 2 -.IP \[bu] 2 -Great Britain Cold -.RE -.IP \[bu] 2 -\[lq]eu\-gb\-flex\[rq] -.RS 2 -.IP \[bu] 2 -Great Britain Flex -.RE -.IP \[bu] 2 -\[lq]ap\-standard\[rq] -.RS 2 -.IP \[bu] 2 -APAC Standard -.RE -.IP \[bu] 2 -\[lq]ap\-vault\[rq] -.RS 2 -.IP \[bu] 2 -APAC Vault -.RE -.IP \[bu] 2 -\[lq]ap\-cold\[rq] -.RS 2 -.IP \[bu] 2 -APAC Cold -.RE -.IP \[bu] 2 -\[lq]ap\-flex\[rq] -.RS 2 -.IP \[bu] 2 -APAC Flex -.RE -.IP \[bu] 2 -\[lq]mel01\-standard\[rq] -.RS 2 -.IP \[bu] 2 -Melbourne Standard -.RE -.IP \[bu] 2 -\[lq]mel01\-vault\[rq] -.RS 2 -.IP \[bu] 2 -Melbourne Vault -.RE -.IP \[bu] 2 -\[lq]mel01\-cold\[rq] -.RS 2 -.IP \[bu] 2 -Melbourne Cold -.RE -.IP \[bu] 2 -\[lq]mel01\-flex\[rq] -.RS 2 -.IP \[bu] 2 -Melbourne Flex -.RE -.IP \[bu] 2 -\[lq]tor01\-standard\[rq] -.RS 2 -.IP \[bu] 2 -Toronto Standard -.RE -.IP \[bu] 2 -\[lq]tor01\-vault\[rq] -.RS 2 -.IP \[bu] 2 -Toronto Vault -.RE -.IP \[bu] 2 -\[lq]tor01\-cold\[rq] -.RS 2 -.IP \[bu] 2 -Toronto Cold -.RE -.IP \[bu] 2 -\[lq]tor01\-flex\[rq] -.RS 2 -.IP \[bu] 2 -Toronto Flex -.RE -.RE -.SS \[en]s3\-location\-constraint -.PP -Location constraint \- must be set to match the Region. -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: "" -.SS \[en]s3\-acl -.PP -Canned ACL used when creating buckets and storing or copying objects. -.PP -This ACL is used for creating objects and if bucket_acl isn'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't copy the ACL from the source but rather writes a fresh one. -.IP \[bu] 2 -Config: acl -.IP \[bu] 2 -Env Var: RCLONE_S3_ACL -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]private\[rq] -.RS 2 -.IP \[bu] 2 -Owner gets FULL_CONTROL. -No one else has access rights (default). -.RE -.IP \[bu] 2 -\[lq]public\-read\[rq] -.RS 2 -.IP \[bu] 2 -Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -.RE -.IP \[bu] 2 -\[lq]public\-read\-write\[rq] -.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 -\[lq]authenticated\-read\[rq] -.RS 2 -.IP \[bu] 2 -Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -.RE -.IP \[bu] 2 -\[lq]bucket\-owner\-read\[rq] -.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 -\[lq]bucket\-owner\-full\-control\[rq] -.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 -\[lq]private\[rq] -.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 -\[lq]public\-read\[rq] -.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 -\[lq]public\-read\-write\[rq] -.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 -\[lq]authenticated\-read\[rq] -.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 \[en]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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -None -.RE -.IP \[bu] 2 -\[lq]AES256\[rq] -.RS 2 -.IP \[bu] 2 -AES256 -.RE -.IP \[bu] 2 -\[lq]aws:kms\[rq] -.RS 2 -.IP \[bu] 2 -aws:kms -.RE -.RE -.SS \[en]s3\-sse\-kms\-key\-id -.PP -If using KMS ID you must provide the ARN of Key. -.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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -None -.RE -.IP \[bu] 2 -"arn:aws:kms:us\-east\-1:*" -.RS 2 -.IP \[bu] 2 -arn:aws:kms:* -.RE -.RE -.SS \[en]s3\-storage\-class -.PP -The storage class to use when storing new objects in S3. -.IP \[bu] 2 -Config: storage_class -.IP \[bu] 2 -Env Var: RCLONE_S3_STORAGE_CLASS -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -Default -.RE -.IP \[bu] 2 -\[lq]STANDARD\[rq] -.RS 2 -.IP \[bu] 2 -Standard storage class -.RE -.IP \[bu] 2 -\[lq]REDUCED_REDUNDANCY\[rq] -.RS 2 -.IP \[bu] 2 -Reduced redundancy storage class -.RE -.IP \[bu] 2 -\[lq]STANDARD_IA\[rq] -.RS 2 -.IP \[bu] 2 -Standard Infrequent Access storage class -.RE -.IP \[bu] 2 -\[lq]ONEZONE_IA\[rq] -.RS 2 -.IP \[bu] 2 -One Zone Infrequent Access storage class -.RE -.IP \[bu] 2 -\[lq]GLACIER\[rq] -.RS 2 -.IP \[bu] 2 -Glacier storage class -.RE -.IP \[bu] 2 -\[lq]DEEP_ARCHIVE\[rq] -.RS 2 -.IP \[bu] 2 -Glacier Deep Archive storage class -.RE -.IP \[bu] 2 -\[lq]INTELLIGENT_TIERING\[rq] -.RS 2 -.IP \[bu] 2 -Intelligent\-Tiering storage class -.RE -.RE -.SS \[en]s3\-storage\-class -.PP -The storage class to use when storing new objects in OSS. -.IP \[bu] 2 -Config: storage_class -.IP \[bu] 2 -Env Var: RCLONE_S3_STORAGE_CLASS -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -Default -.RE -.IP \[bu] 2 -\[lq]STANDARD\[rq] -.RS 2 -.IP \[bu] 2 -Standard storage class -.RE -.IP \[bu] 2 -\[lq]GLACIER\[rq] -.RS 2 -.IP \[bu] 2 -Archive storage mode. -.RE -.IP \[bu] 2 -\[lq]STANDARD_IA\[rq] -.RS 2 -.IP \[bu] 2 -Infrequent access storage mode. -.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, etc)). -.SS \[en]s3\-bucket\-acl -.PP -Canned ACL used when creating buckets. -.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't set then \[lq]acl\[rq] 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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]private\[rq] -.RS 2 -.IP \[bu] 2 -Owner gets FULL_CONTROL. -No one else has access rights (default). -.RE -.IP \[bu] 2 -\[lq]public\-read\[rq] -.RS 2 -.IP \[bu] 2 -Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -.RE -.IP \[bu] 2 -\[lq]public\-read\-write\[rq] -.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 -\[lq]authenticated\-read\[rq] -.RS 2 -.IP \[bu] 2 -Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -.RE -.RE -.SS \[en]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. -.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 \[en]s3\-chunk\-size -.PP -Chunk size to use for uploading. -.PP -When uploading files larger than upload_cutoff they will be uploaded as -multipart uploads using this chunk size. -.PP -Note that \[lq]\[en]s3\-upload\-concurrency\[rq] 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. -.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 \[en]s3\-disable\-checksum -.PP -Don't store MD5 checksum with object metadata -.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 \[en]s3\-session\-token -.PP -An AWS session token -.IP \[bu] 2 -Config: session_token -.IP \[bu] 2 -Env Var: RCLONE_S3_SESSION_TOKEN -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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. -.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 \[en]s3\-force\-path\-style -.PP -If true use path style access if false use virtual hosted style. -.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. -.PP -Some providers (eg Aliyun OSS or Netease COS) require this set to false. -.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 \[en]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't work, eg pre Jewel/v10 CEPH. -.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 \[en]s3\-use\-accelerate\-endpoint -.PP -If true use the AWS S3 accelerated endpoint. -.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 Anonymous access to public buckets -.PP -If you want to use rclone to access a public bucket, configure with a -blank \f[C]access_key_id\f[] and \f[C]secret_access_key\f[]. -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[] -.fi -.PP -Then use it as normal with the name of the public bucket, eg -.IP -.nf -\f[C] -rclone\ lsd\ anons3:1000genomes -\f[] -.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[] -.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[] or put -this in the config file as \f[C]upload_cutoff\ 0\f[] to work around a -bug which causes uploading of small files to fail. -.PP -Note also that Ceph sometimes puts \f[C]/\f[] 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[] escaped as \f[C]\\/\f[]. -Make sure you only write \f[C]/\f[] in the secret access key. -.PP -Eg the dump from Ceph looks something like this (irrelevant keys -removed). -.IP -.nf -\f[C] -{ -\ \ \ \ "user_id":\ "xxx", -\ \ \ \ "display_name":\ "xxxx", -\ \ \ \ "keys":\ [ -\ \ \ \ \ \ \ \ { -\ \ \ \ \ \ \ \ \ \ \ \ "user":\ "xxx", -\ \ \ \ \ \ \ \ \ \ \ \ "access_key":\ "xxxxxx", -\ \ \ \ \ \ \ \ \ \ \ \ "secret_key":\ "xxxxxx\\/xxxx" -\ \ \ \ \ \ \ \ } -\ \ \ \ ], -} -\f[] -.fi -.PP -Because this is a json dump, it is encoding the \f[C]/\f[] as -\f[C]\\/\f[], so if you use the secret key as \f[C]xxxxxx/xxxx\f[] 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] -[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[] -.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 \[lq]Applications & -API (https://cloud.digitalocean.com/settings/api/tokens)\[rq] page of -the DigitalOcean control panel. -They will be needed when promted by \f[C]rclone\ config\f[] for your -\f[C]access_key_id\f[] and \f[C]secret_access_key\f[]. -.PP -When prompted for a \f[C]region\f[] or \f[C]location_constraint\f[], -press enter to use the default value. -The region must be included in the \f[C]endpoint\f[] setting (e.g. -\f[C]nyc3.digitaloceanspaces.com\f[]). -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[], 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[] -.fi -.PP -The resulting configuration file should look like: -.IP -.nf -\f[C] -[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[] -.fi -.PP -Once configured, you can create a new Space and begin copying files. -For example: -.IP -.nf -\f[C] -rclone\ mkdir\ spaces:my\-new\-space -rclone\ copy\ /path/to/files\ spaces:my\-new\-space -\f[] -.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'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: -.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\ "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 -\f[] -.fi -.IP "2." 3 -Enter the name for the configuration -.IP -.nf -\f[C] -\ \ \ \ name>\ -\f[] -.fi -.IP "3." 3 -Select \[lq]s3\[rq] storage. -.IP -.nf -\f[C] -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 -\f[] -.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 -\ \ \ \ \ \ \ \\\ "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 -\f[] -.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[] -.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 -\ \ \ \ \ \ \ \\\ "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 -\f[] -.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 -\ \ \ \ \ \ \ \\\ "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 -\f[] -.fi -.IP "9." 3 -Specify a canned ACL. -IBM Cloud (Strorage) supports \[lq]public\-read\[rq] and -\[lq]private\[rq]. -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 -\ \ \ \ \ \ \\\ "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 -\f[] -.fi -.IP "12." 4 -Review the displayed configuration and accept to save the -\[lq]remote\[rq] 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[] -.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[] -.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 +Notes\ on\ above: -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 +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\[aq]s\ objects. -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 +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\ `rclone\ sync`. + +###\ 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 +`\-\-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 -Drive\ Capacity:\ 26\ GiB\ Free,\ 165\ GiB\ Total -\f[] -.fi -.PP -These details need to go into \f[C]rclone\ config\f[] 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[] -.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[] -.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[] -.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 -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 -force_path_style\ =\ false -server_side_encryption\ = -storage_class\ = -\f[] -.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) -\ \ \ \\\ "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 -\f[] -.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[] -.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[] -.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\ (""). -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 + +\-\ 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) +\ \ \ \ \-\ "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. -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 + +\-\ 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. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -access_key_id>\ accesskeyid + +\-\ 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. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -secret_access_key>\ secretaccesskey + +\-\ 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. +\ \ \ \ \-\ "sa\-east\-1" +\ \ \ \ \ \ \ \ \-\ South\ America\ (Sao\ Paulo)\ Region +\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ sa\-east\-1. + +####\ \-\-s3\-region + +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:\ \ \ \ \ "" +\-\ Examples: +\ \ \ \ \-\ "" +\ \ \ \ \ \ \ \ \-\ Use\ this\ if\ unsure.\ Will\ use\ v4\ signatures\ and\ an\ empty\ region. +\ \ \ \ \-\ "other\-v2\-signature" +\ \ \ \ \ \ \ \ \-\ Use\ this\ only\ if\ v4\ signatures\ don\[aq]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\-api.us\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Endpoint +\ \ \ \ \-\ "s3\-api.dal.us\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Dallas\ Endpoint +\ \ \ \ \-\ "s3\-api.wdc\-us\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Washington\ DC\ Endpoint +\ \ \ \ \-\ "s3\-api.sjc\-us\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ San\ Jose\ Endpoint +\ \ \ \ \-\ "s3\-api.us\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Private\ Endpoint +\ \ \ \ \-\ "s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Dallas\ Private\ Endpoint +\ \ \ \ \-\ "s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Washington\ DC\ Private\ Endpoint +\ \ \ \ \-\ "s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ San\ Jose\ Private\ Endpoint +\ \ \ \ \-\ "s3.us\-east.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ US\ Region\ East\ Endpoint +\ \ \ \ \-\ "s3.us\-east.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ US\ Region\ East\ Private\ Endpoint +\ \ \ \ \-\ "s3.us\-south.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ US\ Region\ South\ Endpoint +\ \ \ \ \-\ "s3.us\-south.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ US\ Region\ South\ Private\ Endpoint +\ \ \ \ \-\ "s3.eu\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Endpoint +\ \ \ \ \-\ "s3.fra\-eu\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Frankfurt\ Endpoint +\ \ \ \ \-\ "s3.mil\-eu\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Milan\ Endpoint +\ \ \ \ \-\ "s3.ams\-eu\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Amsterdam\ Endpoint +\ \ \ \ \-\ "s3.eu\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Private\ Endpoint +\ \ \ \ \-\ "s3.fra\-eu\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Frankfurt\ Private\ Endpoint +\ \ \ \ \-\ "s3.mil\-eu\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Milan\ Private\ Endpoint +\ \ \ \ \-\ "s3.ams\-eu\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Amsterdam\ Private\ Endpoint +\ \ \ \ \-\ "s3.eu\-gb.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Endpoint +\ \ \ \ \-\ "s3.eu\-gb.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Private\ Endpoint +\ \ \ \ \-\ "s3.ap\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Endpoint +\ \ \ \ \-\ "s3.tok\-ap\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Tokyo\ Endpoint +\ \ \ \ \-\ "s3.hkg\-ap\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ HongKong\ Endpoint +\ \ \ \ \-\ "s3.seo\-ap\-geo.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Seoul\ Endpoint +\ \ \ \ \-\ "s3.ap\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Private\ Endpoint +\ \ \ \ \-\ "s3.tok\-ap\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Tokyo\ Private\ Endpoint +\ \ \ \ \-\ "s3.hkg\-ap\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ HongKong\ Private\ Endpoint +\ \ \ \ \-\ "s3.seo\-ap\-geo.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Seoul\ Private\ Endpoint +\ \ \ \ \-\ "s3.mel01.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ Melbourne\ Single\ Site\ Endpoint +\ \ \ \ \-\ "s3.mel01.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ Melbourne\ Single\ Site\ Private\ Endpoint +\ \ \ \ \-\ "s3.tor01.objectstorage.softlayer.net" +\ \ \ \ \ \ \ \ \-\ Toronto\ Single\ Site\ Endpoint +\ \ \ \ \-\ "s3.tor01.objectstorage.service.networklayer.com" +\ \ \ \ \ \ \ \ \-\ Toronto\ Single\ Site\ Private\ Endpoint + +####\ \-\-s3\-endpoint + 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 + +\-\ 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\ 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) +\ \ \ \ \-\ "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\[aq]t\ set,\ for\ creating\ buckets\ too. + +For\ more\ info\ visit\ https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl + Note\ that\ this\ ACL\ is\ applied\ when\ server\ side\ copying\ objects\ as\ S3 doesn\[aq]t\ copy\ the\ ACL\ from\ the\ source\ but\ rather\ writes\ a\ fresh\ one. -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 + +\-\ 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 + 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 -\f[] -.fi -.SS Netease NOS -.PP -For Netease NOS configure as per the configurator -\f[C]rclone\ config\f[] setting the provider \f[C]Netease\f[]. -This will automatically set \f[C]force_path_style\ =\ false\f[] which is -necessary for it to run properly. -.SS Backblaze B2 -.PP -B2 is Backblaze's cloud storage system (https://www.backblaze.com/b2/). -.PP -Paths are specified as \f[C]remote:bucket\f[] (or \f[C]remote:\f[] for -the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:bucket/path/to/dir\f[]. -.PP -Here is an example of making a b2 configuration. -First run -.IP -.nf -\f[C] -rclone\ config + +\-\ 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. + +###\ 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\[aq]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\-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\ 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. + +\-\ Config:\ \ \ \ \ \ chunk_size +\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_CHUNK_SIZE +\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix +\-\ Default:\ \ \ \ \ 5M + +####\ \-\-s3\-disable\-checksum + +Don\[aq]t\ store\ MD5\ checksum\ with\ object\ metadata + +\-\ Config:\ \ \ \ \ \ disable_checksum +\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_DISABLE_CHECKSUM +\-\ Type:\ \ \ \ \ \ \ \ bool +\-\ Default:\ \ \ \ \ false + +####\ \-\-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\ Aliyun\ OSS\ or\ Netease\ COS)\ require\ this\ set\ to\ false. + +\-\ 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\[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 + +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 + + + +###\ 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: \f[] .fi .PP -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. +[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 = .IP .nf \f[C] + +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[] +.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\ `\-\-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). +\f[] +.fi +.PP +{ \[lq]user_id\[rq]: \[lq]xxx\[rq], \[lq]display_name\[rq]: +\[lq]xxxx\[rq], \[lq]keys\[rq]: [ { \[lq]user\[rq]: \[lq]xxx\[rq], +\[lq]access_key\[rq]: \[lq]xxxxxx\[rq], \[lq]secret_key\[rq]: +\[lq]xxxxxx/xxxx\[rq] } ], } +.IP +.nf +\f[C] + +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: +\f[] +.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 = +.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\ "[Applications\ &\ API](https://cloud.digitalocean.com/settings/api/tokens)"\ page\ of\ the\ DigitalOcean\ control\ panel.\ They\ will\ be\ needed\ when\ promted\ 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: +\f[] +.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[] +.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: +\f[] +.fi +.PP +rclone mkdir spaces:my\-new\-space rclone copy /path/to/files +spaces:my\-new\-space +.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'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. +\f[] +.fi +.IP +.nf +\f[C] +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/q>\ n -name>\ remote -Type\ of\ storage\ to\ configure. +n/s/q>\ n +\f[] +.fi +.IP +.nf +\f[C] + +2.\ Enter\ the\ name\ for\ the\ configuration +\f[] +.fi +.IP +.nf +\f[C] +name>\ +\f[] +.fi +.IP +.nf +\f[C] + +3.\ Select\ "s3"\ storage. +\f[] +.fi +.PP +Choose a number from below, or type in your own value 1 / Alias for an +existing remote \ \[lq]alias\[rq] 2 / Amazon Drive \ \[lq]amazon cloud +drive\[rq] 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, +Minio, IBM COS) \ \[lq]s3\[rq] 4 / Backblaze B2 \ \[lq]b2\[rq] [snip] 23 +/ http Connection \ \[lq]http\[rq] Storage> 3 +.IP +.nf +\f[C] + +4.\ Select\ IBM\ COS\ as\ the\ S3\ Storage\ Provider. +\f[] +.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 \ \[lq]AWS\[rq] 2 / Choose this +option to configure Storage to Ceph Systems \ \[lq]Ceph\[rq] 3 / Choose +this option to configure Storage to Dreamhost \ \[lq]Dreamhost\[rq] 4 / +Choose this option to the configure Storage to IBM COS S3 +\ \[lq]IBMCOS\[rq] 5 / Choose this option to the configure Storage to +Minio \ \[lq]Minio\[rq] Provider>4 +.IP +.nf +\f[C] + +5.\ Enter\ the\ Access\ Key\ and\ Secret. +\f[] +.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[] +.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[] +.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 -[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 +\ 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 \f[] .fi .PP -This remote is called \f[C]remote\f[] and can now be used like this -.PP -See all buckets +[snip] 34 / Toronto Single Site Private Endpoint +\ \[lq]s3.tor01.objectstorage.service.networklayer.com\[rq] endpoint>1 .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -Create a new bucket -.IP -.nf -\f[C] -rclone\ mkdir\ remote:bucket -\f[] -.fi -.PP -List the contents of a bucket -.IP -.nf -\f[C] -rclone\ ls\ remote:bucket -\f[] -.fi -.PP -Sync \f[C]/home/local/directory\f[] to the remote bucket, deleting any -excess files in the bucket. -.IP -.nf -\f[C] -rclone\ sync\ /home/local/directory\ remote:bucket -\f[] -.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's docs to create an Application Key with the required -permission and add the \f[C]applicationKeyId\f[] as the \f[C]account\f[] -and the \f[C]Application\ Key\f[] itself as the \f[C]key\f[]. -.PP -Note that you must put the \f[I]applicationKeyId\f[] as the -\f[C]account\f[] \[en] you can't use the master Account ID. -If you try then B2 will return 401 errors. -.SS \[en]fast\-list -.PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use -fewer transactions in exchange for more memory. -See the rclone docs (/docs/#fast-list) for more details. -.SS Modified time -.PP -The modified time is stored as metadata on the object as -\f[C]X\-Bz\-Info\-src_last_modified_millis\f[] 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 SHA1 checksums -.PP -The SHA1 checksums of the files are checked on upload and download and -will be used in the syncing process. -.PP -Large files (bigger than the limit in \f[C]\-\-b2\-upload\-cutoff\f[]) -which are uploaded in chunks will store their SHA1 on the object as -\f[C]X\-Bz\-Info\-large_file_sha1\f[] 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 (/overview/#features) for exactly which remotes support -SHA1. -.PP -Sources which don't support SHA1, in particular \f[C]crypt\f[] 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[] 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 -\f[C]\-\-transfers\ 32\f[] 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[] 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[] 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 \[lq]hard delete\[rq] of files with the -\f[C]\-\-b2\-hard\-delete\f[] 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[] flag. -.PP -\f[B]NB\f[] Note that \f[C]\-\-b2\-versions\f[] does not work with crypt -at the moment #1627 (https://github.com/rclone/rclone/issues/1627). -Using \[en]backup\-dir (/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 -\f[C]rclone\ cleanup\ remote:bucket\f[] 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[]. -.PP -Note that \f[C]cleanup\f[] will remove partially uploaded files from the -bucket if they are more than a day old. -.PP -When you \f[C]purge\f[] a bucket, the current and the old versions will -be deleted then the bucket will be deleted. -.PP -However \f[C]delete\f[] will cause the current versions of the files to -become hidden old versions. -.PP -Here is a session showing the listing and retrieval of an old version -followed by a \f[C]cleanup\f[] of the old versions. -.PP -Show current version and all the versions with \f[C]\-\-b2\-versions\f[] -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[] -.fi -.PP -Retrieve an old version -.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 +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 \f[] .fi -.PP -Clean up all the old versions and show that they've gone. .IP .nf \f[C] -$\ rclone\ \-q\ cleanup\ b2:cleanup\-test +\ 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" +\f[] +.fi +.PP +[snip] 32 / Toronto Flex \ \[lq]tor01\-flex\[rq] location_constraint>1 +.IP +.nf +\f[C] -$\ rclone\ \-q\ ls\ b2:cleanup\-test -\ \ \ \ \ \ \ \ 9\ one.txt +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. +\f[] +.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 \ \[lq]private\[rq] 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 \ \[lq]public\-read\[rq] 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 +\ \[lq]public\-read\-write\[rq] 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 +\ \[lq]authenticated\-read\[rq] acl> 1 +.IP +.nf +\f[C] -$\ rclone\ \-q\ \-\-b2\-versions\ ls\ b2:cleanup\-test -\ \ \ \ \ \ \ \ 9\ one.txt + +12.\ Review\ the\ displayed\ configuration\ and\ accept\ to\ save\ the\ "remote"\ then\ quit.\ The\ config\ file\ should\ look\ like\ this \f[] .fi -.SS Data usage -.PP -It is useful to know how many requests are sent to the server in -different scenarios. -.PP -All copy commands send the following 4 requests: .IP .nf \f[C] -/b2api/v1/b2_authorize_account -/b2api/v1/b2_create_bucket -/b2api/v1/b2_list_buckets -/b2api/v1/b2_list_file_names +[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[] .fi -.PP -The \f[C]b2_list_file_names\f[] 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: .IP .nf \f[C] -/b2api/v1/b2_get_upload_url -/b2api/v1/b2_upload_file/ + +13.\ Execute\ rclone\ commands \f[] .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: .IP .nf \f[C] -/b2api/v1/b2_start_large_file -/b2api/v1/b2_get_upload_part_url -/b2api/v1/b2_upload_part/ -/b2api/v1/b2_finish_large_file +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[] .fi -.SS Versions -.PP -Versions can be viewed with the \f[C]\-\-b2\-versions\f[] 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[] .IP .nf \f[C] -$\ rclone\ \-q\ ls\ b2:cleanup\-test -\ \ \ \ \ \ \ \ 9\ one.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 \f[] .fi .PP -And with +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] -$\ 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 + +These\ details\ need\ to\ go\ into\ `rclone\ config`\ like\ this.\ \ Note\ that\ it +is\ important\ to\ put\ the\ region\ in\ as\ stated\ above. \f[] .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[] no file write operations -are permitted, so you can'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: +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] -\&./rclone\ link\ B2:bucket/path/to/file.txt + +Which\ makes\ the\ config\ file\ look\ like\ this +\f[] +.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[] +.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[] +.fi +.PP +[scaleway] type = s3 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 force_path_style = false +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[] +.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) \ \[lq]s3\[rq] [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 \ \[lq]false\[rq] 2 / Get AWS credentials +from the environment (env vars or IAM) \ \[lq]true\[rq] 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. +\ \[lq]us\-east\-1\[rq] [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). +\ \[lq]private\[rq] [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 \ \[lq]AES256\[rq] 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 \ \[lq]STANDARD\[rq] 3 / Reduced redundancy +storage class \ \[lq]REDUCED_REDUNDANCY\[rq] 4 / Standard Infrequent +Access storage class \ \[lq]STANDARD_IA\[rq] storage_class> Remote +config \[em]\[em]\[em]\[em]\[em]\[em]\[en] [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 = +\[em]\[em]\[em]\[em]\[em]\[em]\[en] 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[] +.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[] +.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 ("\[lq]). 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) +\ \[rq]s3" [snip] Storage> s3 Choose your S3 provider. +Enter a string value. +Press Enter for the default ("\[lq]). Choose a number from below, or +type in your own value 1 / Amazon Web Services (AWS) S3 \ \[rq]AWS" 2 / +Alibaba Cloud Object Storage System (OSS) formerly Aliyun +\ \[lq]Alibaba\[rq] 3 / Ceph Object Storage \ \[lq]Ceph\[rq] [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 (\[lq]false\[rq]). +Choose a number from below, or type in your own value 1 / Enter AWS +credentials in the next step \ \[lq]false\[rq] 2 / Get AWS credentials +from the environment (env vars or IAM) \ \[lq]true\[rq] env_auth> 1 AWS +Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a string value. +Press Enter for the default ("\[lq]). 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 +(\[rq]\[lq]). secret_access_key> secretaccesskey Endpoint for OSS API. +Enter a string value. Press Enter for the default (\[rq]\[lq]). Choose a +number from below, or type in your own value 1 / East China 1 (Hangzhou) +\ \[rq]oss\-cn\-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai) +\ \[lq]oss\-cn\-shanghai.aliyuncs.com\[rq] 3 / North China 1 (Qingdao) +\ \[lq]oss\-cn\-qingdao.aliyuncs.com\[rq] [snip] endpoint> 1 Canned ACL +used when creating buckets and storing or copying objects. +.PP +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 ("\[lq]). Choose a number from below, or +type in your own value 1 / Owner gets FULL_CONTROL. No one else has +access rights (default). \ \[rq]private" 2 / Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +\ \[lq]public\-read\[rq] / 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 ("\[lq]). Choose a number from below, or +type in your own value 1 / Default \ \[rq]" 2 / Standard storage class +\ \[lq]STANDARD\[rq] 3 / Archive storage mode. +\ \[lq]GLACIER\[rq] 4 / Infrequent access storage mode. +\ \[lq]STANDARD_IA\[rq] storage_class> 1 Edit advanced config? +(y/n) y) Yes n) No y/n> n Remote config +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this +is OK e) Edit this remote d) Delete this remote y/e/d> y +.IP +.nf +\f[C] + +###\ 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\[aq]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. +\f[] +.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 \ \[lq]b2\[rq] [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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] +account = 123456789abc key = 0123456789abcdef0123456789abcdef0123456789 +endpoint = \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit +this remote d) Delete this remote y/e/d> y +.IP +.nf +\f[C] + +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\ /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\ `applicationKeyId`\ as\ the\ `account`\ and\ the +`Application\ Key`\ itself\ as\ the\ `key`. + +Note\ that\ you\ must\ put\ the\ _applicationKeyId_\ as\ the\ `account`\ \[en]\ you +can\[aq]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](/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](/overview/#restricted\-characters) +the\ following\ characters\ are\ also\ replaced: + +|\ Character\ |\ Value\ |\ Replacement\ | +|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| +|\ \\\ \ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | + +Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), +as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. + +###\ 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](/overview/#features)\ for\ exactly\ which\ remotes +support\ SHA1. + +Sources\ which\ don\[aq]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](/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. +\f[] +.fi +.PP +$ rclone \-q ls b2:cleanup\-test 9 one.txt +.PP +$ rclone \-q \[en]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] + +Retrieve\ an\ old\ version +\f[] +.fi +.PP +$ rclone \-q \[en]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\[en] 1 ncw +ncw 16 Jul 2 17:46 /tmp/one\-v2016\-07\-04\-141003\-000.txt +.IP +.nf +\f[C] + +Clean\ up\ all\ the\ old\ versions\ and\ show\ that\ they\[aq]ve\ gone. +\f[] +.fi +.PP +$ rclone \-q cleanup b2:cleanup\-test +.PP +$ rclone \-q ls b2:cleanup\-test 9 one.txt +.PP +$ rclone \-q \[en]b2\-versions ls b2:cleanup\-test 9 one.txt +.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: +\f[] +.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\ `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: +\f[] +.fi +.PP +/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ +.IP +.nf +\f[C] + +Uploading\ files\ requiring\ chunking,\ will\ send\ 2\ requests\ (one\ each\ to +start\ and\ finish\ the\ upload)\ and\ another\ 2\ requests\ for\ each\ chunk: +\f[] +.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\ `\-\-b2\-versions`\ flag.\ When\ it\ is\ set +rclone\ will\ show\ and\ act\ on\ older\ versions\ of\ files.\ \ For\ example + +Listing\ without\ `\-\-b2\-versions` +\f[] +.fi +.PP +$ rclone \-q ls b2:cleanup\-test 9 one.txt +.IP +.nf +\f[C] + +And\ with +\f[] +.fi +.PP +$ rclone \-q \[en]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\ `\-\-b2\-versions`\ no\ file\ write\ operations\ are +permitted,\ so\ you\ can\[aq]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: +\f[] +.fi +.PP +\&./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx -\f[] -.fi -.PP -or if run on a directory you will get: .IP .nf \f[C] -\&./rclone\ link\ B2:bucket/path + +or\ if\ run\ on\ a\ directory\ you\ will\ get: +\f[] +.fi +.PP +\&./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx -\f[] -.fi -.PP -you can then use the authorization token (the part of the url from the -\f[C]?Authorization=\f[] on) on any file path under that directory. -For example: .IP .nf \f[C] + +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: +\f[] +.fi +.PP 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 -\f[] -.fi -.SS Standard Options -.PP -Here are the standard options specific to b2 (Backblaze B2). -.SS \[en]b2\-account -.PP -Account ID or Application Key ID -.IP \[bu] 2 -Config: account -.IP \[bu] 2 -Env Var: RCLONE_B2_ACCOUNT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]b2\-key -.PP -Application Key -.IP \[bu] 2 -Config: key -.IP \[bu] 2 -Env Var: RCLONE_B2_KEY -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]b2\-hard\-delete -.PP -Permanently delete files on remote removal, otherwise hide files. -.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). -.SS \[en]b2\-endpoint -.PP -Endpoint for the service. -Leave blank normally. -.IP \[bu] 2 -Config: endpoint -.IP \[bu] 2 -Env Var: RCLONE_B2_ENDPOINT -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]b2\-test\-mode -.PP -A flag string for X\-Bz\-Test\-Mode header for debugging. -.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 -\[lq]fail_some_uploads\[rq] -.IP \[bu] 2 -\[lq]expire_some_account_authorization_tokens\[rq] -.IP \[bu] 2 -\[lq]force_cap_exceeded\[rq] -.PP -These will be set in the \[lq]X\-Bz\-Test\-Mode\[rq] 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: "" -.SS \[en]b2\-versions -.PP -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. -.IP \[bu] 2 -Config: versions -.IP \[bu] 2 -Env Var: RCLONE_B2_VERSIONS -.IP \[bu] 2 -Type: bool -.IP \[bu] 2 -Default: false -.SS \[en]b2\-upload\-cutoff -.PP -Cutoff for switching to chunked upload. -.PP -Files above this size will be uploaded in chunks of -\[lq]\[en]b2\-chunk\-size\[rq]. -.PP -This value should be set no larger than 4.657GiB (== 5GB). -.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 \[en]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 \[lq]\[en]transfers\[rq] 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 \[en]b2\-disable\-checksum -.PP -Disable checksums for large (> upload cutoff) files -.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 \[en]b2\-download\-url -.PP -Custom endpoint for downloads. -.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. -.IP \[bu] 2 -Config: download_url -.IP \[bu] 2 -Env Var: RCLONE_B2_DOWNLOAD_URL -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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. -.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 Box -.PP -Paths are specified as \f[C]remote:path\f[] -.PP -Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. -.PP -The initial setup for Box involves getting a token from Box which you -need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. -.PP -Here is an example of how to make a remote called \f[C]remote\f[]. -First run: .IP .nf \f[C] -\ rclone\ config -\f[] -.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\ /\ Box -\ \ \ \\\ "box" -[snip] -Storage>\ box -Box\ App\ Client\ Id\ \-\ leave\ blank\ normally. -client_id>\ -Box\ App\ Client\ Secret\ \-\ leave\ blank\ normally. -client_secret>\ -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\ =\ {"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 -\f[] -.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 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[] 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[] like this, -.PP -List directories in top level of your Box -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -List all the files in your Box -.IP -.nf -\f[C] -rclone\ ls\ remote: -\f[] -.fi -.PP -To copy a local directory to an Box directory called backup -.IP -.nf -\f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] -.fi -.SS Using rclone with an Enterprise account with SSO -.PP -If you have an \[lq]Enterprise\[rq] 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, -\[lq]Account\[rq] Tab, and then set the password in the -\[lq]Authentication\[rq] 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'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[]. -.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: -Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Type -====\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ==== -remote\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ box + +###\ Standard\ Options -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\[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\ =\ {"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 +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\[aq]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\-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 + +\-\ 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 + + + +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: \f[] .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. +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 +\ \[lq]box\[rq] [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 ("\[lq]). config_json> `enterprise' or +`user' depending on the type of token being requested. Enter a string +value. Press Enter for the default (\[rq]user\[lq]). 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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] +[remote] client_id = client_secret = token = +{\[rq]access_token\[lq]:\[rq]XXX\[lq],\[rq]token_type\[lq]:\[rq]bearer\[lq],\[rq]refresh_token\[lq]:\[rq]XXX\[lq],\[rq]expiry\[lq]:\[rq]XXX"} +\[em]\[em]\[em]\[em]\[em]\[em]\[en] 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\ `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\[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\ `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. +\f[] +.fi .PP -Box supports SHA1 type hashes, so you can use the \f[C]\-\-checksum\f[] +$ 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 +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = box token = +{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2017\-07\-08T23:40:08.059167677+01:00\[rq]} +\[em]\[em]\[em]\[em]\[em]\[em]\[en] Edit remote Value +\[lq]client_id\[rq] = "" Edit? +(y/n)> +.IP "l)" 3 +Yes +.IP "m)" 3 +No y/n> n Value \[lq]client_secret\[rq] = "" 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'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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] +[remote] type = box token = +{\[lq]access_token\[rq]:\[lq]YYY\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]YYY\[rq],\[lq]expiry\[rq]:\[lq]2017\-07\-23T12:22:29.259137901+01:00\[rq]} +\[em]\[em]\[em]\[em]\[em]\[em]\[en] +.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\ `\-\-checksum` flag. -.SS Transfers -.PP -For files above 50MB rclone will use a chunked transfer. -Rclone will upload up to \f[C]\-\-transfers\f[] 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[] 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. -.SS Standard Options -.PP -Here are the standard options specific to box (Box). -.SS \[en]box\-client\-id -.PP -Box App 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: "" -.SS \[en]box\-client\-secret -.PP -Box App 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: "" -.SS Advanced Options -.PP -Here are the advanced options specific to box (Box). -.SS \[en]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 \[en]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 Limitations -.PP -Note that Box is case insensitive so you can't have a file called -\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. -.PP -Box file names can't have the \f[C]\\\f[] character in. -rclone maps this to and from an identical looking unicode equivalent -\f[C]＼\f[]. -.PP -Box only supports filenames up to 255 characters in length. -.SS Cache (BETA) -.PP -The \f[C]cache\f[] remote wraps another existing remote and stores file -structure and its data for long running tasks like -\f[C]rclone\ mount\f[]. -.PP -To get started you just need to have an existing remote which can be -configured with \f[C]cache\f[]. -.PP -Here is an example of how to make a remote called \f[C]test\-cache\f[]. -First run: -.IP -.nf -\f[C] -\ rclone\ config + +####\ Restricted\ filename\ characters + +In\ addition\ to\ the\ [default\ restricted\ characters\ set](/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\ last\ character\ in\ the\ name: + +|\ Character\ |\ Value\ |\ Replacement\ | +|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| +|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | + +Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/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\ `\-\-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. + + +###\ Standard\ Options + +Here\ are\ the\ standard\ options\ specific\ to\ box\ (Box). + +####\ \-\-box\-client\-id + +Box\ App\ Client\ Id. +Leave\ blank\ normally. + +\-\ Config:\ \ \ \ \ \ client_id +\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_CLIENT_ID +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-box\-client\-secret + +Box\ App\ 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. + +\-\ Config:\ \ \ \ \ \ box_config_file +\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_BOX_CONFIG_FILE +\-\ 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\-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 + + + +###\ Limitations\ ### + +Note\ that\ Box\ is\ case\ insensitive\ so\ you\ can\[aq]t\ have\ a\ file\ called +"Hello.doc"\ and\ one\ called\ "hello.doc". + +Box\ file\ names\ can\[aq]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`. + +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: \f[] .fi .PP -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 \ \[lq]cache\[rq] [snip] Storage> cache Remote to cache. +Normally should contain a `:' and a path, eg +\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe +\[lq]myremote:\[rq] (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 \ \[lq]1m\[rq] 2 / 5 MB \ \[lq]5M\[rq] 3 / 10 MB \ \[lq]10M\[rq] +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: \[lq]s\[rq], \[lq]m\[rq], \[lq]h\[rq]. +Default: 5m Choose a number from below, or type in your own value 1 / 1 +hour \ \[lq]1h\[rq] 2 / 24 hours \ \[lq]24h\[rq] 3 / 24 hours +\ \[lq]48h\[rq] 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 \ \[lq]500M\[rq] 2 / 1 GB \ \[lq]1G\[rq] 3 / 10 GB +\ \[lq]10G\[rq] chunk_total_size> 3 Remote config +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [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 .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 -\ \ \ \\\ "cache" -[snip] -Storage>\ cache + +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\[aq]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`\ URL\[aq]s\ to\ ensure\ certificate\ validation\ succeeds. +These\ URL\[aq]s\ are\ used\ by\ Plex\ internally\ to\ connect\ to\ the\ Plex\ server\ securely. + +The\ format\ for\ this\ URL\[aq]s\ 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\ dependant\ 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\ informations\ (`\-\-cache\-info\-age`) +\-\ while\ writes\ aren\[aq]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\[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\ #### + +`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\ \[aq]:\[aq]\ 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\[aq]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 -\f[] -.fi -.PP -You can then use it like this, -.PP -List directories in top level of your drive -.IP -.nf -\f[C] -rclone\ lsd\ test\-cache: -\f[] -.fi -.PP -List all the files in your drive -.IP -.nf -\f[C] -rclone\ ls\ test\-cache: -\f[] -.fi -.PP -To start a cached mount -.IP -.nf -\f[C] -rclone\ mount\ \-\-allow\-other\ test\-cache:\ /var/tmp/test\-cache -\f[] -.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[]. -.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[] passes and the file is next in -line, \f[C]rclone\ move\f[] is used to move the file to the cloud + +\-\ 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 + +\-\ 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\ verifications\ 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\[aq]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\[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\ "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\[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 -.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[] when it's actually -deleted from the temporary path then \f[C]cache\f[] will simply swap the -source to the cloud provider without interrupting the reading (small -blip can happen though) + +\-\ 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 + + + +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\[aq]ll\ call\ it\ `remote:path`\ here. +Note\ that\ anything\ inside\ `remote:path`\ 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\ `s3:bucket`. + +Now\ configure\ `chunker`\ using\ `rclone\ config`.\ We\ will\ call\ this\ one\ `overlay` +to\ separate\ it\ from\ the\ `remote`\ itself. +\f[] +.fi .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[] flag. -.SS Write Support -.PP -Writes are supported through \f[C]cache\f[]. -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[] for reliable writes. -.PP -One special case is covered with \f[C]cache\-writes\f[] 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[] If Plex options are not configured, \f[C]cache\f[] will -function with its configured options without adapting any of its -settings. -.PP -How to enable? -Run \f[C]rclone\ config\f[] 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[]: \f[I]Configured value\f[] -during confirmed playback or \f[I]1\f[] 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[] URL's to ensure certificate -validation succeeds. -These URL's are used by Plex internally to connect to the Plex server -securely. -.PP -The format for this URL's is the following: -.PP -https://ip\-with\-dots\-replaced.server\-hash.plex.direct:32400/ -.PP -The \f[C]ip\-with\-dots\-replaced\f[] part can be any IPv4 address, -where the dots have been replaced with dashes, e.g. -\f[C]127.0.0.1\f[] becomes \f[C]127\-0\-0\-1\f[]. -.PP -To get the \f[C]server\-hash\f[] 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[] 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[] value. -.SS Known issues -.SS Mount and \[en]dir\-cache\-time -.PP -\[en]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[] 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[] to a lower time than -\f[C]\-\-cache\-info\-age\f[]. -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[] 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 dependant -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't use a very small interval for entry -informations (\f[C]\-\-cache\-info\-age\f[]) \- while writes aren't yet -optimised, you can still write through \f[C]cache\f[] 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[] remote. -\f[C]crypt\f[] 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[] \-> \f[B]crypt\f[] \-> \f[B]cache\f[] -.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're downloading the full file instead of -small chunks. -Organizing the remotes in this order yields better results: \f[B]cloud -remote\f[] \-> \f[B]cache\f[] \-> \f[B]crypt\f[] -.SS absolute remote paths -.PP -\f[C]cache\f[] can not differentiate between relative and absolute paths -for the wrapped remote. -Any path given in the \f[C]remote\f[] 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[] character. -.PP -This behavior is irrelevant for most backend types, but there are -backends where a leading \f[C]/\f[] changes the effective directory, -e.g.\ in the \f[C]sftp\f[] backend paths starting with a \f[C]/\f[] 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[] and \f[C]sftp:/bin\f[] will share the same -cache folder, even if they represent a different directory on the SSH -server. -.SS Cache and Remote Control (\[en]rc) -.PP -Cache supports the new \f[C]\-\-rc\f[] 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[] = path to remote \f[B](required)\f[] \- -\f[B]withData\f[] = true/false to delete cached data (chunks) as well -\f[I](optional, false by default)\f[] -.SS Standard Options -.PP -Here are the standard options specific to cache (Cache a remote). -.SS \[en]cache\-remote -.PP -Remote to cache. +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 \ \[lq]chunker\[rq] [snip] +Storage> chunker Remote to chunk/unchunk. Normally should contain a `:' and a path, eg \[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe \[lq]myremote:\[rq] (not recommended). -.IP \[bu] 2 -Config: remote -.IP \[bu] 2 -Env Var: RCLONE_CACHE_REMOTE -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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: "" -.SS \[en]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: "" -.SS \[en]cache\-plex\-password -.PP -The password of the Plex user -.IP \[bu] 2 -Config: plex_password -.IP \[bu] 2 -Env Var: RCLONE_CACHE_PLEX_PASSWORD -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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 -\[lq]1m\[rq] -.RS 2 -.IP \[bu] 2 -1MB -.RE -.IP \[bu] 2 -\[lq]5M\[rq] -.RS 2 -.IP \[bu] 2 -5 MB -.RE -.IP \[bu] 2 -\[lq]10M\[rq] -.RS 2 -.IP \[bu] 2 -10 MB -.RE -.RE -.SS \[en]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 -\[lq]1h\[rq] -.RS 2 -.IP \[bu] 2 -1 hour -.RE -.IP \[bu] 2 -\[lq]24h\[rq] -.RS 2 -.IP \[bu] 2 -24 hours -.RE -.IP \[bu] 2 -\[lq]48h\[rq] -.RS 2 -.IP \[bu] 2 -48 hours -.RE -.RE -.SS \[en]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 -\[lq]500M\[rq] -.RS 2 -.IP \[bu] 2 -500 MB -.RE -.IP \[bu] 2 -\[lq]1G\[rq] -.RS 2 -.IP \[bu] 2 -1 GB -.RE -.IP \[bu] 2 -\[lq]10G\[rq] -.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 \[en]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: "" -.SS \[en]cache\-plex\-insecure -.PP -Skip all certificate verifications 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: "" -.SS \[en]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: \[lq]$HOME/.cache/rclone/cache\-backend\[rq] -.SS \[en]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 \[lq]\[en]cache\-db\-path\[rq]. -If you specify a custom location for \[lq]\[en]cache\-db\-path\[rq] and -don't specify one for \[lq]\[en]cache\-chunk\-path\[rq] then -\[lq]\[en]cache\-chunk\-path\[rq] will use the same path as -\[lq]\[en]cache\-db\-path\[rq]. -.IP \[bu] 2 -Config: chunk_path -.IP \[bu] 2 -Env Var: RCLONE_CACHE_CHUNK_PATH -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: \[lq]$HOME/.cache/rclone/cache\-backend\[rq] -.SS \[en]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 \[en]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 \[lq]cache\-chunk\-total\-size\[rq] -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 \[en]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'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. -.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 \[en]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[]: 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 \[en]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't exceed the number of workers. -However, depending on other settings like \[lq]cache\-chunk\-size\[rq] -and \[lq]cache\-workers\[rq] 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 \[en]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'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[]: 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 \[en]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 \[en]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: "" -.SS \[en]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[] 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 \[en]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 Crypt -.PP -The \f[C]crypt\f[] 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. -.PP -First check your chosen remote is working \- we'll call it -\f[C]remote:path\f[] in these docs. -Note that anything inside \f[C]remote:path\f[] 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 -\f[C]s3:bucket\f[]. -If you just use \f[C]s3:\f[] then rclone will make encrypted bucket -names too (if using file name encryption) which may or may not be what -you want. -.PP -Now configure \f[C]crypt\f[] using \f[C]rclone\ config\f[]. -We will call this one \f[C]secret\f[] to differentiate it from the -\f[C]remote\f[]. +Enter a string value. +Press Enter for the default ("\[lq]). 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 (\[rq]2G\[lq]). chunk_size> 100M +Choose how chunker handles hash sums. All modes but\[rq]none" require +metadata. +Enter a string value. +Press Enter for the default (\[lq]md5\[rq]). +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 \ \[lq]none\[rq] 2 / MD5 for composite files \ \[lq]md5\[rq] 3 +/ SHA1 for composite files \ \[lq]sha1\[rq] 4 / MD5 for all files +\ \[lq]md5all\[rq] 5 / SHA1 for all files \ \[lq]sha1all\[rq] 6 / +Copying a file to chunker will request MD5 from the source falling back +to SHA1 if unsupported \ \[lq]md5quick\[rq] 7 / Similar to +\[lq]md5quick\[rq] but prefers SHA1 over MD5 \ \[lq]sha1quick\[rq] +hash_type> md5 Edit advanced config? +(y/n) y) Yes n) No y/n> n Remote config +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [overlay] type = chunker remote = +remote:bucket chunk_size = 100M hash_type = md5 +\[em]\[em]\[em]\[em]\[em]\[em]\[en] 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>\ 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 + +###\ 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\[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. + +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\ a\ different\ name +format\ using\ the\ `\-\-chunker\-name\-format`\ 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\[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\ `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\[aq]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\[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. + +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\ 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. + +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\ setings,\ you\ should +run\ data\ migration\ as\ described\ above. + +If\ wrapped\ remote\ is\ case\ insensitive,\ the\ chunker\ overlay\ will\ inherit +that\ property\ (so\ you\ can\[aq]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\ \[aq]:\[aq]\ 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](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: +\f[] +.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 ("\[lq]). Choose a number from below, or +type in your own value XX / Citrix Sharefile \ \[rq]sharefile" Storage> +sharefile ** See help for sharefile backend at: +https://rclone.org/sharefile/ ** +.PP +ID of the root folder +.PP +Leave blank to access \[lq]Personal Folders\[rq]. +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 ("\[lq]). Choose a number from below, or +type in your own value 1 / Access the Personal Folders. (Default) +\ \[rq]" 2 / Access the Favorites folder. +\ \[lq]favorites\[rq] 3 / Access all the shared folders. +\ \[lq]allshared\[rq] 4 / Access all the individual connectors. +\ \[lq]connectors\[rq] 5 / Access the home, favorites, and shared +folders as well as the connectors. +\ \[lq]top\[rq] 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 +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = sharefile endpoint = +https://XXX.sharefile.com token = +{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2019\-09\-30T19:41:45.878561877+01:00\[rq]} +\[em]\[em]\[em]\[em]\[em]\[em]\[en] 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\ `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\[aq]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](/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\ first\ or\ last\ character\ in\ the +name: + +|\ Character\ |\ Value\ |\ Replacement\ | +|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| +|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | +|\ .\ \ \ \ \ \ \ \ \ |\ 0x2E\ \ |\ ．\ \ \ \ \ \ \ \ \ \ \ | + +Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/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\ "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:\ \ \ \ \ "" + + + +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\[aq]ll\ call\ it +`remote:path`\ in\ these\ docs.\ \ Note\ that\ anything\ inside\ `remote:path` +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\ `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`. +\f[] +.fi +.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 \ \[lq]crypt\[rq] [snip] Storage> crypt Remote +to encrypt/decrypt. +Normally should contain a `:' and a path, eg +\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe +\[lq]myremote:\[rq] (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 \[lq].bin\[rq] extension only. +\ \[lq]off\[rq] 2 / Encrypt the filenames see the docs for the details. +\ \[lq]standard\[rq] 3 / Very simple filename obfuscation. +\ \[lq]obfuscate\[rq] 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. +\ \[lq]true\[rq] 2 / Don't encrypt directory names, leave them intact. +\ \[lq]false\[rq] 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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] +[secret] remote = remote:path filename_encryption = standard password = +*** ENCRYPTED \f[B]\f[BI] password2 = \f[B]\f[] ENCRYPTED *** +\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this +remote d) Delete this remote y/e/d> y +.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.\ \ Note +that\ if\ you\ reconfigure\ rclone\ with\ the\ same\ passwords/passphrases +elsewhere\ it\ will\ be\ compatible\ \-\ all\ the\ secrets\ used\ are\ derived +from\ those\ two\ passwords/passphrases. + +Note\ that\ rclone\ does\ not\ encrypt + +\ \ *\ file\ length\ \-\ this\ can\ be\ calcuated\ 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\[aq]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. +\f[] +.fi +.PP +plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── +file3.txt └── subsubdir └── file4.txt +.IP +.nf +\f[C] + +Copy\ these\ to\ the\ remote\ and\ list\ them\ back +\f[] +.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[] +.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[] +.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\ `.bin`\ extensions\ added\ to\ prevent\ the\ cloud\ provider +attempting\ to\ interpret\ the\ data. +\f[] +.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\ (~246\ characters) +\ \ *\ can\ use\ sub\ paths\ and\ copy\ single\ files + +Standard + +\ \ *\ file\ names\ encrypted +\ \ *\ file\ names\ can\[aq]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\[aq]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\[aq]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\ \[aq]:\[aq]\ and\ a\ path,\ eg\ "myremote:path/to/dir", "myremote:bucket"\ or\ maybe\ "myremote:"\ (not\ recommended). -remote>\ remote:path + +\-\ Config:\ \ \ \ \ \ remote +\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_REMOTE +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-crypt\-filename\-encryption + 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\ ".bin"\ extension\ only. -\ \ \ \\\ "off" -\ 2\ /\ Encrypt\ the\ filenames\ see\ the\ docs\ for\ the\ details. -\ \ \ \\\ "standard" -\ 3\ /\ Very\ simple\ filename\ obfuscation. -\ \ \ \\\ "obfuscate" -filename_encryption>\ 2 + +\-\ Config:\ \ \ \ \ \ filename_encryption +\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_FILENAME_ENCRYPTION +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "standard" +\-\ Examples: +\ \ \ \ \-\ "off" +\ \ \ \ \ \ \ \ \-\ Don\[aq]t\ encrypt\ the\ file\ names.\ \ Adds\ a\ ".bin"\ extension\ only. +\ \ \ \ \-\ "standard" +\ \ \ \ \ \ \ \ \-\ Encrypt\ the\ filenames\ see\ the\ docs\ for\ the\ details. +\ \ \ \ \-\ "obfuscate" +\ \ \ \ \ \ \ \ \-\ Very\ simple\ filename\ obfuscation. + +####\ \-\-crypt\-directory\-name\-encryption + 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\[aq]t\ encrypt\ directory\ names,\ leave\ them\ intact. -\ \ \ \\\ "false" -filename_encryption>\ 1 + +\-\ Config:\ \ \ \ \ \ directory_name_encryption +\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION +\-\ Type:\ \ \ \ \ \ \ \ bool +\-\ Default:\ \ \ \ \ true +\-\ Examples: +\ \ \ \ \-\ "true" +\ \ \ \ \ \ \ \ \-\ Encrypt\ directory\ names. +\ \ \ \ \-\ "false" +\ \ \ \ \ \ \ \ \-\ Don\[aq]t\ encrypt\ directory\ names,\ leave\ them\ intact. + +####\ \-\-crypt\-password + 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: + +\-\ 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. -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 + +\-\ 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\-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 + + + +##\ Backing\ up\ a\ crypted\ remote\ ## + +If\ you\ wish\ to\ backup\ a\ crypted\ remote,\ it\ it\ 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\[aq]t\ decrypt\ and\ encrypt\ unnecessarily + +For\ example,\ let\[aq]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\ 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\[aq]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\ 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\[aq]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\[aq]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\[aq]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: \f[] .fi -.PP -\f[B]Important\f[] 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. -.PP -A long passphrase is recommended, or you can use a random one. -Note that if you reconfigure rclone with the same passwords/passphrases -elsewhere it will be compatible \- all the secrets used are derived from -those two passwords/passphrases. -.PP -Note that rclone does not encrypt -.IP \[bu] 2 -file length \- this can be calcuated 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[] in. -If you specify the remote without a \f[C]:\f[] then rclone will use a -local directory of that name. -So if you use a remote of \f[C]/path/to/secret/files\f[] then rclone -will encrypt stuff to that directory. -If you use a remote of \f[C]name\f[] then rclone will put files in a -directory called \f[C]name\f[] in the current directory. -.PP -If you specify the remote as \f[C]remote:path/to/dir\f[] then rclone -will store encrypted files in \f[C]path/to/dir\f[] on the remote. -If you are using file name encryption, then when you save files to -\f[C]secret:subdir/subfile\f[] this will store them in the unencrypted -path \f[C]path/to/dir\f[] but the \f[C]subdir/subpath\f[] bit will be -encrypted. -.PP -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 -\f[C]remote:secretbucket\f[] 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 \[lq]standard\[rq] file -name encryption. -.IP -.nf -\f[C] -plaintext/ -├──\ file0.txt -├──\ file1.txt -└──\ subdir -\ \ \ \ ├──\ file2.txt -\ \ \ \ ├──\ file3.txt -\ \ \ \ └──\ subsubdir -\ \ \ \ \ \ \ \ └──\ file4.txt -\f[] -.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[] -.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[] -.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[] -.fi -.PP -If don't use file name encryption then the remote will look like this \- -note the \f[C]\&.bin\f[] 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[] -.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't hide file names or directory structure -.IP \[bu] 2 -allows for longer file names (~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't be as long (~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 \[lq]rotate\[rq] 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 \[lq]hello\[rq] may become \[lq]53.jgnnq\[rq] -.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's an intermediate between \[lq]off\[rq] and -\[lq]standard\[rq]. -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 \[lq]Standard\[rq] -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[] is encrypted to -\f[C]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\f[] -.PP -False -.PP -Only encrypts file names, skips directory names Example: -\f[C]1/12/123.txt\f[] is encrypted to -\f[C]1/12/qgm4avr35m5loi1th53ato71v0\f[] -.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[] command to -check the integrity of a crypted remote instead of -\f[C]rclone\ check\f[] which can't check the checksums properly. -.SS Standard Options -.PP -Here are the standard options specific to crypt (Encrypt/Decrypt a -remote). -.SS \[en]crypt\-remote -.PP -Remote to encrypt/decrypt. -Normally should contain a `:' and a path, eg -\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe -\[lq]myremote:\[rq] (not recommended). -.IP \[bu] 2 -Config: remote -.IP \[bu] 2 -Env Var: RCLONE_CRYPT_REMOTE -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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: \[lq]standard\[rq] -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]off\[rq] -.RS 2 -.IP \[bu] 2 -Don't encrypt the file names. -Adds a \[lq].bin\[rq] extension only. -.RE -.IP \[bu] 2 -\[lq]standard\[rq] -.RS 2 -.IP \[bu] 2 -Encrypt the filenames see the docs for the details. -.RE -.IP \[bu] 2 -\[lq]obfuscate\[rq] -.RS 2 -.IP \[bu] 2 -Very simple filename obfuscation. -.RE -.RE -.SS \[en]crypt\-directory\-name\-encryption -.PP -Option to either encrypt directory names or leave them intact. -.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 -\[lq]true\[rq] -.RS 2 -.IP \[bu] 2 -Encrypt directory names. -.RE -.IP \[bu] 2 -\[lq]false\[rq] -.RS 2 -.IP \[bu] 2 -Don't encrypt directory names, leave them intact. -.RE -.RE -.SS \[en]crypt\-password -.PP -Password or pass phrase for encryption. -.IP \[bu] 2 -Config: password -.IP \[bu] 2 -Env Var: RCLONE_CRYPT_PASSWORD -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]crypt\-password2 -.PP -Password or pass phrase for salt. -Optional but recommended. -Should be different to the previous password. -.IP \[bu] 2 -Config: password2 -.IP \[bu] 2 -Env Var: RCLONE_CRYPT_PASSWORD2 -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS Advanced Options -.PP -Here are the advanced options specific to crypt (Encrypt/Decrypt a -remote). -.SS \[en]crypt\-show\-mapping -.PP -For all files listed show how the names encrypt. -.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. -.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 Backing up a crypted remote -.PP -If you wish to backup a crypted remote, it it recommended that you use -\f[C]rclone\ sync\f[] on the encrypted files, and make sure the -passwords are the same in the new encrypted remote. -.PP -This will have the following advantages -.IP \[bu] 2 -\f[C]rclone\ sync\f[] will check the checksums while copying -.IP \[bu] 2 -you can use \f[C]rclone\ check\f[] between the encrypted remotes -.IP \[bu] 2 -you don't decrypt and encrypt unnecessarily -.PP -For example, let's say you have your original remote at \f[C]remote:\f[] -with the encrypted version at \f[C]eremote:\f[] with path -\f[C]remote:crypt\f[]. -You would then set up the new remote \f[C]remote2:\f[] and then the -encrypted version \f[C]eremote2:\f[] with path \f[C]remote2:crypt\f[] -using the same passwords as \f[C]eremote:\f[]. -.PP -To sync the two remotes you would do -.IP -.nf -\f[C] -rclone\ sync\ remote:crypt\ remote2:crypt -\f[] -.fi -.PP -And to check the integrity you would do -.IP -.nf -\f[C] -rclone\ check\ remote:crypt\ remote2:crypt -\f[] -.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\\x00\\x00\f[] -.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¹⁸ bytes) you would have a -probability of approximately 2×10⁻³² 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: -.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't be too big. -.PP -This uses a 32 byte (256 bit key) key derived from the user password. -.SS Examples -.PP -1 byte file will encrypt to -.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 -.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 \f[C]/\f[] separated strings and these are encrypted individually. -.PP -File segments are padded using 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 \[lq]A Parallelizable Enciphering Mode\[rq] 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't find it -on the cloud storage system. -.PP -This means that -.IP \[bu] 2 -filenames with the same name will encrypt the same -.IP \[bu] 2 -filenames which start the same won'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 \f[C]base32\f[] 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[] -.PP -\f[C]base32\f[] is used rather than the more efficient \f[C]base64\f[] -so rclone can be used on case insensitive remotes (eg Windows, Amazon -Drive). -.SS Key derivation -.PP -Rclone uses \f[C]scrypt\f[] with parameters \f[C]N=16384,\ r=8,\ p=1\f[] -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. -.PP -\f[C]scrypt\f[] 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[] -.PP -Dropbox paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. -.PP -The initial setup for dropbox involves getting a token from Dropbox -which you need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. -.PP -Here is an example of how to make a remote called \f[C]remote\f[]. -First run: -.IP -.nf -\f[C] -\ rclone\ config -\f[] -.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\ /\ 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: +.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 \ \[lq]dropbox\[rq] [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 -\f[] -.fi -.PP -You can then use it like this, -.PP -List directories in top level of your dropbox +Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] app_key = app_secret = +token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX +\[em]\[em]\[em]\[em]\[em]\[em]\[en] +.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] -rclone\ lsd\ remote: -\f[] -.fi -.PP -List all the files in your dropbox -.IP -.nf -\f[C] -rclone\ ls\ remote: -\f[] -.fi -.PP -To copy a local directory to a dropbox directory called backup -.IP -.nf -\f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] -.fi -.SS Dropbox for business -.PP -Rclone supports Dropbox for business and Team Folders. -.PP -When using Dropbox for business \f[C]remote:\f[] and -\f[C]remote:path/to/file\f[] will refer to your personal folder. -.PP -If you wish to see Team Folders you must use a leading \f[C]/\f[] in the -path, so \f[C]rclone\ lsd\ remote:/\f[] 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[] and -\f[C]remote:/TeamFolder/path/to/file\f[]. -.PP -A leading \f[C]/\f[] 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'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 \f[C]\-\-size\-only\f[] or -\f[C]\-\-checksum\f[] 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 Standard Options -.PP -Here are the standard options specific to dropbox (Dropbox). -.SS \[en]dropbox\-client\-id -.PP -Dropbox App 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: "" -.SS \[en]dropbox\-client\-secret -.PP -Dropbox App 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: "" -.SS Advanced Options -.PP -Here are the advanced options specific to dropbox (Dropbox). -.SS \[en]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 \[en]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: "" -.SS Limitations -.PP -Note that Dropbox is case insensitive so you can't have a file called -\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. -.PP -There are some file names such as \f[C]thumbs.db\f[] which Dropbox can't -store. -There is a full list of them in the \[lq]Ignored Files\[rq] 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[] if it attempts to -upload one of those file names, but the sync won't fail. -.PP -If you have more than 10,000 files in a directory then -\f[C]rclone\ purge\ dropbox:dir\f[] will return the error -\f[C]Failed\ to\ purge:\ There\ are\ too\ many\ files\ involved\ in\ this\ operation\f[]. -As a work\-around do an \f[C]rclone\ delete\ dropbox:dir\f[] followed by -an \f[C]rclone\ rmdir\ dropbox:dir\f[]. -.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) + +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\[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\ `\-\-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\ last\ character\ in\ the\ name: + +|\ Character\ |\ Value\ |\ Replacement\ | +|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| +|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | + +Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/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 + +Dropbox\ App\ Client\ Id +Leave\ blank\ normally. + +\-\ Config:\ \ \ \ \ \ client_id +\-\ Env\ Var:\ \ \ \ \ RCLONE_DROPBOX_CLIENT_ID +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-dropbox\-client\-secret + +Dropbox\ App\ 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\-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:\ \ \ \ \ "" + + + +###\ Limitations\ ### + +Note\ that\ Dropbox\ is\ case\ insensitive\ so\ you\ can\[aq]t\ have\ a\ file\ called +"Hello.doc"\ and\ one\ called\ "hello.doc". + +There\ are\ some\ file\ names\ such\ as\ `thumbs.db`\ which\ Dropbox\ can\[aq]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\[aq]t\ fail. + +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`. + +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. -.PP -Here is an example of making an FTP configuration. -First run -.IP -.nf -\f[C] -rclone\ config + +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. \f[] .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[] 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 ("\[lq]). Choose a number from below, or +type in your own value [snip] XX / FTP Connection \ \[rq]ftp" [snip] +Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ ** +.PP +FTP host to connect to Enter a string value. +Press Enter for the default ("\[lq]). Choose a number from below, or +type in your own value 1 / Connect to ftp.example.com +\ \[rq]ftp.example.com" host> ftp.example.com FTP username, leave blank +for current username, ncw Enter a string value. +Press Enter for the default ("\[lq]). user> FTP port, leave blank to use +default (21) Enter a string value. Press Enter for the default +(\[rq]\[lq]). 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 (\[rq]false"). +tls> Remote config \[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = +ftp host = ftp.example.com pass = *** ENCRYPTED *** +\[em]\[em]\[em]\[em]\[em]\[em]\[en] 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 -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/\ ** + +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\ /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. + +####\ Restricted\ filename\ characters + +In\ addition\ to\ the\ [default\ restricted\ characters\ set](/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\ 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\ explictly\ 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 -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>\ -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[] -.fi -.PP -This remote is called \f[C]remote\f[] and can now be used like this -.PP -See all directories in the home directory -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -Make a new directory -.IP -.nf -\f[C] -rclone\ mkdir\ remote:path/to/directory -\f[] -.fi -.PP -List the contents of a directory -.IP -.nf -\f[C] -rclone\ ls\ remote:path/to/directory -\f[] -.fi -.PP -Sync \f[C]/home/local/directory\f[] to the remote directory, deleting -any excess files in the directory. -.IP -.nf -\f[C] -rclone\ sync\ /home/local/directory\ remote:directory -\f[] -.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 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[] so the port will likely have to be -explictly set in the config for the remote. -.SS Standard Options -.PP -Here are the standard options specific to ftp (FTP Connection). -.SS \[en]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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]ftp.example.com\[rq] -.RS 2 -.IP \[bu] 2 -Connect to ftp.example.com -.RE -.RE -.SS \[en]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: "" -.SS \[en]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: "" -.SS \[en]ftp\-pass -.PP -FTP password -.IP \[bu] 2 -Config: pass -.IP \[bu] 2 -Env Var: RCLONE_FTP_PASS -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]ftp\-tls -.PP -Use FTP over TLS (Implicit) -.IP \[bu] 2 -Config: tls -.IP \[bu] 2 -Env Var: RCLONE_FTP_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 \[en]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 \[en]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 Limitations -.PP -Note that since FTP isn't HTTP based the following flags don't work with -it: \f[C]\-\-dump\-headers\f[], \f[C]\-\-dump\-bodies\f[], -\f[C]\-\-dump\-auth\f[] -.PP -Note that \f[C]\-\-timeout\f[] isn't supported (but -\f[C]\-\-contimeout\f[] is). -.PP -Note that \f[C]\-\-bind\f[] isn't supported. -.PP -FTP could support server side move but doesn't yet. -.PP -Note that the ftp backend does not support the \f[C]ftp_proxy\f[] -environment variable yet. -.PP -Note that while implicit FTP over TLS is supported, explicit FTP over -TLS is not. -.SS Google Cloud Storage -.PP -Paths are specified as \f[C]remote:bucket\f[] (or \f[C]remote:\f[] for -the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:bucket/path/to/dir\f[]. -.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[] walks you through it. -.PP -Here is an example of how to make a remote called \f[C]remote\f[]. -First run: -.IP -.nf -\f[C] -\ rclone\ config -\f[] -.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) -\ \ \ \\\ "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\[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\ =\ {"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 -\f[] -.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[] 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[] and can now be used like this -.PP -See all the buckets in your project -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -Make a new bucket -.IP -.nf -\f[C] -rclone\ mkdir\ remote:bucket -\f[] -.fi -.PP -List the contents of a bucket -.IP -.nf -\f[C] -rclone\ ls\ remote:bucket -\f[] -.fi -.PP -Sync \f[C]/home/local/directory\f[] to the remote bucket, deleting any -excess files in the bucket. -.IP -.nf -\f[C] -rclone\ sync\ /home/local/directory\ remote:bucket -\f[] -.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'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[] 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. -.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[] -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 \f[C]service_account_credentials\f[] -with the actual contents of the file instead, or set the equivalent -environment variable. -.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 \[en]fast\-list -.PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use -fewer transactions in exchange for more memory. -See the rclone docs (/docs/#fast-list) for more details. -.SS Modified time -.PP -Google google cloud storage stores md5sums natively and rclone stores -modification times as metadata on the object, under the \[lq]mtime\[rq] -key in RFC3339 format accurate to 1ns. -.SS Standard Options -.PP -Here are the standard options specific to google cloud storage (Google -Cloud Storage (this is not Google Drive)). -.SS \[en]gcs\-client\-id -.PP -Google Application 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: "" -.SS \[en]gcs\-client\-secret -.PP -Google Application 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: "" -.SS \[en]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: "" -.SS \[en]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. -.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: "" -.SS \[en]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: "" -.SS \[en]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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]authenticatedRead\[rq] -.RS 2 -.IP \[bu] 2 -Object owner gets OWNER access, and all Authenticated Users get READER -access. -.RE -.IP \[bu] 2 -\[lq]bucketOwnerFullControl\[rq] -.RS 2 -.IP \[bu] 2 -Object owner gets OWNER access, and project team owners get OWNER -access. -.RE -.IP \[bu] 2 -\[lq]bucketOwnerRead\[rq] -.RS 2 -.IP \[bu] 2 -Object owner gets OWNER access, and project team owners get READER -access. -.RE -.IP \[bu] 2 -\[lq]private\[rq] -.RS 2 -.IP \[bu] 2 -Object owner gets OWNER access [default if left blank]. -.RE -.IP \[bu] 2 -\[lq]projectPrivate\[rq] -.RS 2 -.IP \[bu] 2 -Object owner gets OWNER access, and project team members get access -according to their roles. -.RE -.IP \[bu] 2 -\[lq]publicRead\[rq] -.RS 2 -.IP \[bu] 2 -Object owner gets OWNER access, and all Users get READER access. -.RE -.RE -.SS \[en]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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]authenticatedRead\[rq] -.RS 2 -.IP \[bu] 2 -Project team owners get OWNER access, and all Authenticated Users get -READER access. -.RE -.IP \[bu] 2 -\[lq]private\[rq] -.RS 2 -.IP \[bu] 2 -Project team owners get OWNER access [default if left blank]. -.RE -.IP \[bu] 2 -\[lq]projectPrivate\[rq] -.RS 2 -.IP \[bu] 2 -Project team members get access according to their roles. -.RE -.IP \[bu] 2 -\[lq]publicRead\[rq] -.RS 2 -.IP \[bu] 2 -Project team owners get OWNER access, and all Users get READER access. -.RE -.IP \[bu] 2 -\[lq]publicReadWrite\[rq] -.RS 2 -.IP \[bu] 2 -Project team owners get OWNER access, and all Users get WRITER access. -.RE -.RE -.SS \[en]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: -.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 -.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 \[en]gcs\-location -.PP -Location for the newly created buckets. -.IP \[bu] 2 -Config: location -.IP \[bu] 2 -Env Var: RCLONE_GCS_LOCATION -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -Empty for default location (US). -.RE -.IP \[bu] 2 -\[lq]asia\[rq] -.RS 2 -.IP \[bu] 2 -Multi\-regional location for Asia. -.RE -.IP \[bu] 2 -\[lq]eu\[rq] -.RS 2 -.IP \[bu] 2 -Multi\-regional location for Europe. -.RE -.IP \[bu] 2 -\[lq]us\[rq] -.RS 2 -.IP \[bu] 2 -Multi\-regional location for United States. -.RE -.IP \[bu] 2 -\[lq]asia\-east1\[rq] -.RS 2 -.IP \[bu] 2 -Taiwan. -.RE -.IP \[bu] 2 -\[lq]asia\-east2\[rq] -.RS 2 -.IP \[bu] 2 -Hong Kong. -.RE -.IP \[bu] 2 -\[lq]asia\-northeast1\[rq] -.RS 2 -.IP \[bu] 2 -Tokyo. -.RE -.IP \[bu] 2 -\[lq]asia\-south1\[rq] -.RS 2 -.IP \[bu] 2 -Mumbai. -.RE -.IP \[bu] 2 -\[lq]asia\-southeast1\[rq] -.RS 2 -.IP \[bu] 2 -Singapore. -.RE -.IP \[bu] 2 -\[lq]australia\-southeast1\[rq] -.RS 2 -.IP \[bu] 2 -Sydney. -.RE -.IP \[bu] 2 -\[lq]europe\-north1\[rq] -.RS 2 -.IP \[bu] 2 -Finland. -.RE -.IP \[bu] 2 -\[lq]europe\-west1\[rq] -.RS 2 -.IP \[bu] 2 -Belgium. -.RE -.IP \[bu] 2 -\[lq]europe\-west2\[rq] -.RS 2 -.IP \[bu] 2 -London. -.RE -.IP \[bu] 2 -\[lq]europe\-west3\[rq] -.RS 2 -.IP \[bu] 2 -Frankfurt. -.RE -.IP \[bu] 2 -\[lq]europe\-west4\[rq] -.RS 2 -.IP \[bu] 2 -Netherlands. -.RE -.IP \[bu] 2 -\[lq]us\-central1\[rq] -.RS 2 -.IP \[bu] 2 -Iowa. -.RE -.IP \[bu] 2 -\[lq]us\-east1\[rq] -.RS 2 -.IP \[bu] 2 -South Carolina. -.RE -.IP \[bu] 2 -\[lq]us\-east4\[rq] -.RS 2 -.IP \[bu] 2 -Northern Virginia. -.RE -.IP \[bu] 2 -\[lq]us\-west1\[rq] -.RS 2 -.IP \[bu] 2 -Oregon. -.RE -.IP \[bu] 2 -\[lq]us\-west2\[rq] -.RS 2 -.IP \[bu] 2 -California. -.RE -.RE -.SS \[en]gcs\-storage\-class -.PP -The storage class to use when storing objects in Google Cloud Storage. -.IP \[bu] 2 -Config: storage_class -.IP \[bu] 2 -Env Var: RCLONE_GCS_STORAGE_CLASS -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -"" -.RS 2 -.IP \[bu] 2 -Default -.RE -.IP \[bu] 2 -\[lq]MULTI_REGIONAL\[rq] -.RS 2 -.IP \[bu] 2 -Multi\-regional storage class -.RE -.IP \[bu] 2 -\[lq]REGIONAL\[rq] -.RS 2 -.IP \[bu] 2 -Regional storage class -.RE -.IP \[bu] 2 -\[lq]NEARLINE\[rq] -.RS 2 -.IP \[bu] 2 -Nearline storage class -.RE -.IP \[bu] 2 -\[lq]COLDLINE\[rq] -.RS 2 -.IP \[bu] 2 -Coldline storage class -.RE -.IP \[bu] 2 -\[lq]DURABLE_REDUCED_AVAILABILITY\[rq] -.RS 2 -.IP \[bu] 2 -Durable reduced availability storage class -.RE -.RE -.SS Google Drive -.PP -Paths are specified as \f[C]drive:path\f[] -.PP -Drive paths may be as deep as required, eg -\f[C]drive:directory/subdirectory\f[]. -.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[] walks you through it. -.PP -Here is an example of how to make a remote called \f[C]remote\f[]. -First run: -.IP -.nf -\f[C] -\ rclone\ config -\f[] -.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 -\ \ \ \\\ "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\[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\ =\ {"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 -\f[] -.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[] 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 -.IP -.nf -\f[C] -rclone\ lsd\ remote: -\f[] -.fi -.PP -List all the files in your drive -.IP -.nf -\f[C] -rclone\ ls\ remote: -\f[] -.fi -.PP -To copy a local directory to a drive directory called backup -.IP -.nf -\f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] -.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). -.PP -The scope are -.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't sure. -.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. -.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't be able to see rclone'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[] for rclone. -This is the directory (identified by its \f[C]Folder\ ID\f[]) 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 \[lq]Computers\[rq] tab on the -drive web interface (where files from Google's Backup and Sync desktop -program go). -.PP -In order to do this you will have to find the \f[C]Folder\ ID\f[] 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 -\f[C]https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[] -in the browser, then you use \f[C]1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[] -as the \f[C]root_folder_id\f[] in the config. -.PP -\f[B]NB\f[] folders under the \[lq]Computers\[rq] tab seem to be read -only (drive gives a 500 error) when using rclone. -.PP -There doesn't appear to be an API to discover the folder IDs of the -\[lq]Computers\[rq] tab \- please contact us if you know otherwise! -.PP -Note also that rclone can't access any data under the \[lq]Backups\[rq] -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'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[] -prompt during \f[C]rclone\ config\f[] 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 \f[C]service_account_credentials\f[] -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'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 \f[B]example.com\f[], and the user -\f[B]foo\@example.com\f[]. -.PP -There's a few steps we need to go through to accomplish this: -.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't. -.IP \[bu] 2 -Then go to \[lq]IAM & admin\[rq] \-> \[lq]Service Accounts\[rq]. -.IP \[bu] 2 -Use the \[lq]Create Credentials\[rq] button. -Fill in \[lq]Service account name\[rq] with something that identifies -your client. -\[lq]Role\[rq] can be empty. -.IP \[bu] 2 -Tick \[lq]Furnish a new private key\[rq] \- select \[lq]Key type -JSON\[rq]. -.IP \[bu] 2 -Tick \[lq]Enable G Suite Domain\-wide Delegation\[rq]. -This option makes \[lq]impersonation\[rq] 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 \[lq]Delete service account -key\[rq] button. -.SS 2. Allowing API access to example.com Google Drive -.IP \[bu] 2 -Go to example.com's admin console -.IP \[bu] 2 -Go into \[lq]Security\[rq] (or use the search bar) -.IP \[bu] 2 -Select \[lq]Show more\[rq] and then \[lq]Advanced settings\[rq] -.IP \[bu] 2 -Select \[lq]Manage API client access\[rq] in the -\[lq]Authentication\[rq] section -.IP \[bu] 2 -In the \[lq]Client Name\[rq] field enter the service account's -\[lq]Client ID\[rq] \- this can be found in the Developer Console under -\[lq]IAM & Admin\[rq] \-> \[lq]Service Accounts\[rq], then \[lq]View -Client ID\[rq] for the newly created service account. -It is a ~21 character numerical string. -.IP \[bu] 2 -In the next field, \[lq]One or More API Scopes\[rq], enter -\f[C]https://www.googleapis.com/auth/drive\f[] 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 +\-\ 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 + +\-\ Config:\ \ \ \ \ \ pass +\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_PASS +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-ftp\-tls + +Use\ FTP\ over\ TLS\ (Implicit) + +\-\ Config:\ \ \ \ \ \ tls +\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_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 + + + +###\ Limitations\ ### + +Note\ that\ since\ FTP\ isn\[aq]t\ HTTP\ based\ the\ following\ flags\ don\[aq]t\ work +with\ it:\ `\-\-dump\-headers`,\ `\-\-dump\-bodies`,\ `\-\-dump\-auth` + +Note\ that\ `\-\-timeout`\ isn\[aq]t\ supported\ (but\ `\-\-contimeout`\ is). + +Note\ that\ `\-\-bind`\ isn\[aq]t\ supported. + +FTP\ could\ support\ server\ side\ move\ but\ doesn\[aq]t\ yet. + +Note\ that\ the\ ftp\ backend\ does\ not\ support\ the\ `ftp_proxy`\ environment +variable\ yet. + +Note\ that\ while\ implicit\ FTP\ over\ TLS\ is\ supported, +explicit\ FTP\ over\ TLS\ is\ not. + +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: \f[] .fi -.SS 4. Verify that it's working +.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) \ \[lq]google cloud +storage\[rq] [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. +\ \[lq]authenticatedRead\[rq] 2 / Object owner gets OWNER access, and +project team owners get OWNER access. +\ \[lq]bucketOwnerFullControl\[rq] 3 / Object owner gets OWNER access, +and project team owners get READER access. +\ \[lq]bucketOwnerRead\[rq] 4 / Object owner gets OWNER access [default +if left blank]. +\ \[lq]private\[rq] 5 / Object owner gets OWNER access, and project team +members get access according to their roles. +\ \[lq]projectPrivate\[rq] 6 / Object owner gets OWNER access, and all +Users get READER access. +\ \[lq]publicRead\[rq] 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. +\ \[lq]authenticatedRead\[rq] 2 / Project team owners get OWNER access +[default if left blank]. +\ \[lq]private\[rq] 3 / Project team members get access according to +their roles. +\ \[lq]projectPrivate\[rq] 4 / Project team owners get OWNER access, and +all Users get READER access. +\ \[lq]publicRead\[rq] 5 / Project team owners get OWNER access, and all +Users get WRITER access. +\ \[lq]publicReadWrite\[rq] 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. +\ \[lq]asia\[rq] 3 / Multi\-regional location for Europe. +\ \[lq]eu\[rq] 4 / Multi\-regional location for United States. +\ \[lq]us\[rq] 5 / Taiwan. +\ \[lq]asia\-east1\[rq] 6 / Tokyo. +\ \[lq]asia\-northeast1\[rq] 7 / Singapore. +\ \[lq]asia\-southeast1\[rq] 8 / Sydney. +\ \[lq]australia\-southeast1\[rq] 9 / Belgium. +\ \[lq]europe\-west1\[rq] 10 / London. +\ \[lq]europe\-west2\[rq] 11 / Iowa. +\ \[lq]us\-central1\[rq] 12 / South Carolina. +\ \[lq]us\-east1\[rq] 13 / Northern Virginia. +\ \[lq]us\-east4\[rq] 14 / Oregon. +\ \[lq]us\-west1\[rq] 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 \ \[lq]MULTI_REGIONAL\[rq] 3 / Regional +storage class \ \[lq]REGIONAL\[rq] 4 / Nearline storage class +\ \[lq]NEARLINE\[rq] 5 / Coldline storage class \ \[lq]COLDLINE\[rq] 6 / +Durable reduced availability storage class +\ \[lq]DURABLE_REDUCED_AVAILABILITY\[rq] storage_class> 5 Remote config +Use auto config? .IP \[bu] 2 -\f[C]rclone\ \-v\ \-\-drive\-impersonate\ foo\@example.com\ lsf\ gdrive:backup\f[] +Say Y if not sure .IP \[bu] 2 -The arguments do: -.RS 2 -.IP \[bu] 2 -\f[C]\-v\f[] \- verbose logging -.IP \[bu] 2 -\f[C]\-\-drive\-impersonate\ foo\@example.com\f[] \- this is what does -the magic, pretending to be user foo. -.IP \[bu] 2 -\f[C]lsf\f[] \- list files in a parsing friendly way -.IP \[bu] 2 -\f[C]gdrive:backup\f[] \- use the remote called gdrive, work in the -folder named backup. -.RE -.SS Team drives -.PP -If you want to configure the remote to point to a Google Team Drive then -answer \f[C]y\f[] to the question -\f[C]Configure\ this\ as\ a\ team\ drive?\f[]. -.PP -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. -.PP -For example: -.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 -\ \ \ \\\ "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 -\f[] -.fi -.SS \[en]fast\-list -.PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use -fewer transactions in exchange for more memory. -See the rclone docs (/docs/#fast-list) for more details. -.PP -It does this by combining multiple \f[C]list\f[] calls into a single API -request. -.PP -This works by combining many \f[C]\[aq]%s\[aq]\ in\ parents\f[] 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[] function: -.IP -.nf -\f[C] -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[] -.fi -.PP -These can now be combined into a single request: -.IP -.nf -\f[C] -trashed=false\ and\ (\[aq]a\[aq]\ in\ parents\ or\ \[aq]b\[aq]\ in\ parents\ or\ \[aq]c\[aq]\ in\ parents) -\f[] -.fi -.PP -The implementation of \f[C]ListR\f[] will put up to 50 \f[C]parents\f[] -filters into one request. -It will use the \f[C]\-\-checkers\f[] 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: -.IP -.nf -\f[C] -rclone\ lsjson\ \-vv\ \-R\ \-\-checkers=6\ gdrive:folder -\f[] -.fi -.PP -small folder (220 directories, 700 files): -.IP \[bu] 2 -without \f[C]\-\-fast\-list\f[]: 38s -.IP \[bu] 2 -with \f[C]\-\-fast\-list\f[]: 10s -.PP -large folder (10600 directories, 39000 files): -.IP \[bu] 2 -without \f[C]\-\-fast\-list\f[]: 22:05 min -.IP \[bu] 2 -with \f[C]\-\-fast\-list\f[]: 58s -.SS Modified time -.PP -Google drive stores modification times accurate to 1 ms. -.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[] flag, or set the equivalent -environment variable. -.SS Emptying trash -.PP -If you wish to empty your trash you can use the -\f[C]rclone\ cleanup\ remote:\f[] 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. -.SS Quota information -.PP -To view your current quota you can use the -\f[C]rclone\ about\ remote:\f[] 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 \f[C]\-\-drive\-export\-formats\f[] setting. -By default the export formats are \f[C]docx,xlsx,pptx,svg\f[] 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'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[], or if you prefer -openoffice/libreoffice formats you might use -\f[C]\-\-drive\-export\-formats\ ods,odt,odp\f[]. -.PP -Note that rclone adds the extension to the google doc, so if it is -called \f[C]My\ Spreadsheet\f[] on google docs, it will be exported as -\f[C]My\ Spreadsheet.xlsx\f[] or \f[C]My\ Spreadsheet.pdf\f[] etc. -.PP -When importing files into Google Drive, rclone will convert all files -with an extension in \f[C]\-\-drive\-import\-formats\f[] to their -associated document type. -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[] rules are applied to the uploaded -document. -.PP -Here are some examples for allowed and prohibited conversions. -.PP -.TS -tab(@); -l l l l l. -T{ -export\-formats -T}@T{ -import\-formats -T}@T{ -Upload Ext -T}@T{ -Document Ext -T}@T{ -Allowed -T} -_ -T{ -odt -T}@T{ -odt -T}@T{ -odt -T}@T{ -odt -T}@T{ +Say N if you are working on a remote or headless machine or Y didn't +work +.IP "y)" 3 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[]. -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[], 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[] 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 \[en]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: "" -.SS \[en]drive\-client\-secret -.PP -Google Application Client Secret Setting your own is recommended. -.IP \[bu] 2 -Config: client_secret -.IP \[bu] 2 -Env Var: RCLONE_DRIVE_CLIENT_SECRET -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]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: "" -.IP \[bu] 2 -Examples: -.RS 2 -.IP \[bu] 2 -\[lq]drive\[rq] -.RS 2 -.IP \[bu] 2 -Full access all files, excluding Application Data Folder. -.RE -.IP \[bu] 2 -\[lq]drive.readonly\[rq] -.RS 2 -.IP \[bu] 2 -Read\-only access to file metadata and file contents. -.RE -.IP \[bu] 2 -\[lq]drive.file\[rq] -.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 -\[lq]drive.appfolder\[rq] -.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 -\[lq]drive.metadata.readonly\[rq] -.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 \[en]drive\-root\-folder\-id -.PP -ID of the root folder Leave blank normally. -Fill in to access \[lq]Computers\[rq] folders. -(see docs). -.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: "" -.SS \[en]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. -.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: "" -.SS Advanced Options -.PP -Here are the advanced options specific to drive (Google Drive). -.SS \[en]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: "" -.SS \[en]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: "" -.SS \[en]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 \[en]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[] 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 \[en]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 \[en]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 identifed by being in the \[lq]photos\[rq] 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 \[en]drive\-shared\-with\-me -.PP -Only show files that are shared with me. -.PP -Instructs rclone to operate on your \[lq]Shared with me\[rq] folder -(where Google Drive lets you access the files and folders others have -shared with you). -.PP -This works both with the \[lq]list\[rq] (lsd, lsl, etc) and the -\[lq]copy\[rq] 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 \[en]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 \[en]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: "" -.SS \[en]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: \[lq]docx,xlsx,pptx,svg\[rq] -.SS \[en]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: "" -.SS \[en]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 \[en]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[]: This flag may have some unexpected consequences. -.PP -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 \[lq]\[en]checksum\[rq] -flag. -.PP -This feature was implemented to retain photos capture date as recorded -by google photos. -You will first need to check the \[lq]Create a Google Photos folder\[rq] -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 \[en]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 \[en]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: "" -.SS \[en]drive\-alternate\-export -.PP -Use alternate export URLs for google documents export., -.PP -If this option is set this instructs rclone to use an alternate set of -export URLs for drive documents. -Users have reported that the official export URLs can't export large -documents, whereas these unofficial ones can. -.PP -See rclone issue #2243 (https://github.com/rclone/rclone/issues/2243) -for background, this google drive -issue (https://issuetracker.google.com/issues/36761333) and this helpful -post (https://www.labnol.org/internet/direct-links-for-google-drive/28356/). -.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 \[en]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 \[en]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 \[en]drive\-acknowledge\-abuse -.PP -Set to allow files which return cannotDownloadAbusiveFile to be -downloaded. -.PP -If downloading a file returns the error \[lq]This file has been -identified as malware or spam and cannot be downloaded\[rq] with the -error code \[lq]cannotDownloadAbusiveFile\[rq] 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 \[en]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 \[en]drive\-size\-as\-quota -.PP -Show storage quota usage for file size. -.PP -The storage used by a file is the size of the current version plus any -older versions that have been set to keep forever. -.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 \[en]drive\-v2\-download\-min\-size -.PP -If Object'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 \[en]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 \[en]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 \[en]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't enabled by default because it isn't easy to tell if -it will work beween 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 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[] 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[] and as size 0 -in anything which uses the VFS layer, eg \f[C]rclone\ mount\f[], -\f[C]rclone\ serve\f[]. -.PP -This is because rclone can't find out the size of the Google docs -without downloading them. -.PP -Google docs will transfer correctly with \f[C]rclone\ sync\f[], -\f[C]rclone\ copy\f[] etc as rclone knows to ignore the size when doing -the transfer. -.PP -However an unfortunate consequence of this is that you can't download -Google docs using \f[C]rclone\ mount\f[] \- you will get a 0 sized file. -If you try again the doc may gain its correct size and be downloadable. -.SS Duplicated files -.PP -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. -.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[] to fix duplicated files. -.PP -Note that this isn'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't -.PP -The most likely cause of this is the duplicated file issue above \- run -\f[C]rclone\ dedupe\f[] and check your logs for duplicate object or -directory messages. -.PP -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 \[en]fast\-list. -Files that were uploaded recently may not appear on the directory list -sent to rclone when using \[en]fast\-list. -.PP -Waiting a moderate period of time between attempts (estimated to be -approximately 1 hour) and/or not using \[en]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'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'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 \[lq]ENABLE APIS AND SERVICES\[rq] search for \[lq]Drive\[rq], and -enable the \[lq]Google Drive API\[rq]. -.IP "4." 3 -Click \[lq]Credentials\[rq] in the left\-side panel (not \[lq]Create -credentials\[rq], which opens the wizard), then \[lq]Create -credentials\[rq], then \[lq]OAuth client ID\[rq]. -It will prompt you to set the OAuth consent screen product name, if you -haven't set one already. -.IP "5." 3 -Choose an application type of \[lq]other\[rq], and click -\[lq]Create\[rq]. -(the default name is fine) -.IP "6." 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 -(Thanks to \@balazer on github for these instructions.) -.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[] 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[] walks you through it. -.PP -Here is an example of how to make a remote called \f[C]remote\f[]. -First run: +.IP "z)" 3 +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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] +[remote] type = google cloud storage client_id = client_secret = token = +{\[lq]AccessToken\[rq]:\[lq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]RefreshToken\[rq]:\[lq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[rq],\[lq]Expiry\[rq]:\[lq]2014\-07\-17T20:49:14.929208288+01:00\[rq],\[lq]Extra\[rq]:null} +project_number = 12345678 object_acl = private bucket_acl = private +\[em]\[em]\[em]\[em]\[em]\[em]\[en] +.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] -\ rclone\ config -\f[] -.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\ (""). -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/\ ** + +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\ /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\ `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\[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\ `service_account_file` +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\ `service_account_credentials`\ with +the\ actual\ contents\ of\ the\ file\ instead,\ or\ set\ the\ equivalent +environment\ variable. + +###\ 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](/docs/#fast\-list)\ for\ more\ details. + +###\ 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](/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 Google\ Application\ Client\ Id Leave\ blank\ normally. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -client_id>\ + +\-\ Config:\ \ \ \ \ \ client_id +\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_CLIENT_ID +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +####\ \-\-gcs\-client\-secret + 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\[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 +\-\ Config:\ \ \ \ \ \ client_secret +\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_CLIENT_SECRET +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" -***\ 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. +####\ \-\-gcs\-project\-number -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -[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 +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. + +\-\ 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\-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 +\ \ \ \ \-\ "DURABLE_REDUCED_AVAILABILITY" +\ \ \ \ \ \ \ \ \-\ Durable\ reduced\ availability\ storage\ class + + + +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: \f[] .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. +Choose a number from below, or type in your own value [snip] XX / Google +Drive \ \[lq]drive\[rq] [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. +\ \[lq]drive\[rq] 2 / Read\-only access to file metadata and file +contents. +\ \[lq]drive.readonly\[rq] / 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. +\ \[lq]drive.file\[rq] / Allows read and write access to the Application +Data folder. +4 | This is not visible in the drive website. +\ \[lq]drive.appfolder\[rq] / Allows read\-only access to file metadata +but 5 | does not allow any access to read or download file content. +\ \[lq]drive.metadata.readonly\[rq] scope> 1 ID of the root folder \- +leave blank normally. +Fill in to access \[lq]Computers\[rq] 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 \[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] +client_id = client_secret = scope = drive root_folder_id = +service_account_file = token = +{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]Bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2014\-03\-16T13:57:58.955387075Z\[rq]} +\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this +remote d) Delete this remote y/e/d> y +.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\ `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\[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. + +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\[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\ `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\[aq]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\[aq]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\[aq]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\[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\ `service_account_file` +prompt\ during\ `rclone\ config`\ 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 +`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\[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\@example.com**. + +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\ "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\[aq]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\[aq]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\ ##### +\f[] +.fi +.PP +rclone config +.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\ ##### +\ \ \-\ `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. + +###\ 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: +\f[] +.fi +.PP +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 +\ \[lq]xxxxxxxxxxxxxxxxxxxx\[rq] 2 / Rclone Test 2 +\ \[lq]yyyyyyyyyyyyyyyyyyyy\[rq] 3 / Rclone Test 3 +\ \[lq]zzzzzzzzzzzzzzzzzzzz\[rq] Enter a Team Drive ID> 1 +\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] client_id = client_secret = +token = +{\[lq]AccessToken\[rq]:\[lq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]RefreshToken\[rq]:\[lq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]Expiry\[rq]:\[lq]2014\-03\-16T13:57:58.955387075Z\[rq],\[lq]Extra\[rq]:null} +team_drive = xxxxxxxxxxxxxxxxxxxx \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) +Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y +.IP +.nf +\f[C] + +###\ \-\-fast\-list\ ### + +This\ remote\ supports\ `\-\-fast\-list`\ which\ allows\ you\ to\ use\ fewer +transactions\ in\ exchange\ for\ more\ memory.\ See\ the\ [rclone +docs](/docs/#fast\-list)\ for\ more\ details. + +It\ does\ this\ by\ combining\ multiple\ `list`\ calls\ into\ a\ single\ API\ request. + +This\ works\ by\ combining\ many\ `\[aq]%s\[aq]\ 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: +\f[] +.fi +.PP +trashed=false and `a' in parents trashed=false and `b' in parents +trashed=false and `c' in parents +.IP +.nf +\f[C] +These\ can\ now\ be\ combined\ into\ a\ single\ request: +\f[] +.fi +.PP +trashed=false and (`a' in parents or `b' in parents or `c' in parents) +.IP +.nf +\f[C] + +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: +\f[] +.fi +.PP +rclone lsjson \-vv \-R \[en]checkers=6 gdrive:folder +.IP +.nf +\f[C] + +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](/overview/#invalid\-utf8), +as\ they\ can\[aq]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. + +###\ 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\[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\ `\-\-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 + +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 + +Google\ Application\ Client\ Secret +Setting\ your\ own\ is\ recommended. + +\-\ 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. + +Note\ that\ if\ this\ is\ blank,\ the\ first\ time\ rclone\ runs\ it\ will\ fill\ it +in\ with\ the\ ID\ of\ the\ root\ folder. + + +\-\ 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. + +\-\ Config:\ \ \ \ \ \ service_account_file +\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +\-\ Type:\ \ \ \ \ \ \ \ string +\-\ Default:\ \ \ \ \ "" + +###\ Advanced\ Options + +Here\ are\ the\ advanced\ options\ specific\ to\ drive\ (Google\ Drive). + +####\ \-\-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\ identifed\ 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\-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\[aq]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\-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\-alternate\-export + +Use\ alternate\ export\ URLs\ for\ google\ documents\ export., + +If\ this\ option\ is\ set\ this\ instructs\ rclone\ to\ use\ an\ alternate\ set\ of +export\ URLs\ for\ drive\ documents.\ \ Users\ have\ reported\ that\ the +official\ export\ URLs\ can\[aq]t\ export\ large\ documents,\ whereas\ these +unofficial\ ones\ can. + +See\ rclone\ issue\ [#2243](https://github.com/rclone/rclone/issues/2243)\ for\ background, +[this\ google\ drive\ issue](https://issuetracker.google.com/issues/36761333)\ and +[this\ helpful\ post](https://www.labnol.org/internet/direct\-links\-for\-google\-drive/28356/). + +\-\ Config:\ \ \ \ \ \ alternate_export +\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_ALTERNATE_EXPORT +\-\ Type:\ \ \ \ \ \ \ \ bool +\-\ Default:\ \ \ \ \ false + +####\ \-\-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\ storage\ quota\ usage\ for\ file\ size. + +The\ storage\ used\ by\ a\ file\ is\ the\ size\ of\ the\ current\ version\ plus\ any +older\ versions\ that\ have\ been\ set\ to\ keep\ forever. + +\-\ 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 + + + +###\ 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\[aq]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\[aq]t\ work\ you +will\ get\ a\ 0\ sized\ file.\ \ If\ you\ try\ again\ the\ doc\ may\ gain\ its +correct\ size\ and\ be\ downloadable.\ Whther\ 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\ `rclone\ dedupe`\ 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 +`rclone\ dedupe`\ 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\ "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",\ then +"OAuth\ client\ ID".\ \ It\ will\ prompt\ you\ to\ set\ the\ OAuth\ consent\ screen +product\ name,\ if\ you\ haven\[aq]t\ set\ one\ already. + +5.\ Choose\ an\ application\ type\ of\ "other",\ and\ click\ "Create".\ (the +default\ name\ is\ fine) + +6.\ 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. + +(Thanks\ to\ \@balazer\ on\ github\ for\ these\ instructions.) + +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: +\f[] +.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 ("\[lq]). Choose a number from below, or +type in your own value [snip] XX / Google Photos \ \[rq]google photos" +[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 ("\[lq]). client_id> Google Application +Client Secret Leave blank normally. Enter a string value. Press Enter +for the default (\[rq]"). +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 (\[lq]false\[rq]). +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 +.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). +T{ +[remote] type = google photos token = +{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]Bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2019\-06\-28T17:38:04.644930156+01:00\[rq]} +T} +_ +T{ +y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` +T} +T{ 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 @@ -18563,46 +16331,43 @@ get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[] and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode. -.PP +T} +T{ This remote is called \f[C]remote\f[] and can now be used like this -.PP +T} +T{ See all the albums in your photos -.IP -.nf -\f[C] -rclone\ lsd\ remote:album -\f[] -.fi -.PP +T} +T{ +rclone lsd remote:album +T} +T{ Make a new album -.IP -.nf -\f[C] -rclone\ mkdir\ remote:album/newAlbum -\f[] -.fi -.PP +T} +T{ +rclone mkdir remote:album/newAlbum +T} +T{ List the contents of an album -.IP -.nf -\f[C] -rclone\ ls\ remote:album/newAlbum -\f[] -.fi -.PP +T} +T{ +rclone ls remote:album/newAlbum +T} +T{ Sync \f[C]/home/local/images\f[] to the Google Photos, removing any excess files in the album. -.IP -.nf -\f[C] -rclone\ sync\ /home/local/image\ remote:album/newAlbum -\f[] -.fi -.SS Layout -.PP +T} +T{ +rclone sync /home/local/image remote:album/newAlbum +T} +T{ +## Layout +T} +T{ As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it. -.PP +T} +T{ The directories under \f[C]media\f[] show different ways of categorizing the media. Each file will appear multiple times. @@ -18610,61 +16375,20 @@ So if you want to make a backup of your google photos you might choose to backup \f[C]remote:media/by\-month\f[]. (\f[B]NB\f[] \f[C]remote:media/by\-day\f[] is rather slow at the moment so avoid for syncing.) -.PP +T} +T{ Note that all your photos and videos will appear somewhere under \f[C]media\f[], but they may not appear under \f[C]album\f[] unless you've put them into albums. -.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 -\f[] -.fi -.PP +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\f[] +T} +T{ There are two writable parts of the tree, the \f[C]upload\f[] directory and sub directories of the the \f[C]album\f[] directory. -.PP +T} +T{ The \f[C]upload\f[] 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 @@ -18673,92 +16397,92 @@ 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[] will work better. -.PP +T} +T{ Directories within the \f[C]album\f[] directory are also writeable and you may create new directories (albums) under \f[C]album\f[]. If you copy files with a directory hierarchy in there then rclone will create albums with the \f[C]/\f[] character in them. For example if you do -.IP -.nf -\f[C] -rclone\ copy\ /path/to/images\ remote:album/images -\f[] -.fi -.PP +T} +T{ +rclone copy /path/to/images remote:album/images +T} +T{ and the images directory contains -.IP -.nf -\f[C] -images -\ \ \ \ \-\ file1.jpg -\ \ \ \ dir -\ \ \ \ \ \ \ \ file2.jpg -\ \ \ \ dir2 -\ \ \ \ \ \ \ \ dir3 -\ \ \ \ \ \ \ \ \ \ \ \ file3.jpg -\f[] -.fi -.PP +T} +T{ +\f[C]images\ \-\ file1.jpg\ dir\ file2.jpg\ dir2\ dir3\ file3.jpg\f[] +T} +T{ Then rclone will create the following albums with the following files in -.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 +T} +T{ +\- images \- file1.jpg \- images/dir \- file2.jpg \- images/dir2/dir3 \- file3.jpg -.RE -.PP +T} +T{ This means that you can use the \f[C]album\f[] path pretty much like a normal filesystem and it is a good target for repeated syncing. -.PP +T} +T{ The \f[C]shared\-album\f[] directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface. -.SS Limitations -.PP +T} +T{ +## Limitations +T} +T{ 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. -.PP +T} +T{ Note that all media items uploaded to Google Photos through the API are stored in full resolution at \[lq]original quality\[rq] and \f[B]will\f[] count towards your storage quota in your Google Account. The API does \f[B]not\f[] offer a way to upload in \[lq]high quality\[rq] mode.. -.SS Downloading Images -.PP +T} +T{ +### Downloading Images +T} +T{ 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). -.SS Downloading Videos -.PP +T} +T{ +\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 \[lq]Google Photos\[rq] 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\f[] +T} +T{ +### Downloading Videos +T} +T{ 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). -.SS Duplicates -.PP +T} +T{ +### Duplicates +T} +T{ 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[] would then appear as \f[C]file\ {123456}.jpg\f[] and \f[C]file\ {ABCDEF}.jpg\f[] (the actual IDs are a lot longer alas!). -.PP +T} +T{ 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 @@ -18768,111 +16492,142 @@ the same image to \f[C]album/my_album\f[] the filename of the image in \f[C]album/my_album\f[] will be what it was uploaded with initially, not what you uploaded it with to \f[C]album\f[]. In practise this shouldn't cause too many problems. -.SS Modified time -.PP +T} +T{ +### Modified time +T} +T{ 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. -.PP +T} +T{ 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. -.SS Size -.PP +T} +T{ +### Size +T} +T{ 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. -.PP +T} +T{ 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. +HTTP HEAD request per media item so is \f[B]very slow\f[] and uses up a +lot of transactions. This can be enabled with the \f[C]\-\-gphotos\-read\-size\f[] option or the \f[C]read_size\ =\ true\f[] config parameter. -.PP -If you want to use the backend with \f[C]rclone\ mount\f[] you will need -to enable this flag otherwise you will not be able to read media off the -mount. -.SS Albums -.PP +T} +T{ +If you want to use the backend with \f[C]rclone\ mount\f[] 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. +T} +T{ +### Albums +T} +T{ 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). -.PP +T} +T{ Rclone can remove files it uploaded from albums it created only. -.SS Deleting files -.PP +T} +T{ +### Deleting files +T} +T{ 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). -.PP +T} +T{ Rclone cannot delete files anywhere except under \f[C]album\f[]. -.SS Deleting albums -.PP +T} +T{ +### Deleting albums +T} +T{ The Google Photos API does not support deleting albums \- see bug #135714733 (https://issuetracker.google.com/issues/135714733). -.SS Standard Options -.PP +T} +T{ + ### Standard Options +T} +T{ Here are the standard options specific to google photos (Google Photos). -.SS \[en]gphotos\-client\-id -.PP +T} +T{ +#### \[en]gphotos\-client\-id +T} +T{ Google Application Client Id Leave blank normally. -.IP \[bu] 2 -Config: client_id -.IP \[bu] 2 -Env Var: RCLONE_GPHOTOS_CLIENT_ID -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]gphotos\-client\-secret -.PP +T} +T{ +\- Config: client_id \- Env Var: RCLONE_GPHOTOS_CLIENT_ID \- Type: +string \- Default: "" +T} +T{ +#### \[en]gphotos\-client\-secret +T} +T{ Google Application Client Secret Leave blank normally. -.IP \[bu] 2 -Config: client_secret -.IP \[bu] 2 -Env Var: RCLONE_GPHOTOS_CLIENT_SECRET -.IP \[bu] 2 -Type: string -.IP \[bu] 2 -Default: "" -.SS \[en]gphotos\-read\-only -.PP +T} +T{ +\- Config: client_secret \- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET \- +Type: string \- Default: "" +T} +T{ +#### \[en]gphotos\-read\-only +T} +T{ Set to make the Google Photos backend read only. -.PP +T} +T{ If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. -.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 +T} +T{ +\- Config: read_only \- Env Var: RCLONE_GPHOTOS_READ_ONLY \- Type: bool +\- Default: false +T} +T{ +### Advanced Options +T} +T{ Here are the advanced options specific to google photos (Google Photos). -.SS \[en]gphotos\-read\-size -.PP +T} +T{ +#### \[en]gphotos\-read\-size +T} +T{ Set to read the size of media items. -.PP +T} +T{ 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. -.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 HTTP +T} +T{ +\- Config: read_size \- Env Var: RCLONE_GPHOTOS_READ_SIZE \- Type: bool +\- Default: false +T} +T{ +T} +T{ +HTTP +T} +.TE .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 @@ -19063,6 +16818,36 @@ Env Var: RCLONE_HTTP_NO_SLASH Type: bool .IP \[bu] 2 Default: false +.SS \[en]http\-no\-head +.PP +Don't use HEAD requests to find file sizes in dir listing +.PP +If your site is being very slow to load then you can try this option. +Normally rclone does a HEAD request for each potential file in a +directory listing to: +.IP \[bu] 2 +find its size +.IP \[bu] 2 +check it really exists +.IP \[bu] 2 +check to see if it is a directory +.PP +If you set this option, rclone will not do the HEAD request. +This will mean +.IP \[bu] 2 +directory listings are much quicker +.IP \[bu] 2 +rclone won't have the times or sizes of any files +.IP \[bu] 2 +some files that don't exist may be in the listing +.IP \[bu] 2 +Config: no_head +.IP \[bu] 2 +Env Var: RCLONE_HTTP_NO_HEAD +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Hubic .PP Paths are specified as \f[C]remote:path\f[] @@ -19408,6 +17193,76 @@ temporarily on disk (wherever the \f[C]TMPDIR\f[] environment variable points to) before it is uploaded. Small files will be cached in memory \- see the \f[C]\-\-jottacloud\-md5\-memory\-limit\f[] flag. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +" +T}@T{ +0x22 +T}@T{ +＂ +T} +T{ +* +T}@T{ +0x2A +T}@T{ +＊ +T} +T{ +: +T}@T{ +0x3A +T}@T{ +： +T} +T{ +< +T}@T{ +0x3C +T}@T{ +＜ +T} +T{ +> +T}@T{ +0x3E +T}@T{ +＞ +T} +T{ +? +T}@T{ +0x3F +T}@T{ +？ +T} +T{ +| +T}@T{ +0x7C +T}@T{ +｜ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in XML strings. .SS Deleting files .PP By default rclone will send all files to the trash when deleting files. @@ -19609,6 +17464,34 @@ To copy a local directory to an Koofr directory called backup rclone\ copy\ /home/source\ remote:backup \f[] .fi +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in XML strings. .SS Standard Options .PP Here are the standard options specific to koofr (Koofr). @@ -19678,6 +17561,487 @@ Default: true .PP Note that Koofr is case insensitive so you can't have a file called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +.SS Mail.ru Cloud +.PP +Mail.ru Cloud (https://cloud.mail.ru/) is a cloud storage provided by a +Russian internet company Mail.Ru Group (https://mail.ru). +The official desktop client is Disk\-O: (https://disk-o.cloud/), +available only on Windows. +(Please note that official sites are in Russian) +.SS Features highlights +.IP \[bu] 2 +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[] +.IP \[bu] 2 +Files have a \f[C]last\ modified\ time\f[] property, directories don't +.IP \[bu] 2 +Deleted files are by default moved to the trash +.IP \[bu] 2 +Files and directories can be shared via public links +.IP \[bu] 2 +Partial uploads or streaming are not supported, file size must be known +before upload +.IP \[bu] 2 +Maximum file size is limited to 2G for a free acount, unlimited for paid +accounts +.IP \[bu] 2 +Storage keeps hash for all files and performs transparent deduplication, +the hash algorithm is a modified SHA1 +.IP \[bu] 2 +If a particular file is already present in storage, one can quickly +submit file hash instead of long file upload (this optimization is +supported by rclone) +.SS Configuration +.PP +Here is an example of making a mailru configuration. +First create a Mail.ru Cloud account and choose a tariff, then run +.IP +.nf +\f[C] +rclone\ config +\f[] +.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. +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\ /\ Mail.ru\ Cloud +\ \ \ \\\ "mailru" +[snip] +Storage>\ mailru +User\ name\ (usually\ email) +Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). +user>\ username\@mail.ru +Password +y)\ Yes\ type\ in\ my\ own\ password +g)\ Generate\ random\ password +y/g>\ y +Enter\ the\ password: +password: +Confirm\ the\ password: +password: +Skip\ full\ upload\ if\ there\ is\ another\ file\ with\ same\ data\ hash. +This\ feature\ is\ called\ "speedup"\ or\ "put\ by\ hash".\ It\ is\ especially\ efficient +in\ case\ of\ generally\ available\ files\ like\ popular\ books,\ video\ or\ audio\ clips +[snip] +Enter\ a\ boolean\ value\ (true\ or\ false).\ Press\ Enter\ for\ the\ default\ ("true"). +Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value +\ 1\ /\ Enable +\ \ \ \\\ "true" +\ 2\ /\ Disable +\ \ \ \\\ "false" +speedup_enable>\ 1 +Edit\ advanced\ config?\ (y/n) +y)\ Yes +n)\ No +y/n>\ n +Remote\ config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type\ =\ mailru +user\ =\ username\@mail.ru +pass\ =\ ***\ ENCRYPTED\ *** +speedup_enable\ =\ true +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y)\ Yes\ this\ is\ OK +e)\ Edit\ this\ remote +d)\ Delete\ this\ remote +y/e/d>\ y +\f[] +.fi +.PP +Configuration of this backend does not require a local web browser. +You can use the configured backend as shown below: +.PP +See top level directories +.IP +.nf +\f[C] +rclone\ lsd\ remote: +\f[] +.fi +.PP +Make a new directory +.IP +.nf +\f[C] +rclone\ mkdir\ remote:directory +\f[] +.fi +.PP +List the contents of a directory +.IP +.nf +\f[C] +rclone\ ls\ remote:directory +\f[] +.fi +.PP +Sync \f[C]/home/local/directory\f[] to the remote path, deleting any +excess files in the path. +.IP +.nf +\f[C] +rclone\ sync\ /home/local/directory\ remote:directory +\f[] +.fi +.SS Modified time +.PP +Files support a modification time attribute with up to 1 second +precision. +Directories do not have a modification time, which is shown as \[lq]Jan +1 1970\[rq]. +.SS Hash checksums +.PP +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. +.SS Emptying Trash +.PP +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 +\f[C]rclone\ cleanup\ remote:\f[] command, which will permanently delete +all your trashed files. +This command does not take any path arguments. +.SS Quota information +.PP +To view your current quota you can use the +\f[C]rclone\ about\ remote:\f[] command which will display your usage +limit (quota) and the current usage. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +" +T}@T{ +0x22 +T}@T{ +＂ +T} +T{ +* +T}@T{ +0x2A +T}@T{ +＊ +T} +T{ +: +T}@T{ +0x3A +T}@T{ +： +T} +T{ +< +T}@T{ +0x3C +T}@T{ +＜ +T} +T{ +> +T}@T{ +0x3E +T}@T{ +＞ +T} +T{ +? +T}@T{ +0x3F +T}@T{ +？ +T} +T{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +T{ +| +T}@T{ +0x7C +T}@T{ +｜ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. +.SS Limitations +.PP +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. +.PP +Note that Mailru is case insensitive so you can't have a file called +\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +.SS Standard Options +.PP +Here are the standard options specific to mailru (Mail.ru Cloud). +.SS \[en]mailru\-user +.PP +User name (usually email) +.IP \[bu] 2 +Config: user +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_USER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: "" +.SS \[en]mailru\-pass +.PP +Password +.IP \[bu] 2 +Config: pass +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_PASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: "" +.SS \[en]mailru\-speedup\-enable +.PP +Skip full upload if there is another file with same data hash. +This feature is called \[lq]speedup\[rq] or \[lq]put by hash\[rq]. +It is especially efficient in case of generally available files like +popular books, video or audio clips, because files are searched by hash +in all accounts of all mailru users. +Please note that rclone may need local memory and disk space to +calculate content hash in advance and decide whether full upload is +required. +Also, if rclone does not know file size in advance (e.g.\ in case of +streaming or partial uploads), it will not even try this optimization. +.IP \[bu] 2 +Config: speedup_enable +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]true\[rq] +.RS 2 +.IP \[bu] 2 +Enable +.RE +.IP \[bu] 2 +\[lq]false\[rq] +.RS 2 +.IP \[bu] 2 +Disable +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to mailru (Mail.ru Cloud). +.SS \[en]mailru\-speedup\-file\-patterns +.PP +Comma separated list of file name patterns eligible for speedup (put by +hash). +Patterns are case insensitive and can contain '*' or `?' meta +characters. +.IP \[bu] 2 +Config: speedup_file_patterns +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: +\[lq]\f[I].mkv,\f[].avi,\f[I].mp4,\f[].mp3,\f[I].zip,\f[].gz,\f[I].rar,\f[].pdf\[rq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +"" +.RS 2 +.IP \[bu] 2 +Empty list completely disables speedup (put by hash). +.RE +.IP \[bu] 2 +"*" +.RS 2 +.IP \[bu] 2 +All files will be attempted for speedup. +.RE +.IP \[bu] 2 +\[lq]\f[I].mkv,\f[].avi,\f[I].mp4,\f[].mp3\[rq] +.RS 2 +.IP \[bu] 2 +Only common audio/video files will be tried for put by hash. +.RE +.IP \[bu] 2 +\[lq]\f[I].zip,\f[].gz,\f[I].rar,\f[].pdf\[rq] +.RS 2 +.IP \[bu] 2 +Only common archives or PDF books will be tried for speedup. +.RE +.RE +.SS \[en]mailru\-speedup\-max\-disk +.PP +This option allows you to disable speedup (put by hash) for large files +(because preliminary hashing can exhaust you RAM or disk space) +.IP \[bu] 2 +Config: speedup_max_disk +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 3G +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]0\[rq] +.RS 2 +.IP \[bu] 2 +Completely disable speedup (put by hash). +.RE +.IP \[bu] 2 +\[lq]1G\[rq] +.RS 2 +.IP \[bu] 2 +Files larger than 1Gb will be uploaded directly. +.RE +.IP \[bu] 2 +\[lq]3G\[rq] +.RS 2 +.IP \[bu] 2 +Choose this option if you have less than 3Gb free on local disk. +.RE +.RE +.SS \[en]mailru\-speedup\-max\-memory +.PP +Files larger than the size given below will always be hashed on disk. +.IP \[bu] 2 +Config: speedup_max_memory +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 32M +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]0\[rq] +.RS 2 +.IP \[bu] 2 +Preliminary hashing will always be done in a temporary disk location. +.RE +.IP \[bu] 2 +\[lq]32M\[rq] +.RS 2 +.IP \[bu] 2 +Do not dedicate more than 32Mb RAM for preliminary hashing. +.RE +.IP \[bu] 2 +\[lq]256M\[rq] +.RS 2 +.IP \[bu] 2 +You have at most 256Mb RAM free for hash calculations. +.RE +.RE +.SS \[en]mailru\-check\-hash +.PP +What should copy do if file checksum is mismatched or invalid +.IP \[bu] 2 +Config: check_hash +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_CHECK_HASH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]true\[rq] +.RS 2 +.IP \[bu] 2 +Fail with error. +.RE +.IP \[bu] 2 +\[lq]false\[rq] +.RS 2 +.IP \[bu] 2 +Ignore and continue. +.RE +.RE +.SS \[en]mailru\-user\-agent +.PP +HTTP user agent used internally by client. +Defaults to \[lq]rclone/VERSION\[rq] or \[lq]\[en]user\-agent\[rq] +provided on command line. +.IP \[bu] 2 +Config: user_agent +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_USER_AGENT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: "" +.SS \[en]mailru\-quirks +.PP +Comma separated list of internal maintenance flags. +This option must not be used by an ordinary user. +It is intended only to facilitate remote troubleshooting of backend +issues. +Strict meaning of flags is not documented and not guaranteed to persist +between releases. +Quirks will be removed when the backend grows stable. +Supported quirks: atomicmkdir binlist gzip insecure retry400 +.IP \[bu] 2 +Config: quirks +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_QUIRKS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: "" .SS Mega .PP Mega (https://mega.nz/) is a cloud storage and file hosting service @@ -19777,6 +18141,37 @@ rclone\ copy\ /home/source\ remote:backup .SS Modified time and hashes .PP Mega does not support modification times or hashes yet. +.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{ +␀ +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +／ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Duplicated files .PP Mega can have two files with exactly the same name and path (unlike a @@ -20000,6 +18395,64 @@ The modified time is stored as metadata on the object with the 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. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +/ +T}@T{ +0x2F +T}@T{ +／ +T} +T{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +.TE +.PP +File names can also not end with the following characters. +These only get replaced if they are last character in the name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\&. +T}@T{ +0x2E +T}@T{ +． +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Hashes .PP MD5 hashes are stored with blobs. @@ -20359,35 +18812,35 @@ performing requests by default. If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below: .IP "1." 3 -Open https://apps.dev.microsoft.com/#/appList, then click -\f[C]Add\ an\ app\f[] (Choose \f[C]Converged\ applications\f[] if -applicable) +Open +https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade, +then click \f[C]New\ registration\f[]. .IP "2." 3 -Enter a name for your app, and click continue. -Copy and keep the \f[C]Application\ Id\f[] under the app name for later -use. +Enter a name for your app, choose your account type, select \f[C]Web\f[] +in \f[C]Redirect\ URI\f[] Enter \f[C]http://localhost:53682/\f[] and +click Register. +Copy and keep the \f[C]Application\ (client)\ ID\f[] under the app name +for later use. .IP "3." 3 -Under section \f[C]Application\ Secrets\f[], click -\f[C]Generate\ New\ Password\f[]. -Copy and keep that password for later use. +Under \f[C]manage\f[] select \f[C]Certificates\ &\ secrets\f[], click +\f[C]New\ client\ secret\f[]. +Copy and keep that secret for later use. .IP "4." 3 -Under section \f[C]Platforms\f[], click \f[C]Add\ platform\f[], then -\f[C]Web\f[]. -Enter \f[C]http://localhost:53682/\f[] in \f[C]Redirect\ URLs\f[]. +Under \f[C]manage\f[] select \f[C]API\ permissions\f[], click +\f[C]Add\ a\ permission\f[] and select \f[C]Microsoft\ Graph\f[] then +select \f[C]delegated\ permissions\f[]. .IP "5." 3 -Under section \f[C]Microsoft\ Graph\ Permissions\f[], \f[C]Add\f[] these -\f[C]delegated\ permissions\f[]: \f[C]Files.Read\f[], +Search and select the follwing permssions: \f[C]Files.Read\f[], \f[C]Files.ReadWrite\f[], \f[C]Files.Read.All\f[], \f[C]Files.ReadWrite.All\f[], \f[C]offline_access\f[], \f[C]User.Read\f[]. -.IP "6." 3 -Scroll to the bottom and click \f[C]Save\f[]. +Once selected click \f[C]Add\ permissions\f[] at the bottom. .PP Now the application is complete. Run \f[C]rclone\ config\f[] to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps. -.SS Modified time and hashes +.SS Modification time and hashes .PP OneDrive allows modification times to be set on objects accurate to 1 second. @@ -20398,6 +18851,157 @@ OneDrive for business and Sharepoint Server support QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). .PP For all types of OneDrive you can use the \f[C]\-\-checksum\f[] flag. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +" +T}@T{ +0x22 +T}@T{ +＂ +T} +T{ +* +T}@T{ +0x2A +T}@T{ +＊ +T} +T{ +: +T}@T{ +0x3A +T}@T{ +： +T} +T{ +< +T}@T{ +0x3C +T}@T{ +＜ +T} +T{ +> +T}@T{ +0x3E +T}@T{ +＞ +T} +T{ +? +T}@T{ +0x3F +T}@T{ +？ +T} +T{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +T{ +| +T}@T{ +0x7C +T}@T{ +｜ +T} +T{ +# +T}@T{ +0x23 +T}@T{ +＃ +T} +T{ +% +T}@T{ +0x25 +T}@T{ +％ +T} +.TE +.PP +File names can also not end with the following characters. +These only get replaced if they are 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{ +␠ +T} +T{ +\&. +T}@T{ +0x2E +T}@T{ +． +T} +.TE +.PP +File names can also not begin with the following characters. +These only get replaced if they are first 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{ +␠ +T} +T{ +~ +T}@T{ +0x7E +T}@T{ +～ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Deleting files .PP Any files you delete with rclone will end up in the trash. @@ -20434,9 +19038,11 @@ Default: "" Here are the advanced options specific to onedrive (Microsoft OneDrive). .SS \[en]onedrive\-chunk\-size .PP -Chunk size to upload files with \- must be multiple of 320k. +Chunk size to upload files with \- must be multiple of 320k (327,680 +bytes). .PP -Above this size files will be chunked \- must be multiple of 320k. +Above this size files will be chunked \- must be multiple of 320k +(327,680 bytes). Note that the chunks will be buffered into memory. .IP \[bu] 2 Config: chunk_size @@ -20486,6 +19092,7 @@ Type: bool .IP \[bu] 2 Default: false .SS Limitations +.SS Naming .PP Note that OneDrive is case insensitive so you can't have a file called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. @@ -20497,15 +19104,18 @@ Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a \f[C]?\f[] in it will be mapped to \f[C]？\f[] instead. +.SS File sizes .PP The largest allowed file sizes are 15GB for OneDrive for Business and 35GB for OneDrive Personal (Updated 4 Jan 2019). +.SS Path length .PP The entire path, including the file name, must contain fewer than 400 characters for OneDrive, OneDrive for Business and SharePoint Online. If you are encrypting file and folder names with rclone, you may want to pay attention to this limitation because the encrypted names are typically longer than the original ones. +.SS Number of files .PP 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 @@ -20581,6 +19191,44 @@ Use rclone to upload or modify files. Restore the versioning settings after using rclone. (Optional) .SS Troubleshooting +.SS Unexpected file size/hash differences on Sharepoint +.PP +It is a +known (https://github.com/OneDrive/onedrive-api-docs/issues/935#issuecomment-441741631) +issue that Sharepoint (not OneDrive or OneDrive for Business) silently +modifies uploaded files, mainly Office files (.docx, .xlsx, etc.), +causing file size and hash checks to fail. +To use rclone with such affected files on Sharepoint, you may disable +these checks with the following command line arguments: +.IP +.nf +\f[C] +\-\-ignore\-checksum\ \-\-ignore\-size +\f[] +.fi +.SS Replacing/deleting existing files on Sharepoint gets \[lq]item not +found\[rq] +.PP +It is a +known (https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue +that Sharepoint (not OneDrive or OneDrive for Business) may return +\[lq]item not found\[rq] errors when users try to replace or delete +uploaded files; this seems to mainly affect Office files (.docx, .xlsx, +etc.). +As a workaround, you may use the \f[C]\-\-backup\-dir\ \f[] +command line argument so rclone moves the files to be replaced/deleted +into a given backup directory (instead of directly replacing/deleting +them). +For example, to instruct rclone to move the files into the directory +\f[C]rclone\-backup\-dir\f[] on backend \f[C]mysharepoint\f[], you may +use: +.IP +.nf +\f[C] +\-\-backup\-dir\ mysharepoint:rclone\-backup\-dir +\f[] +.fi +.SS access_denied (AADSTS65005) .IP .nf \f[C] @@ -20596,6 +19244,7 @@ You can't do much about it, maybe write an email to your admins. .PP However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint +.SS invalid_grant (AADSTS50076) .IP .nf \f[C] @@ -20696,6 +19345,145 @@ rclone\ copy\ /home/source\ remote:backup 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. +.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{ +␀ +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +／ +T} +T{ +" +T}@T{ +0x22 +T}@T{ +＂ +T} +T{ +* +T}@T{ +0x2A +T}@T{ +＊ +T} +T{ +: +T}@T{ +0x3A +T}@T{ +： +T} +T{ +< +T}@T{ +0x3C +T}@T{ +＜ +T} +T{ +> +T}@T{ +0x3E +T}@T{ +＞ +T} +T{ +? +T}@T{ +0x3F +T}@T{ +？ +T} +T{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +T{ +| +T}@T{ +0x7C +T}@T{ +｜ +T} +.TE +.PP +File names can also not begin or end with the following characters. +These only get replaced if they are the first or last character in the +name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +␠ +T} +T{ +HT +T}@T{ +0x09 +T}@T{ +␉ +T} +T{ +LF +T}@T{ +0x0A +T}@T{ +␊ +T} +T{ +VT +T}@T{ +0x0B +T}@T{ +␋ +T} +T{ +CR +T}@T{ +0x0D +T}@T{ +␍ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Standard Options .PP Here are the standard options specific to opendrive (OpenDrive). @@ -20890,6 +19678,14 @@ Secret Access Key: \f[C]QS_SECRET_ACCESS_KEY\f[] or \f[C]QS_SECRET_KEY\f[] .RE .RE +.SS Restricted filename characters +.PP +The control characters 0x00\-0x1F and / are replaced as in the default +restricted characters set (/overview/#restricted-characters). +Note that 0x7F is not replaced. +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Standard Options .PP Here are the standard options specific to qingstor (QingCloud Object @@ -21682,6 +20478,37 @@ accurate to 1 ns. .PP This is a defacto standard (used in the official python\-swiftclient amongst others) for storing the modification time for an object. +.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{ +␀ +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +／ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Limitations .PP The Swift API doesn't return a correct MD5SUM for segmented files @@ -21815,6 +20642,34 @@ re\-uploaded. .PP pCloud supports MD5 and SHA1 type hashes, so you can use the \f[C]\-\-checksum\f[] flag. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Deleting files .PP Deleted files will be moved to the trash. @@ -21948,6 +20803,41 @@ rclone\ copy\ /home/source\ remote:backup premiumize.me does not support modification times or hashes, therefore syncing will default to \f[C]\-\-size\-only\f[] checking. Note that using \f[C]\-\-update\f[] will work. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +T{ +" +T}@T{ +0x22 +T}@T{ +＂ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Standard Options .PP Here are the standard options specific to premiumizeme (premiumize.me). @@ -22085,6 +20975,34 @@ To copy a local directory to a put.io directory called backup rclone\ copy\ /home/source\ remote:backup \f[] .fi +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/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{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS SFTP .PP SFTP is the Secure (or SSH) File Transfer @@ -22364,9 +21282,23 @@ Type: bool Default: false .SS \[en]sftp\-use\-insecure\-cipher .PP -Enable the use of the aes128\-cbc cipher and -diffie\-hellman\-group\-exchange\-sha256, -diffie\-hellman\-group\-exchange\-sha1 key exchange. +Enable the use of insecure ciphers and key exchange methods. +.PP +This enables the use of the the following insecure ciphers and key +exchange methods: +.IP \[bu] 2 +aes128\-cbc +.IP \[bu] 2 +aes192\-cbc +.IP \[bu] 2 +aes256\-cbc +.IP \[bu] 2 +3des\-cbc +.IP \[bu] 2 +diffie\-hellman\-group\-exchange\-sha256 +.IP \[bu] 2 +diffie\-hellman\-group\-exchange\-sha1 +.PP Those algorithms are insecure and may allow plaintext data to be recovered by an attacker. .IP \[bu] 2 @@ -22415,6 +21347,9 @@ Here are the advanced options specific to sftp (SSH/SFTP Connection). .SS \[en]sftp\-ask\-password .PP Allow asking for SFTP password when needed. +.PP +If this is set and no password is supplied then rclone will: \- ask for +a password \- not contact the ssh agent .IP \[bu] 2 Config: ask_password .IP \[bu] 2 @@ -22976,6 +21911,22 @@ user\ =\ YourEmailAddress pass\ =\ encryptedpassword \f[] .fi +.SS Required Flags for SharePoint +.PP +As SharePoint does some special things with uploaded documents, you +won't be able to use the documents size or the documents hash to compare +if a file has been changed since the upload / which file is newer. +.PP +For Rclone calls copying files (especially Office files such as .docx, +\&.xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should +append these flags to ensure Rclone uses the \[lq]Last Modified\[rq] +datetime property to compare your documents: +.IP +.nf +\f[C] +\-\-ignore\-size\ \-\-ignore\-checksum\ \-\-update +\f[] +.fi .SS dCache .PP dCache is a storage system that supports many protocols and @@ -23069,9 +22020,6 @@ bearer_token_command\ =\ oidc\-token\ XDC Yandex Disk (https://disk.yandex.com) is a cloud storage solution created by Yandex (https://yandex.com). .PP -Yandex paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. -.PP Here is an example of making a yandex configuration. First run .IP @@ -23169,6 +22117,9 @@ excess files in the path. rclone\ sync\ /home/local/directory\ remote:directory \f[] .fi +.PP +Yandex paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[]. .SS Modified time .PP Modified times are supported and are stored accurate to 1 ns in custom @@ -23188,6 +22139,13 @@ This command does not take any path arguments. To view your current quota you can use the \f[C]rclone\ about\ remote:\f[] command which will display your usage limit (quota) and the current usage. +.SS Restricted filename characters +.PP +The default restricted characters set (/overview/#restricted-characters) +are replaced. +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be used in JSON strings. .SS Limitations .PP When uploading very large files (bigger than about 5GB) you will need to @@ -23266,7 +22224,7 @@ by the OS. Typically this is 1ns on Linux, 10 ns on Windows and 1 Second on OS X. .SS Filenames .PP -Filenames are expected to be encoded in UTF\-8 on disk. +Filenames should be encoded in UTF\-8 on disk. This is the normal case for Windows and OS X. .PP There is a bit more uncertainty in the Linux world, but new @@ -23277,7 +22235,8 @@ filesystem to UTF\-8. This tool is available in most distributions' package managers. .PP If an invalid (non\-UTF8) filename is read, the invalid characters will -be replaced with the unicode replacement character, `�'. +be replaced with a quoted representation of the invalid bytes. +The name \f[C]gro\\xdf\f[] will be transferred as \f[C]gro‛DF\f[]. \f[C]rclone\f[] will emit a debug message in this case (use \f[C]\-v\f[] to see), eg .IP @@ -23286,6 +22245,374 @@ to see), eg Local\ file\ system\ at\ .:\ Replacing\ invalid\ UTF\-8\ characters\ in\ "gro\\xdf" \f[] .fi +.SS Restricted characters +.PP +On non Windows platforms the following characters are replaced when +handling file names. +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +␀ +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +／ +T} +.TE +.PP +When running on Windows the following characters are replaced. +This list is based on the Windows file naming +conventions (https://docs.microsoft.com/de-de/windows/desktop/FileIO/naming-a-file#naming-conventions). +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +␀ +T} +T{ +SOH +T}@T{ +0x01 +T}@T{ +␁ +T} +T{ +STX +T}@T{ +0x02 +T}@T{ +␂ +T} +T{ +ETX +T}@T{ +0x03 +T}@T{ +␃ +T} +T{ +EOT +T}@T{ +0x04 +T}@T{ +␄ +T} +T{ +ENQ +T}@T{ +0x05 +T}@T{ +␅ +T} +T{ +ACK +T}@T{ +0x06 +T}@T{ +␆ +T} +T{ +BEL +T}@T{ +0x07 +T}@T{ +␇ +T} +T{ +BS +T}@T{ +0x08 +T}@T{ +␈ +T} +T{ +HT +T}@T{ +0x09 +T}@T{ +␉ +T} +T{ +LF +T}@T{ +0x0A +T}@T{ +␊ +T} +T{ +VT +T}@T{ +0x0B +T}@T{ +␋ +T} +T{ +FF +T}@T{ +0x0C +T}@T{ +␌ +T} +T{ +CR +T}@T{ +0x0D +T}@T{ +␍ +T} +T{ +SO +T}@T{ +0x0E +T}@T{ +␎ +T} +T{ +SI +T}@T{ +0x0F +T}@T{ +␏ +T} +T{ +DLE +T}@T{ +0x10 +T}@T{ +␐ +T} +T{ +DC1 +T}@T{ +0x11 +T}@T{ +␑ +T} +T{ +DC2 +T}@T{ +0x12 +T}@T{ +␒ +T} +T{ +DC3 +T}@T{ +0x13 +T}@T{ +␓ +T} +T{ +DC4 +T}@T{ +0x14 +T}@T{ +␔ +T} +T{ +NAK +T}@T{ +0x15 +T}@T{ +␕ +T} +T{ +SYN +T}@T{ +0x16 +T}@T{ +␖ +T} +T{ +ETB +T}@T{ +0x17 +T}@T{ +␗ +T} +T{ +CAN +T}@T{ +0x18 +T}@T{ +␘ +T} +T{ +EM +T}@T{ +0x19 +T}@T{ +␙ +T} +T{ +SUB +T}@T{ +0x1A +T}@T{ +␚ +T} +T{ +ESC +T}@T{ +0x1B +T}@T{ +␛ +T} +T{ +FS +T}@T{ +0x1C +T}@T{ +␜ +T} +T{ +GS +T}@T{ +0x1D +T}@T{ +␝ +T} +T{ +RS +T}@T{ +0x1E +T}@T{ +␞ +T} +T{ +US +T}@T{ +0x1F +T}@T{ +␟ +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +／ +T} +T{ +" +T}@T{ +0x22 +T}@T{ +＂ +T} +T{ +* +T}@T{ +0x2A +T}@T{ +＊ +T} +T{ +: +T}@T{ +0x3A +T}@T{ +： +T} +T{ +< +T}@T{ +0x3C +T}@T{ +＜ +T} +T{ +> +T}@T{ +0x3E +T}@T{ +＞ +T} +T{ +? +T}@T{ +0x3F +T}@T{ +？ +T} +T{ +\\ +T}@T{ +0x5C +T}@T{ +＼ +T} +T{ +| +T}@T{ +0x7C +T}@T{ +｜ +T} +.TE +.PP +File names on Windows can also not end with the following characters. +These only get replaced if they are 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{ +␠ +T} +T{ +\&. +T}@T{ +0x2E +T}@T{ +． +T} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can't be converted to UTF\-16. .SS Long paths on Windows .PP Rclone handles long paths automatically, by converting all paths to long @@ -23536,7 +22863,7 @@ Disables long file names .SS Advanced Options .PP Here are the advanced options specific to local (Local Disk). -.SS \[en]copy\-links +.SS \[en]copy\-links / \-L .PP Follow symlinks and copy the pointed to item. .IP \[bu] 2 @@ -23547,7 +22874,7 @@ Env Var: RCLONE_LOCAL_COPY_LINKS Type: bool .IP \[bu] 2 Default: false -.SS \[en]links +.SS \[en]links / \-l .PP Translate symlinks to/from regular files with a `.rclonelink' extension .IP \[bu] 2 @@ -23606,7 +22933,7 @@ Env Var: RCLONE_LOCAL_NO_CHECK_UPDATED Type: bool .IP \[bu] 2 Default: false -.SS \[en]one\-file\-system +.SS \[en]one\-file\-system / \-x .PP Don't cross filesystem boundaries (unix/macOS only). .IP \[bu] 2 @@ -23648,6 +22975,415 @@ Type: bool .IP \[bu] 2 Default: false .SH Changelog +.SS v1.50.0 \- 2019\-10\-26 +.IP \[bu] 2 +New backends +.RS 2 +.IP \[bu] 2 +Citrix Sharefile (/sharefile) (Nick Craig\-Wood) +.IP \[bu] 2 +Chunker (/chunker) \- an overlay backend to split files into smaller +parts (Ivan Andreev) +.IP \[bu] 2 +Mail.ru Cloud (/mailru) (Ivan Andreev) +.RE +.IP \[bu] 2 +New Features +.RS 2 +.IP \[bu] 2 +encodings (Fabian Möller & Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +All backends now use file name encoding to ensure any file name can be +written to any backend. +.IP \[bu] 2 +See the restricted file name docs (/overview/#restricted-filenames) for +more info and the local backend docs (/local/#filenames). +.IP \[bu] 2 +Some file names may look different in rclone if you are using any +control characters in names or unicode FULLWIDTH +symbols (https://en.wikipedia.org/wiki/Halfwidth_and_Fullwidth_Forms_(Unicode_block)). +.RE +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Update to use go1.13 for the build (Nick Craig\-Wood) +.IP \[bu] 2 +Drop support for go1.9 (Nick Craig\-Wood) +.IP \[bu] 2 +Build rclone with GitHub actions (Nick Craig\-Wood) +.IP \[bu] 2 +Convert python scripts to python3 (Nick Craig\-Wood) +.IP \[bu] 2 +Swap Azure/go\-ansiterm for mattn/go\-colorable (Nick Craig\-Wood) +.IP \[bu] 2 +Dockerfile fixes (Matei David) +.IP \[bu] 2 +Add plugin +support (https://github.com/rclone/rclone/blob/master/CONTRIBUTING.md#writing-a-plugin) +for backends and commands (Richard Patel) +.RE +.IP \[bu] 2 +config +.RS 2 +.IP \[bu] 2 +Use alternating Red/Green in config to make more obvious (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +contrib +.RS 2 +.IP \[bu] 2 +Add sample DLNA server Docker Compose manifest. +(pataquets) +.IP \[bu] 2 +Add sample WebDAV server Docker Compose manifest. +(pataquets) +.RE +.IP \[bu] 2 +copyurl +.RS 2 +.IP \[bu] 2 +Add \f[C]\-\-auto\-filename\f[] flag for using file name from URL in +destination path (Denis) +.RE +.IP \[bu] 2 +serve dlna: +.RS 2 +.IP \[bu] 2 +Many compatability improvements (Dan Walters) +.IP \[bu] 2 +Support for external srt subtitles (Dan Walters) +.RE +.IP \[bu] 2 +rc +.RS 2 +.IP \[bu] 2 +Added command core/quit (Saksham Khanna) +.RE +.RE +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +sync +.RS 2 +.IP \[bu] 2 +Make \f[C]\-\-update\f[]/\f[C]\-u\f[] not transfer files that haven't +changed (Nick Craig\-Wood) +.IP \[bu] 2 +Free objects after they come out of the transfer pipe to save memory +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix \f[C]\-\-files\-from\ without\ \-\-no\-traverse\f[] doing a +recursive scan (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +operations +.RS 2 +.IP \[bu] 2 +Fix accounting for server side copies (Nick Craig\-Wood) +.IP \[bu] 2 +Display `All duplicates removed' only if dedupe successful (Sezal +Agrawal) +.IP \[bu] 2 +Display `Deleted X extra copies' only if dedupe successful (Sezal +Agrawal) +.RE +.IP \[bu] 2 +accounting +.RS 2 +.IP \[bu] 2 +Only allow up to 100 completed transfers in the accounting list to save +memory (Nick Craig\-Wood) +.IP \[bu] 2 +Cull the old time ranges when possible to save memory (Nick Craig\-Wood) +.IP \[bu] 2 +Fix panic due to server\-side copy fallback (Ivan Andreev) +.IP \[bu] 2 +Fix memory leak noticeable for transfers of large numbers of objects +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix total duration calculation (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +cmd +.RS 2 +.IP \[bu] 2 +Fix environment variables not setting command line flags (Nick +Craig\-Wood) +.IP \[bu] 2 +Make autocomplete compatible with bash's posix mode for macOS (Danil +Semelenov) +.IP \[bu] 2 +Make \f[C]\-\-progress\f[] work in git bash on Windows (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix `compopt: command not found' on autocomplete on macOS (Danil +Semelenov) +.RE +.IP \[bu] 2 +config +.RS 2 +.IP \[bu] 2 +Fix setting of non top level flags from environment variables (Nick +Craig\-Wood) +.IP \[bu] 2 +Check config names more carefully and report errors (Nick Craig\-Wood) +.IP \[bu] 2 +Remove error: can't use \f[C]\-\-size\-only\f[] and +\f[C]\-\-ignore\-size\f[] together. +(Nick Craig\-Wood) +.RE +.IP \[bu] 2 +filter: Prevent mixing options when \f[C]\-\-files\-from\f[] is in use +(Michele Caci) +.IP \[bu] 2 +serve sftp: Fix crash on unsupported operations (eg Readlink) (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +Allow files of unkown size to be read properly (Nick Craig\-Wood) +.IP \[bu] 2 +Skip tests on <= 2 CPUs to avoid lockup (Nick Craig\-Wood) +.IP \[bu] 2 +Fix panic on File.Open (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \[lq]mount_fusefs: \-o timeout=: option not supported\[rq] on +FreeBSD (Nick Craig\-Wood) +.IP \[bu] 2 +Don't pass huge filenames (>4k) to FUSE as it can't cope (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Add flag \f[C]\-\-vfs\-case\-insensitive\f[] for windows/macOS mounts +(Ivan Andreev) +.IP \[bu] 2 +Make objects of unknown size readable through the VFS (Nick Craig\-Wood) +.IP \[bu] 2 +Move writeback of dirty data out of close() method into its own method +(FlushWrites) and remove close() call from Flush() (Brett Dutro) +.IP \[bu] 2 +Stop empty dirs disappearing when renamed on bucket based remotes (Nick +Craig\-Wood) +.IP \[bu] 2 +Stop change notify polling clearing so much of the directory cache (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Azure Blob +.RS 2 +.IP \[bu] 2 +Disable logging to the Windows event log (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +B2 +.RS 2 +.IP \[bu] 2 +Remove \f[C]unverified:\f[] prefix on sha1 to improve interop (eg with +CyberDuck) (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Box +.RS 2 +.IP \[bu] 2 +Add options to get access token via JWT auth (David) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Disable HTTP/2 by default to work around INTERNAL_ERROR problems (Nick +Craig\-Wood) +.IP \[bu] 2 +Make sure that drive root ID is always canonical (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \f[C]\-\-drive\-shared\-with\-me\f[] from the root with lsand +\f[C]\-\-fast\-list\f[] (Nick Craig\-Wood) +.IP \[bu] 2 +Fix ChangeNotify polling for shared drives (Nick Craig\-Wood) +.IP \[bu] 2 +Fix change notify polling when using appDataFolder (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Dropbox +.RS 2 +.IP \[bu] 2 +Make disallowed filenames errors not retry (Nick Craig\-Wood) +.IP \[bu] 2 +Fix nil pointer exception on restricted files (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Fichier +.RS 2 +.IP \[bu] 2 +Fix accessing files > 2GB on 32 bit systems (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +FTP +.RS 2 +.IP \[bu] 2 +Allow disabling EPSV mode (Jon Fautley) +.RE +.IP \[bu] 2 +HTTP +.RS 2 +.IP \[bu] 2 +HEAD directory entries in parallel to speedup (Nick Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-http\-no\-head\f[] to stop rclone doing HEAD in listings +(Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Putio +.RS 2 +.IP \[bu] 2 +Add ability to resume uploads (Cenk Alti) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Fix signature v2_auth headers (Anthony Rusdi) +.IP \[bu] 2 +Fix encoding for control characters (Nick Craig\-Wood) +.IP \[bu] 2 +Only ask for URL encoded directory listings if we need them on Ceph +(Nick Craig\-Wood) +.IP \[bu] 2 +Add option for multipart failiure behaviour (Aleksandar Jankovic) +.IP \[bu] 2 +Support for multipart copy (庄天翼) +.IP \[bu] 2 +Fix nil pointer reference if no metadata returned for object (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +SFTP +.RS 2 +.IP \[bu] 2 +Fix \f[C]\-\-sftp\-ask\-password\f[] trying to contact the ssh agent +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix hashes of files with backslashes (Nick Craig\-Wood) +.IP \[bu] 2 +Include more ciphers with \f[C]\-\-sftp\-use\-insecure\-cipher\f[] +(Carlos Ferreyra) +.RE +.IP \[bu] 2 +WebDAV +.RS 2 +.IP \[bu] 2 +Parse and return Sharepoint error response (Henning Surmeier) +.RE +.SS v1.49.5 \- 2019\-10\-05 +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +Revert back to go1.12.x for the v1.49.x builds as go1.13.x was causing +issues (Nick Craig\-Wood) +.IP \[bu] 2 +Fix rpm packages by using master builds of nfpm (Nick Craig\-Wood) +.IP \[bu] 2 +Fix macOS build after brew changes (Nick Craig\-Wood) +.RE +.SS v1.49.4 \- 2019\-09\-29 +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +cmd/rcd: Address ZipSlip vulnerability (Richard Patel) +.IP \[bu] 2 +accounting: Fix file handle leak on errors (Nick Craig\-Wood) +.IP \[bu] 2 +oauthutil: Fix security problem when running with two users on the same +machine (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +FTP +.RS 2 +.IP \[bu] 2 +Fix listing of an empty root returning: error dir not found (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Fix SetModTime on GLACIER/ARCHIVE objects and implement set/get tier +(Nick Craig\-Wood) +.RE +.SS v1.49.3 \- 2019\-09\-15 +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting +.RS 2 +.IP \[bu] 2 +Fix total duration calculation (Aleksandar Jankovic) +.IP \[bu] 2 +Fix \[lq]file already closed\[rq] on transfer retries (Nick Craig\-Wood) +.RE +.RE +.SS v1.49.2 \- 2019\-09\-08 +.IP \[bu] 2 +New Features +.RS 2 +.IP \[bu] 2 +build: Add Docker workflow support (Alfonso Montero) +.RE +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting: Fix locking in Transfer to avoid deadlock with +\f[C]\-\-progress\f[] (Nick Craig\-Wood) +.IP \[bu] 2 +docs: Fix template argument for mktemp in install.sh (Cnly) +.IP \[bu] 2 +operations: Fix \f[C]\-u\f[]/\f[C]\-\-update\f[] with google photos / +files of unknown size (Nick Craig\-Wood) +.IP \[bu] 2 +rc: Fix docs for config/create /update /password (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Google Cloud Storage +.RS 2 +.IP \[bu] 2 +Fix need for elevated permissions on SetModTime (Nick Craig\-Wood) +.RE +.SS v1.49.1 \- 2019\-08\-28 +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +config: Fix generated passwords being stored as empty password (Nick +Craig\-Wood) +.IP \[bu] 2 +rcd: Added missing parameter for web\-gui info logs. +(Chaitanya) +.RE +.IP \[bu] 2 +Googlephotos +.RS 2 +.IP \[bu] 2 +Fix crash on error response (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +Fix crash on error response (Nick Craig\-Wood) +.RE .SS v1.49.0 \- 2019\-08\-26 .IP \[bu] 2 New backends @@ -23673,12 +23409,19 @@ Implement \f[C]\-\-compare\-dest\f[] & \f[C]\-\-copy\-dest\f[] Implement \f[C]\-\-suffix\f[] without \f[C]\-\-backup\-dir\f[] for backup to current dir (yparitcher) .IP \[bu] 2 -Add \f[C]\-\-use\-json\-log\f[] for JSON logging (justinalin) -.IP \[bu] 2 -Add \f[C]config\ reconnect\f[], \f[C]config\ userinfo\f[] and -\f[C]config\ disconnect\f[] subcommands. +\f[C]config\ reconnect\f[] to re\-login (re\-run the oauth login) for +the backend. (Nick Craig\-Wood) .IP \[bu] 2 +\f[C]config\ userinfo\f[] to discover which user you are logged in as. +(Nick Craig\-Wood) +.IP \[bu] 2 +\f[C]config\ disconnect\f[] to disconnect you (log out) from the +backend. +(Nick Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-use\-json\-log\f[] for JSON logging (justinalin) +.IP \[bu] 2 Add context propagation to rclone (Aleksandar Jankovic) .IP \[bu] 2 Reworking internal statistics interfaces so they work with rc jobs @@ -28634,7 +28377,7 @@ more. It may do in future (probably with a flag). .SS Bugs .PP -Bugs are stored in rclone's Github project: +Bugs are stored in rclone's GitHub project: .IP \[bu] 2 Reported bugs (https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug) @@ -28883,7 +28626,7 @@ at the expense of CPU usage. The most common cause of rclone using lots of memory is a single directory with thousands or millions of files in. Rclone has to load this entirely into memory as rclone objects. -Each Rclone object takes 0.5k\-1k of memory. +Each rclone object takes 0.5k\-1k of memory. .SS License .PP This is free software under the terms of MIT the license (check the @@ -29473,6 +29216,50 @@ Patrick Wang Cenk Alti .IP \[bu] 2 Andreas Chlupka +.IP \[bu] 2 +Alfonso Montero +.IP \[bu] 2 +Ivan Andreev +.IP \[bu] 2 +David Baumgold +.IP \[bu] 2 +Lars Lehtonen +.IP \[bu] 2 +Matei David +.IP \[bu] 2 +David +.IP \[bu] 2 +Anthony Rusdi <33247310+antrusd@users.noreply.github.com> +.IP \[bu] 2 +Richard Patel +.IP \[bu] 2 +庄天翼 +.IP \[bu] 2 +SwitchJS +.IP \[bu] 2 +Raphael +.IP \[bu] 2 +Sezal Agrawal +.IP \[bu] 2 +Tyler +.IP \[bu] 2 +Brett Dutro +.IP \[bu] 2 +Vighnesh SK +.IP \[bu] 2 +Arijit Biswas +.IP \[bu] 2 +Michele Caci +.IP \[bu] 2 +AlexandrBoltris +.IP \[bu] 2 +Bryce Larson +.IP \[bu] 2 +Carlos Ferreyra +.IP \[bu] 2 +Saksham Khanna +.IP \[bu] 2 +dausruddin <5763466+dausruddin@users.noreply.github.com> .SH Contact the rclone project .SS Forum .PP