From 7f5ee5d81f12045d1565fd5dc6596bc81d44d431 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Tue, 2 Feb 2021 13:42:35 +0000 Subject: [PATCH] Version v1.54.0 --- MANUAL.html | 20496 ++++++----- MANUAL.md | 5207 ++- MANUAL.txt | 21032 ++++++----- docs/content/azureblob.md | 100 +- docs/content/b2.md | 4 +- docs/content/changelog.md | 207 + docs/content/commands/rclone.md | 14 +- docs/content/commands/rclone_about.md | 25 +- docs/content/commands/rclone_backend.md | 2 +- docs/content/commands/rclone_cat.md | 6 +- docs/content/commands/rclone_check.md | 7 +- docs/content/commands/rclone_cleanup.md | 4 +- docs/content/commands/rclone_config_create.md | 2 +- docs/content/commands/rclone_config_delete.md | 4 - docs/content/commands/rclone_config_dump.md | 4 - docs/content/commands/rclone_config_file.md | 4 - .../commands/rclone_config_providers.md | 4 - docs/content/commands/rclone_config_show.md | 4 - docs/content/commands/rclone_config_update.md | 2 +- docs/content/commands/rclone_copy.md | 6 +- docs/content/commands/rclone_copyto.md | 4 +- docs/content/commands/rclone_cryptcheck.md | 2 +- docs/content/commands/rclone_cryptdecode.md | 3 + docs/content/commands/rclone_dedupe.md | 37 +- docs/content/commands/rclone_delete.md | 19 +- .../commands/rclone_genautocomplete_bash.md | 5 +- .../commands/rclone_genautocomplete_fish.md | 5 +- .../commands/rclone_genautocomplete_zsh.md | 5 +- docs/content/commands/rclone_ls.md | 6 +- docs/content/commands/rclone_lsd.md | 6 +- docs/content/commands/rclone_lsf.md | 12 +- docs/content/commands/rclone_lsjson.md | 14 +- docs/content/commands/rclone_lsl.md | 6 +- docs/content/commands/rclone_mkdir.md | 4 - docs/content/commands/rclone_mount.md | 277 +- docs/content/commands/rclone_move.md | 8 +- docs/content/commands/rclone_ncdu.md | 5 +- docs/content/commands/rclone_obscure.md | 7 +- docs/content/commands/rclone_purge.md | 5 +- docs/content/commands/rclone_rc.md | 4 +- docs/content/commands/rclone_rmdir.md | 13 +- docs/content/commands/rclone_rmdirs.md | 16 +- docs/content/commands/rclone_serve.md | 2 +- docs/content/commands/rclone_serve_dlna.md | 27 +- docs/content/commands/rclone_serve_ftp.md | 33 +- docs/content/commands/rclone_serve_http.md | 31 +- docs/content/commands/rclone_serve_restic.md | 9 +- docs/content/commands/rclone_serve_sftp.md | 31 +- docs/content/commands/rclone_serve_webdav.md | 31 +- docs/content/commands/rclone_size.md | 4 - docs/content/commands/rclone_touch.md | 6 +- docs/content/commands/rclone_tree.md | 2 +- docs/content/compress.md | 14 + docs/content/drive.md | 52 +- docs/content/flags.md | 63 +- docs/content/ftp.md | 19 +- docs/content/googlephotos.md | 2 +- docs/content/hdfs.md | 2 +- docs/content/local.md | 18 + docs/content/mailru.md | 3 +- docs/content/onedrive.md | 69 +- docs/content/rc.md | 25 +- docs/content/s3.md | 209 +- docs/content/sftp.md | 18 + docs/content/swift.md | 9 + docs/content/zoho.md | 57 +- go.sum | 2 - rclone.1 | 29922 ++++++++++------ 68 files changed, 49017 insertions(+), 29240 deletions(-) diff --git a/MANUAL.html b/MANUAL.html index 00a44dc4a..62fcc7800 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -17,7 +17,7 @@

rclone(1) User Manual

Nick Craig-Wood

-

Sep 02, 2020

+

Feb 02, 2021

Rclone syncs your files to cloud storage

rclone logo

@@ -34,8 +34,8 @@

Rclone is a command line program to manage files on cloud storage. It is a feature rich alternative to cloud vendors' web storage interfaces. Over 40 cloud storage products support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols.

Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone's familiar syntax includes shell pipeline support, and --dry-run protection. It is used at the command line, in scripts or via its API.

Users call rclone "The Swiss army knife of cloud storage", and "Technology indistinguishable from magic".

-

Rclone really looks after your data. It preserves timestamps and verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can check the integrity of your files. Where possible, rclone employs server side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk.

-

Virtual backends wrap local and cloud file systems to apply encryption, caching, chunking and joining.

+

Rclone really looks after your data. It preserves timestamps and verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can check the integrity of your files. Where possible, rclone employs server-side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk.

+

Virtual backends wrap local and cloud file systems to apply encryption, caching, compression chunking and joining.

Rclone mounts any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serves these over SFTP, HTTP, WebDAV, FTP and DLNA.

Rclone is mature, open source software originally inspired by rsync and written in Go. The friendly support community are familiar with varied use cases. Official Ubuntu, Debian, Fedora, Brew and Chocolatey repos. include rclone. For the latest version downloading from rclone.org is recommended.

Rclone is widely used on Linux, Windows and Mac. Third party developers create innovative backup, restore, GUI and business process solutions using the rclone command line or API.

@@ -58,7 +58,7 @@
  • MD5, SHA1 hashes are checked at all times for file integrity
  • Timestamps are preserved on files
  • Operations can be restarted at any time
    • -
  • Can be to and from network, eg two different cloud providers
    • +
  • Can be to and from network, e.g. two different cloud providers
  • Can use multi-threaded downloads to local disk
  • Copy new or changed files to cloud storage
    • @@ -84,10 +84,12 @@
  • DigitalOcean Spaces
  • Dreamhost
  • Dropbox
    • +
  • Enterprise File Fabric
  • FTP
  • Google Cloud Storage
  • Google Drive
  • Google Photos
    • +
  • HDFS
  • HTTP
  • Hubic
  • Jottacloud
    • @@ -118,9 +120,11 @@
  • StackPath
  • SugarSync
  • Tardigrade
    • +
  • Tencent Cloud Object Storage (COS)
  • Wasabi
  • WebDAV
  • Yandex Disk
    • +
  • Zoho WorkDrive
  • The local filesystem

    • Links

    @@ -185,7 +189,7 @@ macOS cannot verify that this app is free from malware. 
    xattr -d com.apple.quarantine rclone

    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.

    +

    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, e.g. :1.49.1, :1.49 or :1.

    $ docker pull rclone/rclone:latest
 latest: Pulling from rclone/rclone
 Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11
@@ -231,7 +235,7 @@ docker run --rm \
 ls ~/data/mount
 kill %1

    Install from source

    -

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

    +

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

    git clone https://github.com/rclone/rclone.git
 cd rclone
 go build
@@ -241,7 +245,7 @@ go build
 
    go get github.com/rclone/rclone
    
 
    or the latest version (equivalent to the beta) with
    
 
    go get github.com/rclone/rclone@master
    
-
    These will build the binary in $(go env GOPATH)/bin (~/go/bin/rclone by default) after downloading the source to the go module cache. Note - do not use the -u flag here. This causes go to try to update the depencencies that rclone uses and sometimes these don't work with the current version of rclone.
    
+
    These will build the binary in $(go env GOPATH)/bin (~/go/bin/rclone by default) after downloading the source to the go module cache. Note - do not use the -u flag here. This causes go to try to update the dependencies that rclone uses and sometimes these don't work with the current version of rclone.
    
 
    Installation with Ansible
    
 
    This can be done with Stefan Weichinger's ansible role.
    
 
    Instructions
    
@@ -267,13 +271,16 @@ go build
 
  • Cache
    • 
 
  • Chunker - transparently splits large files for other remotes
    • 
 
  • Citrix ShareFile
    • 
+
  • Compress
    • 
 
  • Crypt - to encrypt other remotes
    • 
 
  • DigitalOcean Spaces
    • 
 
  • Dropbox
    • 
+
  • Enterprise File Fabric
    • 
 
  • FTP
    • 
 
  • Google Cloud Storage
    • 
 
  • Google Drive
    • 
 
  • Google Photos
    • 
+
  • HDFS
    • 
 
  • HTTP
    • 
 
  • Hubic
    • 
 
  • Jottacloud / GetSky.no
    • 
@@ -296,13 +303,14 @@ go build
 
  • Union
    • 
 
  • WebDAV
    • 
 
  • Yandex Disk
    • 
+
  • Zoho WorkDrive
    • 
 
  • The local filesystem
    • 
 
 
    Usage
    
 
    Rclone syncs a directory tree from one storage system to another.
    
 
    Its syntax is like this
    
 
    Syntax: [options] subcommand <parameters> <parameters...>
    
-
    Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, eg "drive:myfolder" to look at "myfolder" in Google drive.
    
+
    Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, e.g. "drive:myfolder" to look at "myfolder" in Google drive.
    
 
    You can define as many storage paths as you like in the config file.
    
 
    Please use the -i / --interactive flag while learning rclone to avoid accidental data loss.
    
 
    Subcommands
    
@@ -335,7 +343,7 @@ rclone sync -i /local/path remote:path # syncs /local/path to the remote    <
 
  • rclone config userinfo - Prints info about logged in user of remote.
    • 
 
 
    rclone copy
    
-
    Copy files from source to dest, skipping already copied
    
+
    Copy files from source to dest, skipping already copied.
    
 
    Synopsis
    
 
    Copy the source to the destination. Doesn't transfer unchanged files, testing by size and modification time or MD5SUM. Doesn't delete files from the destination.
    
 
    Note that it is always the contents of the directory that is synced, not the directory so when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents.
    
@@ -351,7 +359,7 @@ destpath/two.txt

    Not to

    destpath/sourcepath/one.txt
 destpath/sourcepath/two.txt
    -

    If you are familiar with rsync, rclone always works as if you had written a trailing / - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination.

    +

    If you are familiar with rsync, rclone always works as if you had written a trailing / - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination.

    See the --no-traverse option for controlling whether rclone lists the destination directory or not. Supplying this option when copying a small number of files into a large destination can speed transfers up greatly.

    For example, if you have many files in /path/to/src but only a few of them change every day, you can copy all the files which have changed recently very efficiently like this:

    rclone copy --max-age 24h --no-traverse /path/to/src remote:
    @@ -388,9 +396,9 @@ destpath/sourcepath/two.txt

    rclone move

    Move files from source to dest.

    Synopsis

    -

    Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server side directory move operation.

    -

    If no filters are in use and if possible this will server side move source:path into dest:path. After this source:path will no longer exist.

    -

    Otherwise for each file in source:path selected by the filters (if any) this will move it into dest:path. If possible a server side move will be used, otherwise it will copy it (server side if possible) into dest:path then delete the original (if no errors on copy) in source:path.

    +

    Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server-side directory move operation.

    +

    If no filters are in use and if possible this will server-side move source:path into dest:path. After this source:path will no longer exist.

    +

    Otherwise for each file in source:path selected by the filters (if any) this will move it into dest:path. If possible a server-side move will be used, otherwise it will copy it (server-side if possible) into dest:path then delete the original (if no errors on copy) in source:path.

    If you want to delete empty source directories after move, use the --delete-empty-src-dirs flag.

    See the --no-traverse option for controlling whether rclone lists the destination directory or not. Supplying this option when moving a small number of files into a large destination can speed transfers up greatly.

    Important: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag.

    @@ -406,16 +414,15 @@ destpath/sourcepath/two.txt
  • rclone - Show help for rclone commands, flags and backends.

    • rclone delete

    -

    Remove the contents of path.

    +

    Remove the files in path.

    Synopsis

    Remove the files in path. Unlike purge it obeys include/exclude filters so can be used to selectively delete files.

    -

    rclone delete only deletes objects but leaves the directory structure alone. If you want to delete a directory and all of its contents use rclone purge

    -

    If you supply the --rmdirs flag, it will remove all empty directories along with it.

    -

    Eg delete all files bigger than 100MBytes

    -

    Check what would be deleted first (use either)

    +

    rclone delete only deletes files but leaves the directory structure alone. If you want to delete a directory and all of its contents use the purge command.

    +

    If you supply the --rmdirs flag, it will remove all empty directories along with it. You can also use the separate command rmdir or rmdirs to delete empty directories only.

    +

    For example, to delete all files bigger than 100MBytes, you may first want to check what would be deleted (use either):

    rclone --min-size 100M lsl remote:path
 rclone --dry-run --min-size 100M delete remote:path
    -

    Then delete

    +

    Then proceed with the actual delete:

    rclone --min-size 100M delete remote:path

    That reads "delete everything with a minimum size of 100 MB", hence delete all files bigger than 100MBytes.

    Important: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag.

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

    rclone purge

    Remove the path and all of its contents.

    Synopsis

    -

    Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use delete if you want to selectively delete files.

    +

    Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use the delete command if you want to selectively delete files. To delete empty directories only, use command rmdir or rmdirs.

    Important: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag.

    rclone purge remote:path [flags]

    Options

    @@ -443,8 +450,6 @@ rclone --dry-run --min-size 100M delete remote:path

    rclone mkdir

    Make the path if it doesn't already exist.

    -

    Synopsis

    -

    Make the path if it doesn't already exist.

    rclone mkdir remote:path [flags]

    Options

      -h, --help   help for mkdir
    @@ -454,9 +459,10 @@ rclone --dry-run --min-size 100M delete remote:path
  • rclone - Show help for rclone commands, flags and backends.

    • rclone rmdir

    -

    Remove the path if empty.

    -

    Synopsis

    -

    Remove the path. Note that you can't remove a path with objects in it, use purge for that.

    +

    Remove the empty directory at path.

    +

    Synopsis

    +

    This removes empty directory given by path. Will not remove the path if it has any objects in it, not even empty subdirectories. Use command rmdirs (or delete with option --rmdirs) to do that.

    +

    To delete a path and any objects in it, use purge command.

    rclone rmdir remote:path [flags]

    Options

      -h, --help   help for rmdir
    @@ -467,12 +473,12 @@ rclone --dry-run --min-size 100M delete remote:path

    rclone check

    Checks the files in the source and destination match.

    -

    Synopsis

    +

    Synopsis

    Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don't match. It doesn't alter the source or destination.

    -

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

    -

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

    +

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

    +

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

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

    -

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

    +

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

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

    rclone ls

    List the objects in the path with size and path.

    -

    Synopsis

    +

    Synopsis

    Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default.

    Eg

    $ rclone ls swift:bucket
@@ -516,9 +523,9 @@ rclone --dry-run --min-size 100M delete remote:path
  • lsjson to list objects and directories in JSON format

    • ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable.

    -

    Note that ls and lsl recurse by default - use "--max-depth 1" to stop the recursion.

    -

    The other list commands lsd,lsf,lsjson do not recurse by default - use "-R" to make them recurse.

    -

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).

    +

    Note that ls and lsl recurse by default - use --max-depth 1 to stop the recursion.

    +

    The other list commands lsd,lsf,lsjson do not recurse by default - use -R to make them recurse.

    +

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes).

    rclone ls remote:path [flags]

    Options

      -h, --help   help for ls
    @@ -529,7 +536,7 @@ rclone --dry-run --min-size 100M delete remote:path

    rclone lsd

    List all directories/containers/buckets in the path.

    -

    Synopsis

    +

    Synopsis

    Lists the directories in the source path to standard output. Does not recurse by default. Use the -R flag to recurse.

    This command lists the total size of the directory (if known, -1 if not), the modification time (if known, the current time if not), the number of objects in the directory (if known, -1 if not) and the name of the directory, Eg

    $ rclone lsd swift:
@@ -551,9 +558,9 @@ rclone --dry-run --min-size 100M delete remote:path
  • lsjson to list objects and directories in JSON format

    • ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable.

    -

    Note that ls and lsl recurse by default - use "--max-depth 1" to stop the recursion.

    -

    The other list commands lsd,lsf,lsjson do not recurse by default - use "-R" to make them recurse.

    -

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).

    +

    Note that ls and lsl recurse by default - use --max-depth 1 to stop the recursion.

    +

    The other list commands lsd,lsf,lsjson do not recurse by default - use -R to make them recurse.

    +

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes).

    rclone lsd remote:path [flags]

    Options

      -h, --help        help for lsd
@@ -565,7 +572,7 @@ rclone --dry-run --min-size 100M delete remote:path

    rclone lsl

    List the objects in path with modification time, size and path.

    -

    Synopsis

    +

    Synopsis

    Lists the objects in the source path to standard output in a human readable format with modification time, size and path. Recurses by default.

    Eg

    $ rclone lsl swift:bucket
@@ -583,9 +590,9 @@ rclone --dry-run --min-size 100M delete remote:path
  • lsjson to list objects and directories in JSON format

    • ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable.

    -

    Note that ls and lsl recurse by default - use "--max-depth 1" to stop the recursion.

    -

    The other list commands lsd,lsf,lsjson do not recurse by default - use "-R" to make them recurse.

    -

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).

    +

    Note that ls and lsl recurse by default - use --max-depth 1 to stop the recursion.

    +

    The other list commands lsd,lsf,lsjson do not recurse by default - use -R to make them recurse.

    +

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes).

    rclone lsl remote:path [flags]

    Options

      -h, --help   help for lsl
    @@ -596,11 +603,15 @@ rclone --dry-run --min-size 100M delete remote:path

    rclone md5sum

    Produces an md5sum file for all the objects in the path.

    -

    Synopsis

    +

    Synopsis

    Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces.

    +

    By default, the hash is requested from the remote. If MD5 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling MD5 for any remote.

    rclone md5sum remote:path [flags]

    Options

    -
      -h, --help   help for md5sum
    +
          --base64               Output base64 encoded hashsum
+      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
+  -h, --help                 help for md5sum
+      --output-file string   Output hashsums to a file rather than the terminal

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

    SEE ALSO

    rclone sha1sum

    Produces an sha1sum file for all the objects in the path.

    -

    Synopsis

    +

    Synopsis

    Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces.

    +

    By default, the hash is requested from the remote. If SHA-1 is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling SHA-1 for any remote.

    rclone sha1sum remote:path [flags]

    Options

    -
      -h, --help   help for sha1sum
    +
          --base64               Output base64 encoded hashsum
+      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
+  -h, --help                 help for sha1sum
+      --output-file string   Output hashsums to a file rather than the terminal

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

    SEE ALSO

    rclone size

    Prints the total size and number of objects in remote:path.

    -

    Synopsis

    -

    Prints the total size and number of objects in remote:path.

    rclone size remote:path [flags]

    Options

      -h, --help   help for size
@@ -633,7 +646,7 @@ rclone --dry-run --min-size 100M delete remote:path

    rclone version

    Show the version number.

    -

    Synopsis

    +

    Synopsis

    Show the version number, the go version and the architecture.

    Eg

    $ rclone version
@@ -662,8 +675,8 @@ beta:   1.42.0.5      (released 2018-06-17)
 
  • rclone - Show help for rclone commands, flags and backends.
    • 
 
 
    rclone cleanup
    
-
    Clean up the remote if possible
    
-
    Synopsis
    
+
    Clean up the remote if possible.
    
+
    Synopsis
    
 
    Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.
    
 
    rclone cleanup remote:path [flags]
    
 
    Options
    
@@ -675,12 +688,14 @@ beta:   1.42.0.5      (released 2018-06-17)
 
 
    rclone dedupe
    
 
    Interactively find duplicate filenames and delete/rename them.
    
-
    Synopsis
    
-
    By default dedupe interactively finds files with duplicate names and offers to delete all but one or rename them to be different.
    
-
    This is only useful with backends like Google Drive which can have duplicate file names. It can be run on wrapping backends (eg crypt) if they wrap a backend which supports duplicate file names.
    
-
    In the first pass it will merge directories with the same name. It will do this iteratively until all the identically named directories have been merged.
    
-
    In the second pass, for every group of duplicate file names, it will delete all but one identical files it finds without confirmation. This means that for most duplicated files the dedupe command will not be interactive.
    
-
    dedupe considers files to be identical if they have the same hash. If the backend does not support hashes (eg crypt wrapping Google Drive) then they will never be found to be identical. If you use the --size-only flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes.
    
+
    Synopsis
    
+
    By default dedupe interactively finds files with duplicate names and offers to delete all but one or rename them to be different. This is known as deduping by name.
    
+
    Deduping by name is only useful with backends like Google Drive which can have duplicate file names. It can be run on wrapping backends (e.g. crypt) if they wrap a backend which supports duplicate file names.
    
+
    However if --by-hash is passed in then dedupe will find files with duplicate hashes instead which will work on any backend which supports at least one hash. This can be used to find files with duplicate content. This is known as deduping by hash.
    
+
    If deduping by name, first rclone will merge directories with the same name. It will do this iteratively until all the identically named directories have been merged.
    
+
    Next, if deduping by name, for every group of duplicate file names / hashes, it will delete all but one identical files it finds without confirmation. This means that for most duplicated files the dedupe command will not be interactive.
    
+
    dedupe considers files to be identical if they have the same file path and the same hash. If the backend does not support hashes (e.g. crypt wrapping Google Drive) then they will never be found to be identical. If you use the --size-only flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes.
    
+
    Next rclone will resolve the remaining duplicates. Exactly which action is taken depends on the dedupe mode. By default rclone will interactively query the user for each one.
    
 
    Important: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag.
    
 
    Here is an example run.
    
 
    Before - with duplicates
    
@@ -734,6 +749,7 @@ two-3.txt: renamed from: two.txt
  • --dedupe-mode largest - removes identical files then keeps the largest one.
  • --dedupe-mode smallest - removes identical files then keeps the smallest one.
  • --dedupe-mode rename - removes identical files then renames the rest to be different.
    • +
  • --dedupe-mode list - lists duplicate dirs and files only and changes nothing.

    • For example to rename all the identically named photos in your Google Photos directory, do

    rclone dedupe --dedupe-mode rename "drive:Google Photos"
    @@ -741,7 +757,8 @@ two-3.txt: renamed from: two.txt 
    rclone dedupe rename "drive:Google Photos"
    rclone dedupe [mode] remote:path [flags]

    Options

    -
          --dedupe-mode string   Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive")
+
          --by-hash              Find indentical hashes rather than names
+      --dedupe-mode string   Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive")
   -h, --help                 help for dedupe
    
 
    See the global flags page for global options not listed here.
    
 
    SEE ALSO
    
@@ -750,9 +767,9 @@ two-3.txt: renamed from: two.txt

    rclone about

    Get quota information from the remote.

    -

    Synopsis

    -

    Get quota information from the remote, like bytes used/free/quota and bytes used in the trash. Not supported by all remotes.

    -

    This will print to stdout something like this:

    +

    Synopsis

    +

    rclone aboutprints quota information about a remote to standard output. The output is typically used, free, quota and trash contents.

    +

    E.g. Typical output fromrclone about remote:is:

    Total:   17G
 Used:    7.444G
 Free:    1.315G
@@ -762,19 +779,19 @@ Other:   8.241G
    -

    Note that not all the backends provide all the fields - they will be missing if they are not known for that backend. Where it is known that the value is unlimited the value will also be omitted.

    -

    Use the --full flag to see the numbers written out in full, eg

    +

    Not all backends print all fields. Information is not included if it is not provided by a backend. Where the value is unlimited it is omitted.

    +

    Applying a --full flag to the command prints the bytes in full, e.g.

    Total:   18253611008
 Used:    7993453766
 Free:    1411001220
 Trashed: 104857602
 Other:   8849156022
    -

    Use the --json flag for a computer readable output, eg

    +

    A --jsonflag generates conveniently computer readable output, e.g.

    {
     "total": 18253611008,
     "used": 7993453766,
@@ -782,6 +799,8 @@ Other:   8849156022
    "other": 8849156022, "free": 1411001220 } +

    Not all backends support the rclone about command.

    +

    See List of backends that do not support about

    rclone about remote: [flags]

    Options

          --full   Full numbers instead of SI units
@@ -794,7 +813,7 @@ Other:   8849156022

    rclone authorize

    Remote authorization.

    -

    Synopsis

    +

    Synopsis

    Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.

    Use the --auth-no-open-browser to prevent rclone to open auth link in default browser automatically.

    rclone authorize [flags]
    @@ -808,14 +827,14 @@ Other: 8849156022

    rclone backend

    Run a backend specific command.

    -

    Synopsis

    +

    Synopsis

    This runs a backend specific command. The commands themselves (except for "help" and "features") are defined by the backends and you should see the backend docs for definitions.

    You can discover what commands a backend implements by using

    rclone backend help remote:
 rclone backend help <backendname>

    You can also discover information about the backend using (see operations/fsinfo in the remote control docs for more info).

    rclone backend features remote:
    -

    Pass options to the backend command with -o. This should be key=value or key, eg:

    +

    Pass options to the backend command with -o. This should be key=value or key, e.g.:

    rclone backend stats remote:path stats -o format=json -o long

    Pass arguments to the backend by placing them on the end of the line

    rclone backend cleanup remote:path file1 file2 file3
    @@ -832,7 +851,7 @@ rclone backend help <backendname>

    rclone cat

    Concatenates any files and sends them to stdout.

    -

    Synopsis

    +

    Synopsis

    rclone cat sends any files to standard output.

    You can use it like this to output a single file

    rclone cat remote:path/to/file
    @@ -840,7 +859,7 @@ rclone backend help <backendname> 
    rclone cat remote:path/to/dir

    Or like this to output any .txt files in dir or its subdirectories.

    rclone --include "*.txt" cat remote:path/to/dir
    -

    Use the --head flag to print characters only at the start, --tail for the end and --offset and --count to print a section in the middle. Note that if offset is negative it will count from the end, so --offset -1 --count 1 is equivalent to --tail 1.

    +

    Use the --head flag to print characters only at the start, --tail for the end and --offset and --count to print a section in the middle. Note that if offset is negative it will count from the end, so --offset -1 --count 1 is equivalent to --tail 1.

    rclone cat remote:path [flags]

    Options

          --count int    Only print N characters. (default -1)
@@ -856,13 +875,13 @@ rclone backend help <backendname>

    rclone config create

    Create a new remote with name, type and options.

    -

    Synopsis

    +

    Synopsis

    Create a new remote of name with type and options. The options should be passed in pairs of key value.

    For example to make a swift remote of name myremote using auto config you would do:

    rclone config create myremote swift env_auth true

    Note that if the config process would normally ask a question the default is taken. Each time that happens rclone will print a message saying how to affect the value taken.

    If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren't already obscured before putting them in the config file.

    -

    NB If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use "--no-obscure". You can also set osbscured passwords using the "rclone config password" command.

    +

    NB If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use "--no-obscure". You can also set obscured passwords using the "rclone config password" command.

    So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this:

    rclone config create mydrive drive config_is_local false
    rclone config create `name` `type` [`key` `value`]* [flags]
    @@ -877,8 +896,6 @@ rclone backend help <backendname>

    rclone config delete

    Delete an existing remote name.

    -

    Synopsis

    -

    Delete an existing remote name.

    rclone config delete `name` [flags]

    Options

      -h, --help   help for delete
    @@ -889,7 +906,7 @@ rclone backend help <backendname>

    rclone config disconnect

    Disconnects user from remote

    -

    Synopsis

    +

    Synopsis

    This disconnects the remote: passed in to the cloud storage system.

    This normally means revoking the oauth token.

    To reconnect use "rclone config reconnect".

    @@ -903,8 +920,6 @@ rclone backend help <backendname>

    rclone config dump

    Dump the config file as JSON.

    -

    Synopsis

    -

    Dump the config file as JSON.

    rclone config dump [flags]

    Options

      -h, --help   help for dump
    @@ -915,7 +930,7 @@ rclone backend help <backendname>

    rclone config edit

    Enter an interactive configuration session.

    -

    Synopsis

    +

    Synopsis

    Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration.

    rclone config edit [flags]

    Options

    @@ -927,8 +942,6 @@ rclone backend help <backendname>

    rclone config file

    Show path of configuration file in use.

    -

    Synopsis

    -

    Show path of configuration file in use.

    rclone config file [flags]

    Options

      -h, --help   help for file
    @@ -939,7 +952,7 @@ rclone backend help <backendname>

    rclone config password

    Update password in an existing remote.

    -

    Synopsis

    +

    Synopsis

    Update an existing remote's password. The password should be passed in pairs of key value.

    For example to set password of a remote of name myremote you would do:

    rclone config password myremote fieldname mypassword
    @@ -954,8 +967,6 @@ rclone backend help <backendname>

    rclone config providers

    List in JSON format all the providers and options.

    -

    Synopsis

    -

    List in JSON format all the providers and options.

    rclone config providers [flags]

    Options

      -h, --help   help for providers
    @@ -966,7 +977,7 @@ rclone backend help <backendname>

    rclone config reconnect

    Re-authenticates user with remote.

    -

    Synopsis

    +

    Synopsis

    This reconnects remote: passed in to the cloud storage system.

    To disconnect the remote use "rclone config disconnect".

    This normally means going through the interactive oauth flow again.

    @@ -980,8 +991,6 @@ rclone backend help <backendname>

    rclone config show

    Print (decrypted) config file, or the config for a single remote.

    -

    Synopsis

    -

    Print (decrypted) config file, or the config for a single remote.

    rclone config show [<remote>] [flags]

    Options

      -h, --help   help for show
    @@ -992,12 +1001,12 @@ rclone backend help <backendname>

    rclone config update

    Update options in an existing remote.

    -

    Synopsis

    +

    Synopsis

    Update an existing remote's options. The options should be passed in in pairs of key value.

    For example to update the env_auth field of a remote of name myremote you would do:

    rclone config update myremote swift env_auth true

    If any of the parameters passed is a password field, then rclone will automatically obscure them if they aren't already obscured before putting them in the config file.

    -

    NB If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use "--no-obscure". You can also set osbscured passwords using the "rclone config password" command.

    +

    NB If the password parameter is 22 characters or longer and consists only of base64 characters then rclone can get confused about whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use "--no-obscure". You can also set obscured passwords using the "rclone config password" command.

    If the remote uses OAuth the token will be updated, if you don't require this add an extra parameter thus:

    rclone config update myremote swift env_auth true config_refresh_token false
    rclone config update `name` [`key` `value`]+ [flags]
    @@ -1012,7 +1021,7 @@ rclone backend help <backendname>

    rclone config userinfo

    Prints info about logged in user of remote.

    -

    Synopsis

    +

    Synopsis

    This prints the details of the person logged in to the cloud storage system.

    rclone config userinfo remote: [flags]

    Options

    @@ -1024,8 +1033,8 @@ rclone backend help <backendname>
  • rclone config - Enter an interactive configuration session.

    • rclone copyto

    -

    Copy files from source to dest, skipping already copied

    -

    Synopsis

    +

    Copy files from source to dest, skipping already copied.

    +

    Synopsis

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

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

    So

    @@ -1049,7 +1058,7 @@ if src is directory

    rclone copyurl

    Copy url content to dest.

    -

    Synopsis

    +

    Synopsis

    Download a URL's content and copy it to the destination without saving it in temporary storage.

    Setting --auto-filename will cause the file name to be retrieved from the from URL (after any redirections) and used in the destination path.

    Setting --no-clobber will prevent overwriting file on the destination if there is one with the same name.

    @@ -1067,7 +1076,7 @@ if src is directory

    rclone cryptcheck

    Cryptcheck checks the integrity of a crypted remote.

    -

    Synopsis

    +

    Synopsis

    rclone cryptcheck checks a remote against a crypted remote. This is the equivalent of running rclone check, but able to check the checksums of the crypted remote.

    For it to work the underlying remote of the cryptedremote must support some kind of checksum.

    It works by reading the nonce from each file on the cryptedremote: and using that to encrypt each file on the remote:. It then checks the checksum of the underlying file on the cryptedremote: against the checksum of the file it has just encrypted.

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

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

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

    -

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

    +

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

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

    rclone cryptdecode

    Cryptdecode returns unencrypted file names.

    -

    Synopsis

    +

    Synopsis

    rclone cryptdecode returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items.

    If you supply the --reverse flag, it will return encrypted file names.

    use it like this

    rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2
 
 rclone cryptdecode --reverse encryptedremote: filename1 filename2
    +

    Another way to accomplish this is by using the rclone backend encode (or decode)command. See the documentation on the crypt overlay for more info.

    rclone cryptdecode encryptedremote: encryptedfilename [flags]

    Options

      -h, --help      help for cryptdecode
@@ -1121,7 +1131,7 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone deletefile

    Remove a single file from remote.

    -

    Synopsis

    +

    Synopsis

    Remove a single file from remote. Unlike delete it cannot be used to remove a directory and it doesn't obey include/exclude filters - if the specified file exists, it will always be removed.

    rclone deletefile remote:path [flags]

    Options

    @@ -1133,7 +1143,7 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone genautocomplete

    Output completion script for a given shell.

    -

    Synopsis

    +

    Synopsis

    Generates a shell completion script for rclone. Run with --help to list the supported shells.

    Options

      -h, --help   help for genautocomplete
    @@ -1147,13 +1157,14 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone genautocomplete bash

    Output bash completion script for rclone.

    -

    Synopsis

    +

    Synopsis

    Generates a bash shell autocompletion script for rclone.

    -

    This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, eg

    +

    This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, e.g.

    sudo rclone genautocomplete bash

    Logout and login again to use the autocompletion scripts, or source them directly

    . /etc/bash_completion

    If you supply a command line argument the script will be written there.

    +

    If output_file is "-", then the output will be written to stdout.

    rclone genautocomplete bash [output_file] [flags]

    Options

      -h, --help   help for bash
    @@ -1164,13 +1175,14 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone genautocomplete fish

    Output fish completion script for rclone.

    -

    Synopsis

    +

    Synopsis

    Generates a fish autocompletion script for rclone.

    -

    This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, eg

    +

    This writes to /etc/fish/completions/rclone.fish by default so will probably need to be run with sudo or as root, e.g.

    sudo rclone genautocomplete fish

    Logout and login again to use the autocompletion scripts, or source them directly

    . /etc/fish/completions/rclone.fish

    If you supply a command line argument the script will be written there.

    +

    If output_file is "-", then the output will be written to stdout.

    rclone genautocomplete fish [output_file] [flags]

    Options

      -h, --help   help for fish
    @@ -1181,13 +1193,14 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone genautocomplete zsh

    Output zsh completion script for rclone.

    -

    Synopsis

    +

    Synopsis

    Generates a zsh autocompletion script for rclone.

    -

    This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, eg

    +

    This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, e.g.

    sudo rclone genautocomplete zsh

    Logout and login again to use the autocompletion scripts, or source them directly

    autoload -U compinit && compinit

    If you supply a command line argument the script will be written there.

    +

    If output_file is "-", then the output will be written to stdout.

    rclone genautocomplete zsh [output_file] [flags]

    Options

      -h, --help   help for zsh
    @@ -1198,7 +1211,7 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone gendocs

    Output markdown docs for rclone to the directory supplied.

    -

    Synopsis

    +

    Synopsis

    This produces markdown docs for the rclone commands to the directory supplied. These are in a format suitable for hugo to render into the rclone.org website.

    rclone gendocs output_directory [flags]

    Options

    @@ -1210,9 +1223,10 @@ rclone cryptdecode --reverse encryptedremote: filename1 filename2

    rclone hashsum

    Produces a hashsum file for all the objects in the path.

    -

    Synopsis

    +

    Synopsis

    Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool.

    -

    Run without a hash to see the list of supported hashes, eg

    +

    By default, the hash is requested from the remote. If the hash is not supported by the remote, no hash will be returned. With the download flag, the file will be downloaded from the remote and hashed locally enabling any hash for any remote.

    +

    Run without a hash to see the list of all supported hashes, e.g.

    $ rclone hashsum
 Supported hashes are:
   * MD5
@@ -1223,8 +1237,10 @@ Supported hashes are:
 
    $ rclone hashsum MD5 remote:path
    
 
    rclone hashsum <hash> remote:path [flags]
    
 
    Options
    
-
          --base64   Output base64 encoded hashsum
-  -h, --help     help for hashsum
    
+
          --base64               Output base64 encoded hashsum
+      --download             Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote
+  -h, --help                 help for hashsum
+      --output-file string   Output hashsums to a file rather than the terminal
    
 
    See the global flags page for global options not listed here.
    
 
    SEE ALSO
    
 
      
@@ -1232,7 +1248,7 @@ Supported hashes are:
 
    
 
    rclone link
    
 
    Generate public link to file/folder.
    
-
    Synopsis
    
+
    Synopsis
    
 
    rclone link will create, retrieve or remove a public link to the given file or folder.
    
 
    rclone link remote:path/to/file
 rclone link remote:path/to/folder/
@@ -1253,7 +1269,7 @@ rclone link --expire 1d remote:path/to/file
    
 
 
    rclone listremotes
    
 
    List all the remotes in the config file.
    
-
    Synopsis
    
+
    Synopsis
    
 
    rclone listremotes lists all the available remotes from the config file.
    
 
    When uses with the -l flag it lists the types too.
    
 
    rclone listremotes [flags]
    
@@ -1266,8 +1282,8 @@ rclone link --expire 1d remote:path/to/file
  • rclone - Show help for rclone commands, flags and backends.

    • rclone lsf

    -

    List directories and objects in remote:path formatted for parsing

    -

    Synopsis

    +

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

    +

    Synopsis

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

    Eg

    $ rclone lsf swift:bucket
@@ -1285,7 +1301,7 @@ i - ID of object
 o - Original ID of underlying object
 m - MimeType of object if known
 e - encrypted name
-T - tier of storage if known, eg "Hot" or "Cool"
    +T - tier of storage if known, e.g. "Hot" or "Cool"

    So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last.

    Eg

    $ rclone lsf  --format "tsp" swift:bucket
@@ -1333,9 +1349,9 @@ rclone copy --files-from-raw new_files /path/to/local remote:path
  • lsjson to list objects and directories in JSON format

    • ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable.

    -

    Note that ls and lsl recurse by default - use "--max-depth 1" to stop the recursion.

    -

    The other list commands lsd,lsf,lsjson do not recurse by default - use "-R" to make them recurse.

    -

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).

    +

    Note that ls and lsl recurse by default - use --max-depth 1 to stop the recursion.

    +

    The other list commands lsd,lsf,lsjson do not recurse by default - use -R to make them recurse.

    +

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes).

    rclone lsf remote:path [flags]

    Options

          --absolute           Put a leading / in front of path names.
@@ -1355,19 +1371,19 @@ rclone copy --files-from-raw new_files /path/to/local remote:path

    rclone lsjson

    List directories and objects in the path in JSON format.

    -

    Synopsis

    +

    Synopsis

    List directories and objects in the path in JSON format.

    The output is an array of Items, where each Item looks like this

    { "Hashes" : { "SHA-1" : "f572d396fae9206628714fb2ce00f72e94f2258f", "MD5" : "b1946ac92492d2347c6235b4d2611184", "DropboxHash" : "ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc" }, "ID": "y2djkhiujf83u33", "OrigID": "UYOJVTUW00Q1RzTDA", "IsBucket" : false, "IsDir" : false, "MimeType" : "application/octet-stream", "ModTime" : "2017-05-31T16:15:57.034468261+01:00", "Name" : "file.txt", "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", "EncryptedPath" : "kja9098349023498/v0qpsdq8anpci8n929v3uu9338", "Path" : "full/path/goes/here/file.txt", "Size" : 6, "Tier" : "hot", }

    If --hash is not specified the Hashes property won't be emitted. The types of hash can be specified with the --hash-type parameter (which may be repeated). If --hash-type is set then it implies --hash.

    -

    If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (eg s3, swift).

    -

    If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (eg s3, swift).

    +

    If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request (e.g. s3, swift).

    +

    If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra request (e.g. s3, swift).

    If --encrypted is not specified the Encrypted won't be emitted.

    If --dirs-only is not specified files in addition to directories are returned

    If --files-only is not specified directories in addition to the files will be returned.

    The Path field will only show folders below the remote path being listed. If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt" will be "subfolder/file.txt", not "remote:path/subfolder/file.txt". When used without --recursive the Path will always be the same as Name.

    If the directory is a bucket in a bucket based backend, then "IsBucket" will be set to true. This key won't be present unless it is "true".

    -

    The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the nearest millisecond (eg Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav etc) no digits will be shown ("2017-05-31T16:15:57+01:00").

    +

    The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the nearest millisecond (e.g. Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits will be shown ("2017-05-31T16:15:57+01:00").

    The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line.

    Any of the filtering options can be applied to this command.

    There are several related list commands

    @@ -1379,9 +1395,9 @@ rclone copy --files-from-raw new_files /path/to/local remote:path
  • lsjson to list objects and directories in JSON format

    • ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable.

    -

    Note that ls and lsl recurse by default - use "--max-depth 1" to stop the recursion.

    -

    The other list commands lsd,lsf,lsjson do not recurse by default - use "-R" to make them recurse.

    -

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).

    +

    Note that ls and lsl recurse by default - use --max-depth 1 to stop the recursion.

    +

    The other list commands lsd,lsf,lsjson do not recurse by default - use -R to make them recurse.

    +

    Listing a non existent directory will produce an error except for remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes).

    rclone lsjson remote:path [flags]

    Options

          --dirs-only               Show only directories in the listing.
@@ -1401,47 +1417,71 @@ rclone copy --files-from-raw new_files /path/to/local remote:path

    rclone mount

    Mount the remote as file system on a mountpoint.

    -

    Synopsis

    +

    Synopsis

    rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.

    First set up your remote using rclone config. Check it works with rclone ls etc.

    -

    You can either run mount in foreground mode or background (daemon) mode. Mount runs in foreground mode by default, use the --daemon flag to specify background mode mode. Background mode is only supported on Linux and OSX, you can only run mount in foreground mode on Windows.

    -

    On Linux/macOS/FreeBSD Start the mount like this where /path/to/local/mount is an empty existing directory.

    +

    On Linux and OSX, you can either run mount in foreground mode or background (daemon) mode. Mount runs in foreground mode by default, use the --daemon flag to specify background mode. You can only run mount in foreground mode on Windows.

    +

    On Linux/macOS/FreeBSD start the mount like this, where /path/to/local/mount is an empty existing directory:

    rclone mount remote:path/to/files /path/to/local/mount
    -

    Or on Windows like this where X: is an unused drive letter or use a path to non-existent directory.

    -
    rclone mount remote:path/to/files X:
-rclone mount remote:path/to/files C:\path\to\nonexistent\directory
    -

    When running in background mode the user will have to stop the mount manually (specified below).

    -

    When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount is automatically stopped.

    -

    The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually.

    -

    Stopping the mount manually:

    +

    On Windows you can start a mount in different ways. See below for details. The following examples will mount to an automatically assigned drive, to specific drive letter X:, to path C:\path\to\nonexistent\directory (which must be non-existent subdirectory of an existing parent directory or drive, and is not supported when mounting as a network drive), and the last example will mount as network share \\cloud\remote and map it to an automatically assigned drive:

    +
    rclone mount remote:path/to/files *
+rclone mount remote:path/to/files X:
+rclone mount remote:path/to/files C:\path\to\nonexistent\directory
+rclone mount remote:path/to/files \\cloud\remote
    +

    When the program ends while in foreground mode, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped.

    +

    When running in background mode the user will have to stop the mount manually:

    # Linux
 fusermount -u /path/to/local/mount
 # OS X
 umount /path/to/local/mount
    +

    The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually.

    +

    The size of the mounted file system will be set according to information retrieved from the remote, the same as returned by the rclone about command. Remotes with unlimited storage may report the used size only, then an additional 1PB of free space is assumed. If the remote does not support the about feature at all, then 1PB is set as both the total and the free size.

    +

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

    Installing on Windows

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

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

    +

    Mounting modes on windows

    +

    Unlike other operating systems, Microsoft Windows provides a different filesystem type for network and fixed drives. It optimises access on the assumption fixed disk drives are fast and reliable, while network drives have relatively high latency and less reliability. Some settings can also be differentiated between the two types, for example that Windows Explorer should just display icons and not create preview thumbnails for image and video files on network drives.

    +

    In most cases, rclone will mount the remote as a normal, fixed disk drive by default. However, you can also choose to mount it as a remote network drive, often described as a network share. If you mount an rclone remote using the default, fixed drive mode and experience unexpected program errors, freezes or other issues, consider mounting as a network drive instead.

    +

    When mounting as a fixed disk drive you can either mount to an unused drive letter, or to a path - which must be non-existent subdirectory of an existing parent directory or drive. Using the special value * will tell rclone to automatically assign the next available drive letter, starting with Z: and moving backward. Examples:

    +
    rclone mount remote:path/to/files *
+rclone mount remote:path/to/files X:
+rclone mount remote:path/to/files C:\path\to\nonexistent\directory
+rclone mount remote:path/to/files X:
    +

    Option --volname can be used to set a custom volume name for the mounted file system. The default is to use the remote name and path.

    +

    To mount as network drive, you can add option --network-mode to your mount command. Mounting to a directory path is not supported in this mode, it is a limitation Windows imposes on junctions, so the remote must always be mounted to a drive letter.

    +
    rclone mount remote:path/to/files X: --network-mode
    +

    A volume name specified with --volname will be used to create the network share path. A complete UNC path, such as \\cloud\remote, optionally with path \\cloud\remote\madeup\path, will be used as is. Any other string will be used as the share part, after a default prefix \\server\. If no volume name is specified then \\server\share will be used. You must make sure the volume name is unique when you are mounting more than one drive, or else the mount command will fail. The share name will treated as the volume label for the mapped drive, shown in Windows Explorer etc, while the complete \\server\share will be reported as the remote UNC path by net use etc, just like a normal network drive mapping.

    +

    If you specify a full network share UNC path with --volname, this will implicitely set the --network-mode option, so the following two examples have same result:

    +
    rclone mount remote:path/to/files X: --network-mode
+rclone mount remote:path/to/files X: --volname \\server\share
    +

    You may also specify the network share UNC path as the mountpoint itself. Then rclone will automatically assign a drive letter, same as with * and use that as mountpoint, and instead use the UNC path specified as the volume name, as if it were specified with the --volname option. This will also implicitely set the --network-mode option. This means the following two examples have same result:

    +
    rclone mount remote:path/to/files \\cloud\remote
+rclone mount remote:path/to/files * --volname \\cloud\remote
    +

    There is yet another way to enable network mode, and to set the share path, and that is to pass the "native" libfuse/WinFsp option directly: --fuse-flag --VolumePrefix=\server\share. Note that the path must be with just a single backslash prefix in this case.

    +

    Note: In previous versions of rclone this was the only supported method.

    +

    Read more about drive mapping

    +

    See also Limitations section below.

    +

    Windows filesystem permissions

    +

    The FUSE emulation layer on Windows must convert between the POSIX-based permission model used in FUSE, and the permission model used in Windows, based on access-control lists (ACL).

    +

    The mounted filesystem will normally get three entries in its access-control list (ACL), representing permissions for the POSIX permission scopes: Owner, group and others. By default, the owner and group will be taken from the current user, and the built-in group "Everyone" will be used to represent others. The user/group can be customized with FUSE options "UserName" and "GroupName", e.g. -o UserName=user123 -o GroupName="Authenticated Users".

    +

    The permissions on each entry will be set according to options --dir-perms and --file-perms, which takes a value in traditional numeric notation, where the default corresponds to --file-perms 0666 --dir-perms 0777.

    +

    Note that the mapping of permissions is not always trivial, and the result you see in Windows Explorer may not be exactly like you expected. For example, when setting a value that includes write access, this will be mapped to individual permissions "write attributes", "write data" and "append data", but not "write extended attributes" (WinFsp does not support extended attributes, see this). Windows will then show this as basic permission "Special" instead of "Write", because "Write" includes the "write extended attributes" permission.

    Windows caveats

    Note that drives created as Administrator are not visible by other accounts (including the account that was elevated as Administrator). So if you start a Windows drive from an Administrative Command Prompt and then try to access the same drive from Explorer (which does not run as Administrator), you will not be able to see the new drive.

    The easiest way around this is to start the drive from a normal command prompt. It is also possible to start a drive from the SYSTEM account (using the WinFsp.Launcher infrastructure) which creates drives accessible for everyone on the system or alternatively using the nssm service manager.

    -

    Mount as a network drive

    -

    By default, rclone will mount the remote as a normal drive. However, you can also mount it as a Network Drive (or Network Share, as mentioned in some places)

    -

    Unlike other systems, Windows provides a different filesystem type for network drives. Windows and other programs treat the network drives and fixed/removable drives differently: In network drives, many I/O operations are optimized, as the high latency and low reliability (compared to a normal drive) of a network is expected.

    -

    Although many people prefer network shares to be mounted as normal system drives, this might cause some issues, such as programs not working as expected or freezes and errors while operating with the mounted remote in Windows Explorer. If you experience any of those, consider mounting rclone remotes as network shares, as Windows expects normal drives to be fast and reliable, while cloud storage is far from that. See also Limitations section below for more info

    -

    Add "--fuse-flag --VolumePrefix=" to your "mount" command, replacing "share" with any other name of your choice if you are mounting more than one remote. Otherwise, the mountpoints will conflict and your mounted filesystems will overlap.

    -

    Read more about drive mapping

    Limitations

    -

    Without the use of "--vfs-cache-mode" this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without "--vfs-cache-mode writes" or "--vfs-cache-mode full". See the File Caching section for more info.

    -

    The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.

    +

    Without the use of --vfs-cache-mode this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without --vfs-cache-mode writes or --vfs-cache-mode full. See the File Caching section for more info.

    +

    The bucket based remotes (e.g. Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.

    Only supported on Linux, FreeBSD, OS X and Windows at the moment.

    rclone mount vs rclone sync/copy

    File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the uploads. Look at the file caching for solutions to make mount more reliable.

    Attribute caching

    -

    You can use the flag --attr-timeout to set the time the kernel caches the attributes (size, modification time etc) for directory entries.

    -

    The default is "1s" which caches files just long enough to avoid too many callbacks to rclone from the kernel.

    +

    You can use the flag --attr-timeout to set the time the kernel caches the attributes (size, modification time, etc.) for directory entries.

    +

    The default is 1s which caches files just long enough to avoid too many callbacks to rclone from the kernel.

    In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as rclone using too much memory, rclone not serving files to samba and excessive time listing directories.

    -

    The kernel can cache the info about a file for the time given by "--attr-timeout". You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With "--attr-timeout 1s" this is very unlikely but not impossible. The higher you set "--attr-timeout" the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above.

    -

    If you set it higher ('10s' or '1m' say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above.

    +

    The kernel can cache the info about a file for the time given by --attr-timeout. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With --attr-timeout 1s this is very unlikely but not impossible. The higher you set --attr-timeout the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above.

    +

    If you set it higher (10s or 1m say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above.

    If files don't change on the remote outside of the control of rclone then there is no chance of corruption.

    This is the same as setting the attr_timeout option in mount.fuse.

    Filters

    @@ -1449,10 +1489,9 @@ umount /path/to/local/mount

    systemd

    When running rclone mount as a systemd service, it is possible to use Type=notify. In this case the service will enter the started state after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode.

    chunked reading

    -

    --vfs-read-chunk-size will enable reading the source objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests.

    -

    When --vfs-read-chunk-size-limit is also specified and greater than --vfs-read-chunk-size, the chunk size for each open file will get doubled for each chunk read, until the specified value is reached. A value of -1 will disable the limit and the chunk size will grow indefinitely.

    -

    With --vfs-read-chunk-size 100M and --vfs-read-chunk-size-limit 0 the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When --vfs-read-chunk-size-limit 500M is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.

    -

    Chunked reading will only work with --vfs-cache-mode < full, as the file will always be copied to the vfs cache before opening with --vfs-cache-mode full.

    +

    --vfs-read-chunk-size will enable reading the source objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests.

    +

    When --vfs-read-chunk-size-limit is also specified and greater than --vfs-read-chunk-size, the chunk size for each open file will get doubled for each chunk read, until the specified value is reached. A value of -1 will disable the limit and the chunk size will grow indefinitely.

    +

    With --vfs-read-chunk-size 100M and --vfs-read-chunk-size-limit 0 the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When --vfs-read-chunk-size-limit 500M is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.

    VFS - Virtual File System

    This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system.

    Cloud storage objects have lots of properties which aren't like disk files - you can't extend them or write to the middle of them, so the VFS layer has to deal with that. Because there is no one right way of doing this there are various options explained below.

    @@ -1486,7 +1525,7 @@ umount /path/to/local/mount

    If run with -vv rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with --cache-dir or setting the appropriate environment variable.

    The cache has 4 different modes selected by --vfs-cache-mode. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.

    Note that files are written back to the remote only when they are closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

    -

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    +

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    --vfs-cache-mode off

    In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

    This will mean some operations are not possible

    @@ -1514,11 +1553,12 @@ umount /path/to/local/mount

    If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.

    --vfs-cache-mode full

    In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.

    -

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has dowloaded.

    +

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.

    So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.

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

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

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

    +

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

    VFS Performance

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

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

    @@ -1533,40 +1573,45 @@ umount /path/to/local/mount

    Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.

    --vfs-read-wait duration   Time to wait for in-sequence read before seeking. (default 20ms)
 --vfs-write-wait duration  Time to wait for in-sequence write before giving error. (default 1s)
    +

    When using VFS write caching (--vfs-cache-mode with value writes or full), the global flag --transfers can be set to adjust the number of parallel uploads of modified files from cache (the related global flag --checkers have no effect on mount).

    +
    --transfers int  Number of file transfers to run in parallel. (default 4)

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

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

    rclone mount remote:path /path/to/mountpoint [flags]

    Options

    -
          --allow-non-empty                        Allow mounting over a non-empty directory (not Windows).
-      --allow-other                            Allow access to other users.
-      --allow-root                             Allow access to root user.
-      --async-read                             Use asynchronous reads. (default true)
+
          --allow-non-empty                        Allow mounting over a non-empty directory. Not supported on Windows.
+      --allow-other                            Allow access to other users. Not supported on Windows.
+      --allow-root                             Allow access to root user. Not supported on Windows.
+      --async-read                             Use asynchronous reads. Not supported on Windows. (default true)
       --attr-timeout duration                  Time for which file/directory attributes are cached. (default 1s)
-      --daemon                                 Run mount as a daemon (background mode).
-      --daemon-timeout duration                Time limit for rclone to respond to kernel (not supported by all OSes).
+      --daemon                                 Run mount as a daemon (background mode). Not supported on Windows.
+      --daemon-timeout duration                Time limit for rclone to respond to kernel. Not supported on Windows.
       --debug-fuse                             Debug the FUSE internals - needs -v.
-      --default-permissions                    Makes kernel enforce access control based on the file mode.
+      --default-permissions                    Makes kernel enforce access control based on the file mode. Not supported on Windows.
       --dir-cache-time duration                Time to cache directory entries for. (default 5m0s)
       --dir-perms FileMode                     Directory permissions (default 0777)
       --file-perms FileMode                    File permissions (default 0666)
       --fuse-flag stringArray                  Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required.
-      --gid uint32                             Override the gid field set by the filesystem. (default 1000)
+      --gid uint32                             Override the gid field set by the filesystem. Not supported on Windows. (default 1000)
   -h, --help                                   help for mount
-      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads. (default 128k)
+      --max-read-ahead SizeSuffix              The number of bytes that can be prefetched for sequential reads. Not supported on Windows. (default 128k)
+      --network-mode                           Mount as remote network drive, instead of fixed disk drive. Supported on Windows only
       --no-checksum                            Don't compare checksums on up/download.
       --no-modtime                             Don't read/write the modification time (can speed things up).
       --no-seek                                Don't allow seeking in files.
+      --noappledouble                          Ignore Apple Double (._) and .DS_Store files. Supported on OSX only. (default true)
+      --noapplexattr                           Ignore all "com.apple.*" extended attributes. Supported on OSX only.
   -o, --option stringArray                     Option for libfuse/WinFsp. Repeat if required.
       --poll-interval duration                 Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
       --read-only                              Mount read-only.
-      --uid uint32                             Override the uid field set by the filesystem. (default 1000)
-      --umask int                              Override the permission bits set by the filesystem.
+      --uid uint32                             Override the uid field set by the filesystem. Not supported on Windows. (default 1000)
+      --umask int                              Override the permission bits set by the filesystem. Not supported on Windows.
       --vfs-cache-max-age duration             Max age of objects in the cache. (default 1h0m0s)
       --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)
@@ -1578,8 +1623,8 @@ umount /path/to/local/mount
    
       --vfs-read-wait duration                 Time to wait for in-sequence read before seeking. (default 20ms)
       --vfs-write-back duration                Time to writeback files after last use when using cache. (default 5s)
       --vfs-write-wait duration                Time to wait for in-sequence write before giving error. (default 1s)
-      --volname string                         Set the volume name (not supported by all OSes).
-      --write-back-cache                       Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used.
    + --volname string Set the volume name. Supported on Windows and OSX only. + --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. Not supported on Windows.

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

    SEE ALSO

    rclone moveto

    Move file or directory from source to dest.

    -

    Synopsis

    +

    Synopsis

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

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

    So

    @@ -1612,7 +1657,7 @@ if src is directory

    rclone ncdu

    Explore a remote with a text based user interface.

    -

    Synopsis

    +

    Synopsis

    This displays a text based user interface allowing the navigation of a remote. It is most useful for answering the question - "What is using all my disk space?".

    To make the user interface it first scans the entire remote given and builds an in memory representation. rclone ncdu can be used during this scanning phase and you will see it building up the directory structure as it goes along.

    Here are the keys - press '?' to toggle the help on and off

    @@ -1621,9 +1666,10 @@ if src is directory ←,h to return c toggle counts g toggle graph - n,s,C sort by name,size,count + a toggle average size in directory + n,s,C,A sort by name,size,count,average size d delete file/directory - y copy current path to clipbard + y copy current path to clipboard Y display current path ^L refresh screen ? to toggle help on and off @@ -1639,11 +1685,11 @@ if src is directory
  • rclone - Show help for rclone commands, flags and backends.

    • rclone obscure

    -

    Obscure password for use in the rclone config file

    -

    Synopsis

    +

    Obscure password for use in the rclone config file.

    +

    Synopsis

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

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

    -

    This command can also accept a password through STDIN instead of an argument by passing a hyphen as an argument. Example:

    +

    This command can also accept a password through STDIN instead of an argument by passing a hyphen as an argument. This will use the first line of STDIN as the password not including the trailing newline.

    echo "secretpassword" | rclone obscure -

    If there is no data on STDIN to read, rclone obscure will default to obfuscating the hyphen itself.

    If you want to encrypt the config file then please use config file encryption - see rclone config for more info.

    @@ -1657,7 +1703,7 @@ if src is directory

    rclone rc

    Run a command against a running rclone.

    -

    Synopsis

    +

    Synopsis

    This runs a command against a running rclone. Use the --url flag to specify an non default URL to connect on. This can be either a ":port" which is taken to mean "http://localhost:port" or a "host:port" which is taken to mean "http://host:port"

    A username and password can be passed in with --user and --pass.

    Note that --rc-addr, --rc-user, --rc-pass will be read also for --url, --user, --pass.

    @@ -1672,7 +1718,7 @@ if src is directory 
    -a value -a value2

    Will place this in the "arg" value

    ["value", "value2"]
    -

    Use --loopback to connect to the rclone instance running "rclone rc". This is very useful for testing commands without having to run an rclone rc server, eg:

    +

    Use --loopback to connect to the rclone instance running "rclone rc". This is very useful for testing commands without having to run an rclone rc server, e.g.:

    rclone rc --loopback operations/about fs=/

    Use "rclone rc" to see a list of all possible commands.

    rclone rc commands parameter [flags]
    @@ -1681,7 +1727,7 @@ if src is directory -h, --help help for rc --json string Input JSON - use instead of key=value args. --loopback If set connect to this rclone instance not via HTTP. - --no-output If set don't output the JSON result. + --no-output If set, don't output the JSON result. -o, --opt stringArray Option in the form name=value or name placed in the "opt" array. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") @@ -1693,7 +1739,7 @@ if src is directory

    rclone rcat

    Copies standard input to file on remote.

    -

    Synopsis

    +

    Synopsis

    rclone rcat reads from standard input (stdin) and copies it to a single remote file.

    echo "hello world" | rclone rcat remote:path/to/file
 ffmpeg - | rclone rcat remote:path/to/file
    @@ -1710,7 +1756,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    rclone rcd

    Run rclone listening to remote control commands only.

    -

    Synopsis

    +

    Synopsis

    This runs rclone so that it only listens to remote control commands.

    This is useful if you are controlling rclone via the rc API.

    If you pass in a path to a directory, rclone will serve that directory for GET requests on the URL passed in. It will also open the URL in the browser when rclone is run.

    @@ -1725,10 +1771,11 @@ ffmpeg - | rclone rcat remote:path/to/file

    rclone rmdirs

    Remove empty directories under the path.

    -

    Synopsis

    -

    This removes any empty directories (or directories that only contain empty directories) under the path that it finds, including the path if it has nothing in.

    -

    If you supply the --leave-root flag, it will not remove the root directory.

    -

    This is useful for tidying up remotes that rclone has left a lot of empty directories in.

    +

    Synopsis

    +

    This recursively removes any empty directories (including directories that only contain empty directories), that it finds under the path. The root path itself will also be removed if it is empty, unless you supply the --leave-root flag.

    +

    Use command rmdir to delete just the empty directory given by path, not recurse.

    +

    This is useful for tidying up remotes that rclone has left a lot of empty directories in. For example the delete command will delete files but leave the directory structure (unless used with option --rmdirs).

    +

    To delete a path and any objects in it, use purge command.

    rclone rmdirs remote:path [flags]

    Options

      -h, --help         help for rmdirs
@@ -1740,8 +1787,8 @@ ffmpeg - | rclone rcat remote:path/to/file

    rclone serve

    Serve a remote over a protocol.

    -

    Synopsis

    -

    rclone serve is used to serve a remote over a given protocol. This command requires the use of a subcommand to specify the protocol, eg

    +

    Synopsis

    +

    rclone serve is used to serve a remote over a given protocol. This command requires the use of a subcommand to specify the protocol, e.g.

    rclone serve http remote:

    Each subcommand has its own options which you can see in their help.

    rclone serve <protocol> [opts] <remote> [flags]
    @@ -1760,11 +1807,11 @@ ffmpeg - | rclone rcat remote:path/to/file

    rclone serve dlna

    Serve remote:path over DLNA

    -

    Synopsis

    +

    Synopsis

    rclone serve dlna is a DLNA media server for media stored in an rclone remote. Many devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast packets (SSDP) and will thus only work on LANs.

    Rclone will list all files present in the remote, without filtering based on media formats or file extensions. Additionally, there is no media transcoding support. This means that some players might show files that they are not able to play back correctly.

    Server options

    -

    Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs.

    +

    Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs.

    Use --name to choose the friendly server name, which is by default "rclone (hostname)".

    Use --log-trace in conjunction with -vv to enable additional debug logging of all UPNP traffic.

    VFS - Virtual File System

    @@ -1800,7 +1847,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    If run with -vv rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with --cache-dir or setting the appropriate environment variable.

    The cache has 4 different modes selected by --vfs-cache-mode. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.

    Note that files are written back to the remote only when they are closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

    -

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    +

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    --vfs-cache-mode off

    In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

    This will mean some operations are not possible

    @@ -1828,11 +1875,12 @@ ffmpeg - | rclone rcat remote:path/to/file

    If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.

    --vfs-cache-mode full

    In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.

    -

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has dowloaded.

    +

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.

    So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.

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

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

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

    +

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

    VFS Performance

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

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

    @@ -1847,11 +1895,13 @@ ffmpeg - | rclone rcat remote:path/to/file

    Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.

    --vfs-read-wait duration   Time to wait for in-sequence read before seeking. (default 20ms)
 --vfs-write-wait duration  Time to wait for in-sequence write before giving error. (default 1s)
    +

    When using VFS write caching (--vfs-cache-mode with value writes or full), the global flag --transfers can be set to adjust the number of parallel uploads of modified files from cache (the related global flag --checkers have no effect on mount).

    +
    --transfers int  Number of file transfers to run in parallel. (default 4)

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

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

    @@ -1861,7 +1911,7 @@ ffmpeg - | rclone rcat remote:path/to/file --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for dlna --log-trace enable trace logging of SOAP traffic --name string name of DLNA server @@ -1870,8 +1920,8 @@ ffmpeg - | rclone rcat remote:path/to/file --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) @@ -1890,10 +1940,10 @@ ffmpeg - | rclone rcat remote:path/to/file

    rclone serve ftp

    Serve remote:path over FTP.

    -

    Synopsis

    +

    Synopsis

    rclone serve ftp implements a basic ftp server to serve the remote over FTP protocol. This can be viewed with a ftp client or you can make a remote of type ftp to read and write it.

    Server options

    -

    Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    +

    Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.

    Authentication

    By default this will serve files without needing a login.

    @@ -1931,7 +1981,7 @@ ffmpeg - | rclone rcat remote:path/to/file

    If run with -vv rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with --cache-dir or setting the appropriate environment variable.

    The cache has 4 different modes selected by --vfs-cache-mode. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.

    Note that files are written back to the remote only when they are closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

    -

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    +

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    --vfs-cache-mode off

    In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

    This will mean some operations are not possible

    @@ -1959,11 +2009,12 @@ ffmpeg - | rclone rcat remote:path/to/file

    If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.

    --vfs-cache-mode full

    In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.

    -

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has dowloaded.

    +

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.

    So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.

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

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

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

    +

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

    VFS Performance

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

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

    @@ -1978,16 +2029,18 @@ ffmpeg - | rclone rcat remote:path/to/file

    Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.

    --vfs-read-wait duration   Time to wait for in-sequence read before seeking. (default 20ms)
 --vfs-write-wait duration  Time to wait for in-sequence write before giving error. (default 1s)
    +

    When using VFS write caching (--vfs-cache-mode with value writes or full), the global flag --transfers can be set to adjust the number of parallel uploads of modified files from cache (the related global flag --checkers have no effect on mount).

    +
    --transfers int  Number of file transfers to run in parallel. (default 4)

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

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

    Auth Proxy

    -

    If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocl with input on STDIN and output on STDOUT.

    +

    If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.

    PLEASE NOTE: --auth-proxy and --authorized-keys cannot be used together, if --auth-proxy is set the authorized keys option will be ignored.

    There is an example program bin/test_proxy.py in the rclone source code.

    The program's job is to take a user and pass on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.

    @@ -2020,11 +2073,13 @@ ffmpeg - | rclone rcat remote:path/to/file

    Options

          --addr string                            IPaddress:Port or :Port to bind server to. (default "localhost:2121")
       --auth-proxy string                      A program to use to create the backend from the auth.
+      --cert string                            TLS PEM key (concatenation of certificate and CA certificate)
       --dir-cache-time duration                Time to cache directory entries for. (default 5m0s)
       --dir-perms FileMode                     Directory permissions (default 0777)
       --file-perms FileMode                    File permissions (default 0666)
-      --gid uint32                             Override the gid field set by the filesystem. (default 1000)
+      --gid uint32                             Override the gid field set by the filesystem. Not supported on Windows. (default 1000)
   -h, --help                                   help for ftp
+      --key string                             TLS PEM Private key
       --no-checksum                            Don't compare checksums on up/download.
       --no-modtime                             Don't read/write the modification time (can speed things up).
       --no-seek                                Don't allow seeking in files.
@@ -2033,8 +2088,8 @@ ffmpeg - | rclone rcat remote:path/to/file
    --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2054,13 +2109,13 @@ ffmpeg - | rclone rcat remote:path/to/file

    rclone serve http

    Serve the remote over HTTP.

    -

    Synopsis

    +

    Synopsis

    rclone serve http implements a basic web server to serve the remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it.

    -

    You can use the filter flags (eg --include, --exclude) to control what is served.

    +

    You can use the filter flags (e.g. --include, --exclude) to control what is served.

    The server will log errors. Use -v to see access logs.

    --bwlimit will be respected for file transfers. Use --stats to control the stats printing.

    Server options

    -

    Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    +

    Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.

    --server-read-timeout and --server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.

    --max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.

    @@ -2092,7 +2147,7 @@ ffmpeg - | rclone rcat remote:path/to/file -Sort Options: namedirfist,name,size,time (default namedirfirst) +Sort Options: namedirfirst,name,size,time (default namedirfirst) .Order @@ -2190,7 +2245,7 @@ htpasswd -B htpasswd anotherUser

    If run with -vv rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with --cache-dir or setting the appropriate environment variable.

    The cache has 4 different modes selected by --vfs-cache-mode. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.

    Note that files are written back to the remote only when they are closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

    -

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    +

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    --vfs-cache-mode off

    In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

    This will mean some operations are not possible

    @@ -2218,11 +2273,12 @@ htpasswd -B htpasswd anotherUser

    If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.

    --vfs-cache-mode full

    In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.

    -

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has dowloaded.

    +

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.

    So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.

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

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

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

    +

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

    VFS Performance

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

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

    @@ -2237,11 +2293,13 @@ htpasswd -B htpasswd anotherUser

    Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.

    --vfs-read-wait duration   Time to wait for in-sequence read before seeking. (default 20ms)
 --vfs-write-wait duration  Time to wait for in-sequence write before giving error. (default 1s)
    +

    When using VFS write caching (--vfs-cache-mode with value writes or full), the global flag --transfers can be set to adjust the number of parallel uploads of modified files from cache (the related global flag --checkers have no effect on mount).

    +
    --transfers int  Number of file transfers to run in parallel. (default 4)

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

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

    @@ -2254,7 +2312,7 @@ htpasswd -B htpasswd anotherUser --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -2269,8 +2327,8 @@ htpasswd -B htpasswd anotherUser --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2290,7 +2348,7 @@ htpasswd -B htpasswd anotherUser

    rclone serve restic

    Serve the remote for restic's REST API.

    -

    Synopsis

    +

    Synopsis

    rclone serve restic implements restic's REST backend API over HTTP. This allows restic to use rclone as a data storage mechanism for cloud providers that restic does not support directly.

    Restic is a command line program for doing backups.

    The server will log errors. Use -v to see access logs.

    @@ -2303,6 +2361,7 @@ htpasswd -B htpasswd anotherUser

    Where you can replace "backup" in the above by whatever path in the remote you wish to use.

    By default this will serve on "localhost:8080" you can change this with use of the "--addr" flag.

    You might wish to start this server on boot.

    +

    Adding --cache-objects=false will cause rclone to stop caching objects returned from the List call. Caching is normally desirable as it speeds up downloading objects, saves transactions and uses very little memory.

    Setting up restic to use rclone

    Now you can follow the restic instructions on setting up restic.

    Note that you will need restic 0.8.2 or later to interoperate with rclone.

    @@ -2331,7 +2390,7 @@ $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/

    Private repositories

    The "--private-repos" flag can be used to limit users to repositories starting with a path of /<username>/.

    Server options

    -

    Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    +

    Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.

    --server-read-timeout and --server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.

    --max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.

    @@ -2363,7 +2422,7 @@ $ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ -Sort Options: namedirfist,name,size,time (default namedirfirst) +Sort Options: namedirfirst,name,size,time (default namedirfirst) .Order @@ -2433,6 +2492,7 @@ htpasswd -B htpasswd anotherUser 
          --addr string                     IPaddress:Port or :Port to bind server to. (default "localhost:8080")
       --append-only                     disallow deletion of repository data
       --baseurl string                  Prefix for URLs - leave blank for root.
+      --cache-objects                   cache listed objects (default true)
       --cert string                     SSL PEM key (concatenation of certificate and CA certificate)
       --client-ca string                Client certificate authority to verify clients with
   -h, --help                            help for restic
@@ -2454,9 +2514,9 @@ htpasswd -B htpasswd anotherUser

    rclone serve sftp

    Serve the remote over SFTP.

    -

    Synopsis

    +

    Synopsis

    rclone serve sftp implements an SFTP server to serve the remote over SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it.

    -

    You can use the filter flags (eg --include, --exclude) to control what is served.

    +

    You can use the filter flags (e.g. --include, --exclude) to control what is served.

    The server will log errors. Use -v to see access logs.

    --bwlimit will be respected for file transfers. Use --stats to control the stats printing.

    You must provide some means of authentication, either with --user/--pass, an authorized keys file (specify location with --authorized-keys - the default is the same as ssh), an --auth-proxy, or set the --no-auth flag for no authentication when logging in.

    @@ -2497,7 +2557,7 @@ htpasswd -B htpasswd anotherUser

    If run with -vv rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with --cache-dir or setting the appropriate environment variable.

    The cache has 4 different modes selected by --vfs-cache-mode. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.

    Note that files are written back to the remote only when they are closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

    -

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    +

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    --vfs-cache-mode off

    In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

    This will mean some operations are not possible

    @@ -2525,11 +2585,12 @@ htpasswd -B htpasswd anotherUser

    If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.

    --vfs-cache-mode full

    In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.

    -

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has dowloaded.

    +

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.

    So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.

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

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

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

    +

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

    VFS Performance

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

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

    @@ -2544,16 +2605,18 @@ htpasswd -B htpasswd anotherUser

    Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.

    --vfs-read-wait duration   Time to wait for in-sequence read before seeking. (default 20ms)
 --vfs-write-wait duration  Time to wait for in-sequence write before giving error. (default 1s)
    +

    When using VFS write caching (--vfs-cache-mode with value writes or full), the global flag --transfers can be set to adjust the number of parallel uploads of modified files from cache (the related global flag --checkers have no effect on mount).

    +
    --transfers int  Number of file transfers to run in parallel. (default 4)

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

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

    Auth Proxy

    -

    If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocl with input on STDIN and output on STDOUT.

    +

    If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.

    PLEASE NOTE: --auth-proxy and --authorized-keys cannot be used together, if --auth-proxy is set the authorized keys option will be ignored.

    There is an example program bin/test_proxy.py in the rclone source code.

    The program's job is to take a user and pass on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.

    @@ -2590,7 +2653,7 @@ htpasswd -B htpasswd anotherUser --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for sftp --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) --no-auth Allow connections with no authentication if set. @@ -2600,8 +2663,8 @@ htpasswd -B htpasswd anotherUser --pass string Password for authentication. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2621,7 +2684,7 @@ htpasswd -B htpasswd anotherUser

    rclone serve webdav

    Serve remote:path over webdav.

    -

    Synopsis

    +

    Synopsis

    rclone serve webdav implements a basic webdav server to serve the remote over HTTP via the webdav protocol. This can be viewed with a webdav client, through a web browser, or you can make a remote of type webdav to read and write it.

    Webdav options

    --etag-hash

    @@ -2629,7 +2692,7 @@ htpasswd -B htpasswd anotherUser

    If this flag is set to "auto" then rclone will choose the first supported hash on the backend or you can use a named hash such as "MD5" or "SHA-1".

    Use "rclone hashsum" to see the full list.

    Server options

    -

    Use --addr to specify which IP address and port the server should listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    +

    Use --addr to specify which IP address and port the server should listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

    If you set --addr to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.

    --server-read-timeout and --server-write-timeout can be used to control the timeouts on the server. Note that this is the total time for a transfer.

    --max-header-bytes controls the maximum number of bytes the server will accept in the HTTP header.

    @@ -2661,7 +2724,7 @@ htpasswd -B htpasswd anotherUser -Sort Options: namedirfist,name,size,time (default namedirfirst) +Sort Options: namedirfirst,name,size,time (default namedirfirst) .Order @@ -2759,7 +2822,7 @@ htpasswd -B htpasswd anotherUser

    If run with -vv rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with --cache-dir or setting the appropriate environment variable.

    The cache has 4 different modes selected by --vfs-cache-mode. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.

    Note that files are written back to the remote only when they are closed and if they haven't been accessed for --vfs-write-back second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags.

    -

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    +

    If using --vfs-cache-max-size note that the cache may exceed this size for two reasons. Firstly because it is only checked every --vfs-cache-poll-interval. Secondly because open files cannot be evicted from the cache.

    --vfs-cache-mode off

    In this mode (the default) the cache will read directly from the remote and write directly to the remote without caching anything on disk.

    This will mean some operations are not possible

    @@ -2787,11 +2850,12 @@ htpasswd -B htpasswd anotherUser

    If an upload fails it will be retried at exponentially increasing intervals up to 1 minute.

    --vfs-cache-mode full

    In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well.

    -

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has dowloaded.

    +

    In this mode the files in the cache will be sparse files and rclone will keep track of which bits of the files it has downloaded.

    So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be their full size in the cache, but they will be sparse files with only the data that has been downloaded present in them.

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

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

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

    +

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

    VFS Performance

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

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

    @@ -2806,16 +2870,18 @@ htpasswd -B htpasswd anotherUser

    Sometimes rclone is delivered reads or writes out of order. Rather than seeking rclone will wait a short time for the in sequence read or write to come in. These flags only come into effect when not using an on disk cache file.

    --vfs-read-wait duration   Time to wait for in-sequence read before seeking. (default 20ms)
 --vfs-write-wait duration  Time to wait for in-sequence write before giving error. (default 1s)
    +

    When using VFS write caching (--vfs-cache-mode with value writes or full), the global flag --transfers can be set to adjust the number of parallel uploads of modified files from cache (the related global flag --checkers have no effect on mount).

    +
    --transfers int  Number of file transfers to run in parallel. (default 4)

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

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

    Auth Proxy

    -

    If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocl with input on STDIN and output on STDOUT.

    +

    If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based protocol with input on STDIN and output on STDOUT.

    PLEASE NOTE: --auth-proxy and --authorized-keys cannot be used together, if --auth-proxy is set the authorized keys option will be ignored.

    There is an example program bin/test_proxy.py in the rclone source code.

    The program's job is to take a user and pass on the input and turn those into the config for a backend on STDOUT in JSON format. This config will have any default parameters for the backend added, but it won't use configuration from environment variables or command line options - it is the job of the proxy program to make a complete config.

    @@ -2856,7 +2922,7 @@ htpasswd -B htpasswd anotherUser --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -2871,8 +2937,8 @@ htpasswd -B htpasswd anotherUser --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -2892,7 +2958,7 @@ htpasswd -B htpasswd anotherUser

    rclone settier

    Changes storage class/tier of objects in remote.

    -

    Synopsis

    +

    Synopsis

    rclone settier changes storage tier or class at remote if supported. Few cloud storage services provides different storage classes on objects, for example AWS S3 and Glacier, Azure Blob storage - Hot, Cool and Archive, Google Cloud Storage, Regional Storage, Nearline, Coldline etc.

    Note that, certain tier changes make objects not available to access immediately. For example tiering to archive in azure blob storage makes objects in frozen state, user can restore by setting tier to Hot/Cool, similarly S3 to Glacier makes object inaccessible.true

    You can use it to tier single object

    @@ -2911,14 +2977,14 @@ htpasswd -B htpasswd anotherUser

    rclone touch

    Create new file or change file modification time.

    -

    Synopsis

    +

    Synopsis

    Set the modification time on object(s) as specified by remote:path to have the current time.

    If remote:path does not exist then a zero sized object will be created unless the --no-create flag is provided.

    If --timestamp is used then it will set the modification time to that time instead of the current time. Times may be specified as one of:

    Note that --timestamp is in UTC if you want local time then add the --localtime flag.

    rclone touch remote:path [flags]
    @@ -2934,7 +3000,7 @@ htpasswd -B htpasswd anotherUser

    rclone tree

    List the contents of the remote in a tree like fashion.

    -

    Synopsis

    +

    Synopsis

    rclone tree lists the contents of a remote in a similar way to the unix tree command.

    For example

    $ rclone tree remote:path
@@ -2947,7 +3013,7 @@ htpasswd -B htpasswd anotherUser
    └── file5 1 directories, 5 files -

    You can use any of the filtering options with the tree command (eg --include and --exclude). You can also use --fast-list.

    +

    You can use any of the filtering options with the tree command (e.g. --include and --exclude). You can also use --fast-list.

    The tree command has many options for controlling the listing which are compatible with the tree command. Note that not all of them have short options as they conflict with rclone's short options.

    rclone tree remote:path [flags]

    Options

    @@ -3017,15 +3083,15 @@ htpasswd -B htpasswd anotherUser

    When you are typing commands to your computer you are using something called the command line shell. This interprets various characters in an OS specific way.

    Here are some gotchas which may help users unfamiliar with the shell rules

    Linux / OSX

    -

    If your names have spaces or shell metacharacters (eg *, ?, $, ', " etc) then you must quote them. Use single quotes ' by default.

    +

    If your names have spaces or shell metacharacters (e.g. *, ?, $, ', ", etc.) then you must quote them. Use single quotes ' by default.

    rclone copy 'Important files?' remote:backup
    -

    If you want to send a ' you will need to use ", eg

    +

    If you want to send a ' you will need to use ", e.g.

    rclone copy "O'Reilly Reviews" remote:backup

    The rules for quoting metacharacters are complicated and if you want the full details you'll have to consult the manual page for your shell.

    Windows

    -

    If your names have spaces in you need to put them in ", eg

    +

    If your names have spaces in you need to put them in ", e.g.

    rclone copy "E:\folder name\folder name\folder name" remote:backup
    -

    If you are using the root directory on its own then don't quote it (see #464 for why), eg

    +

    If you are using the root directory on its own then don't quote it (see #464 for why), e.g.

    rclone copy E:\ remote:backup

    Copying files or directories with : in the names

    rclone uses : to mark a remote name. This is, however, a valid filename component in non-Windows OSes. The remote name parser will only search for a : up to the first / so if you need to act on a file or directory like this then use the full path starting with a /, or use ./ as a current directory prefix.

    @@ -3034,26 +3100,26 @@ htpasswd -B htpasswd anotherUser

    or

    rclone sync -i /full/path/to/sync:me remote:path

    Server Side Copy

    -

    Most remotes (but not all - see the overview) support server side copy.

    +

    Most remotes (but not all - see the overview) support server-side copy.

    This means if you want to copy one folder to another then rclone won't download all the files and re-upload them; it will instruct the server to copy them in place.

    Eg

    rclone copy s3:oldbucket s3:newbucket

    Will copy the contents of oldbucket to newbucket without downloading and re-uploading.

    -

    Remotes which don't support server side copy will download and re-upload in this case.

    -

    Server side copies are used with sync and copy and will be identified in the log when using the -v flag. The move command may also use them if remote doesn't support server side move directly. This is done by issuing a server side copy then a delete which is much quicker than a download and re-upload.

    +

    Remotes which don't support server-side copy will download and re-upload in this case.

    +

    Server side copies are used with sync and copy and will be identified in the log when using the -v flag. The move command may also use them if remote doesn't support server-side move directly. This is done by issuing a server-side copy then a delete which is much quicker than a download and re-upload.

    Server side copies will only be attempted if the remote names are the same.

    -

    This can be used when scripting to make aged backups efficiently, eg

    +

    This can be used when scripting to make aged backups efficiently, e.g.

    rclone sync -i remote:current-backup remote:previous-backup
 rclone sync -i /path/to/files remote:current-backup

    Options

    Rclone has a number of options to control its behaviour.

    Options that take parameters can have the values passed in two ways, --option=value or --option value. However boolean (true/false) options behave slightly differently to the other options in that --boolean sets the option to true and the absence of the flag sets it to false. It is also possible to specify --boolean=false or --boolean=true. Note that --boolean false is not valid - this is parsed as --boolean and the false is parsed as an extra command line argument for rclone.

    Options which use TIME use the go time parser. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    -

    Options which use SIZE use kByte by default. However, a suffix of b for bytes, k for kBytes, M for MBytes, G for GBytes, T for TBytes and P for PBytes may be used. These are the binary units, eg 1, 2**10, 2**20, 2**30 respectively.

    +

    Options which use SIZE use kByte by default. However, a suffix of b for bytes, k for kBytes, M for MBytes, G for GBytes, T for TBytes and P for PBytes may be used. These are the binary units, e.g. 1, 2**10, 2**20, 2**30 respectively.

    --backup-dir=DIR

    When using sync, copy or move any files which would have been overwritten or deleted are moved in their original hierarchy into this directory.

    If --suffix is set, then the moved files will have the suffix added to them. If there is a file with the same path (after the suffix has been added) in DIR, then it will be overwritten.

    -

    The remote in use must support server side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory.

    +

    The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory.

    For example

    rclone sync -i /path/to/local remote:current --backup-dir remote:old

    will sync /path/to/local to remote:current, but for any files which would have been updated or deleted will be stored in remote:old.

    @@ -3062,22 +3128,33 @@ rclone sync -i /path/to/files remote:current-backup

    --bind string

    Local address to bind to for outgoing connections. This can be an IPv4 address (1.2.3.4), an IPv6 address (1234::789A) or host name. If the host name doesn't resolve or resolves to more than one IP address it will give an error.

    --bwlimit=BANDWIDTH_SPEC

    -

    This option controls the bandwidth limit. Limits can be specified in two ways: As a single limit, or as a timetable.

    -

    Single limits last for the duration of the session. To use a single limit, specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The default is 0 which means to not limit bandwidth.

    -

    For example, to limit bandwidth usage to 10 MBytes/s use --bwlimit 10M

    -

    It is also possible to specify a "timetable" of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH... where: WEEKDAY is optional element. It could be written as whole world or only using 3 first characters. HH:MM is an hour from 00:00 to 23:59.

    +

    This option controls the bandwidth limit. For example

    +
    --bwlimit 10M
    +

    would mean limit the upload and download bandwidth to 10 Mbyte/s. NB this is bytes per second not bits per second. To use a single limit, specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The default is 0 which means to not limit bandwidth.

    +

    The upload and download bandwidth can be specified seperately, as --bwlimit UP:DOWN, so

    +
    --bwlimit 10M:100k
    +

    would mean limit the upload bandwidth to 10 Mbyte/s and the download bandwidth to 100 kByte/s. Either limit can be "off" meaning no limit, so to just limit the upload bandwidth you would use

    +
    --bwlimit 10M:off
    +

    this would limit the upload bandwidth to 10MByte/s but the download bandwidth would be unlimited.

    +

    When specified as above the bandwidth limits last for the duration of run of the rclone binary.

    +

    It is also possible to specify a "timetable" of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH... where: WEEKDAY is optional element.

    +

    An example of a typical timetable to avoid link saturation during daytime working hours could be:

    -

    --bwlimit "08:00,512 12:00,10M 13:00,512 18:00,30M 23:00,off"

    -

    In this example, the transfer bandwidth will be every day set to 512kBytes/sec at 8am. At noon, it will raise to 10Mbytes/s, and drop back to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited.

    +

    --bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off"

    +

    In this example, the transfer bandwidth will be set to 512kBytes/sec at 8am every day. At noon, it will rise to 10Mbytes/s, and drop back to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited.

    An example of timetable with WEEKDAY could be:

    --bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"

    -

    It mean that, the transfer bandwidth will be set to 512kBytes/sec on Monday. It will raise to 10Mbytes/s before the end of Friday. At 10:00 on Sunday it will be set to 1Mbyte/s. From 20:00 at Sunday will be unlimited.

    -

    Timeslots without weekday are extended to whole week. So this one example:

    +

    It means that, the transfer bandwidth will be set to 512kBytes/sec on Monday. It will rise to 10Mbytes/s before the end of Friday. At 10:00 on Saturday it will be set to 1Mbyte/s. From 20:00 on Sunday it will be unlimited.

    +

    Timeslots without WEEKDAY are extended to the whole week. So this example:

    --bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off"

    -

    Is equal to this:

    +

    Is equivalent to this:

    --bwlimit "Mon-00:00,512Mon-12:00,1M Tue-12:00,1M Wed-12:00,1M Thu-12:00,1M Fri-12:00,1M Sat-12:00,1M Sun-12:00,1M Sun-20:00,off"

    -

    Bandwidth limits only apply to the data transfer. They don't apply to the bandwidth of the directory listings etc.

    -

    Note that the units are Bytes/s, not Bits/s. Typically connections are measured in Bits/s - to convert divide by 8. For example, let's say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would use a --bwlimit 0.625M parameter for rclone.

    +

    Bandwidth limit apply to the data transfer for all backends. For most backends the directory listing bandwidth is also included (exceptions being the non HTTP backends, ftp, sftp and tardigrade).

    +

    Note that the units are Bytes/s, not Bits/s. Typically connections are measured in Bits/s - to convert divide by 8. For example, let's say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would use a --bwlimit 0.625M parameter for rclone.

    On Unix systems (Linux, macOS, …) the bandwidth limiter can be toggled by sending a SIGUSR2 signal to rclone. This allows to remove the limitations of a long running rclone transfer and to restore it back to the value specified with --bwlimit quickly when needed. Assuming there is only one rclone instance running, you can toggle the limiter like this:

    kill -SIGUSR2 $(pidof rclone)

    If you configure rclone with a remote control then you can use change the bwlimit dynamically:

    @@ -3096,14 +3173,15 @@ rclone sync -i /path/to/files remote:current-backup

    --check-first

    If this flag is set then in a sync, copy or move, rclone will do all the checks to see whether files need to be transferred before doing any of the transfers. Normally rclone would start running transfers as soon as possible.

    This flag can be useful on IO limited systems where transfers interfere with checking.

    +

    It can also be useful to ensure perfect ordering when using --order-by.

    Using this flag can use more memory as it effectively sets --max-backlog to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start.

    --checkers=N

    -

    The number of checkers to run in parallel. Checkers do the equality checking of files during a sync. For some storage systems (eg S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel.

    +

    The number of checkers to run in parallel. Checkers do the equality checking of files during a sync. For some storage systems (e.g. S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel.

    The default is to run 8 checkers in parallel.

    -c, --checksum

    Normally rclone will look at modification time and size of files to see if they are equal. If you set this flag then rclone will check the file hash and size to determine if files are equal.

    This is useful when the remote doesn't support setting modified time and a more accurate sync is desired than just checking the file size.

    -

    This is very useful when transferring between remotes which store the same hash type on the object, eg Drive and Swift. For details of which remotes support which hash type see the table in the overview section.

    +

    This is very useful when transferring between remotes which store the same hash type on the object, e.g. Drive and Swift. For details of which remotes support which hash type see the table in the overview section.

    Eg rclone --checksum sync s3:/bucket swift:/bucket would run much quicker than without the --checksum flag.

    When using this flag, rclone won't update mtimes of remote files if they are incorrect as it would normally.

    --compare-dest=DIR

    @@ -3115,24 +3193,24 @@ rclone sync -i /path/to/files remote:current-backup

    Normally the config file is in your home directory as a file called .config/rclone/rclone.conf (or .rclone.conf if created with an older version). If $XDG_CONFIG_HOME is set it will be at $XDG_CONFIG_HOME/rclone/rclone.conf.

    If there is a file rclone.conf in the same directory as the rclone executable it will be preferred. This file must be created manually for Rclone to use it, it will never be created automatically.

    If you run rclone config file you will see where the default location is for you.

    -

    Use this flag to override the config location, eg rclone --config=".myconfig" .config.

    +

    Use this flag to override the config location, e.g. rclone --config=".myconfig" .config.

    --contimeout=TIME

    Set the connection timeout. This should be in go time format which looks like 5s for 5 seconds, 10m for 10 minutes, or 3h30m.

    The connection timeout is the amount of time rclone will wait for a connection to go through to a remote object storage system. It is 1m by default.

    --copy-dest=DIR

    -

    When using sync, copy or move DIR is checked in addition to the destination for files. If a file identical to the source is found that file is server side copied from DIR to the destination. This is useful for incremental backup.

    -

    The remote in use must support server side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory.

    +

    When using sync, copy or move DIR is checked in addition to the destination for files. If a file identical to the source is found that file is server-side copied from DIR to the destination. This is useful for incremental backup.

    +

    The remote in use must support server-side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory.

    See --compare-dest and --backup-dir.

    --dedupe-mode MODE

    Mode to run dedupe command in. One of interactive, skip, first, newest, oldest, rename. The default is interactive. See the dedupe command for more information as to what these options mean.

    --disable FEATURE,FEATURE,...

    -

    This disables a comma separated list of optional features. For example to disable server side move and server side copy use:

    +

    This disables a comma separated list of optional features. For example to disable server-side move and server-side copy use:

    --disable move,copy

    The features can be put in any case.

    To see a list of which features can be disabled use:

    --disable help

    See the overview features and optional features to get an idea of which feature does what.

    -

    This flag can be useful for debugging and in exceptional circumstances (eg Google Drive limiting the total volume of Server Side Copies to 100GB/day).

    +

    This flag can be useful for debugging and in exceptional circumstances (e.g. Google Drive limiting the total volume of Server Side Copies to 100GB/day).

    -n, --dry-run

    Do a trial run with no permanent changes. Use this to see what rclone would do without actually doing it. Useful when setting up the sync command which deletes files in the destination.

    --expect-continue-timeout=TIME

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

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

    --log-file=FILE

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

    +

    If FILE exists then rclone will append to it.

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

    --log-format LIST

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

    @@ -3273,7 +3352,7 @@ y/n/s/!/q> n

    This flag is useful to minimise the transactions if you know that none of the files are on the destination.

    @@ -3292,7 +3371,7 @@ y/n/s/!/q> n

    Using this flag will disable that functionality, treating each unicode character as unique. For example, by default é and é will be normalized into the same character. With --no-unicode-normalization they will be treated as unique characters.

    --no-update-modtime

    When using this flag, rclone won't update modification times of remote files if they are incorrect as it would normally.

    -

    This can be used if the remote is being synced with another tool also (eg the Google Drive client).

    +

    This can be used if the remote is being synced with another tool also (e.g. the Google Drive client).

    --order-by string

    The --order-by flag controls the order in which files in the backlog are processed in rclone sync, rclone copy and rclone move.

    The order by string is constructed like this. The first part describes what aspect is being measured:

    @@ -3307,7 +3386,7 @@ y/n/s/!/q> n
  • descending or desc - order so that the largest (or newest) is processed first
  • mixed - order so that the smallest is processed first for some threads and the largest for others
    • -

    If the modifier is mixed then it can have an optional percentage (which defaults to 50), eg size,mixed,25 which means that 25% of the threads should be taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The mixed mode can be useful to minimise the transfer time when you are transferring a mixture of large and small files - the large files are guaranteed upload threads and bandwidth and the small files will be processed continuously.

    +

    If the modifier is mixed then it can have an optional percentage (which defaults to 50), e.g. size,mixed,25 which means that 25% of the threads should be taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The mixed mode can be useful to minimise the transfer time when you are transferring a mixture of large and small files - the large files are guaranteed upload threads and bandwidth and the small files will be processed continuously.

    If no modifier is supplied then the order is ascending.

    For example

    Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of --order-by as being more of a best efforts flag rather than a perfect ordering.

    +

    If you want perfect ordering then you will need to specify --check-first which will find all the files which need transferring first before transferring any.

    --password-command SpaceSepList

    This flag supplies a program which should supply the config password when run. This is an alternative to rclone prompting for the password or setting the RCLONE_CONFIG_PASS variable.

    The argument to this should be a command with a space separated list of arguments. If one of the arguments has a space in then enclose it in ", if you want a literal " in an argument then enclose the argument in " and double the ". See CSV encoding for more info.

    @@ -3338,15 +3418,17 @@ y/n/s/!/q> n

    Normally this is updated every 500mS but this period can be overridden with the --stats flag.

    This can be used with the --stats-one-line flag for a simpler display.

    Note: On Windows until this bug is fixed all non-ASCII characters will be replaced with . when --progress is in use.

    +

    --progress-terminal-title

    +

    This flag, when used with -P/--progress, will print the string ETA: %s to the terminal title.

    -q, --quiet

    This flag will limit rclone's output to error messages only.

    --refresh-times

    The --refresh-times flag can be used to update modification times of existing files when they are out of sync on backends which don't support hashes.

    This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them.

    -

    This flag is only useful for destinations which don't support hashes (eg crypt).

    +

    This flag is only useful for destinations which don't support hashes (e.g. crypt).

    This can be used any of the sync commands sync, copy or move.

    To use this flag you will need to be doing a modification time sync (so not using --size-only or --checksum). The flag will have no effect when using --size-only or --checksum.

    -

    If this flag is used when rclone comes to upload a file it will check to see if there is an existing file on the destination. If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re-uploading it, rclone will update the timestamp on the destination file. If the checksum does not match rclone will upload the new file. If the checksum is absent (eg on a crypt backend) then rclone will update the timestamp.

    +

    If this flag is used when rclone comes to upload a file it will check to see if there is an existing file on the destination. If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re-uploading it, rclone will update the timestamp on the destination file. If the checksum does not match rclone will upload the new file. If the checksum is absent (e.g. on a crypt backend) then rclone will update the timestamp.

    Note that some remotes can't set the modification time without re-uploading the file so this flag is less useful on them.

    Normally if you are doing a modification time sync rclone will update modification times without --refresh-times provided that the remote supports checksums and the checksums match on the file. However if the checksums are absent then rclone will upload the file rather than setting the timestamp as this is the safe behaviour.

    --retries int

    @@ -3384,11 +3466,13 @@ y/n/s/!/q> n

    The default is bytes.

    --suffix=SUFFIX

    When using sync, copy or move any files which would have been overwritten or deleted will have the suffix added to them. If there is a file with the same path (after the suffix has been added), then it will be overwritten.

    -

    The remote in use must support server side move or copy and you must use the same remote as the destination of the sync.

    +

    The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync.

    This is for use with files to add the suffix in the current directory or with --backup-dir. See --backup-dir for more info.

    For example

    -
    rclone sync -i /path/to/local/file remote:current --suffix .bak
    -

    will sync /path/to/local to remote:current, but for any files which would have been updated or deleted have .bak added.

    +
    rclone copy -i /path/to/local/file remote:current --suffix .bak
    +

    will copy /path/to/local to remote:current, but for any files which would have been updated or deleted have .bak added.

    +

    If using rclone sync with --suffix and without --backup-dir then it is recommended to put a filter rule in excluding the suffix otherwise the sync will delete the backup files.

    +
    rclone sync -i /path/to/local/file remote:current --suffix .bak --exclude "*.bak"

    --suffix-keep-extension

    When using --suffix, setting this causes rclone put the SUFFIX before the extension of the files that it backs up rather than after.

    So let's say we had --suffix -2019-01-01, without the flag file.txt would be backed up to file.txt-2019-01-01 and with the flag it would be backed up to file-2019-01-01.txt. This can be helpful to make sure the suffixed files can still be opened.

    @@ -3396,12 +3480,14 @@ y/n/s/!/q> n

    On capable OSes (not Windows or Plan9) send all log output to syslog.

    This can be useful for running rclone in a script or rclone mount.

    --syslog-facility string

    -

    If using --syslog this sets the syslog facility (eg KERN, USER). See man syslog for a list of possible facilities. The default facility is DAEMON.

    +

    If using --syslog this sets the syslog facility (e.g. KERN, USER). See man syslog for a list of possible facilities. The default facility is DAEMON.

    --tpslimit float

    -

    Limit HTTP transactions per second to this. Default is 0 which is used to mean unlimited transactions per second.

    -

    For example to limit rclone to 10 HTTP transactions per second use --tpslimit 10, or to 1 transaction every 2 seconds use --tpslimit 0.5.

    -

    Use this when the number of transactions per second from rclone is causing a problem with the cloud storage provider (eg getting you banned or rate limited).

    +

    Limit transactions per second to this number. Default is 0 which is used to mean unlimited transactions per second.

    +

    A transaction is roughly defined as an API call; its exact meaning will depend on the backend. For HTTP based backends it is an HTTP PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip transaction over TCP.

    +

    For example to limit rclone to 10 transactions per second use --tpslimit 10, or to 1 transaction every 2 seconds use --tpslimit 0.5.

    +

    Use this when the number of transactions per second from rclone is causing a problem with the cloud storage provider (e.g. getting you banned or rate limited).

    This can be very useful for rclone mount to control the behaviour of applications using it.

    +

    This limit applies to all HTTP based backends and to the FTP and SFTP backends. It does not apply to the local backend or the Tardigrade backend.

    See also --tpslimit-burst.

    --tpslimit-burst int

    Max burst of transactions for --tpslimit (default 1).

    @@ -3410,7 +3496,7 @@ y/n/s/!/q> n

    This may be used to increase performance of --tpslimit without changing the long term average number of transactions per second.

    --track-renames

    By default, rclone doesn't keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy.

    -

    If you use this flag, and the remote supports server side copy or server side move, and the source and destination have a compatible hash, then this will track renames during sync operations and perform renaming server-side.

    +

    If you use this flag, and the remote supports server-side copy or server-side move, and the source and destination have a compatible hash, then this will track renames during sync operations and perform renaming server-side.

    Files will be matched by size and hash - if both match then a rename will be considered.

    If the destination does not support server-side copy or move, rclone will fall back to the default behaviour and log an error level message to the console.

    Encrypted destinations are not currently supported by --track-renames if --track-renames-strategy includes hash.

    @@ -3435,8 +3521,8 @@ y/n/s/!/q> n

    Specifying --delete-during will delete files while checking and uploading files. This is the fastest option and uses the least memory.

    Specifying --delete-after (the default value) will delay deletion of files until all new/updated files have been successfully transferred. The files to be deleted are collected in the copy pass then deleted after the copy pass has completed successfully. The files to be deleted are held in memory so this mode may use more memory. This is the safest mode as it will only delete files if there have been no errors subsequent to that. If there have been errors before the deletions start then you will get the message not deleting files as there were IO errors.

    --fast-list

    -

    When doing anything which involves a directory listing (eg sync, copy, ls - in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. This can be parallelised and works very quickly using the least amount of memory.

    -

    However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. These tend to be the bucket based remotes (eg S3, B2, GCS, Swift, Hubic).

    +

    When doing anything which involves a directory listing (e.g. sync, copy, ls - in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. This can be parallelised and works very quickly using the least amount of memory.

    +

    However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. These tend to be the bucket based remotes (e.g. S3, B2, GCS, Swift, Hubic).

    If you use the --fast-list flag then rclone will use this method for listing directories. This will have the following consequences for the listing:

    Returns

    For example

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

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

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

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

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

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

    -
    
-### core/version: Shows the current version of rclone and the go runtime. {#core-version}
-
-This shows the current version of go and the go runtime
-
-- version - rclone version, eg "v1.53.0"
-- decomposed - version number as [major, minor, patch]
-- isGit - boolean - true if this was compiled from the git version
-- isBeta - boolean - true if this is a beta version
-- os - OS in use as according to Go
-- arch - cpu architecture in use according to Go
-- goVersion - version of Go runtime in use
-
-### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate}
-
-SetBlockProfileRate controls the fraction of goroutine blocking events
-that are reported in the blocking profile. The profiler aims to sample
-an average of one blocking event per rate nanoseconds spent blocked.
-
-To include every blocking event in the profile, pass rate = 1. To turn
-off profiling entirely, pass rate <= 0.
-
-After calling this you can use this to see the blocking profile:
-
-    go tool pprof http://localhost:5572/debug/pprof/block
-
-Parameters
-
-- rate - int
-
-### debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug-set-mutex-profile-fraction}
-
-SetMutexProfileFraction controls the fraction of mutex contention
-events that are reported in the mutex profile. On average 1/rate
-events are reported. The previous rate is returned.
-
-To turn off profiling entirely, pass rate 0. To just read the current
-rate, pass rate < 0. (For n>1 the details of sampling may change.)
-
-Once this is set you can look use this to profile the mutex contention:
-
-    go tool pprof http://localhost:5572/debug/pprof/mutex
-
-Parameters
-
-- rate - int
-
-Results
-
-- previousRate - int
-
-### job/list: Lists the IDs of the running jobs {#job-list}
-
-Parameters - None
-
-Results
-
-- jobids - array of integer job ids
-
-### job/status: Reads the status of the job ID {#job-status}
-
-Parameters
-
-- jobid - id of the job (integer)
-
-Results
-
-- finished - boolean
-- duration - time in seconds that the job ran for
-- endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00")
-- error - error from the job or empty string for no error
-- finished - boolean whether the job has finished or not
-- id - as passed in above
-- startTime - time the job started (eg "2018-10-26T18:50:20.528336039+01:00")
-- success - boolean - true for success false otherwise
-- output - output of the job as would have been returned if called synchronously
-- progress - output of the progress related to the underlying job
-
-### job/stop: Stop the running job {#job-stop}
-
-Parameters
-
-- jobid - id of the job (integer)
-
-### mount/listmounts: Show current mount points {#mount-listmounts}
-
-This shows currently mounted points, which can be used for performing an unmount
-
-This takes no parameters and returns
-
-- mountPoints: list of current mount points
-
-Eg
-
-    rclone rc mount/listmounts
-
-**Authentication is required for this call.**
-
-### mount/mount: Create a new mount point {#mount-mount}
-
-rclone allows Linux, FreeBSD, macOS and Windows to mount any of
-Rclone's cloud storage systems as a file system with FUSE.
-
-If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2
-
-This takes the following parameters
-
-- fs - a remote path to be mounted (required)
-- mountPoint: valid path on the local machine (required)
-- mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use
-- mountOpt: a JSON object with Mount options in.
-- vfsOpt: a JSON object with VFS options in.
-
-Eg
-
-    rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
-    rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
-    rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
-
-The vfsOpt are as described in options/get and can be seen in the the
-"vfs" section when running and the mountOpt can be seen in the "mount" section.
-
-    rclone rc options/get
-
-**Authentication is required for this call.**
-
-### mount/types: Show all possible mount types {#mount-types}
-
-This shows all possible mount types and returns them as a list.
-
-This takes no parameters and returns
-
-- mountTypes: list of mount types
-
-The mount types are strings like "mount", "mount2", "cmount" and can
-be passed to mount/mount as the mountType parameter.
-
-Eg
-
-    rclone rc mount/types
-
-**Authentication is required for this call.**
-
-### mount/unmount: Unmount selected active mount {#mount-unmount}
-
-rclone allows Linux, FreeBSD, macOS and Windows to
-mount any of Rclone's cloud storage systems as a file system with
-FUSE.
-
-This takes the following parameters
-
-- mountPoint: valid path on the local machine where the mount was created (required)
-
-Eg
-
-    rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
-
-**Authentication is required for this call.**
-
-### mount/unmountall: Show current mount points {#mount-unmountall}
-
-This shows currently mounted points, which can be used for performing an unmount
-
-This takes no parameters and returns error if unmount does not succeed.
-
-Eg
-
-    rclone rc mount/unmountall
-
-**Authentication is required for this call.**
-
-### operations/about: Return the space used on the remote {#operations-about}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-The result is as returned from rclone about --json
-
-See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:" for the source
-- srcRemote - a path within that remote eg "file.txt" for the source
-- dstFs - a remote name string eg "drive2:" for the destination
-- dstRemote - a path within that remote eg "file2.txt" for the destination
-
-**Authentication is required for this call.**
-
-### operations/copyurl: Copy the URL to the object {#operations-copyurl}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- url - string, URL to read from
- - autoFilename - boolean, set to true to retrieve destination file name from url
-See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/delete: Remove files in the path {#operations-delete}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/deletefile: Remove the single file pointed to {#operations-deletefile}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/fsinfo: Return information about the remote {#operations-fsinfo}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-
-This returns info about the remote passed in;
+
    Authentication is required for this call.
    
+
    core/gc: Runs a garbage collection.
    
+
    This tells the go runtime to do a garbage collection run. It isn't necessary to call this normally, but it can be useful for debugging memory problems.
    
+
    core/group-list: Returns list of stats.
    
+
    This returns list of stats groups currently in memory.
    
+
    Returns the following values:
    
+
    {
+    "groups":  an array of group names:
+        [
+            "group1",
+            "group2",
+            ...
+        ]
+}
    
+
    core/memstats: Returns the memory statistics
    
+
    This returns the memory statistics of the running program. What the values mean are explained in the go docs: https://golang.org/pkg/runtime/#MemStats
    
+
    The most interesting values for most people are:
    
+
      
+
    • 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.
    
+
    Pass a clear string and rclone will obscure it for the config file: - clear - string
    
+
    Returns - obscured - string
    
+
    core/pid: Return PID of current process
    
+
    This returns PID of current process. Useful for stopping rclone process.
    
+
    core/quit: Terminates the app.
    
+
    (optional) Pass an exit code to be used for terminating the app: - exitCode - int
    
+
    core/stats: Returns stats about current transfers.
    
+
    This returns all available stats:
    
+
    rclone rc core/stats
    
+
    If group is not provided then summed up stats for all groups will be returned.
    
+
    Parameters
    
+
      
+
    • group - name of the stats group (string)
      • 
+
    
+
    Returns the following values:
    
+
    {
+    "speed": average speed in bytes/sec since start of the process,
+    "bytes": total transferred bytes since the start of the process,
+    "errors": number of errors,
+    "fatalError": whether there has been at least one FatalError,
+    "retryError": whether there has been at least one non-NoRetryError,
+    "checks": number of checked files,
+    "transfers": number of transferred files,
+    "deletes" : number of deleted files,
+    "renames" : number of renamed files,
+    "transferTime" : total time spent on running jobs,
+    "elapsedTime": time in seconds since the start of the process,
+    "lastError": last occurred error,
+    "transferring": an array of currently active file transfers:
+        [
+            {
+                "bytes": total transferred bytes for this file,
+                "eta": estimated time in seconds until file transfer completion
+                "name": name of the file,
+                "percentage": progress of the file transfer in percent,
+                "speed": average speed over the whole transfer in bytes/sec,
+                "speedAvg": current speed in bytes/sec as an exponentially weighted moving average,
+                "size": size of the file in bytes
+            }
+        ],
+    "checking": an array of names of currently active file checks
+        []
+}
    
+
    Values for "transferring", "checking" and "lastError" are only assigned if data is available. The value for "eta" is null if an eta cannot be determined.
    
+
    core/stats-delete: Delete stats group.
    
+
    This deletes entire stats group
    
+
    Parameters
    
+
      
+
    • group - name of the stats group (string)
      • 
+
    
+
    core/stats-reset: Reset stats.
    
+
    This clears counters, errors and finished transfers for all stats or specific stats group if group is provided.
    
+
    Parameters
    
+
      
+
    • group - name of the stats group (string)
      • 
+
    
+
    core/transferred: Returns stats about completed transfers.
    
+
    This returns stats about completed transfers:
    
+
    rclone rc core/transferred
    
+
    If group is not provided then completed transfers for all groups will be returned.
    
+
    Note only the last 100 completed transfers are returned.
    
+
    Parameters
    
+
      
+
    • group - name of the stats group (string)
      • 
+
    
+
    Returns the following values:
    
+
    {
+    "transferred":  an array of completed transfers (including failed ones):
+        [
+            {
+                "name": name of the file,
+                "size": size of the file in bytes,
+                "bytes": total transferred bytes for this file,
+                "checked": if the transfer is only checked (skipped, deleted),
+                "timestamp": integer representing millisecond unix epoch,
+                "error": string description of the error (empty if successful),
+                "jobid": id of the job that this transfer belongs to
+            }
+        ]
+}
    
+
    core/version: Shows the current version of rclone and the go runtime.
    
+
    This shows the current version of go and the go runtime
    
+
      
+
    • version - rclone version, e.g. "v1.53.0"
      • 
+
    • decomposed - version number as [major, minor, patch]
      • 
+
    • isGit - boolean - true if this was compiled from the git version
      • 
+
    • isBeta - boolean - true if this is a beta version
      • 
+
    • os - OS in use as according to Go
      • 
+
    • arch - cpu architecture in use according to Go
      • 
+
    • goVersion - version of Go runtime in use
      • 
+
    
+
    debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling.
    
+
    SetBlockProfileRate controls the fraction of goroutine blocking events that are reported in the blocking profile. The profiler aims to sample an average of one blocking event per rate nanoseconds spent blocked.
    
+
    To include every blocking event in the profile, pass rate = 1. To turn off profiling entirely, pass rate <= 0.
    
+
    After calling this you can use this to see the blocking profile:
    
+
    go tool pprof http://localhost:5572/debug/pprof/block
    
+
    Parameters
    
+
      
+
    • rate - int
      • 
+
    
+
    debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling.
    
+
    SetMutexProfileFraction controls the fraction of mutex contention events that are reported in the mutex profile. On average 1/rate events are reported. The previous rate is returned.
    
+
    To turn off profiling entirely, pass rate 0. To just read the current rate, pass rate < 0. (For n>1 the details of sampling may change.)
    
+
    Once this is set you can look use this to profile the mutex contention:
    
+
    go tool pprof http://localhost:5572/debug/pprof/mutex
    
+
    Parameters
    
+
      
+
    • rate - int
      • 
+
    
+
    Results
    
+
      
+
    • previousRate - int
      • 
+
    
+
    job/list: Lists the IDs of the running jobs
    
+
    Parameters - None
    
+
    Results
    
+
      
+
    • jobids - array of integer job ids
      • 
+
    
+
    job/status: Reads the status of the job ID
    
+
    Parameters
    
+
      
+
    • jobid - id of the job (integer)
      • 
+
    
+
    Results
    
+
      
+
    • finished - boolean
      • 
+
    • duration - time in seconds that the job ran for
      • 
+
    • endTime - time the job finished (e.g. "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 (e.g. "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
    
+
    Parameters
    
+
      
+
    • jobid - id of the job (integer)
      • 
+
    
+
    mount/listmounts: Show current mount points
    
+
    This shows currently mounted points, which can be used for performing an unmount
    
+
    This takes no parameters and returns
    
+
      
+
    • mountPoints: list of current mount points
      • 
+
    
+
    Eg
    
+
    rclone rc mount/listmounts
    
+
    Authentication is required for this call.
    
+
    mount/mount: Create a new mount point
    
+
    rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.
    
+
    If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote path to be mounted (required)
      • 
+
    • mountPoint: valid path on the local machine (required)
      • 
+
    • mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use
      • 
+
    • mountOpt: a JSON object with Mount options in.
      • 
+
    • vfsOpt: a JSON object with VFS options in.
      • 
+
    
+
    Eg
    
+
    rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint
+rclone rc mount/mount fs=mydrive: mountPoint=/home/<user>/mountPoint mountType=mount
+rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}'
    
+
    The vfsOpt are as described in options/get and can be seen in the the "vfs" section when running and the mountOpt can be seen in the "mount" section.
    
+
    rclone rc options/get
    
+
    Authentication is required for this call.
    
+
    mount/types: Show all possible mount types
    
+
    This shows all possible mount types and returns them as a list.
    
+
    This takes no parameters and returns
    
+
      
+
    • mountTypes: list of mount types
      • 
+
    
+
    The mount types are strings like "mount", "mount2", "cmount" and can be passed to mount/mount as the mountType parameter.
    
+
    Eg
    
+
    rclone rc mount/types
    
+
    Authentication is required for this call.
    
+
    mount/unmount: Unmount selected active mount
    
+
    rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.
    
+
    This takes the following parameters
    
+
      
+
    • mountPoint: valid path on the local machine where the mount was created (required)
      • 
+
    
+
    Eg
    
+
    rclone rc mount/unmount mountPoint=/home/<user>/mountPoint
    
+
    Authentication is required for this call.
    
+
    mount/unmountall: Show current mount points
    
+
    This shows currently mounted points, which can be used for performing an unmount
    
+
    This takes no parameters and returns error if unmount does not succeed.
    
+
    Eg
    
+
    rclone rc mount/unmountall
    
+
    Authentication is required for this call.
    
+
    operations/about: Return the space used on the remote
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    
+
    The result is as returned from rclone about --json
    
+
    See the about command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/cleanup: Remove trashed files in the remote or path
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    
+
    See the cleanup command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/copyfile: Copy a file from source remote to destination remote
    
+
    This takes the following parameters
    
+
      
+
    • srcFs - a remote name string e.g. "drive:" for the source
      • 
+
    • srcRemote - a path within that remote e.g. "file.txt" for the source
      • 
+
    • dstFs - a remote name string e.g. "drive2:" for the destination
      • 
+
    • dstRemote - a path within that remote e.g. "file2.txt" for the destination
      • 
+
    
+
    Authentication is required for this call.
    
+
    operations/copyurl: Copy the URL to the object
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    • url - string, URL to read from
      • 
+
    • autoFilename - boolean, set to true to retrieve destination file name from url See the copyurl command command for more information on the above.
      • 
+
    
+
    Authentication is required for this call.
    
+
    operations/delete: Remove files in the path
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    
+
    See the delete command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/deletefile: Remove the single file pointed to
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    
+
    See the deletefile command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/fsinfo: Return information about the remote
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    
+
    This returns info about the remote passed in;
    
+
    {
+    // optional features and whether they are available or not
+    "Features": {
+        "About": true,
+        "BucketBased": false,
+        "CanHaveEmptyDirectories": true,
+        "CaseInsensitive": false,
+        "ChangeNotify": false,
+        "CleanUp": false,
+        "Copy": false,
+        "DirCacheFlush": false,
+        "DirMove": true,
+        "DuplicateFiles": false,
+        "GetTier": false,
+        "ListR": false,
+        "MergeDirs": false,
+        "Move": true,
+        "OpenWriterAt": true,
+        "PublicLink": false,
+        "Purge": true,
+        "PutStream": true,
+        "PutUnchecked": false,
+        "ReadMimeType": false,
+        "ServerSideAcrossConfigs": false,
+        "SetTier": false,
+        "SetWrapper": false,
+        "UnWrap": false,
+        "WrapFs": false,
+        "WriteMimeType": false
+    },
+    // Names of hashes available
+    "Hashes": [
+        "MD5",
+        "SHA-1",
+        "DropboxHash",
+        "QuickXorHash"
+    ],
+    "Name": "local",    // Name as created
+    "Precision": 1,     // Precision of timestamps in ns
+    "Root": "/",        // Path as created
+    "String": "Local file system at /" // how the remote will appear in logs
+}
    
+
    This command does not have a command line equivalent so use this instead:
    
+
    rclone rc --loopback operations/fsinfo fs=remote:
    
+
    operations/list: List the given remote and path in JSON format
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "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 for more information on the above and examples.
    
+
    Authentication is required for this call.
    
+
    operations/mkdir: Make a destination directory or container
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    
+
    See the mkdir command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/movefile: Move a file from source remote to destination remote
    
+
    This takes the following parameters
    
+
      
+
    • srcFs - a remote name string e.g. "drive:" for the source
      • 
+
    • srcRemote - a path within that remote e.g. "file.txt" for the source
      • 
+
    • dstFs - a remote name string e.g. "drive2:" for the destination
      • 
+
    • dstRemote - a path within that remote e.g. "file2.txt" for the destination
      • 
+
    
+
    Authentication is required for this call.
    
+
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    • unlink - boolean - if set removes the link rather than adding it (optional)
      • 
+
    • expire - string - the expiry time of the link e.g. "1d" (optional)
      • 
+
    
+
    Returns
    
+
      
+
    • url - URL of the resource
      • 
+
    
+
    See the link command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/purge: Remove a directory or container and all of its contents
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    
+
    See the purge command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/rmdir: Remove an empty directory or container
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    
+
    See the rmdir command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/rmdirs: Remove all the empty directories in the path
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    • leaveRoot - boolean, set to true not to delete the root
      • 
+
    
+
    See the rmdirs command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/size: Count the number of bytes and files in remote
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:path/to/dir"
      • 
+
    
+
    Returns
    
+
      
+
    • count - number of files
      • 
+
    • bytes - number of bytes in those files
      • 
+
    
+
    See the size command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    operations/uploadfile: Upload file using multiform/form-data
    
+
    This takes the following parameters
    
+
      
+
    • fs - a remote name string e.g. "drive:"
      • 
+
    • remote - a path within that remote e.g. "dir"
      • 
+
    • each part in body represents a file to be uploaded See the uploadfile command command for more information on the above.
      • 
+
    
+
    Authentication is required for this call.
    
+
    options/blocks: List all the option blocks
    
+
    Returns - options - a list of the options block names
    
+
    options/get: Get all the options
    
+
    Returns an object where keys are option block names and values are an object with the current option values in.
    
+
    This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions.
    
+
    options/set: Set an option
    
+
    Parameters
    
+
      
+
    • option block name containing an object with
+
        
+
      • key: value
        • 
+
      • 
+
    
+
    Repeated as often as required.
    
+
    Only supply the options you wish to change. If an option is unknown it will be silently ignored. Not all options will have an effect when changed like this.
    
+
    For example:
    
+
    This sets DEBUG level logs (-vv)
    
+
    rclone rc options/set --json '{"main": {"LogLevel": 8}}'
    
+
    And this sets INFO level logs (-v)
    
+
    rclone rc options/set --json '{"main": {"LogLevel": 7}}'
    
+
    And this sets NOTICE level logs (normal without -v)
    
+
    rclone rc options/set --json '{"main": {"LogLevel": 6}}'
    
+
    pluginsctl/addPlugin: Add a plugin using url
    
+
    used for adding a plugin to the webgui
    
+
    This takes the following parameters
    
+
      
+
    • url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react)
      • 
+
    
+
    Eg
    
+
    rclone rc pluginsctl/addPlugin
    
+
    Authentication is required for this call.
    
+
    pluginsctl/getPluginsForType: Get plugins with type criteria
    
+
    This shows all possible plugins by a mime type
    
+
    This takes the following parameters
    
+
      
+
    • type: supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3)
      • 
+
    • pluginType: filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL)
      • 
+
    
+
    and returns
    
+
      
+
    • loadedPlugins: list of current production plugins
      • 
+
    • testPlugins: list of temporarily loaded development plugins, usually running on a different server.
      • 
+
    
+
    Eg
    
+
    rclone rc pluginsctl/getPluginsForType type=video/mp4
    
+
    Authentication is required for this call.
    
+
    pluginsctl/listPlugins: Get the list of currently loaded plugins
    
+
    This allows you to get the currently enabled plugins and their details.
    
+
    This takes no parameters and returns
    
+
      
+
    • loadedPlugins: list of current production plugins
      • 
+
    • testPlugins: list of temporarily loaded development plugins, usually running on a different server.
      • 
+
    
+
    Eg
    
+
    rclone rc pluginsctl/listPlugins
    
+
    Authentication is required for this call.
    
+
    pluginsctl/listTestPlugins: Show currently loaded test plugins
    
+
    allows listing of test plugins with the rclone.test set to true in package.json of the plugin
    
+
    This takes no parameters and returns
    
+
      
+
    • loadedTestPlugins: list of currently available test plugins
      • 
+
    
+
    Eg
    
+
    rclone rc pluginsctl/listTestPlugins
    
+
    Authentication is required for this call.
    
+
    pluginsctl/removePlugin: Remove a loaded plugin
    
+
    This allows you to remove a plugin using it's name
    
+
    This takes parameters
    
+
      
+
    • name: name of the plugin in the format author/plugin_name
      • 
+
    
+
    Eg
    
+
    rclone rc pluginsctl/removePlugin name=rclone/video-plugin
    
+
    Authentication is required for this call.
    
+
    pluginsctl/removeTestPlugin: Remove a test plugin
    
+
    This allows you to remove a plugin using it's name
    
+
    This takes the following parameters
    
+
      
+
    • name: name of the plugin in the format author/plugin_name
      • 
+
    
+
    Eg
    
+
    rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
    
+
    Authentication is required for this call.
    
+
    rc/error: This returns an error
    
+
    This returns an error with the input as part of its error string. Useful for testing error handling.
    
+
    rc/list: List all the registered remote control commands
    
+
    This lists all the registered remote control commands as a JSON map in the commands response.
    
+
    rc/noop: Echo the input to the output parameters
    
+
    This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly.
    
+
    rc/noopauth: Echo the input to the output parameters requiring auth
    
+
    This echoes the input parameters to the output parameters for testing purposes. It can be used to check that rclone is still alive and to check that parameter passing is working properly.
    
+
    Authentication is required for this call.
    
+
    sync/copy: copy a directory from source remote to destination remote
    
+
    This takes the following parameters
    
+
      
+
    • srcFs - a remote name string e.g. "drive:src" for the source
      • 
+
    • dstFs - a remote name string e.g. "drive:dst" for the destination
      • 
+
    
+
    See the copy command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    sync/move: move a directory from source remote to destination remote
    
+
    This takes the following parameters
    
+
      
+
    • srcFs - a remote name string e.g. "drive:src" for the source
      • 
+
    • dstFs - a remote name string e.g. "drive:dst" for the destination
      • 
+
    • deleteEmptySrcDirs - delete empty src directories if set
      • 
+
    
+
    See the move command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    sync/sync: sync a directory from source remote to destination remote
    
+
    This takes the following parameters
    
+
      
+
    • srcFs - a remote name string e.g. "drive:src" for the source
      • 
+
    • dstFs - a remote name string e.g. "drive:dst" for the destination
      • 
+
    
+
    See the sync command command for more information on the above.
    
+
    Authentication is required for this call.
    
+
    vfs/forget: Forget files or directories in the directory cache.
    
+
    This forgets the paths in the directory cache causing them to be re-read from the remote when needed.
    
+
    If no paths are passed in then it will forget all the paths in the directory cache.
    
+
    rclone rc vfs/forget
    
+
    Otherwise pass files or dirs in as file=path or dir=path. Any parameter key starting with file will forget that file and any starting with dir will forget that dir, e.g.
    
+
    rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
    
+
    This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.
    
+
    vfs/list: List active VFSes.
    
+
    This lists the active VFSes.
    
+
    It returns a list under the key "vfses" where the values are the VFS names that could be passed to the other VFS commands in the "fs" parameter.
    
+
    vfs/poll-interval: Get the status or update the value of the poll-interval option.
    
+
    Without any parameter given this returns the current status of the poll-interval setting.
    
+
    When the interval=duration parameter is set, the poll-interval value is updated and the polling function is notified. Setting interval=0 disables poll-interval.
    
+
    rclone rc vfs/poll-interval interval=5m
    
+
    The timeout=duration parameter can be used to specify a time to wait for the current poll function to apply the new value. If timeout is less or equal 0, which is the default, wait indefinitely.
    
+
    The new poll-interval value will only be active when the timeout is not reached.
    
+
    If poll-interval is updated or disabled temporarily, some changes might not get picked up by the polling function, depending on the used remote.
    
+
    This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.
    
+
    vfs/refresh: Refresh the directory cache.
    
+
    This reads the directories for the specified paths and freshens the directory cache.
    
+
    If no paths are passed in then it will refresh the root directory.
    
+
    rclone rc vfs/refresh
    
+
    Otherwise pass directories in as dir=path. Any parameter key starting with dir will refresh that directory, e.g.
    
+
    rclone rc vfs/refresh dir=home/junk dir2=data/misc
    
+
    If the parameter recursive=true is given the whole directory tree will get refreshed. This refresh will use --fast-list if enabled.
    
+
    This command takes an "fs" parameter. If this parameter is not supplied and if there is only one VFS in use then that VFS will be used. If there is more than one VFS in use then the "fs" parameter must be supplied.
    
+
    Accessing the remote control via HTTP
    
+
    Rclone implements a simple HTTP based protocol.
    
+
    Each endpoint takes an JSON object and returns a JSON object or an error. The JSON objects are essentially a map of string names to values.
    
+
    All calls must made using POST.
    
+
    The input objects can be supplied using URL parameters, POST parameters or by supplying "Content-Type: application/json" and a JSON blob in the body. There are examples of these below using curl.
    
+
    The response will be a JSON blob in the body of the response. This is formatted to be reasonably human readable.
    
+
    Error returns
    
+
    If an error occurs then there will be an HTTP error status (e.g. 500) and the body of the response will contain a JSON encoded error object, e.g.
    
+
    {
+    "error": "Expecting string value for key \"remote\" (was float64)",
+    "input": {
+        "fs": "/tmp",
+        "remote": 3
+    },
+    "status": 400
+    "path": "operations/rmdir",
+}
    
+
    The keys in the error response are - error - error string - input - the input parameters to the call - status - the HTTP status code - path - the path of the call
    
+
    CORS
    
+
    The sever implements basic CORS support and allows all origins for that. The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back.
    
+
    Using POST with URL parameters only
    
+
    curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'
    
+
    Response
    
+
    {
+    "potato": "1",
+    "sausage": "2"
+}
    
+
    Here is what an error response looks like:
    
+
    curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'
    
+
    {
+    "error": "arbitrary error on input map[potato:1 sausage:2]",
+    "input": {
+        "potato": "1",
+        "sausage": "2"
+    }
+}
    
+
    Note that curl doesn't return errors to the shell unless you use the -f option
    
+
    $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'
+curl: (22) The requested URL returned error: 400 Bad Request
+$ echo $?
+22
    
+
    Using POST with a form
    
+
    curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop
    
+
    Response
    
+
    {
+    "potato": "1",
+    "sausage": "2"
+}
    
+
    Note that you can combine these with URL parameters too with the POST parameters taking precedence.
    
+
    curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"
    
+
    Response
    
+
    {
+    "potato": "1",
+    "rutabaga": "3",
+    "sausage": "4"
+}
 
    
-
    { // optional features and whether they are available or not "Features": { "About": true, "BucketBased": false, "CanHaveEmptyDirectories": true, "CaseInsensitive": false, "ChangeNotify": false, "CleanUp": false, "Copy": false, "DirCacheFlush": false, "DirMove": true, "DuplicateFiles": false, "GetTier": false, "ListR": false, "MergeDirs": false, "Move": true, "OpenWriterAt": true, "PublicLink": false, "Purge": true, "PutStream": true, "PutUnchecked": false, "ReadMimeType": false, "ServerSideAcrossConfigs": false, "SetTier": false, "SetWrapper": false, "UnWrap": false, "WrapFs": false, "WriteMimeType": false }, // Names of hashes available "Hashes": [ "MD5", "SHA-1", "DropboxHash", "QuickXorHash" ], "Name": "local", // Name as created "Precision": 1, // Precision of timestamps in ns "Root": "/", // Path as created "String": "Local file system at /" // how the remote will appear in logs }
    
-
    
-This command does not have a command line equivalent so use this instead:
-
-    rclone rc --loopback operations/fsinfo fs=remote:
-
-### operations/list: List the given remote and path in JSON format {#operations-list}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- opt - a dictionary of options to control the listing (optional)
-    - recurse - If set recurse directories
-    - noModTime - If set return modification time
-    - showEncrypted -  If set show decrypted names
-    - showOrigIDs - If set show the IDs for each item if known
-    - showHash - If set return a dictionary of hashes
-
-The result is
-
-- list
-    - This is an array of objects as described in the lsjson command
-
-See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples.
-
-**Authentication is required for this call.**
-
-### operations/mkdir: Make a destination directory or container {#operations-mkdir}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/movefile: Move a file from source remote to destination remote {#operations-movefile}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:" for the source
-- srcRemote - a path within that remote eg "file.txt" for the source
-- dstFs - a remote name string eg "drive2:" for the destination
-- dstRemote - a path within that remote eg "file2.txt" for the destination
-
-**Authentication is required for this call.**
-
-### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- unlink - boolean - if set removes the link rather than adding it (optional)
-- expire - string - the expiry time of the link eg "1d" (optional)
-
-Returns
-
-- url - URL of the resource
-
-See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/purge: Remove a directory or container and all of its contents {#operations-purge}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/rmdir: Remove an empty directory or container {#operations-rmdir}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-
-See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- leaveRoot - boolean, set to true not to delete the root
-
-See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/size: Count the number of bytes and files in remote {#operations-size}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:path/to/dir"
-
-Returns
-
-- count - number of files
-- bytes - number of bytes in those files
-
-See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile}
-
-This takes the following parameters
-
-- fs - a remote name string eg "drive:"
-- remote - a path within that remote eg "dir"
-- each part in body represents a file to be uploaded
-See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### options/blocks: List all the option blocks {#options-blocks}
-
-Returns
-- options - a list of the options block names
-
-### options/get: Get all the options {#options-get}
-
-Returns an object where keys are option block names and values are an
-object with the current option values in.
-
-This shows the internal names of the option within rclone which should
-map to the external options very easily with a few exceptions.
-
-### options/set: Set an option {#options-set}
-
-Parameters
-
-- option block name containing an object with
-  - key: value
-
-Repeated as often as required.
-
-Only supply the options you wish to change.  If an option is unknown
-it will be silently ignored.  Not all options will have an effect when
-changed like this.
-
-For example:
-
-This sets DEBUG level logs (-vv)
-
-    rclone rc options/set --json '{"main": {"LogLevel": 8}}'
-
-And this sets INFO level logs (-v)
-
-    rclone rc options/set --json '{"main": {"LogLevel": 7}}'
-
-And this sets NOTICE level logs (normal without -v)
-
-    rclone rc options/set --json '{"main": {"LogLevel": 6}}'
-
-### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl-addPlugin}
-
-used for adding a plugin to the webgui
-
-This takes the following parameters
-
-- url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react)
-
-Eg
-
-   rclone rc pluginsctl/addPlugin
-
-**Authentication is required for this call.**
-
-### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType}
-
-This shows all possible plugins by a mime type
-
-This takes the following parameters
-
-- type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3)
-- pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) 
-
-and returns
-
-- loadedPlugins: list of current production plugins
-- testPlugins: list of temporarily loaded development plugins, usually running on a different server.
-
-Eg
-
-   rclone rc pluginsctl/getPluginsForType type=video/mp4
-
-**Authentication is required for this call.**
-
-### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins}
-
-This allows you to get the currently enabled plugins and their details.
-
-This takes no parameters and returns
-
-- loadedPlugins: list of current production plugins
-- testPlugins: list of temporarily loaded development plugins, usually running on a different server.
-
-Eg
-
-   rclone rc pluginsctl/listPlugins
-
-**Authentication is required for this call.**
-
-### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins}
-
-allows listing of test plugins with the rclone.test set to true in package.json of the plugin
-
-This takes no parameters and returns
-
-- loadedTestPlugins: list of currently available test plugins
-
-Eg
-
-    rclone rc pluginsctl/listTestPlugins
-
-**Authentication is required for this call.**
-
-### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin}
-
-This allows you to remove a plugin using it's name
-
-This takes parameters
-
-- name: name of the plugin in the format <author>/<plugin_name>
-
-Eg
-
-   rclone rc pluginsctl/removePlugin name=rclone/video-plugin
-
-**Authentication is required for this call.**
-
-### pluginsctl/removeTestPlugin: Remove  a test plugin {#pluginsctl-removeTestPlugin}
-
-This allows you to remove a plugin using it's name
-
-This takes the following parameters
-
-- name: name of the plugin in the format <author>/<plugin_name>
-
-Eg
-
-    rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react
-
-**Authentication is required for this call.**
-
-### rc/error: This returns an error {#rc-error}
-
-This returns an error with the input as part of its error string.
-Useful for testing error handling.
-
-### rc/list: List all the registered remote control commands {#rc-list}
-
-This lists all the registered remote control commands as a JSON map in
-the commands response.
-
-### rc/noop: Echo the input to the output parameters {#rc-noop}
-
-This echoes the input parameters to the output parameters for testing
-purposes.  It can be used to check that rclone is still alive and to
-check that parameter passing is working properly.
-
-### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth}
-
-This echoes the input parameters to the output parameters for testing
-purposes.  It can be used to check that rclone is still alive and to
-check that parameter passing is working properly.
-
-**Authentication is required for this call.**
-
-### sync/copy: copy a directory from source remote to destination remote {#sync-copy}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:src" for the source
-- dstFs - a remote name string eg "drive:dst" for the destination
-
-
-See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### sync/move: move a directory from source remote to destination remote {#sync-move}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:src" for the source
-- dstFs - a remote name string eg "drive:dst" for the destination
-- deleteEmptySrcDirs - delete empty src directories if set
-
-
-See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### sync/sync: sync a directory from source remote to destination remote {#sync-sync}
-
-This takes the following parameters
-
-- srcFs - a remote name string eg "drive:src" for the source
-- dstFs - a remote name string eg "drive:dst" for the destination
-
-
-See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above.
-
-**Authentication is required for this call.**
-
-### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget}
-
-This forgets the paths in the directory cache causing them to be
-re-read from the remote when needed.
-
-If no paths are passed in then it will forget all the paths in the
-directory cache.
-
-    rclone rc vfs/forget
-
-Otherwise pass files or dirs in as file=path or dir=path.  Any
-parameter key starting with file will forget that file and any
-starting with dir will forget that dir, eg
-
-    rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
- 
-This command takes an "fs" parameter. If this parameter is not
-supplied and if there is only one VFS in use then that VFS will be
-used. If there is more than one VFS in use then the "fs" parameter
-must be supplied.
-
-### vfs/list: List active VFSes. {#vfs-list}
-
-This lists the active VFSes.
-
-It returns a list under the key "vfses" where the values are the VFS
-names that could be passed to the other VFS commands in the "fs"
-parameter.
-
-### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval}
-
-Without any parameter given this returns the current status of the
-poll-interval setting.
-
-When the interval=duration parameter is set, the poll-interval value
-is updated and the polling function is notified.
-Setting interval=0 disables poll-interval.
-
-    rclone rc vfs/poll-interval interval=5m
-
-The timeout=duration parameter can be used to specify a time to wait
-for the current poll function to apply the new value.
-If timeout is less or equal 0, which is the default, wait indefinitely.
-
-The new poll-interval value will only be active when the timeout is
-not reached.
-
-If poll-interval is updated or disabled temporarily, some changes
-might not get picked up by the polling function, depending on the
-used remote.
- 
-This command takes an "fs" parameter. If this parameter is not
-supplied and if there is only one VFS in use then that VFS will be
-used. If there is more than one VFS in use then the "fs" parameter
-must be supplied.
-
-### vfs/refresh: Refresh the directory cache. {#vfs-refresh}
-
-This reads the directories for the specified paths and freshens the
-directory cache.
-
-If no paths are passed in then it will refresh the root directory.
-
-    rclone rc vfs/refresh
-
-Otherwise pass directories in as dir=path. Any parameter key
-starting with dir will refresh that directory, eg
-
-    rclone rc vfs/refresh dir=home/junk dir2=data/misc
-
-If the parameter recursive=true is given the whole directory tree
-will get refreshed. This refresh will use --fast-list if enabled.
- 
-This command takes an "fs" parameter. If this parameter is not
-supplied and if there is only one VFS in use then that VFS will be
-used. If there is more than one VFS in use then the "fs" parameter
-must be supplied.
-
-
-
-## Accessing the remote control via HTTP
-
-Rclone implements a simple HTTP based protocol.
-
-Each endpoint takes an JSON object and returns a JSON object or an
-error.  The JSON objects are essentially a map of string names to
-values.
-
-All calls must made using POST.
-
-The input objects can be supplied using URL parameters, POST
-parameters or by supplying "Content-Type: application/json" and a JSON
-blob in the body.  There are examples of these below using `curl`.
-
-The response will be a JSON blob in the body of the response.  This is
-formatted to be reasonably human readable.
-
-### Error returns
-
-If an error occurs then there will be an HTTP error status (eg 500)
-and the body of the response will contain a JSON encoded error object,
-eg
-
    
-
    { "error": "Expecting string value for key "remote" (was float64)", "input": { "fs": "/tmp", "remote": 3 }, "status": 400 "path": "operations/rmdir", }
    
-
    
-The keys in the error response are
-- error - error string
-- input - the input parameters to the call
-- status - the HTTP status code
-- path - the path of the call
-
-### CORS
-
-The sever implements basic CORS support and allows all origins for that.
-The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back.
-
-### Using POST with URL parameters only
-
    
-
    curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2'
    
-
    
-Response
-
    
-
    { "potato": "1", "sausage": "2" }
    
-
    
-Here is what an error response looks like:
-
    
-
    curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2'
    
-
    
-
    { "error": "arbitrary error on input map[potato:1 sausage:2]", "input": { "potato": "1", "sausage": "2" } }
    
-
    
-Note that curl doesn't return errors to the shell unless you use the `-f` option
-
    
-
    $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' curl: (22) The requested URL returned error: 400 Bad Request $ echo $? 22
    
-
    
-### Using POST with a form
-
    
-
    curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop
    
-
    
-Response
-
    
-
    { "potato": "1", "sausage": "2" }
    
-
    
-Note that you can combine these with URL parameters too with the POST
-parameters taking precedence.
-
    
-
    curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4"
    
-
    
-Response
-
    
-
    { "potato": "1", "rutabaga": "3", "sausage": "4" }
    
-
    
-### Using POST with a JSON blob
-
    
-
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop
    
-
    
-response
-
    
-
    { "password": "xyz", "username": "xyz" }
    
-
    
-This can be combined with URL parameters too if required.  The JSON
-blob takes precedence.
-
    
-
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4'
    
-
    
-
    { "potato": 2, "rutabaga": "3", "sausage": 1 }
    
-
    
-## Debugging rclone with pprof ##
-
-If you use the `--rc` flag this will also enable the use of the go
-profiling tools on the same port.
-
-To use these, first [install go](https://golang.org/doc/install).
-
-### Debugging memory use
-
-To profile rclone's memory use you can run:
-
-    go tool pprof -web http://localhost:5572/debug/pprof/heap
-
-This should open a page in your browser showing what is using what
-memory.
-
-You can also use the `-text` flag to produce a textual summary
-
    
-
    $ go tool pprof -text http://localhost:5572/debug/pprof/heap Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% 100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% net/http.(conn).readRequest 0 0% 100% 513kB 33.38% net/http.(conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main
    
-
    
-### Debugging go routine leaks
-
-Memory leaks are most often caused by go routine leaks keeping memory
-alive which should have been garbage collected.
-
-See all active go routines using
-
-    curl http://localhost:5572/debug/pprof/goroutine?debug=1
-
-Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.
-
-### Other profiles to look at
-
-You can see a summary of profiles available at http://localhost:5572/debug/pprof/
-
-Here is how to use some of them:
-
-- Memory: `go tool pprof http://localhost:5572/debug/pprof/heap`
-- Go routines: `curl http://localhost:5572/debug/pprof/goroutine?debug=1`
-- 30-second CPU profile: `go tool pprof http://localhost:5572/debug/pprof/profile`
-- 5-second execution trace: `wget http://localhost:5572/debug/pprof/trace?seconds=5`
-- Goroutine blocking profile
-    - Enable first with: `rclone rc debug/set-block-profile-rate rate=1` ([docs](#debug/set-block-profile-rate))
-    - `go tool pprof http://localhost:5572/debug/pprof/block`
-- Contended mutexes:
-    - Enable first with: `rclone rc debug/set-mutex-profile-fraction rate=1` ([docs](#debug/set-mutex-profile-fraction))
-    - `go tool pprof http://localhost:5572/debug/pprof/mutex`
-
-See the [net/http/pprof docs](https://golang.org/pkg/net/http/pprof/)
-for more info on how to use the profiling and for a general overview
-see [the Go team's blog post on profiling go programs](https://blog.golang.org/profiling-go-programs).
-
-The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234).
-
-# Overview of cloud storage systems #
-
-Each cloud storage system is slightly different.  Rclone attempts to
-provide a unified interface to them, but some underlying differences
-show through.
-
-## Features ##
-
-Here is an overview of the major features of each cloud storage system.
-
-| Name                         | Hash        | ModTime | Case Insensitive | Duplicate Files | MIME Type |
-| ---------------------------- |:-----------:|:-------:|:----------------:|:---------------:|:---------:|
-| 1Fichier                     | Whirlpool   | No      | No               | Yes             | R         |
-| Amazon Drive                 | MD5         | No      | Yes              | No              | R         |
-| Amazon S3                    | MD5         | Yes     | No               | No              | R/W       |
-| Backblaze B2                 | SHA1        | Yes     | No               | No              | R/W       |
-| Box                          | SHA1        | Yes     | Yes              | No              | -         |
-| Citrix ShareFile             | MD5         | Yes     | Yes              | No              | -         |
-| Dropbox                      | DBHASH †    | Yes     | Yes              | No              | -         |
-| FTP                          | -           | No      | No               | No              | -         |
-| Google Cloud Storage         | MD5         | Yes     | No               | No              | R/W       |
-| Google Drive                 | MD5         | Yes     | No               | Yes             | R/W       |
-| Google Photos                | -           | No      | No               | Yes             | R         |
-| HTTP                         | -           | No      | No               | No              | R         |
-| Hubic                        | MD5         | Yes     | No               | No              | R/W       |
-| Jottacloud                   | MD5         | Yes     | Yes              | No              | R/W       |
-| Koofr                        | MD5         | No      | Yes              | No              | -         |
-| Mail.ru Cloud                | Mailru ‡‡‡  | Yes     | Yes              | No              | -         |
-| Mega                         | -           | No      | No               | Yes             | -         |
-| Memory                       | MD5         | Yes     | No               | No              | -         |
-| Microsoft Azure Blob Storage | MD5         | Yes     | No               | No              | R/W       |
-| Microsoft OneDrive           | SHA1 ‡‡     | Yes     | Yes              | No              | R         |
-| OpenDrive                    | MD5         | Yes     | Yes              | Partial \*      | -         |
-| OpenStack Swift              | MD5         | Yes     | No               | No              | R/W       |
-| pCloud                       | MD5, SHA1   | Yes     | No               | No              | W         |
-| premiumize.me                | -           | No      | Yes              | No              | R         |
-| put.io                       | CRC-32      | Yes     | No               | Yes             | R         |
-| QingStor                     | MD5         | No      | No               | No              | R/W       |
-| Seafile                      | -           | No      | No               | No              | -         |
-| SFTP                         | MD5, SHA1 ‡ | Yes     | Depends          | No              | -         |
-| SugarSync                    | -           | No      | No               | No              | -         |
-| Tardigrade                   | -           | Yes     | No               | No              | -         |
-| WebDAV                       | MD5, SHA1 ††| Yes ††† | Depends          | No              | -         |
-| Yandex Disk                  | MD5         | Yes     | No               | No              | R/W       |
-| The local filesystem         | All         | Yes     | Depends          | No              | -         |
-
-### Hash ###
-
-The cloud storage system supports various hash types of the objects.
-The hashes are used when transferring data as an integrity check and
-can be specifically used with the `--checksum` flag in syncs and in
-the `check` command.
-
-To use the verify checksums when transferring between cloud storage
-systems they must support a common hash type.
-
-† Note that Dropbox supports [its own custom
-hash](https://www.dropbox.com/developers/reference/content-hash).
-This is an SHA256 sum of all the 4MB block SHA256s.
-
-‡ SFTP supports checksums if the same login has shell access and `md5sum`
-or `sha1sum` as well as `echo` are in the remote's PATH.
-
-†† WebDAV supports hashes when used with Owncloud and Nextcloud only.
-
-††† WebDAV supports modtimes when used with Owncloud and Nextcloud only.
-
-‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive
-for business and SharePoint server support Microsoft's own
-[QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash).
-
-‡‡‡ Mail.ru uses its own modified SHA1 hash
-
-### ModTime ###
-
-The cloud storage system supports setting modification times on
-objects.  If it does then this enables a using the modification times
-as part of the sync.  If not then only the size will be checked by
-default, though the MD5SUM can be checked with the `--checksum` flag.
-
-All cloud storage systems support some kind of date on the object and
-these will be set when transferring from the cloud storage system.
-
-### Case Insensitive ###
-
-If a cloud storage systems is case sensitive then it is possible to
-have two files which differ only in case, eg `file.txt` and
-`FILE.txt`.  If a cloud storage system is case insensitive then that
-isn't possible.
-
-This can cause problems when syncing between a case insensitive
-system and a case sensitive system.  The symptom of this is that no
-matter how many times you run the sync it never completes fully.
-
-The local filesystem and SFTP may or may not be case sensitive
-depending on OS.
-
-  * Windows - usually case insensitive, though case is preserved
-  * OSX - usually case insensitive, though it is possible to format case sensitive
-  * Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys)
-
-Most of the time this doesn't cause any problems as people tend to
-avoid files whose name differs only by case even on case sensitive
-systems.
-
-### Duplicate files ###
-
-If a cloud storage system allows duplicate files then it can have two
-objects with the same name.
-
-This confuses rclone greatly when syncing - use the `rclone dedupe`
-command to rename or remove duplicates.
-
-\* Opendrive does not support creation of duplicate files using
-their web client interface or other stock clients, but the underlying
-storage platform has been determined to allow duplicate files, and it
-is possible to create them with `rclone`.  It may be that this is a
-mistake or an unsupported feature.
-
-### Restricted filenames ###
-
-Some cloud storage systems might have restrictions on the characters
-that are usable in file or directory names.
-When `rclone` detects such a name during a file upload, it will
-transparently replace the restricted characters with similar looking
-Unicode characters.
-
-This process is designed to avoid ambiguous file names as much as
-possible and allow to move files between many cloud storage systems
-transparently.
-
-The name shown by `rclone` to the user or during log output will only
-contain a minimal set of [replaced characters](#restricted-characters)
-to ensure correct formatting and not necessarily the actual name used
-on the cloud storage.
-
-This transformation is reversed when downloading a file or parsing
-`rclone` arguments.
-For example, when uploading a file named `my file?.txt` to Onedrive
-will be displayed as `my file?.txt` on the console, but stored as
-`my file？.txt` (the `?` gets replaced by the similar looking `？`
-character) to Onedrive.
-The reverse transformation allows to read a file`unusual/name.txt`
-from Google Drive, by passing the name `unusual／name.txt` (the `/` needs
-to be replaced by the similar looking `／` character) on the command line.
-
-#### Default restricted characters {#restricted-characters}
-
-The table below shows the characters that are replaced by default.
-
-When a replacement character is found in a filename, this character
-will be escaped with the `‛` character to avoid ambiguous file names.
-(e.g. a file named `␀.txt` would shown as `‛␀.txt`)
-
-Each cloud storage backend can use a different set of characters,
-which will be specified in the documentation for each backend.
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| SOH       | 0x01  | ␁           |
-| STX       | 0x02  | ␂           |
-| ETX       | 0x03  | ␃           |
-| EOT       | 0x04  | ␄           |
-| ENQ       | 0x05  | ␅           |
-| ACK       | 0x06  | ␆           |
-| BEL       | 0x07  | ␇           |
-| BS        | 0x08  | ␈           |
-| HT        | 0x09  | ␉           |
-| LF        | 0x0A  | ␊           |
-| VT        | 0x0B  | ␋           |
-| FF        | 0x0C  | ␌           |
-| CR        | 0x0D  | ␍           |
-| SO        | 0x0E  | ␎           |
-| SI        | 0x0F  | ␏           |
-| DLE       | 0x10  | ␐           |
-| DC1       | 0x11  | ␑           |
-| DC2       | 0x12  | ␒           |
-| DC3       | 0x13  | ␓           |
-| DC4       | 0x14  | ␔           |
-| NAK       | 0x15  | ␕           |
-| SYN       | 0x16  | ␖           |
-| ETB       | 0x17  | ␗           |
-| CAN       | 0x18  | ␘           |
-| EM        | 0x19  | ␙           |
-| SUB       | 0x1A  | ␚           |
-| ESC       | 0x1B  | ␛           |
-| FS        | 0x1C  | ␜           |
-| GS        | 0x1D  | ␝           |
-| RS        | 0x1E  | ␞           |
-| US        | 0x1F  | ␟           |
-| /         | 0x2F  | ／           |
-| DEL       | 0x7F  | ␡           |
-
-The default encoding will also encode these file names as they are
-problematic with many cloud storage systems.
-
-| File name | Replacement |
-| --------- |:-----------:|
-| .         | ．          |
-| ..        | ．．         |
-
-#### Invalid UTF-8 bytes {#invalid-utf8}
-
-Some backends only support a sequence of well formed UTF-8 bytes
-as file or directory names.
-
-In this case all invalid UTF-8 bytes will be replaced with a quoted
-representation of the byte value to allow uploading a file to such a
-backend. For example, the invalid byte `0xFE` will be encoded as `‛FE`.
-
-A common source of invalid UTF-8 bytes are local filesystems, that store
-names in a different encoding than UTF-8 or UTF-16, like latin1. See the
-[local filenames](https://rclone.org/local/#filenames) section for details.
-
-#### Encoding option {#encoding}
-
-Most backends have an encoding options, specified as a flag
-`--backend-encoding` where `backend` is the name of the backend, or as
-a config parameter `encoding` (you'll need to select the Advanced
-config in `rclone config` to see it).
-
-This will have default value which encodes and decodes characters in
-such a way as to preserve the maximum number of characters (see
-above).
-
-However this can be incorrect in some scenarios, for example if you
-have a Windows file system with characters such as `＊` and `？` that
-you want to remain as those characters on the remote rather than being
-translated to `*` and `?`.
-
-The `--backend-encoding` flags allow you to change that. You can
-disable the encoding completely with `--backend-encoding None` or set
-`encoding = None` in the config file.
-
-Encoding takes a comma separated list of encodings. You can see the
-list of all available characters by passing an invalid value to this
-flag, eg `--local-encoding "help"` and `rclone help flags encoding`
-will show you the defaults for the backends.
-
-| Encoding  | Characters |
-| --------- | ---------- |
-| Asterisk | `*` |
-| BackQuote | `` ` `` |
-| BackSlash | `\` |
-| Colon | `:` |
-| CrLf | CR 0x0D, LF 0x0A |
-| Ctl | All control characters 0x00-0x1F |
-| Del | DEL 0x7F |
-| Dollar | `$` |
-| Dot | `.` |
-| DoubleQuote | `"` |
-| Hash | `#` |
-| InvalidUtf8 | An invalid UTF-8 character (eg latin1) |
-| LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string |
-| LeftPeriod | `.` on the left of a string |
-| LeftSpace | SPACE on the left of a string |
-| LeftTilde | `~` on the left of a string |
-| LtGt | `<`, `>` |
-| None | No characters are encoded |
-| Percent | `%` |
-| Pipe | \| |
-| Question | `?` |
-| RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string |
-| RightPeriod | `.` on the right of a string |
-| RightSpace | SPACE on the right of a string |
-| SingleQuote | `'` |
-| Slash | `/` |
-
-To take a specific example, the FTP backend's default encoding is
-
-    --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot"
-
-However, let's say the FTP server is running on Windows and can't have
-any of the invalid Windows characters in file names. You are backing
-up Linux servers to this FTP server which do have those characters in
-file names. So you would add the Windows set which are
-
-    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
-
-to the existing ones, giving:
-
-    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace
-
-This can be specified using the `--ftp-encoding` flag or using an `encoding` parameter in the config file.
-
-Or let's say you have a Windows server but you want to preserve `＊`
-and `？`, you would then have this as the encoding (the Windows
-encoding minus `Asterisk` and `Question`).
-
-    Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
-
-This can be specified using the `--local-encoding` flag or using an
-`encoding` parameter in the config file.
-
-### MIME Type ###
-
-MIME types (also known as media types) classify types of documents
-using a simple text classification, eg `text/html` or
-`application/pdf`.
-
-Some cloud storage systems support reading (`R`) the MIME type of
-objects and some support writing (`W`) the MIME type of objects.
-
-The MIME type can be important if you are serving files directly to
-HTTP from the storage system.
-
-If you are copying from a remote which supports reading (`R`) to a
-remote which supports writing (`W`) then rclone will preserve the MIME
-types.  Otherwise they will be guessed from the extension, or the
-remote itself may assign the MIME type.
-
-## Optional Features ##
-
-All the remotes support a basic set of features, but there are some
-optional features supported by some remotes used to make some
-operations more efficient.
-
-| Name                         | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir |
-| ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| :------: |
-| 1Fichier                     | No    | No   | No   | No      | No      | No    | No           | No           |   No  |  Yes |
-| Amazon Drive                 | Yes   | No   | Yes  | Yes     | No [#575](https://github.com/rclone/rclone/issues/575) | No  | No  | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | Yes |
-| Amazon S3                    | No    | Yes  | No   | No      | Yes     | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Backblaze B2                 | No    | Yes  | No   | No      | Yes     | Yes   | Yes          | Yes          | No  | No |
-| Box                          | Yes   | Yes  | Yes  | Yes     | Yes ‡‡  | No    | Yes          | Yes          | No  | Yes |
-| Citrix ShareFile             | Yes   | Yes  | Yes  | Yes     | No      | No    | Yes          | No          | No  | Yes |
-| Dropbox                      | Yes   | Yes  | Yes  | Yes     | No [#575](https://github.com/rclone/rclone/issues/575) | No  | Yes | Yes | Yes | Yes |
-| FTP                          | No    | No   | Yes  | Yes     | No      | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | Yes |
-| Google Cloud Storage         | Yes   | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Google Drive                 | Yes   | Yes  | Yes  | Yes     | Yes     | Yes   | Yes          | Yes         | Yes | Yes |
-| Google Photos                | No    | No   | No   | No      | No      | No    | No           | No          | No | No |
-| HTTP                         | No    | No   | No   | No      | No      | No    | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | Yes |
-| Hubic                        | Yes † | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No |
-| Jottacloud                   | Yes   | Yes  | Yes  | Yes     | Yes     | Yes   | No           | Yes                                                   | Yes | Yes |
-| Mail.ru Cloud                | Yes   | Yes  | Yes  | Yes     | Yes     | No    | No           | Yes                                                   | Yes | Yes |
-| Mega                         | Yes   | No   | Yes  | Yes     | Yes     | No    | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes |
-| Memory                       | No    | Yes  | No   | No      | No      | Yes   | Yes          | No          | No | No |
-| Microsoft Azure Blob Storage | Yes   | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Microsoft OneDrive           | Yes   | Yes  | Yes  | Yes     | Yes     | No    | No           | Yes | Yes | Yes |
-| OpenDrive                    | Yes   | Yes  | Yes  | Yes     | No      | No    | No           | No                                                    | No  | Yes |
-| OpenStack Swift              | Yes † | Yes  | No   | No      | No      | Yes   | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No |
-| pCloud                       | Yes   | Yes  | Yes  | Yes     | Yes     | No    | No           | Yes | Yes | Yes |
-| premiumize.me                | Yes   | No   | Yes  | Yes     | No      | No    | No           | Yes         | Yes | Yes |
-| put.io                       | Yes   | No   | Yes  | Yes     | Yes     | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes |
-| QingStor                     | No    | Yes  | No   | No      | Yes     | Yes   | No           | No [#2178](https://github.com/rclone/rclone/issues/2178) | No  | No |
-| Seafile                      | Yes   | Yes  | Yes  | Yes     | Yes     | Yes   | Yes          | Yes         | Yes | Yes |
-| SFTP                         | No    | No   | Yes  | Yes     | No      | No    | Yes          | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes  | Yes |
-| SugarSync                    | Yes   | Yes  | Yes  | Yes     | No      | No    | Yes          | Yes         | No  | Yes |
-| Tardigrade                   | Yes † | No   | No   | No      | No      | Yes   | Yes          | No          | No  | No  |
-| WebDAV                       | Yes   | Yes  | Yes  | Yes     | No      | No    | Yes ‡        | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes  | Yes |
-| Yandex Disk                  | Yes   | Yes  | Yes  | Yes     | Yes     | No    | Yes          | Yes         | Yes | Yes |
-| The local filesystem         | Yes   | No   | Yes  | Yes     | No      | No    | Yes          | No          | Yes | Yes |
-
-### Purge ###
-
-This deletes a directory quicker than just deleting all the files in
-the directory.
-
-† Note Swift, Hubic, and Tardigrade implement this in order to delete
-directory markers but they don't actually have a quicker way of deleting
-files other than deleting them individually.
-
-‡ StreamUpload is not supported with Nextcloud
-
-### Copy ###
-
-Used when copying an object to and from the same remote.  This known
-as a server side copy so you can copy a file without downloading it
-and uploading it again.  It is used if you use `rclone copy` or
-`rclone move` if the remote doesn't support `Move` directly.
-
-If the server doesn't support `Copy` directly then for copy operations
-the file is downloaded then re-uploaded.
-
-### Move ###
-
-Used when moving/renaming an object on the same remote.  This is known
-as a server side move of a file.  This is used in `rclone move` if the
-server doesn't support `DirMove`.
-
-If the server isn't capable of `Move` then rclone simulates it with
-`Copy` then delete.  If the server doesn't support `Copy` then rclone
-will download the file and re-upload it.
-
-### DirMove ###
-
-This is used to implement `rclone move` to move a directory if
-possible.  If it isn't then it will use `Move` on each file (which
-falls back to `Copy` then download and upload - see `Move` section).
-
-### CleanUp ###
-
-This is used for emptying the trash for a remote by `rclone cleanup`.
-
-If the server can't do `CleanUp` then `rclone cleanup` will return an
-error.
-
-‡‡ Note that while Box implements this it has to delete every file
-idividually so it will be slower than emptying the trash via the WebUI
-
-### ListR ###
-
-The remote supports a recursive list to list all the contents beneath
-a directory quickly.  This enables the `--fast-list` flag to work.
-See the [rclone docs](https://rclone.org/docs/#fast-list) for more details.
-
-### StreamUpload ###
-
-Some remotes allow files to be uploaded without knowing the file size
-in advance. This allows certain operations to work without spooling the
-file to local disk first, e.g. `rclone rcat`.
-
-### LinkSharing ###
-
-Sets the necessary permissions on a file or folder and prints a link
-that allows others to access them, even if they don't have an account
-on the particular cloud provider.
-
-### About ###
-
-This is used to fetch quota information from the remote, like bytes
-used/free/quota and bytes used in the trash.
-
-This is also used to return the space used, available for `rclone mount`.
-
-If the server can't do `About` then `rclone about` will return an
-error.
-
-### EmptyDir ###
-
-The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations)
- for details. Most Object/Bucket based remotes do not support this.
-
-# Global Flags
-
-This describes the global flags available to every rclone command
-split into two groups, non backend and backend flags.
-
-## Non Backend Flags
-
-These flags are available for every command.
-
    
-
      --ask-password                         Allow prompt for password for encrypted configuration. (default true)
-  --auto-confirm                         If enabled, do not request console confirmation.
-  --backup-dir string                    Make backups into hierarchy based in DIR.
-  --bind string                          Local address to bind to for outgoing connections, IPv4, IPv6 or name.
-  --buffer-size SizeSuffix               In memory buffer size when reading files for each --transfer. (default 16M)
-  --bwlimit BwTimetable                  Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
-  --bwlimit-file BwTimetable             Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable.
-  --ca-cert string                       CA certificate used to verify servers
-  --cache-dir string                     Directory rclone will use for caching. (default "$HOME/.cache/rclone")
-  --check-first                          Do all the checks before starting transfers.
-  --checkers int                         Number of checkers to run in parallel. (default 8)
    
-
    -c, --checksum Skip based on checksum (if available) & size, not mod-time & size --client-cert string Client SSL certificate (PEM) for mutual TLS auth --client-key string Client SSL private key (PEM) for mutual TLS auth --compare-dest string Include additional server-side path during comparison. --config string Config file. (default "$HOME/.config/rclone/rclone.conf") --contimeout duration Connect timeout (default 1m0s) --copy-dest string Implies --compare-dest but also copies files from path into destination. --cpuprofile string Write cpu profile to file --cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring --delete-during When synchronizing, delete files during transfer --delete-excluded Delete files on dest excluded from sync --disable string Disable a comma separated list of features. Use help to see a list. -n, --dry-run Do a trial run with no permanent changes --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles --dump-bodies Dump HTTP headers and bodies - may contain sensitive info --dump-headers Dump HTTP headers - may contain sensitive info --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read exclude patterns from file (use - to read from stdin) --exclude-if-present string Exclude directories if filename is present --expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s) --fast-list Use recursive list if available. Uses more memory but fewer transactions. --files-from stringArray Read list of source-file names from file (use - to read from stdin) --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) -f, --filter stringArray Add a file-filtering rule --filter-from stringArray Read filtering patterns from a file (use - to read from stdin) --header stringArray Set HTTP header for all transactions --header-download stringArray Set HTTP header for download transactions --header-upload stringArray Set HTTP header for upload transactions --ignore-case Ignore case in filters (case insensitive) --ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip post copy check of checksums. --ignore-errors delete even if there are I/O errors --ignore-existing Skip all files that exist on destination --ignore-size Ignore size when skipping use mod-time or checksum. -I, --ignore-times Don't skip files that match size and time - transfer all files --immutable Do not modify files. Fail if existing files have been modified. --include stringArray Include files matching pattern --include-from stringArray Read include patterns from file (use - to read from stdin) -i, --interactive Enable interactive mode --log-file string Log everything to this file --log-format string Comma separated list of log format options (default "date,time") --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") --low-level-retries int Number of low level retries to do. (default 10) --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) --max-delete int When synchronizing, limit the number of deletes (default -1) --max-depth int If set limits the recursion depth to this. (default -1) --max-duration duration Maximum duration rclone will transfer data for. --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) --max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) --max-transfer SizeSuffix Maximum size of data to transfer. (default off) --memprofile string Write memory profile to file --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) --min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) --modify-window duration Max time diff to be considered the same (default 1ns) --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) --no-check-certificate Do not verify the server SSL certificate. Insecure. --no-check-dest Don't check the destination, copy regardless. --no-gzip-encoding Don't set Accept-Encoding: gzip. --no-traverse Don't traverse destination file system on copy. --no-unicode-normalization Don't normalize unicode characters in filenames. --no-update-modtime Don't update destination mod-time if files identical. --order-by string Instructions on how to order the transfers, eg 'size,descending' --password-command SpaceSepList Command for supplying password for encrypted configuration. -P, --progress Show progress during transfer. -q, --quiet Print as little stuff as possible --rc Enable the remote control server. --rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572") --rc-allow-origin string Set the allowed origin for CORS. --rc-baseurl string Prefix for URLs - leave blank for root. --rc-cert string SSL PEM key (concatenation of certificate and CA certificate) --rc-client-ca string Client certificate authority to verify clients with --rc-enable-metrics Enable prometheus metrics on /metrics --rc-files string Path to local files to serve on the HTTP server. --rc-htpasswd string htpasswd file - if not provided no authentication is done --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) --rc-key string SSL PEM Private key --rc-max-header-bytes int Maximum size of request header (default 4096) --rc-no-auth Don't require auth for certain methods. --rc-pass string Password for authentication. --rc-realm string realm for authentication (default "rclone") --rc-serve Enable the serving of remote objects. --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) --rc-template string User Specified Template. --rc-user string User name for authentication. --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") --rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force update to latest version of web gui --rc-web-gui-no-open-browser Don't open the browser automatically --rc-web-gui-update Check and update to latest version of web gui --refresh-times Refresh the modtime of remote files. --retries int Retry operations this many times if they fail (default 3) --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) --size-only Skip based on size only, not mod-time or checksum --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") --stats-one-line Make the stats fit on one line. --stats-one-line-date Enables --stats-one-line and add current date/time prefix. --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) --suffix string Suffix to add to changed files. --suffix-keep-extension Preserve the extension when using --suffix. --syslog Use Syslog for logging --syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON") --timeout duration IO idle timeout (default 5m0s) --tpslimit float Limit HTTP transactions per second to this. --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) --track-renames When synchronizing, track file renames and do a server side move if possible --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") --transfers int Number of file transfers to run in parallel. (default 4) -u, --update Skip files that are newer on the destination. --use-cookies Enable session cookiejar. --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.0") -v, --verbose count Print lots more stuff (repeat for more)
    
-
    
-## Backend Flags
-
-These flags are available for every command. They control the backends
-and may be set in the config file.
-
    
-
      --acd-auth-url string                                      Auth server URL.
-  --acd-client-id string                                     OAuth Client Id
-  --acd-client-secret string                                 OAuth Client Secret
-  --acd-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
-  --acd-templink-threshold SizeSuffix                        Files >= this size will be downloaded via their tempLink. (default 9G)
-  --acd-token string                                         OAuth Access Token as a JSON blob.
-  --acd-token-url string                                     Token server url.
-  --acd-upload-wait-per-gb Duration                          Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
-  --alias-remote string                                      Remote or path to alias.
-  --azureblob-access-tier string                             Access tier of blob: hot, cool or archive.
-  --azureblob-account string                                 Storage Account Name (leave blank to use SAS URL or Emulator)
-  --azureblob-chunk-size SizeSuffix                          Upload chunk size (<= 100MB). (default 4M)
-  --azureblob-disable-checksum                               Don't store MD5 checksum with object metadata.
-  --azureblob-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
-  --azureblob-endpoint string                                Endpoint for the service
-  --azureblob-key string                                     Storage Account Key (leave blank to use SAS URL or Emulator)
-  --azureblob-list-chunk int                                 Size of blob list. (default 5000)
-  --azureblob-memory-pool-flush-time Duration                How often internal memory buffer pools will be flushed. (default 1m0s)
-  --azureblob-memory-pool-use-mmap                           Whether to use mmap buffers in internal memory pool.
-  --azureblob-sas-url string                                 SAS URL for container level access only
-  --azureblob-upload-cutoff SizeSuffix                       Cutoff for switching to chunked upload (<= 256MB). (default 256M)
-  --azureblob-use-emulator                                   Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)
-  --b2-account string                                        Account ID or Application Key ID
-  --b2-chunk-size SizeSuffix                                 Upload chunk size. Must fit in memory. (default 96M)
-  --b2-copy-cutoff SizeSuffix                                Cutoff for switching to multipart copy (default 4G)
-  --b2-disable-checksum                                      Disable checksums for large (> upload cutoff) files
-  --b2-download-auth-duration Duration                       Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w)
-  --b2-download-url string                                   Custom endpoint for downloads.
-  --b2-encoding MultiEncoder                                 This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
-  --b2-endpoint string                                       Endpoint for the service.
-  --b2-hard-delete                                           Permanently delete files on remote removal, otherwise hide files.
-  --b2-key string                                            Application Key
-  --b2-memory-pool-flush-time Duration                       How often internal memory buffer pools will be flushed. (default 1m0s)
-  --b2-memory-pool-use-mmap                                  Whether to use mmap buffers in internal memory pool.
-  --b2-test-mode string                                      A flag string for X-Bz-Test-Mode header for debugging.
-  --b2-upload-cutoff SizeSuffix                              Cutoff for switching to chunked upload. (default 200M)
-  --b2-versions                                              Include old versions in directory listings.
-  --box-access-token string                                  Box App Primary Access Token
-  --box-auth-url string                                      Auth server URL.
-  --box-box-config-file string                               Box App config.json location
-  --box-box-sub-type string                                   (default "user")
-  --box-client-id string                                     OAuth Client Id
-  --box-client-secret string                                 OAuth Client Secret
-  --box-commit-retries int                                   Max number of times to try committing a multipart file. (default 100)
-  --box-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
-  --box-root-folder-id string                                Fill in for rclone to use a non root folder as its starting point.
-  --box-token string                                         OAuth Access Token as a JSON blob.
-  --box-token-url string                                     Token server url.
-  --box-upload-cutoff SizeSuffix                             Cutoff for switching to multipart upload (>= 50MB). (default 50M)
-  --cache-chunk-clean-interval Duration                      How often should the cache perform cleanups of the chunk storage. (default 1m0s)
-  --cache-chunk-no-memory                                    Disable the in-memory cache for storing chunks during streaming.
-  --cache-chunk-path string                                  Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend")
-  --cache-chunk-size SizeSuffix                              The size of a chunk (partial file data). (default 5M)
-  --cache-chunk-total-size SizeSuffix                        The total size that the chunks can take up on the local disk. (default 10G)
-  --cache-db-path string                                     Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend")
-  --cache-db-purge                                           Clear all the cached data for this remote on start.
-  --cache-db-wait-time Duration                              How long to wait for the DB to be available - 0 is unlimited (default 1s)
-  --cache-info-age Duration                                  How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s)
-  --cache-plex-insecure string                               Skip all certificate verification when connecting to the Plex server
-  --cache-plex-password string                               The password of the Plex user (obscured)
-  --cache-plex-url string                                    The URL of the Plex server
-  --cache-plex-username string                               The username of the Plex user
-  --cache-read-retries int                                   How many times to retry a read from a cache storage. (default 10)
-  --cache-remote string                                      Remote to cache.
-  --cache-rps int                                            Limits the number of requests per second to the source FS (-1 to disable) (default -1)
-  --cache-tmp-upload-path string                             Directory to keep temporary files until they are uploaded.
-  --cache-tmp-wait-time Duration                             How long should files be stored in local cache before being uploaded (default 15s)
-  --cache-workers int                                        How many workers should run in parallel to download chunks. (default 4)
-  --cache-writes                                             Cache file data on writes through the FS
-  --chunker-chunk-size SizeSuffix                            Files larger than chunk size will be split in chunks. (default 2G)
-  --chunker-fail-hard                                        Choose how chunker should handle files with missing or invalid chunks.
-  --chunker-hash-type string                                 Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5")
-  --chunker-meta-format string                               Format of the metadata object or "none". By default "simplejson". (default "simplejson")
-  --chunker-name-format string                               String format of chunk file names. (default "*.rclone_chunk.###")
-  --chunker-remote string                                    Remote to chunk/unchunk.
-  --chunker-start-from int                                   Minimum valid chunk number. Usually 0 or 1. (default 1)
    
--L, --copy-links Follow symlinks and copy the pointed to item. --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) --crypt-filename-encryption string How to encrypt the filenames. (default "standard") --crypt-password string Password or pass phrase for encryption. (obscured) --crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) --crypt-remote string Remote to encrypt/decrypt. --crypt-server-side-across-configs Allow server side operations (eg copy) to work across different crypt configs. --crypt-show-mapping For all files listed show how the names encrypt. --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. --drive-auth-owner-only Only consider files owned by the authenticated user. --drive-auth-url string Auth server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) --drive-client-id string OAuth Client Id --drive-client-secret string OAuth Client Secret --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") --drive-formats string Deprecated: see export_formats --drive-impersonate string Impersonate this user when using a service account. --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. --drive-keep-revision-forever Keep new head revision of each file forever. --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) --drive-root-folder-id string ID of the root folder --drive-scope string Scope that rclone should use when requesting access from drive. --drive-server-side-across-configs Allow server side operations (eg copy) to work across different drive configs. --drive-service-account-credentials string Service Account Credentials JSON blob --drive-service-account-file string Service Account Credentials JSON file path --drive-shared-with-me Only show files that are shared with me. --drive-size-as-quota Show sizes as storage quota usage, not actual size. --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. --drive-skip-gdocs Skip google documents in all listings. --drive-skip-shortcuts If set skip shortcut files --drive-starred-only Only show files that are starred. --drive-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Team Drive --drive-token string OAuth Access Token as a JSON blob. --drive-token-url string Token server url. --drive-trashed-only Only show files that are in the trash. --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) --drive-use-created-date Use file created date instead of modified date., --drive-use-shared-date Use date file was shared instead of modified date. --drive-use-trash Send files to the trash instead of deleting permanently. (default true) --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) --dropbox-auth-url string Auth server URL. --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) --dropbox-client-id string OAuth Client Id --dropbox-client-secret string OAuth Client Secret --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-impersonate string Impersonate this user when using a business account. --dropbox-token string OAuth Access Token as a JSON blob. --dropbox-token-url string Token server url. --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) --fichier-shared-folder string If you want to download a shared folder, add this parameter --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited --ftp-disable-epsv Disable using EPSV even if server advertises support --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) --ftp-explicit-tls Use FTP over TLS (Explicit) --ftp-host string FTP host to connect to --ftp-no-check-certificate Do not verify the TLS certificate of the server --ftp-pass string FTP password (obscured) --ftp-port string FTP port, leave blank to use default (21) --ftp-tls Use FTPS over TLS (Implicit) --ftp-user string FTP username, leave blank for current username, $USER --gcs-anonymous Access public buckets and objects without credentials --gcs-auth-url string Auth server URL. --gcs-bucket-acl string Access Control List for new buckets. --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. --gcs-client-id string OAuth Client Id --gcs-client-secret string OAuth Client Secret --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) --gcs-location string Location for the newly created buckets. --gcs-object-acl string Access Control List for new objects. --gcs-project-number string Project number. --gcs-service-account-file string Service Account Credentials JSON file path --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. --gcs-token string OAuth Access Token as a JSON blob. --gcs-token-url string Token server url. --gphotos-auth-url string Auth server URL. --gphotos-client-id string OAuth Client Id --gphotos-client-secret string OAuth Client Secret --gphotos-read-only Set to make the Google Photos backend read only. --gphotos-read-size Set to read the size of media items. --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) --gphotos-token string OAuth Access Token as a JSON blob. --gphotos-token-url string Token server url. --http-headers CommaSepList Set HTTP headers for all transactions --http-no-head Don't use HEAD requests to find file sizes in dir listing --http-no-slash Set this if the site doesn't end directories with / --http-url string URL of http host to connect to --hubic-auth-url string Auth server URL. --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --hubic-client-id string OAuth Client Id --hubic-client-secret string OAuth Client Secret --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) --hubic-no-chunk Don't chunk files during streaming upload. --hubic-token string OAuth Access Token as a JSON blob. --hubic-token-url string Token server url. --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) --jottacloud-trashed-only Only show files that are in the trash. --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) --koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net") --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) --koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) --koofr-user string Your Koofr user name -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension --local-case-insensitive Force the filesystem to report itself as case insensitive --local-case-sensitive Force the filesystem to report itself as case sensitive. --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) --local-no-check-updated Don't check to see if the files change during upload --local-no-set-modtime Disable setting modtime --local-no-sparse Disable sparse files for multi-thread downloads --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) --local-nounc string Disable UNC (long path names) conversion on Windows --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) --mailru-pass string Password (obscured) --mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true) --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default ".mkv,.avi,.mp4,.mp3,.zip,.gz,.rar,.pdf") --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) --mailru-user string User name (usually email) --mega-debug Output more debug from Mega. --mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) --mega-hard-delete Delete files permanently rather than putting them into the trash. --mega-pass string Password. (obscured) --mega-user string User name -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). --onedrive-auth-url string Auth server URL. --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) --onedrive-client-id string OAuth Client Id --onedrive-client-secret string OAuth Client Secret --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. --onedrive-no-versions Remove all versions on modifying operations --onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs. --onedrive-token string OAuth Access Token as a JSON blob. --onedrive-token-url string Token server url. --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) --opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) --opendrive-password string Password. (obscured) --opendrive-username string Username --pcloud-auth-url string Auth server URL. --pcloud-client-id string OAuth Client Id --pcloud-client-secret string OAuth Client Secret --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --pcloud-hostname string Hostname to connect to. (default "api.pcloud.com") --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") --pcloud-token string OAuth Access Token as a JSON blob. --pcloud-token-url string Token server url. --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --qingstor-access-key-id string QingStor Access Key ID --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) --qingstor-connection-retries int Number of connection retries. (default 3) --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. --qingstor-secret-access-key string QingStor Secret Access Key (password) --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) --qingstor-zone string Zone to connect to. --s3-access-key-id string AWS Access Key ID. --s3-acl string Canned ACL used when creating buckets and storing or copying objects. --s3-bucket-acl string Canned ACL used when creating buckets. --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) --s3-disable-checksum Don't store MD5 checksum with object metadata --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) --s3-endpoint string Endpoint for S3 API. --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) --s3-location-constraint string Location constraint - must be set to match the Region. --s3-max-upload-parts int Maximum number of parts in a multipart upload. (default 10000) --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. --s3-no-check-bucket If set don't attempt to check the bucket exists or create it --s3-profile string Profile to use in the shared credentials file --s3-provider string Choose your S3 provider. --s3-region string Region to connect to. --s3-secret-access-key string AWS Secret Access Key (password) --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. --s3-session-token string An AWS session token --s3-shared-credentials-file string Path to the shared credentials file --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. --s3-storage-class string The storage class to use when storing new objects in S3. --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. --s3-v2-auth If true use v2 authentication. --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) --seafile-create-library Should rclone create a library if it doesn't exist --seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) --seafile-library string Name of the library. Leave blank to access all non-encrypted libraries. --seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) --seafile-pass string Password (obscured) --seafile-url string URL of seafile host to connect to --seafile-user string User name (usually email address) --sftp-ask-password Allow asking for SFTP password when needed. --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. --sftp-host string SSH host to connect to --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. --sftp-key-use-agent When set forces the usage of the ssh-agent. --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) --sftp-path-override string Override path used by SSH connection. --sftp-port string SSH port, leave blank to use default (22) --sftp-server-command string Specifies the path or command to run a sftp server on the remote host. --sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. --sftp-skip-links Set to skip any symlinks and any other non regular files. --sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp") --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. --sftp-user string SSH username, leave blank for current username, ncw --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) --sharefile-endpoint string Endpoint for API calls. --sharefile-root-folder-id string ID of the root folder --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) --skip-links Don't warn about skipped symlinks. --sugarsync-access-key-id string Sugarsync Access Key ID. --sugarsync-app-id string Sugarsync App ID. --sugarsync-authorization string Sugarsync authorization --sugarsync-authorization-expiry string Sugarsync authorization expiry --sugarsync-deleted-id string Sugarsync deleted folder id --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) --sugarsync-hard-delete Permanently delete files if true --sugarsync-private-access-key string Sugarsync Private Access Key --sugarsync-refresh-token string Sugarsync refresh token --sugarsync-root-id string Sugarsync root id --sugarsync-user string Sugarsync user --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) --swift-auth string Authentication URL for server (OS_AUTH_URL). --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. --swift-key string API key or password (OS_PASSWORD). --swift-no-chunk Don't chunk files during streaming upload. --swift-region string Region name - optional (OS_REGION_NAME) --swift-storage-policy string The storage policy to use when creating a new container --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) --swift-user string User name to log in (OS_USERNAME). --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). --tardigrade-access-grant string Access Grant. --tardigrade-api-key string API Key. --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. --tardigrade-provider string Choose an authentication method. (default "existing") --tardigrade-satellite-address @
-
    
-: Satellite Address. Custom satellite address should match the format: @
-
    
-
    :. (default "us-central-1.tardigrade.io") --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") --union-upstreams string List of space separated upstreams. --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) --webdav-bearer-token-command string Command to run to get a bearer token --webdav-pass string Password. (obscured) --webdav-url string URL of http host to connect to --webdav-user string User name --webdav-vendor string Name of the Webdav site/service/software you are using --yandex-auth-url string Auth server URL. --yandex-client-id string OAuth Client Id --yandex-client-secret string OAuth Client Secret --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-token string OAuth Access Token as a JSON blob. --yandex-token-url string Token server url.
    
-
    
- 1Fichier
------------------------------------------
-
-This is a backend for the [1fichier](https://1fichier.com) cloud
-storage service. Note that a Premium subscription is required to use
-the API.
-
-Paths are specified as `remote:path`
-
-Paths may be as deep as required, eg `remote:directory/subdirectory`.
-
-The initial setup for 1Fichier involves getting the API key from the website which you
-need to do in your browser.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / 1Fichier  "fichier" [snip] Storage> fichier ** See help for fichier backend at: https://rclone.org/fichier/ **
    
-
    Your API Key, get it from https://1fichier.com/console/params.pl Enter a string value. Press Enter for the default (""). api_key> example_key
    
-
    Edit advanced config? (y/n) y) Yes n) No y/n> Remote config -------------------- [remote] type = fichier api_key = example_key -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your 1Fichier account
-
-    rclone lsd remote:
-
-List all the files in your 1Fichier account
-
-    rclone ls remote:
-
-To copy a local directory to a 1Fichier directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Modified time and hashes ###
-
-1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
-
-### Duplicated files ###
-
-1Fichier can have two files with exactly the same name and path (unlike a
-normal file system).
-
-Duplicated files cause problems with the syncing and you will see
-messages in the log about duplicates.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \         | 0x5C  | ＼           |
-| <         | 0x3C  | ＜           |
-| >         | 0x3E  | ＞           |
-| "         | 0x22  | ＂           |
-| $         | 0x24  | ＄           |
-| `         | 0x60  | ｀           |
-| '         | 0x27  | ＇           |
-
-File names can also not start or end with the following characters.
-These only get replaced if they are the first or last character in the
-name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to fichier (1Fichier).
-
-#### --fichier-api-key
+
    Using POST with a JSON blob
    
+
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop
    
+
    response
    
+
    {
+    "password": "xyz",
+    "username": "xyz"
+}
    
+
    This can be combined with URL parameters too if required. The JSON blob takes precedence.
    
+
    curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4'
    
+
    {
+    "potato": 2,
+    "rutabaga": "3",
+    "sausage": 1
+}
    
+
    Debugging rclone with pprof
    
+
    If you use the --rc flag this will also enable the use of the go profiling tools on the same port.
    
+
    To use these, first install go.
    
+
    Debugging memory use
    
+
    To profile rclone's memory use you can run:
    
+
    go tool pprof -web http://localhost:5572/debug/pprof/heap
    
+
    This should open a page in your browser showing what is using what memory.
    
+
    You can also use the -text flag to produce a textual summary
    
+
    $ go tool pprof -text http://localhost:5572/debug/pprof/heap
+Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total
+      flat  flat%   sum%        cum   cum%
+ 1024.03kB 66.62% 66.62%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode
+     513kB 33.38%   100%      513kB 33.38%  net/http.newBufioWriterSize
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/all.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/cmd/serve/restic.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init
+         0     0%   100%  1024.03kB 66.62%  github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0
+         0     0%   100%  1024.03kB 66.62%  main.init
+         0     0%   100%      513kB 33.38%  net/http.(*conn).readRequest
+         0     0%   100%      513kB 33.38%  net/http.(*conn).serve
+         0     0%   100%  1024.03kB 66.62%  runtime.main
    
+
    Debugging go routine leaks
    
+
    Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected.
    
+
    See all active go routines using
    
+
    curl http://localhost:5572/debug/pprof/goroutine?debug=1
    
+
    Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser.
    
+
    Other profiles to look at
    
+
    You can see a summary of profiles available at http://localhost:5572/debug/pprof/
    
+
    Here is how to use some of them:
    
+
      
+
    • Memory: go tool pprof http://localhost:5572/debug/pprof/heap
      • 
+
    • Go routines: curl http://localhost:5572/debug/pprof/goroutine?debug=1
      • 
+
    • 30-second CPU profile: go tool pprof http://localhost:5572/debug/pprof/profile
      • 
+
    • 5-second execution trace: wget http://localhost:5572/debug/pprof/trace?seconds=5
      • 
+
    • Goroutine blocking profile
+
        
+
      • Enable first with: rclone rc debug/set-block-profile-rate rate=1 (docs)
        • 
+
      • go tool pprof http://localhost:5572/debug/pprof/block
        • 
+
      • 
+
    • Contended mutexes:
+
        
+
      • Enable first with: rclone rc debug/set-mutex-profile-fraction rate=1 (docs)
        • 
+
      • go tool pprof http://localhost:5572/debug/pprof/mutex
        • 
+
      • 
+
    
+
    See the net/http/pprof docs for more info on how to use the profiling and for a general overview see the Go team's blog post on profiling go programs.
    
+
    The profiling hook is zero overhead unless it is used.
    
+
    Overview of cloud storage systems
    
+
    Each cloud storage system is slightly different. Rclone attempts to provide a unified interface to them, but some underlying differences show through.
    
+
    Features
    
+
    Here is an overview of the major features of each cloud storage system.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    NameHashModTimeCase InsensitiveDuplicate FilesMIME Type
    1FichierWhirlpoolNoNoYesR
    Amazon DriveMD5NoYesNoR
    Amazon S3MD5YesNoNoR/W
    Backblaze B2SHA1YesNoNoR/W
    BoxSHA1YesYesNo-
    Citrix ShareFileMD5YesYesNo-
    DropboxDBHASH ¹YesYesNo-
    Enterprise File Fabric-YesYesNoR/W
    FTP-NoNoNo-
    Google Cloud StorageMD5YesNoNoR/W
    Google DriveMD5YesNoYesR/W
    Google Photos-NoNoYesR
    HDFS-YesNoNo-
    HTTP-NoNoNoR
    HubicMD5YesNoNoR/W
    JottacloudMD5YesYesNoR
    KoofrMD5NoYesNo-
    Mail.ru CloudMailru ⁶YesYesNo-
    Mega-NoNoYes-
    MemoryMD5YesNoNo-
    Microsoft Azure Blob StorageMD5YesNoNoR/W
    Microsoft OneDriveSHA1 ⁵YesYesNoR
    OpenDriveMD5YesYesPartial ⁸-
    OpenStack SwiftMD5YesNoNoR/W
    pCloudMD5, SHA1 ⁷YesNoNoW
    premiumize.me-NoYesNoR
    put.ioCRC-32YesNoYesR
    QingStorMD5NoNoNoR/W
    Seafile-NoNoNo-
    SFTPMD5, SHA1 ²YesDependsNo-
    SugarSync-NoNoNo-
    Tardigrade-YesNoNo-
    WebDAVMD5, SHA1 ³Yes ⁴DependsNo-
    Yandex DiskMD5YesNoNoR
    Zoho WorkDrive-NoNoNo-
    The local filesystemAllYesDependsNo-
    
+
    Notes
    
+
    ¹ Dropbox supports its own custom hash. This is an SHA256 sum of all the 4MB block SHA256s.
    
+
    ² SFTP supports checksums if the same login has shell access and md5sum or sha1sum as well as echo are in the remote's PATH.
    
+
    ³ WebDAV supports hashes when used with Owncloud and Nextcloud only.
    
+
    ⁴ WebDAV supports modtimes when used with Owncloud and Nextcloud only.
    
+
    ⁵ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for business and SharePoint server support Microsoft's own QuickXorHash.
    
+
    ⁶ Mail.ru uses its own modified SHA1 hash
    
+
    ⁷ pCloud only supports SHA1 (not MD5) in its EU region
    
+
    ⁸ Opendrive does not support creation of duplicate files using their web client interface or other stock clients, but the underlying storage platform has been determined to allow duplicate files, and it is possible to create them with rclone. It may be that this is a mistake or an unsupported feature.
    
+
    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.
    
+
    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, e.g. 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 (e.g. 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 to ensure correct formatting and not necessarily the actual name used on the cloud storage.
    
+
    This transformation is reversed when downloading a file or parsing rclone arguments. For example, when uploading a file named my file?.txt to Onedrive will be displayed as my file?.txt on the console, but stored as my file？.txt (the ? gets replaced by the similar looking ？ character) to Onedrive. The reverse transformation allows to read a fileunusual/name.txt from Google Drive, by passing the name unusual／name.txt (the / needs to be replaced by the similar looking ／ character) on the command line.
    
+
    Default restricted characters
    
+
    The table below shows the characters that are replaced by default.
    
+
    When a replacement character is found in a filename, this character will be escaped with the ‛ character to avoid ambiguous file names. (e.g. a file named ␀.txt would shown as ‛␀.txt)
    
+
    Each cloud storage backend can use a different set of characters, which will be specified in the documentation for each backend.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    SOH0x01␁
    STX0x02␂
    ETX0x03␃
    EOT0x04␄
    ENQ0x05␅
    ACK0x06␆
    BEL0x07␇
    BS0x08␈
    HT0x09␉
    LF0x0A␊
    VT0x0B␋
    FF0x0C␌
    CR0x0D␍
    SO0x0E␎
    SI0x0F␏
    DLE0x10␐
    DC10x11␑
    DC20x12␒
    DC30x13␓
    DC40x14␔
    NAK0x15␕
    SYN0x16␖
    ETB0x17␗
    CAN0x18␘
    EM0x19␙
    SUB0x1A␚
    ESC0x1B␛
    FS0x1C␜
    GS0x1D␝
    RS0x1E␞
    US0x1F␟
    /0x2F／
    DEL0x7F␡
    
+
    The default encoding will also encode these file names as they are problematic with many cloud storage systems.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    File nameReplacement
    .．
    ..．．
    
+
    Invalid UTF-8 bytes
    
+
    Some backends only support a sequence of well formed UTF-8 bytes as file or directory names.
    
+
    In this case all invalid UTF-8 bytes will be replaced with a quoted representation of the byte value to allow uploading a file to such a backend. For example, the invalid byte 0xFE will be encoded as ‛FE.
    
+
    A common source of invalid UTF-8 bytes are local filesystems, that store names in a different encoding than UTF-8 or UTF-16, like latin1. See the local filenames section for details.
    
+
    Encoding option
    
+
    Most backends have an encoding options, specified as a flag --backend-encoding where backend is the name of the backend, or as a config parameter encoding (you'll need to select the Advanced config in rclone config to see it).
    
+
    This will have default value which encodes and decodes characters in such a way as to preserve the maximum number of characters (see above).
    
+
    However this can be incorrect in some scenarios, for example if you have a Windows file system with characters such as ＊ and ？ that you want to remain as those characters on the remote rather than being translated to * and ?.
    
+
    The --backend-encoding flags allow you to change that. You can disable the encoding completely with --backend-encoding None or set encoding = None in the config file.
    
+
    Encoding takes a comma separated list of encodings. You can see the list of all available characters by passing an invalid value to this flag, e.g. --local-encoding "help" and rclone help flags encoding will show you the defaults for the backends.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    EncodingCharacters
    Asterisk*
    BackQuote`
    BackSlash\
    Colon:
    CrLfCR 0x0D, LF 0x0A
    CtlAll control characters 0x00-0x1F
    DelDEL 0x7F
    Dollar$
    Dot.
    DoubleQuote"
    Hash#
    InvalidUtf8An invalid UTF-8 character (e.g. latin1)
    LeftCrLfHtVtCR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string
    LeftPeriod. on the left of a string
    LeftSpaceSPACE on the left of a string
    LeftTilde~ on the left of a string
    LtGt<, >
    NoneNo characters are encoded
    Percent%
    Pipe|
    Question?
    RightCrLfHtVtCR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string
    RightPeriod. on the right of a string
    RightSpaceSPACE on the right of a string
    SingleQuote'
    Slash/
    
+
    To take a specific example, the FTP backend's default encoding is
    
+
    --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot"
    
+
    However, let's say the FTP server is running on Windows and can't have any of the invalid Windows characters in file names. You are backing up Linux servers to this FTP server which do have those characters in file names. So you would add the Windows set which are
    
+
    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
    
+
    to the existing ones, giving:
    
+
    Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace
    
+
    This can be specified using the --ftp-encoding flag or using an encoding parameter in the config file.
    
+
    Or let's say you have a Windows server but you want to preserve ＊ and ？, you would then have this as the encoding (the Windows encoding minus Asterisk and Question).
    
+
    Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot
    
+
    This can be specified using the --local-encoding flag or using an encoding parameter in the config file.
    
+
    MIME Type
    
+
    MIME types (also known as media types) classify types of documents using a simple text classification, e.g. 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 rclone remotes support a base command set. Other features depend upon backend specific capabilities.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    NamePurgeCopyMoveDirMoveCleanUpListRStreamUploadLinkSharingAboutEmptyDir
    1FichierNoNoNoNoNoNoNoNoNoYes
    Amazon DriveYesNoYesYesNo #575NoNoNo #2178NoYes
    Amazon S3NoYesNoNoYesYesYesNo #2178NoNo
    Backblaze B2NoYesNoNoYesYesYesYesNoNo
    BoxYesYesYesYesYes ‡‡NoYesYesNoYes
    Citrix ShareFileYesYesYesYesNoNoYesNoNoYes
    DropboxYesYesYesYesNo #575NoYesYesYesYes
    Enterprise File FabricYesYesYesYesNoNoNoNoNoYes
    FTPNoNoYesYesNoNoYesNo #2178NoYes
    Google Cloud StorageYesYesNoNoNoYesYesNo #2178NoNo
    Google DriveYesYesYesYesYesYesYesYesYesYes
    Google PhotosNoNoNoNoNoNoNoNoNoNo
    HDFSYesNoNoNoNoNoYesNoYesYes
    HTTPNoNoNoNoNoNoNoNo #2178NoYes
    HubicYes †YesNoNoNoYesYesNo #2178YesNo
    JottacloudYesYesYesYesYesYesNoYesYesYes
    Mail.ru CloudYesYesYesYesYesNoNoYesYesYes
    MegaYesNoYesYesYesNoNoNo #2178YesYes
    MemoryNoYesNoNoNoYesYesNoNoNo
    Microsoft Azure Blob StorageYesYesNoNoNoYesYesNo #2178NoNo
    Microsoft OneDriveYesYesYesYesYesNoNoYesYesYes
    OpenDriveYesYesYesYesNoNoNoNoNoYes
    OpenStack SwiftYes †YesNoNoNoYesYesNo #2178YesNo
    pCloudYesYesYesYesYesNoNoYesYesYes
    premiumize.meYesNoYesYesNoNoNoYesYesYes
    put.ioYesNoYesYesYesNoYesNo #2178YesYes
    QingStorNoYesNoNoYesYesNoNo #2178NoNo
    SeafileYesYesYesYesYesYesYesYesYesYes
    SFTPNoNoYesYesNoNoYesNo #2178YesYes
    SugarSyncYesYesYesYesNoNoYesYesNoYes
    TardigradeYes †NoNoNoNoYesYesNoNoNo
    WebDAVYesYesYesYesNoNoYes ‡No #2178YesYes
    Yandex DiskYesYesYesYesYesNoYesYesYesYes
    Zoho WorkDriveYesYesYesYesNoNoNoNoYesYes
    The local filesystemYesNoYesYesNoNoYesNoYesYes
    
+
    Purge
    
+
    This deletes a directory quicker than just deleting all the files in the directory.
    
+
    † Note Swift, Hubic, and Tardigrade implement this in order to delete directory markers but they don't actually have a quicker way of deleting files other than deleting them individually.
    
+
    ‡ StreamUpload is not supported with Nextcloud
    
+
    Copy
    
+
    Used when copying an object to and from the same remote. This known as a server-side copy so you can copy a file without downloading it and uploading it again. It is used if you use rclone copy or rclone move if the remote doesn't support Move directly.
    
+
    If the server doesn't support Copy directly then for copy operations the file is downloaded then re-uploaded.
    
+
    Move
    
+
    Used when moving/renaming an object on the same remote. This is known as a server-side move of a file. This is used in rclone move if the server doesn't support DirMove.
    
+
    If the server isn't capable of Move then rclone simulates it with Copy then delete. If the server doesn't support Copy then rclone will download the file and re-upload it.
    
+
    DirMove
    
+
    This is used to implement rclone move to move a directory if possible. If it isn't then it will use Move on each file (which falls back to Copy then download and upload - see Move section).
    
+
    CleanUp
    
+
    This is used for emptying the trash for a remote by rclone cleanup.
    
+
    If the server can't do CleanUp then rclone cleanup will return an error.
    
+
    ‡‡ Note that while Box implements this it has to delete every file individually so it will be slower than emptying the trash via the WebUI
    
+
    ListR
    
+
    The remote supports a recursive list to list all the contents beneath a directory quickly. This enables the --fast-list flag to work. See the rclone docs for more details.
    
+
    StreamUpload
    
+
    Some remotes allow files to be uploaded without knowing the file size in advance. This allows certain operations to work without spooling the file to local disk first, e.g. rclone rcat.
    
+
    LinkSharing
    
+
    Sets the necessary permissions on a file or folder and prints a link that allows others to access them, even if they don't have an account on the particular cloud provider.
    
+
    About
    
+
    Rclone about prints quota information for a remote. Typical output includes bytes used, free, quota and in trash.
    
+
    If a remote lacks about capability rclone about remote:returns an error.
    
+
    Backends without about capability cannot determine free space for an rclone mount, or use policy mfs (most free space) as a member of an rclone union remote.
    
+
    See rclone about command
    
+
    EmptyDir
    
+
    The remote supports empty directories. See Limitations for details. Most Object/Bucket based remotes do not support this.
    
+
    Global Flags
    
+
    This describes the global flags available to every rclone command split into two groups, non backend and backend flags.
    
+
    Non Backend Flags
    
+
    These flags are available for every command.
    
+
          --ask-password                         Allow prompt for password for encrypted configuration. (default true)
+      --auto-confirm                         If enabled, do not request console confirmation.
+      --backup-dir string                    Make backups into hierarchy based in DIR.
+      --bind string                          Local address to bind to for outgoing connections, IPv4, IPv6 or name.
+      --buffer-size SizeSuffix               In memory buffer size when reading files for each --transfer. (default 16M)
+      --bwlimit BwTimetable                  Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable.
+      --bwlimit-file BwTimetable             Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable.
+      --ca-cert string                       CA certificate used to verify servers
+      --cache-dir string                     Directory rclone will use for caching. (default "$HOME/.cache/rclone")
+      --check-first                          Do all the checks before starting transfers.
+      --checkers int                         Number of checkers to run in parallel. (default 8)
+  -c, --checksum                             Skip based on checksum (if available) & size, not mod-time & size
+      --client-cert string                   Client SSL certificate (PEM) for mutual TLS auth
+      --client-key string                    Client SSL private key (PEM) for mutual TLS auth
+      --compare-dest string                  Include additional server-side path during comparison.
+      --config string                        Config file. (default "$HOME/.config/rclone/rclone.conf")
+      --contimeout duration                  Connect timeout (default 1m0s)
+      --copy-dest string                     Implies --compare-dest but also copies files from path into destination.
+      --cpuprofile string                    Write cpu profile to file
+      --cutoff-mode string                   Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD")
+      --delete-after                         When synchronizing, delete files on destination after transferring (default)
+      --delete-before                        When synchronizing, delete files on destination before transferring
+      --delete-during                        When synchronizing, delete files during transfer
+      --delete-excluded                      Delete files on dest excluded from sync
+      --disable string                       Disable a comma separated list of features.  Use help to see a list.
+  -n, --dry-run                              Do a trial run with no permanent changes
+      --dump DumpFlags                       List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles
+      --dump-bodies                          Dump HTTP headers and bodies - may contain sensitive info
+      --dump-headers                         Dump HTTP headers - may contain sensitive info
+      --error-on-no-transfer                 Sets exit code 9 if no files are transferred, useful in scripts
+      --exclude stringArray                  Exclude files matching pattern
+      --exclude-from stringArray             Read exclude patterns from file (use - to read from stdin)
+      --exclude-if-present string            Exclude directories if filename is present
+      --expect-continue-timeout duration     Timeout when using expect / 100-continue in HTTP (default 1s)
+      --fast-list                            Use recursive list if available. Uses more memory but fewer transactions.
+      --files-from stringArray               Read list of source-file names from file (use - to read from stdin)
+      --files-from-raw stringArray           Read list of source-file names from file without any processing of lines (use - to read from stdin)
+  -f, --filter stringArray                   Add a file-filtering rule
+      --filter-from stringArray              Read filtering patterns from a file (use - to read from stdin)
+      --header stringArray                   Set HTTP header for all transactions
+      --header-download stringArray          Set HTTP header for download transactions
+      --header-upload stringArray            Set HTTP header for upload transactions
+      --ignore-case                          Ignore case in filters (case insensitive)
+      --ignore-case-sync                     Ignore case when synchronizing
+      --ignore-checksum                      Skip post copy check of checksums.
+      --ignore-errors                        delete even if there are I/O errors
+      --ignore-existing                      Skip all files that exist on destination
+      --ignore-size                          Ignore size when skipping use mod-time or checksum.
+  -I, --ignore-times                         Don't skip files that match size and time - transfer all files
+      --immutable                            Do not modify files. Fail if existing files have been modified.
+      --include stringArray                  Include files matching pattern
+      --include-from stringArray             Read include patterns from file (use - to read from stdin)
+  -i, --interactive                          Enable interactive mode
+      --log-file string                      Log everything to this file
+      --log-format string                    Comma separated list of log format options (default "date,time")
+      --log-level string                     Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE")
+      --log-systemd                          Activate systemd integration for the logger.
+      --low-level-retries int                Number of low level retries to do. (default 10)
+      --max-age Duration                     Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off)
+      --max-backlog int                      Maximum number of objects in sync or check backlog. (default 10000)
+      --max-delete int                       When synchronizing, limit the number of deletes (default -1)
+      --max-depth int                        If set limits the recursion depth to this. (default -1)
+      --max-duration duration                Maximum duration rclone will transfer data for.
+      --max-size SizeSuffix                  Only transfer files smaller than this in k or suffix b|k|M|G (default off)
+      --max-stats-groups int                 Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000)
+      --max-transfer SizeSuffix              Maximum size of data to transfer. (default off)
+      --memprofile string                    Write memory profile to file
+      --min-age Duration                     Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off)
+      --min-size SizeSuffix                  Only transfer files bigger than this in k or suffix b|k|M|G (default off)
+      --modify-window duration               Max time diff to be considered the same (default 1ns)
+      --multi-thread-cutoff SizeSuffix       Use multi-thread downloads for files above this size. (default 250M)
+      --multi-thread-streams int             Max number of streams to use for multi-thread downloads. (default 4)
+      --no-check-certificate                 Do not verify the server SSL certificate. Insecure.
+      --no-check-dest                        Don't check the destination, copy regardless.
+      --no-console                           Hide console window. Supported on Windows only.
+      --no-gzip-encoding                     Don't set Accept-Encoding: gzip.
+      --no-traverse                          Don't traverse destination file system on copy.
+      --no-unicode-normalization             Don't normalize unicode characters in filenames.
+      --no-update-modtime                    Don't update destination mod-time if files identical.
+      --order-by string                      Instructions on how to order the transfers, e.g. 'size,descending'
+      --password-command SpaceSepList        Command for supplying password for encrypted configuration.
+  -P, --progress                             Show progress during transfer.
+      --progress-terminal-title              Show progress on the terminal title. Requires -P/--progress.
+  -q, --quiet                                Print as little stuff as possible
+      --rc                                   Enable the remote control server.
+      --rc-addr string                       IPaddress:Port or :Port to bind server to. (default "localhost:5572")
+      --rc-allow-origin string               Set the allowed origin for CORS.
+      --rc-baseurl string                    Prefix for URLs - leave blank for root.
+      --rc-cert string                       SSL PEM key (concatenation of certificate and CA certificate)
+      --rc-client-ca string                  Client certificate authority to verify clients with
+      --rc-enable-metrics                    Enable prometheus metrics on /metrics
+      --rc-files string                      Path to local files to serve on the HTTP server.
+      --rc-htpasswd string                   htpasswd file - if not provided no authentication is done
+      --rc-job-expire-duration duration      expire finished async jobs older than this value (default 1m0s)
+      --rc-job-expire-interval duration      interval to check for expired async jobs (default 10s)
+      --rc-key string                        SSL PEM Private key
+      --rc-max-header-bytes int              Maximum size of request header (default 4096)
+      --rc-no-auth                           Don't require auth for certain methods.
+      --rc-pass string                       Password for authentication.
+      --rc-realm string                      realm for authentication (default "rclone")
+      --rc-serve                             Enable the serving of remote objects.
+      --rc-server-read-timeout duration      Timeout for server reading data (default 1h0m0s)
+      --rc-server-write-timeout duration     Timeout for server writing data (default 1h0m0s)
+      --rc-template string                   User Specified Template.
+      --rc-user string                       User name for authentication.
+      --rc-web-fetch-url string              URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
+      --rc-web-gui                           Launch WebGUI on localhost
+      --rc-web-gui-force-update              Force update to latest version of web gui
+      --rc-web-gui-no-open-browser           Don't open the browser automatically
+      --rc-web-gui-update                    Check and update to latest version of web gui
+      --refresh-times                        Refresh the modtime of remote files.
+      --retries int                          Retry operations this many times if they fail (default 3)
+      --retries-sleep duration               Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable)
+      --size-only                            Skip based on size only, not mod-time or checksum
+      --stats duration                       Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s)
+      --stats-file-name-length int           Max file name length in stats. 0 for no limit (default 45)
+      --stats-log-level string               Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO")
+      --stats-one-line                       Make the stats fit on one line.
+      --stats-one-line-date                  Enables --stats-one-line and add current date/time prefix.
+      --stats-one-line-date-format string    Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format
+      --stats-unit string                    Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes")
+      --streaming-upload-cutoff SizeSuffix   Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k)
+      --suffix string                        Suffix to add to changed files.
+      --suffix-keep-extension                Preserve the extension when using --suffix.
+      --syslog                               Use Syslog for logging
+      --syslog-facility string               Facility for syslog, e.g. KERN,USER,... (default "DAEMON")
+      --timeout duration                     IO idle timeout (default 5m0s)
+      --tpslimit float                       Limit HTTP transactions per second to this.
+      --tpslimit-burst int                   Max burst of transactions for --tpslimit. (default 1)
+      --track-renames                        When synchronizing, track file renames and do a server-side move if possible
+      --track-renames-strategy string        Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash")
+      --transfers int                        Number of file transfers to run in parallel. (default 4)
+  -u, --update                               Skip files that are newer on the destination.
+      --use-cookies                          Enable session cookiejar.
+      --use-json-log                         Use json log format.
+      --use-mmap                             Use mmap allocator (see docs).
+      --use-server-modtime                   Use server modified time instead of object metadata
+      --user-agent string                    Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.54.0")
+  -v, --verbose count                        Print lots more stuff (repeat for more)
    
+
    Backend Flags
    
+
    These flags are available for every command. They control the backends and may be set in the config file.
    
+
          --acd-auth-url string                                      Auth server URL.
+      --acd-client-id string                                     OAuth Client Id
+      --acd-client-secret string                                 OAuth Client Secret
+      --acd-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
+      --acd-templink-threshold SizeSuffix                        Files >= this size will be downloaded via their tempLink. (default 9G)
+      --acd-token string                                         OAuth Access Token as a JSON blob.
+      --acd-token-url string                                     Token server url.
+      --acd-upload-wait-per-gb Duration                          Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s)
+      --alias-remote string                                      Remote or path to alias.
+      --azureblob-access-tier string                             Access tier of blob: hot, cool or archive.
+      --azureblob-account string                                 Storage Account Name (leave blank to use SAS URL or Emulator)
+      --azureblob-archive-tier-delete                            Delete archive tier blobs before overwriting.
+      --azureblob-chunk-size SizeSuffix                          Upload chunk size (<= 100MB). (default 4M)
+      --azureblob-disable-checksum                               Don't store MD5 checksum with object metadata.
+      --azureblob-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8)
+      --azureblob-endpoint string                                Endpoint for the service
+      --azureblob-key string                                     Storage Account Key (leave blank to use SAS URL or Emulator)
+      --azureblob-list-chunk int                                 Size of blob list. (default 5000)
+      --azureblob-memory-pool-flush-time Duration                How often internal memory buffer pools will be flushed. (default 1m0s)
+      --azureblob-memory-pool-use-mmap                           Whether to use mmap buffers in internal memory pool.
+      --azureblob-msi-client-id string                           Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified.
+      --azureblob-msi-mi-res-id string                           Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified.
+      --azureblob-msi-object-id string                           Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified.
+      --azureblob-sas-url string                                 SAS URL for container level access only
+      --azureblob-service-principal-file string                  Path to file containing credentials for use with a service principal.
+      --azureblob-upload-cutoff string                           Cutoff for switching to chunked upload (<= 256MB). (Deprecated)
+      --azureblob-use-emulator                                   Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)
+      --azureblob-use-msi                                        Use a managed service identity to authenticate (only works in Azure)
+      --b2-account string                                        Account ID or Application Key ID
+      --b2-chunk-size SizeSuffix                                 Upload chunk size. Must fit in memory. (default 96M)
+      --b2-copy-cutoff SizeSuffix                                Cutoff for switching to multipart copy (default 4G)
+      --b2-disable-checksum                                      Disable checksums for large (> upload cutoff) files
+      --b2-download-auth-duration Duration                       Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w)
+      --b2-download-url string                                   Custom endpoint for downloads.
+      --b2-encoding MultiEncoder                                 This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --b2-endpoint string                                       Endpoint for the service.
+      --b2-hard-delete                                           Permanently delete files on remote removal, otherwise hide files.
+      --b2-key string                                            Application Key
+      --b2-memory-pool-flush-time Duration                       How often internal memory buffer pools will be flushed. (default 1m0s)
+      --b2-memory-pool-use-mmap                                  Whether to use mmap buffers in internal memory pool.
+      --b2-test-mode string                                      A flag string for X-Bz-Test-Mode header for debugging.
+      --b2-upload-cutoff SizeSuffix                              Cutoff for switching to chunked upload. (default 200M)
+      --b2-versions                                              Include old versions in directory listings.
+      --box-access-token string                                  Box App Primary Access Token
+      --box-auth-url string                                      Auth server URL.
+      --box-box-config-file string                               Box App config.json location
+      --box-box-sub-type string                                   (default "user")
+      --box-client-id string                                     OAuth Client Id
+      --box-client-secret string                                 OAuth Client Secret
+      --box-commit-retries int                                   Max number of times to try committing a multipart file. (default 100)
+      --box-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot)
+      --box-root-folder-id string                                Fill in for rclone to use a non root folder as its starting point.
+      --box-token string                                         OAuth Access Token as a JSON blob.
+      --box-token-url string                                     Token server url.
+      --box-upload-cutoff SizeSuffix                             Cutoff for switching to multipart upload (>= 50MB). (default 50M)
+      --cache-chunk-clean-interval Duration                      How often should the cache perform cleanups of the chunk storage. (default 1m0s)
+      --cache-chunk-no-memory                                    Disable the in-memory cache for storing chunks during streaming.
+      --cache-chunk-path string                                  Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend")
+      --cache-chunk-size SizeSuffix                              The size of a chunk (partial file data). (default 5M)
+      --cache-chunk-total-size SizeSuffix                        The total size that the chunks can take up on the local disk. (default 10G)
+      --cache-db-path string                                     Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend")
+      --cache-db-purge                                           Clear all the cached data for this remote on start.
+      --cache-db-wait-time Duration                              How long to wait for the DB to be available - 0 is unlimited (default 1s)
+      --cache-info-age Duration                                  How long to cache file structure information (directory listings, file size, times, etc.). (default 6h0m0s)
+      --cache-plex-insecure string                               Skip all certificate verification when connecting to the Plex server
+      --cache-plex-password string                               The password of the Plex user (obscured)
+      --cache-plex-url string                                    The URL of the Plex server
+      --cache-plex-username string                               The username of the Plex user
+      --cache-read-retries int                                   How many times to retry a read from a cache storage. (default 10)
+      --cache-remote string                                      Remote to cache.
+      --cache-rps int                                            Limits the number of requests per second to the source FS (-1 to disable) (default -1)
+      --cache-tmp-upload-path string                             Directory to keep temporary files until they are uploaded.
+      --cache-tmp-wait-time Duration                             How long should files be stored in local cache before being uploaded (default 15s)
+      --cache-workers int                                        How many workers should run in parallel to download chunks. (default 4)
+      --cache-writes                                             Cache file data on writes through the FS
+      --chunker-chunk-size SizeSuffix                            Files larger than chunk size will be split in chunks. (default 2G)
+      --chunker-fail-hard                                        Choose how chunker should handle files with missing or invalid chunks.
+      --chunker-hash-type string                                 Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5")
+      --chunker-remote string                                    Remote to chunk/unchunk.
+      --compress-level int                                       GZIP compression level (-2 to 9). (default -1)
+      --compress-mode string                                     Compression mode. (default "gzip")
+      --compress-ram-cache-limit SizeSuffix                      Some remotes don't allow the upload of files with unknown size. (default 20M)
+      --compress-remote string                                   Remote to compress.
+  -L, --copy-links                                               Follow symlinks and copy the pointed to item.
+      --crypt-directory-name-encryption                          Option to either encrypt directory names or leave them intact. (default true)
+      --crypt-filename-encryption string                         How to encrypt the filenames. (default "standard")
+      --crypt-password string                                    Password or pass phrase for encryption. (obscured)
+      --crypt-password2 string                                   Password or pass phrase for salt. Optional but recommended. (obscured)
+      --crypt-remote string                                      Remote to encrypt/decrypt.
+      --crypt-server-side-across-configs                         Allow server-side operations (e.g. copy) to work across different crypt configs.
+      --crypt-show-mapping                                       For all files listed show how the names encrypt.
+      --drive-acknowledge-abuse                                  Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
+      --drive-allow-import-name-change                           Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.
+      --drive-auth-owner-only                                    Only consider files owned by the authenticated user.
+      --drive-auth-url string                                    Auth server URL.
+      --drive-chunk-size SizeSuffix                              Upload chunk size. Must a power of 2 >= 256k. (default 8M)
+      --drive-client-id string                                   Google Application Client Id
+      --drive-client-secret string                               OAuth Client Secret
+      --drive-disable-http2                                      Disable drive using http2 (default true)
+      --drive-encoding MultiEncoder                              This sets the encoding for the backend. (default InvalidUtf8)
+      --drive-export-formats string                              Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg")
+      --drive-formats string                                     Deprecated: see export_formats
+      --drive-impersonate string                                 Impersonate this user when using a service account.
+      --drive-import-formats string                              Comma separated list of preferred formats for uploading Google docs.
+      --drive-keep-revision-forever                              Keep new head revision of each file forever.
+      --drive-list-chunk int                                     Size of listing chunk 100-1000. 0 to disable. (default 1000)
+      --drive-pacer-burst int                                    Number of API calls to allow without sleeping. (default 100)
+      --drive-pacer-min-sleep Duration                           Minimum time to sleep between API calls. (default 100ms)
+      --drive-root-folder-id string                              ID of the root folder
+      --drive-scope string                                       Scope that rclone should use when requesting access from drive.
+      --drive-server-side-across-configs                         Allow server-side operations (e.g. copy) to work across different drive configs.
+      --drive-service-account-credentials string                 Service Account Credentials JSON blob
+      --drive-service-account-file string                        Service Account Credentials JSON file path
+      --drive-shared-with-me                                     Only show files that are shared with me.
+      --drive-size-as-quota                                      Show sizes as storage quota usage, not actual size.
+      --drive-skip-checksum-gphotos                              Skip MD5 checksum on Google photos and videos only.
+      --drive-skip-gdocs                                         Skip google documents in all listings.
+      --drive-skip-shortcuts                                     If set skip shortcut files
+      --drive-starred-only                                       Only show files that are starred.
+      --drive-stop-on-download-limit                             Make download limit errors be fatal
+      --drive-stop-on-upload-limit                               Make upload limit errors be fatal
+      --drive-team-drive string                                  ID of the Team Drive
+      --drive-token string                                       OAuth Access Token as a JSON blob.
+      --drive-token-url string                                   Token server url.
+      --drive-trashed-only                                       Only show files that are in the trash.
+      --drive-upload-cutoff SizeSuffix                           Cutoff for switching to chunked upload (default 8M)
+      --drive-use-created-date                                   Use file created date instead of modified date.,
+      --drive-use-shared-date                                    Use date file was shared instead of modified date.
+      --drive-use-trash                                          Send files to the trash instead of deleting permanently. (default true)
+      --drive-v2-download-min-size SizeSuffix                    If Object's are greater, use drive v2 API to download. (default off)
+      --dropbox-auth-url string                                  Auth server URL.
+      --dropbox-chunk-size SizeSuffix                            Upload chunk size. (< 150M). (default 48M)
+      --dropbox-client-id string                                 OAuth Client Id
+      --dropbox-client-secret string                             OAuth Client Secret
+      --dropbox-encoding MultiEncoder                            This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot)
+      --dropbox-impersonate string                               Impersonate this user when using a business account.
+      --dropbox-shared-files                                     Instructs rclone to work on individual shared files.
+      --dropbox-shared-folders                                   Instructs rclone to work on shared folders.
+      --dropbox-token string                                     OAuth Access Token as a JSON blob.
+      --dropbox-token-url string                                 Token server url.
+      --fichier-api-key string                                   Your API Key, get it from https://1fichier.com/console/params.pl
+      --fichier-encoding MultiEncoder                            This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot)
+      --fichier-shared-folder string                             If you want to download a shared folder, add this parameter
+      --filefabric-encoding MultiEncoder                         This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot)
+      --filefabric-permanent-token string                        Permanent Authentication Token
+      --filefabric-root-folder-id string                         ID of the root folder
+      --filefabric-token string                                  Session Token
+      --filefabric-token-expiry string                           Token expiry time
+      --filefabric-url string                                    URL of the Enterprise File Fabric to connect to
+      --filefabric-version string                                Version read from the file fabric
+      --ftp-concurrency int                                      Maximum number of FTP simultaneous connections, 0 for unlimited
+      --ftp-disable-epsv                                         Disable using EPSV even if server advertises support
+      --ftp-disable-mlsd                                         Disable using MLSD even if server advertises support
+      --ftp-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot)
+      --ftp-explicit-tls                                         Use Explicit FTPS (FTP over TLS)
+      --ftp-host string                                          FTP host to connect to
+      --ftp-no-check-certificate                                 Do not verify the TLS certificate of the server
+      --ftp-pass string                                          FTP password (obscured)
+      --ftp-port string                                          FTP port, leave blank to use default (21)
+      --ftp-tls                                                  Use Implicit FTPS (FTP over TLS)
+      --ftp-user string                                          FTP username, leave blank for current username, $USER
+      --gcs-anonymous                                            Access public buckets and objects without credentials
+      --gcs-auth-url string                                      Auth server URL.
+      --gcs-bucket-acl string                                    Access Control List for new buckets.
+      --gcs-bucket-policy-only                                   Access checks should use bucket-level IAM policies.
+      --gcs-client-id string                                     OAuth Client Id
+      --gcs-client-secret string                                 OAuth Client Secret
+      --gcs-encoding MultiEncoder                                This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot)
+      --gcs-location string                                      Location for the newly created buckets.
+      --gcs-object-acl string                                    Access Control List for new objects.
+      --gcs-project-number string                                Project number.
+      --gcs-service-account-file string                          Service Account Credentials JSON file path
+      --gcs-storage-class string                                 The storage class to use when storing objects in Google Cloud Storage.
+      --gcs-token string                                         OAuth Access Token as a JSON blob.
+      --gcs-token-url string                                     Token server url.
+      --gphotos-auth-url string                                  Auth server URL.
+      --gphotos-client-id string                                 OAuth Client Id
+      --gphotos-client-secret string                             OAuth Client Secret
+      --gphotos-include-archived                                 Also view and download archived media.
+      --gphotos-read-only                                        Set to make the Google Photos backend read only.
+      --gphotos-read-size                                        Set to read the size of media items.
+      --gphotos-start-year int                                   Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000)
+      --gphotos-token string                                     OAuth Access Token as a JSON blob.
+      --gphotos-token-url string                                 Token server url.
+      --hdfs-data-transfer-protection string                     Kerberos data transfer protection: authentication|integrity|privacy
+      --hdfs-encoding MultiEncoder                               This sets the encoding for the backend. (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot)
+      --hdfs-namenode string                                     hadoop name node and port
+      --hdfs-service-principal-name string                       Kerberos service principal name for the namenode
+      --hdfs-username string                                     hadoop user name
+      --http-headers CommaSepList                                Set HTTP headers for all transactions
+      --http-no-head                                             Don't use HEAD requests to find file sizes in dir listing
+      --http-no-slash                                            Set this if the site doesn't end directories with /
+      --http-url string                                          URL of http host to connect to
+      --hubic-auth-url string                                    Auth server URL.
+      --hubic-chunk-size SizeSuffix                              Above this size files will be chunked into a _segments container. (default 5G)
+      --hubic-client-id string                                   OAuth Client Id
+      --hubic-client-secret string                               OAuth Client Secret
+      --hubic-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,InvalidUtf8)
+      --hubic-no-chunk                                           Don't chunk files during streaming upload.
+      --hubic-token string                                       OAuth Access Token as a JSON blob.
+      --hubic-token-url string                                   Token server url.
+      --jottacloud-encoding MultiEncoder                         This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot)
+      --jottacloud-hard-delete                                   Delete files permanently rather than putting them into the trash.
+      --jottacloud-md5-memory-limit SizeSuffix                   Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M)
+      --jottacloud-trashed-only                                  Only show files that are in the trash.
+      --jottacloud-upload-resume-limit SizeSuffix                Files bigger than this can be resumed if the upload fail's. (default 10M)
+      --koofr-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --koofr-endpoint string                                    The Koofr API endpoint to use (default "https://app.koofr.net")
+      --koofr-mountid string                                     Mount ID of the mount to use. If omitted, the primary mount is used.
+      --koofr-password string                                    Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured)
+      --koofr-setmtime                                           Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true)
+      --koofr-user string                                        Your Koofr user name
+  -l, --links                                                    Translate symlinks to/from regular files with a '.rclonelink' extension
+      --local-case-insensitive                                   Force the filesystem to report itself as case insensitive
+      --local-case-sensitive                                     Force the filesystem to report itself as case sensitive.
+      --local-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,Dot)
+      --local-no-check-updated                                   Don't check to see if the files change during upload
+      --local-no-set-modtime                                     Disable setting modtime
+      --local-no-sparse                                          Disable sparse files for multi-thread downloads
+      --local-no-unicode-normalization                           Don't apply unicode normalization to paths and filenames (Deprecated)
+      --local-nounc string                                       Disable UNC (long path names) conversion on Windows
+      --local-zero-size-links                                    Assume the Stat size of links is zero (and read them instead)
+      --mailru-check-hash                                        What should copy do if file checksum is mismatched or invalid (default true)
+      --mailru-encoding MultiEncoder                             This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --mailru-pass string                                       Password (obscured)
+      --mailru-speedup-enable                                    Skip full upload if there is another file with same data hash. (default true)
+      --mailru-speedup-file-patterns string                      Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf")
+      --mailru-speedup-max-disk SizeSuffix                       This option allows you to disable speedup (put by hash) for large files (default 3G)
+      --mailru-speedup-max-memory SizeSuffix                     Files larger than the size given below will always be hashed on disk. (default 32M)
+      --mailru-user string                                       User name (usually email)
+      --mega-debug                                               Output more debug from Mega.
+      --mega-encoding MultiEncoder                               This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
+      --mega-hard-delete                                         Delete files permanently rather than putting them into the trash.
+      --mega-pass string                                         Password. (obscured)
+      --mega-user string                                         User name
+  -x, --one-file-system                                          Don't cross filesystem boundaries (unix/macOS only).
+      --onedrive-auth-url string                                 Auth server URL.
+      --onedrive-chunk-size SizeSuffix                           Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M)
+      --onedrive-client-id string                                OAuth Client Id
+      --onedrive-client-secret string                            OAuth Client Secret
+      --onedrive-drive-id string                                 The ID of the drive to use
+      --onedrive-drive-type string                               The type of the drive ( personal | business | documentLibrary )
+      --onedrive-encoding MultiEncoder                           This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot)
+      --onedrive-expose-onenote-files                            Set to make OneNote files show up in directory listings.
+      --onedrive-link-password string                            Set the password for links created by the link command.
+      --onedrive-link-scope string                               Set the scope of the links created by the link command. (default "anonymous")
+      --onedrive-link-type string                                Set the type of the links created by the link command. (default "view")
+      --onedrive-no-versions                                     Remove all versions on modifying operations
+      --onedrive-region string                                   Choose national cloud region for OneDrive. (default "global")
+      --onedrive-server-side-across-configs                      Allow server-side operations (e.g. copy) to work across different onedrive configs.
+      --onedrive-token string                                    OAuth Access Token as a JSON blob.
+      --onedrive-token-url string                                Token server url.
+      --opendrive-chunk-size SizeSuffix                          Files will be uploaded in chunks this size. (default 10M)
+      --opendrive-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot)
+      --opendrive-password string                                Password. (obscured)
+      --opendrive-username string                                Username
+      --pcloud-auth-url string                                   Auth server URL.
+      --pcloud-client-id string                                  OAuth Client Id
+      --pcloud-client-secret string                              OAuth Client Secret
+      --pcloud-encoding MultiEncoder                             This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --pcloud-hostname string                                   Hostname to connect to. (default "api.pcloud.com")
+      --pcloud-root-folder-id string                             Fill in for rclone to use a non root folder as its starting point. (default "d0")
+      --pcloud-token string                                      OAuth Access Token as a JSON blob.
+      --pcloud-token-url string                                  Token server url.
+      --premiumizeme-encoding MultiEncoder                       This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --putio-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot)
+      --qingstor-access-key-id string                            QingStor Access Key ID
+      --qingstor-chunk-size SizeSuffix                           Chunk size to use for uploading. (default 4M)
+      --qingstor-connection-retries int                          Number of connection retries. (default 3)
+      --qingstor-encoding MultiEncoder                           This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8)
+      --qingstor-endpoint string                                 Enter an endpoint URL to connection QingStor API.
+      --qingstor-env-auth                                        Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank.
+      --qingstor-secret-access-key string                        QingStor Secret Access Key (password)
+      --qingstor-upload-concurrency int                          Concurrency for multipart uploads. (default 1)
+      --qingstor-upload-cutoff SizeSuffix                        Cutoff for switching to chunked upload (default 200M)
+      --qingstor-zone string                                     Zone to connect to.
+      --s3-access-key-id string                                  AWS Access Key ID.
+      --s3-acl string                                            Canned ACL used when creating buckets and storing or copying objects.
+      --s3-bucket-acl string                                     Canned ACL used when creating buckets.
+      --s3-chunk-size SizeSuffix                                 Chunk size to use for uploading. (default 5M)
+      --s3-copy-cutoff SizeSuffix                                Cutoff for switching to multipart copy (default 4.656G)
+      --s3-disable-checksum                                      Don't store MD5 checksum with object metadata
+      --s3-disable-http2                                         Disable usage of http2 for S3 backends
+      --s3-encoding MultiEncoder                                 This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot)
+      --s3-endpoint string                                       Endpoint for S3 API.
+      --s3-env-auth                                              Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+      --s3-force-path-style                                      If true use path style access if false use virtual hosted style. (default true)
+      --s3-leave-parts-on-error                                  If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
+      --s3-list-chunk int                                        Size of listing chunk (response list for each ListObject S3 request). (default 1000)
+      --s3-location-constraint string                            Location constraint - must be set to match the Region.
+      --s3-max-upload-parts int                                  Maximum number of parts in a multipart upload. (default 10000)
+      --s3-memory-pool-flush-time Duration                       How often internal memory buffer pools will be flushed. (default 1m0s)
+      --s3-memory-pool-use-mmap                                  Whether to use mmap buffers in internal memory pool.
+      --s3-no-check-bucket                                       If set, don't attempt to check the bucket exists or create it
+      --s3-no-head                                               If set, don't HEAD uploaded objects to check integrity
+      --s3-profile string                                        Profile to use in the shared credentials file
+      --s3-provider string                                       Choose your S3 provider.
+      --s3-region string                                         Region to connect to.
+      --s3-requester-pays                                        Enables requester pays option when interacting with S3 bucket.
+      --s3-secret-access-key string                              AWS Secret Access Key (password)
+      --s3-server-side-encryption string                         The server-side encryption algorithm used when storing this object in S3.
+      --s3-session-token string                                  An AWS session token
+      --s3-shared-credentials-file string                        Path to the shared credentials file
+      --s3-sse-customer-algorithm string                         If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
+      --s3-sse-customer-key string                               If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
+      --s3-sse-customer-key-md5 string                           If using SSE-C you may provide the secret encryption key MD5 checksum (optional).
+      --s3-sse-kms-key-id string                                 If using KMS ID you must provide the ARN of Key.
+      --s3-storage-class string                                  The storage class to use when storing new objects in S3.
+      --s3-upload-concurrency int                                Concurrency for multipart uploads. (default 4)
+      --s3-upload-cutoff SizeSuffix                              Cutoff for switching to chunked upload (default 200M)
+      --s3-use-accelerate-endpoint                               If true use the AWS S3 accelerated endpoint.
+      --s3-v2-auth                                               If true use v2 authentication.
+      --seafile-2fa                                              Two-factor authentication ('true' if the account has 2FA enabled)
+      --seafile-create-library                                   Should rclone create a library if it doesn't exist
+      --seafile-encoding MultiEncoder                            This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8)
+      --seafile-library string                                   Name of the library. Leave blank to access all non-encrypted libraries.
+      --seafile-library-key string                               Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured)
+      --seafile-pass string                                      Password (obscured)
+      --seafile-url string                                       URL of seafile host to connect to
+      --seafile-user string                                      User name (usually email address)
+      --sftp-ask-password                                        Allow asking for SFTP password when needed.
+      --sftp-disable-hashcheck                                   Disable the execution of SSH commands to determine if remote file hashing is available.
+      --sftp-host string                                         SSH host to connect to
+      --sftp-key-file string                                     Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.
+      --sftp-key-file-pass string                                The passphrase to decrypt the PEM-encoded private key file. (obscured)
+      --sftp-key-pem string                                      Raw PEM-encoded private key, If specified, will override key_file parameter.
+      --sftp-key-use-agent                                       When set forces the usage of the ssh-agent.
+      --sftp-known-hosts-file string                             Optional path to known_hosts file.
+      --sftp-md5sum-command string                               The command used to read md5 hashes. Leave blank for autodetect.
+      --sftp-pass string                                         SSH password, leave blank to use ssh-agent. (obscured)
+      --sftp-path-override string                                Override path used by SSH connection.
+      --sftp-port string                                         SSH port, leave blank to use default (22)
+      --sftp-pubkey-file string                                  Optional path to public key file.
+      --sftp-server-command string                               Specifies the path or command to run a sftp server on the remote host.
+      --sftp-set-modtime                                         Set the modified time on the remote if set. (default true)
+      --sftp-sha1sum-command string                              The command used to read sha1 hashes. Leave blank for autodetect.
+      --sftp-skip-links                                          Set to skip any symlinks and any other non regular files.
+      --sftp-subsystem string                                    Specifies the SSH2 subsystem on the remote host. (default "sftp")
+      --sftp-use-fstat                                           If set use fstat instead of stat
+      --sftp-use-insecure-cipher                                 Enable the use of insecure ciphers and key exchange methods.
+      --sftp-user string                                         SSH username, leave blank for current username, $USER
+      --sharefile-chunk-size SizeSuffix                          Upload chunk size. Must a power of 2 >= 256k. (default 64M)
+      --sharefile-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot)
+      --sharefile-endpoint string                                Endpoint for API calls.
+      --sharefile-root-folder-id string                          ID of the root folder
+      --sharefile-upload-cutoff SizeSuffix                       Cutoff for switching to multipart upload. (default 128M)
+      --skip-links                                               Don't warn about skipped symlinks.
+      --sugarsync-access-key-id string                           Sugarsync Access Key ID.
+      --sugarsync-app-id string                                  Sugarsync App ID.
+      --sugarsync-authorization string                           Sugarsync authorization
+      --sugarsync-authorization-expiry string                    Sugarsync authorization expiry
+      --sugarsync-deleted-id string                              Sugarsync deleted folder id
+      --sugarsync-encoding MultiEncoder                          This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot)
+      --sugarsync-hard-delete                                    Permanently delete files if true
+      --sugarsync-private-access-key string                      Sugarsync Private Access Key
+      --sugarsync-refresh-token string                           Sugarsync refresh token
+      --sugarsync-root-id string                                 Sugarsync root id
+      --sugarsync-user string                                    Sugarsync user
+      --swift-application-credential-id string                   Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)
+      --swift-application-credential-name string                 Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)
+      --swift-application-credential-secret string               Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)
+      --swift-auth string                                        Authentication URL for server (OS_AUTH_URL).
+      --swift-auth-token string                                  Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)
+      --swift-auth-version int                                   AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)
+      --swift-chunk-size SizeSuffix                              Above this size files will be chunked into a _segments container. (default 5G)
+      --swift-domain string                                      User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)
+      --swift-encoding MultiEncoder                              This sets the encoding for the backend. (default Slash,InvalidUtf8)
+      --swift-endpoint-type string                               Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public")
+      --swift-env-auth                                           Get swift credentials from environment variables in standard OpenStack form.
+      --swift-key string                                         API key or password (OS_PASSWORD).
+      --swift-leave-parts-on-error                               If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions.
+      --swift-no-chunk                                           Don't chunk files during streaming upload.
+      --swift-region string                                      Region name - optional (OS_REGION_NAME)
+      --swift-storage-policy string                              The storage policy to use when creating a new container
+      --swift-storage-url string                                 Storage URL - optional (OS_STORAGE_URL)
+      --swift-tenant string                                      Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)
+      --swift-tenant-domain string                               Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)
+      --swift-tenant-id string                                   Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)
+      --swift-user string                                        User name to log in (OS_USERNAME).
+      --swift-user-id string                                     User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).
+      --tardigrade-access-grant string                           Access Grant.
+      --tardigrade-api-key string                                API Key.
+      --tardigrade-passphrase string                             Encryption Passphrase. To access existing objects enter passphrase used for uploading.
+      --tardigrade-provider string                               Choose an authentication method. (default "existing")
+      --tardigrade-satellite-address <nodeid>@<address>:<port>   Satellite Address. Custom satellite address should match the format: <nodeid>@<address>:<port>. (default "us-central-1.tardigrade.io")
+      --union-action-policy string                               Policy to choose upstream on ACTION category. (default "epall")
+      --union-cache-time int                                     Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120)
+      --union-create-policy string                               Policy to choose upstream on CREATE category. (default "epmfs")
+      --union-search-policy string                               Policy to choose upstream on SEARCH category. (default "ff")
+      --union-upstreams string                                   List of space separated upstreams.
+      --webdav-bearer-token string                               Bearer token instead of user/pass (e.g. a Macaroon)
+      --webdav-bearer-token-command string                       Command to run to get a bearer token
+      --webdav-pass string                                       Password. (obscured)
+      --webdav-url string                                        URL of http host to connect to
+      --webdav-user string                                       User name
+      --webdav-vendor string                                     Name of the Webdav site/service/software you are using
+      --yandex-auth-url string                                   Auth server URL.
+      --yandex-client-id string                                  OAuth Client Id
+      --yandex-client-secret string                              OAuth Client Secret
+      --yandex-encoding MultiEncoder                             This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot)
+      --yandex-token string                                      OAuth Access Token as a JSON blob.
+      --yandex-token-url string                                  Token server url.
+      --zoho-encoding MultiEncoder                               This sets the encoding for the backend. (default Del,Ctl,InvalidUtf8)
+      --zoho-region string                                       Zoho region to connect to. You'll have to use the region you organization is registered in.
    
+
    1Fichier
    
+
    This is a backend for the 1fichier cloud storage service. Note that a Premium subscription is required to use the API.
    
+
    Paths are specified as remote:path
    
+
    Paths may be as deep as required, e.g. remote:directory/subdirectory.
    
+
    The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+XX / 1Fichier
+   \ "fichier"
+[snip]
+Storage> fichier
+** See help for fichier backend at: https://rclone.org/fichier/ **
 
 Your API Key, get it from https://1fichier.com/console/params.pl
+Enter a string value. Press Enter for the default ("").
+api_key> example_key
 
-- Config:      api_key
-- Env Var:     RCLONE_FICHIER_API_KEY
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to fichier (1Fichier).
-
-#### --fichier-shared-folder
-
-If you want to download a shared folder, add this parameter
-
-- Config:      shared_folder
-- Env Var:     RCLONE_FICHIER_SHARED_FOLDER
-- Type:        string
-- Default:     ""
-
-#### --fichier-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_FICHIER_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
-
-
-
- Alias
------------------------------------------
-
-The `alias` remote provides a new name for another remote.
-
-Paths may be as deep as required or a local path, 
-eg `remote:directory/subdirectory` or `/directory/subdirectory`.
-
-During the initial setup with `rclone config` you will specify the target
-remote. The target remote can either be a local path or another remote.
-
-Subfolders can be used in target remote. Assume an alias remote named `backup`
-with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop`
-is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`.
-
-There will be no special handling of paths containing `..` segments.
-Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking
-`rclone mkdir mydrive:private/backup/../desktop`.
-The empty path is not allowed as a remote. To alias the current directory
-use `.` instead.
-
-Here is an example of how to make an alias called `remote` for local folder.
-First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Alias for an existing remote  "alias" [snip] Storage> alias Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". remote> /mnt/storage/backup Remote config -------------------- [remote] remote = /mnt/storage/backup -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes:
    
-
    Name Type ==== ==== remote alias
    
-
      
-
    1. Edit existing remote
      2. 
-
    2. New remote
      3. 
-
    3. Delete remote
      4. 
-
    4. Rename remote
      5. 
-
    5. Copy remote
      6. 
-
    6. Set configuration password
      7. 
-
    7. Quit config e/n/d/r/c/s/q> q
      8. 
-
    
-
    
-Once configured you can then use `rclone` like this,
-
-List directories in top level in `/mnt/storage/backup`
-
-    rclone lsd remote:
-
-List all the files in `/mnt/storage/backup`
-
-    rclone ls remote:
-
-Copy another local directory to the alias directory called source
-
-    rclone copy /home/source remote:source
-
-
-### Standard Options
-
-Here are the standard options specific to alias (Alias for an existing remote).
-
-#### --alias-remote
-
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> 
+Remote config
+--------------------
+[remote]
+type = fichier
+api_key = example_key
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your 1Fichier account
    
+
    rclone lsd remote:
    
+
    List all the files in your 1Fichier account
    
+
    rclone ls remote:
    
+
    To copy a local directory to a 1Fichier directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Modified time and hashes
    
+
    1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
    
+
    Duplicated files
    
+
    1Fichier can have two files with exactly the same name and path (unlike a normal file system).
    
+
    Duplicated files cause problems with the syncing and you will see messages in the log about duplicates.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    \0x5C＼
    <0x3C＜
    >0x3E＞
    "0x22＂
    $0x24＄
    `0x60｀
    '0x27＇
    
+
    File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Standard Options
    
+
    Here are the standard options specific to fichier (1Fichier).
    
+
    --fichier-api-key
    
+
    Your API Key, get it from https://1fichier.com/console/params.pl
    
+
      
+
    • Config: api_key
      • 
+
    • Env Var: RCLONE_FICHIER_API_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to fichier (1Fichier).
    
+
    --fichier-shared-folder
    
+
    If you want to download a shared folder, add this parameter
    
+
      
+
    • Config: shared_folder
      • 
+
    • Env Var: RCLONE_FICHIER_SHARED_FOLDER
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --fichier-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_FICHIER_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    rclone about is not supported by the 1Fichier backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.
    
+
    See List of backends that do not support rclone about See rclone about
    
+
    Alias
    
+
    The alias remote provides a new name for another remote.
    
+
    Paths may be as deep as required or a local path, e.g. remote:directory/subdirectory or /directory/subdirectory.
    
+
    During the initial setup with rclone config you will specify the target remote. The target remote can either be a local path or another remote.
    
+
    Subfolders can be used in target remote. Assume an alias remote named backup with the target mydrive:private/backup. Invoking rclone mkdir backup:desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/desktop.
    
+
    There will be no special handling of paths containing .. segments. Invoking rclone mkdir backup:../desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/../desktop. The empty path is not allowed as a remote. To alias the current directory use . instead.
    
+
    Here is an example of how to make an alias called remote for local folder. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Alias for an existing remote
+   \ "alias"
+[snip]
+Storage> alias
 Remote or path to alias.
 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
-
-- Config:      remote
-- Env Var:     RCLONE_ALIAS_REMOTE
-- Type:        string
-- Default:     ""
-
-
-
- Amazon Drive
------------------------------------------
-
-Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage
-service run by Amazon for consumers.
-
-## Status
-
-**Important:** rclone supports Amazon Drive only if you have your own
-set of API keys. Unfortunately the [Amazon Drive developer
-program](https://developer.amazon.com/amazon-drive) is now closed to
-new entries so if you don't already have your own set of keys you will
-not be able to use rclone with Amazon Drive.
-
-For the history on why rclone no longer has a set of Amazon Drive API
-keys see [the forum](https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314).
-
-If you happen to know anyone who works at Amazon then please ask them
-to re-instate rclone into the Amazon Drive developer program - thanks!
-
-## Setup
-
-The initial setup for Amazon Drive involves getting a token from
-Amazon which you need to do in your browser.  `rclone config` walks
-you through it.
-
-The configuration process for Amazon Drive may involve using an [oauth
-proxy](https://github.com/ncw/oauthproxy). This is used to keep the
-Amazon credentials out of the source code.  The proxy runs in Google's
-very secure App Engine environment and doesn't store any credentials
-which pass through it.
-
-Since rclone doesn't currently have its own Amazon Drive credentials
-so you will either need to have your own `client_id` and
-`client_secret` with Amazon Drive, or use a third party oauth proxy
-in which case you will need to enter `client_id`, `client_secret`,
-`auth_url` and `token_url`.
-
-Note also if you are not using Amazon's `auth_url` and `token_url`,
-(ie you filled in something for those) then if setting up on a remote
-machine you can only use the [copying the config method of
-configuration](https://rclone.org/remote_setup/#configuring-by-copying-the-config-file)
-- `rclone authorize` will not work.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon Drive  "amazon cloud drive" [snip] Storage> amazon cloud drive Amazon Application Client Id - required. client_id> your client ID goes here Amazon Application Client Secret - required. client_secret> your client secret goes here Auth server URL - leave blank to use Amazon's. auth_url> Optional auth URL Token server url - leave blank to use Amazon's. token_url> Optional token URL Remote config Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] client_id = your client ID goes here client_secret = your client secret goes here auth_url = Optional auth URL token_url = Optional token URL token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
-machine with no Internet browser available.
-
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Amazon. This only runs from the moment it
-opens your browser to the moment you get back the verification
-code.  This is on `http://127.0.0.1:53682/` and this it may require
-you to unblock it temporarily if you are running a host firewall.
-
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your Amazon Drive
-
-    rclone lsd remote:
-
-List all the files in your Amazon Drive
-
-    rclone ls remote:
-
-To copy a local directory to an Amazon Drive directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Modified time and MD5SUMs ###
-
-Amazon Drive doesn't allow modification times to be changed via
-the API so these won't be accurate or used for syncing.
-
-It does store MD5SUMs so for a more accurate sync, you can use the
-`--checksum` flag.
-
-#### Restricted filename characters
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| /         | 0x2F  | ／          |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-### Deleting files ###
-
-Any files you delete with rclone will end up in the trash.  Amazon
-don't provide an API to permanently delete files, nor to empty the
-trash, so you will have to do that with one of Amazon's apps or via
-the Amazon Drive website. As of November 17, 2016, files are 
-automatically deleted by Amazon from the trash after 30 days.
-
-### Using with non `.com` Amazon accounts ###
-
-Let's say you usually use `amazon.co.uk`. When you authenticate with
-rclone it will take you to an `amazon.com` page to log in.  Your
-`amazon.co.uk` email and password should work here just fine.
-
-
-### Standard Options
-
-Here are the standard options specific to amazon cloud drive (Amazon Drive).
-
-#### --acd-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_ACD_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --acd-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_ACD_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to amazon cloud drive (Amazon Drive).
-
-#### --acd-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_ACD_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --acd-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_ACD_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --acd-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_ACD_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --acd-checkpoint
-
-Checkpoint for internal polling (debug).
-
-- Config:      checkpoint
-- Env Var:     RCLONE_ACD_CHECKPOINT
-- Type:        string
-- Default:     ""
-
-#### --acd-upload-wait-per-gb
-
-Additional time per GB to wait after a failed complete upload to see if it appears.
-
-Sometimes Amazon Drive gives an error when a file has been fully
-uploaded but the file appears anyway after a little while.  This
-happens sometimes for files over 1GB in size and nearly every time for
-files bigger than 10GB. This parameter controls the time rclone waits
-for the file to appear.
-
-The default value for this parameter is 3 minutes per GB, so by
-default it will wait 3 minutes for every GB uploaded to see if the
-file appears.
-
-You can disable this feature by setting it to 0. This may cause
-conflict errors as rclone retries the failed upload but the file will
-most likely appear correctly eventually.
-
-These values were determined empirically by observing lots of uploads
-of big files for a range of file sizes.
-
-Upload with the "-v" flag to see more info about what rclone is doing
-in this situation.
-
-- Config:      upload_wait_per_gb
-- Env Var:     RCLONE_ACD_UPLOAD_WAIT_PER_GB
-- Type:        Duration
-- Default:     3m0s
-
-#### --acd-templink-threshold
-
-Files >= this size will be downloaded via their tempLink.
-
-Files this size or more will be downloaded via their "tempLink". This
-is to work around a problem with Amazon Drive which blocks downloads
-of files bigger than about 10GB.  The default for this is 9GB which
-shouldn't need to be changed.
-
-To download files above this threshold, rclone requests a "tempLink"
-which downloads the file through a temporary URL directly from the
-underlying S3 storage.
-
-- Config:      templink_threshold
-- Env Var:     RCLONE_ACD_TEMPLINK_THRESHOLD
-- Type:        SizeSuffix
-- Default:     9G
-
-#### --acd-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_ACD_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,InvalidUtf8,Dot
-
-
-
-### Limitations ###
-
-Note that Amazon Drive is case insensitive so you can't have a
-file called "Hello.doc" and one called "hello.doc".
-
-Amazon Drive has rate limiting so you may notice errors in the
-sync (429 errors).  rclone will automatically retry the sync up to 3
-times by default (see `--retries` flag) which should hopefully work
-around this problem.
-
-Amazon Drive has an internal limit of file sizes that can be uploaded
-to the service. This limit is not officially published, but all files
-larger than this will fail.
-
-At the time of writing (Jan 2016) is in the area of 50GB per file.
-This means that larger files are likely to fail.
-
-Unfortunately there is no way for rclone to see that this failure is
-because of file size, so it will retry the operation, as any other
-failure. To avoid this problem, use `--max-size 50000M` option to limit
-the maximum size of uploaded files. Note that `--max-size` does not split
-files into segments, it only ignores files over this size.
-
- Amazon S3 Storage Providers
---------------------------------------------------------
-
-The S3 backend can be used with a number of different providers:
-
-
-- AWS S3
-- Alibaba Cloud (Aliyun) Object Storage System (OSS)
-- Ceph
-- DigitalOcean Spaces
-- Dreamhost
-- IBM COS S3
-- Minio
-- Scaleway
-- StackPath
-- Wasabi
-
-
-Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
-command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
-
-Once you have made a remote (see the provider specific section above)
-you can use it like this:
-
-See all buckets
-
-    rclone lsd remote:
-
-Make a new bucket
-
-    rclone mkdir remote:bucket
-
-List the contents of a bucket
-
-    rclone ls remote:bucket
-
-Sync `/home/local/directory` to the remote bucket, deleting any excess
-files in the bucket.
-
-    rclone sync -i /home/local/directory remote:bucket
-
-## AWS S3 {#amazon-s3}
-
-Here is an example of making an s3 configuration.  First run
-
-    rclone config
-
-This will guide you through an interactive setup process.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio)  "s3" [snip] Storage> s3 Choose your S3 provider. Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3  "AWS" 2 / Ceph Object Storage  "Ceph" 3 / Digital Ocean Spaces  "DigitalOcean" 4 / Dreamhost DreamObjects  "Dreamhost" 5 / IBM COS S3  "IBMCOS" 6 / Minio Object Storage  "Minio" 7 / Wasabi Object Storage  "Wasabi" 8 / Any other S3 compatible provider  "Other" provider> 1 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step  "false" 2 / Get AWS credentials from the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> XXX AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> YYY Region to connect to. Choose a number from below, or type in your own value / The default endpoint - a good choice if you are unsure. 1 | US Region, Northern Virginia or Pacific Northwest. | Leave location constraint empty.  "us-east-1" / US East (Ohio) Region 2 | Needs location constraint us-east-2.  "us-east-2" / US West (Oregon) Region 3 | Needs location constraint us-west-2.  "us-west-2" / US West (Northern California) Region 4 | Needs location constraint us-west-1.  "us-west-1" / Canada (Central) Region 5 | Needs location constraint ca-central-1.  "ca-central-1" / EU (Ireland) Region 6 | Needs location constraint EU or eu-west-1.  "eu-west-1" / EU (London) Region 7 | Needs location constraint eu-west-2.  "eu-west-2" / EU (Frankfurt) Region 8 | Needs location constraint eu-central-1.  "eu-central-1" / Asia Pacific (Singapore) Region 9 | Needs location constraint ap-southeast-1.  "ap-southeast-1" / Asia Pacific (Sydney) Region 10 | Needs location constraint ap-southeast-2.  "ap-southeast-2" / Asia Pacific (Tokyo) Region 11 | Needs location constraint ap-northeast-1.  "ap-northeast-1" / Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2.  "ap-northeast-2" / Asia Pacific (Mumbai) 13 | Needs location constraint ap-south-1.  "ap-south-1" / Asia Patific (Hong Kong) Region 14 | Needs location constraint ap-east-1.  "ap-east-1" / South America (Sao Paulo) Region 15 | Needs location constraint sa-east-1.  "sa-east-1" region> 1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. endpoint> Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value 1 / Empty for US Region, Northern Virginia or Pacific Northwest.  "" 2 / US East (Ohio) Region.  "us-east-2" 3 / US West (Oregon) Region.  "us-west-2" 4 / US West (Northern California) Region.  "us-west-1" 5 / Canada (Central) Region.  "ca-central-1" 6 / EU (Ireland) Region.  "eu-west-1" 7 / EU (London) Region.  "eu-west-2" 8 / EU Region.  "EU" 9 / Asia Pacific (Singapore) Region.  "ap-southeast-1" 10 / Asia Pacific (Sydney) Region.  "ap-southeast-2" 11 / Asia Pacific (Tokyo) Region.  "ap-northeast-1" 12 / Asia Pacific (Seoul)  "ap-northeast-2" 13 / Asia Pacific (Mumbai)  "ap-south-1" 14 / Asia Pacific (Hong Kong)  "ap-east-1" 15 / South America (Sao Paulo) Region.  "sa-east-1" location_constraint> 1 Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default).  "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.  "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. 3 | Granting this on a bucket is generally not recommended.  "public-read-write" 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.  "authenticated-read" / Object owner gets FULL_CONTROL. Bucket owner gets READ access. 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.  "bucket-owner-read" / Both the object owner and the bucket owner get FULL_CONTROL over the object. 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.  "bucket-owner-full-control" acl> 1 The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value 1 / None  "" 2 / AES256  "AES256" server_side_encryption> 1 The storage class to use when storing objects in S3. Choose a number from below, or type in your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 / Reduced redundancy storage class  "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access storage class  "STANDARD_IA" 5 / One Zone Infrequent Access storage class  "ONEZONE_IA" 6 / Glacier storage class  "GLACIER" 7 / Glacier Deep Archive storage class  "DEEP_ARCHIVE" 8 / Intelligent-Tiering storage class  "INTELLIGENT_TIERING" storage_class> 1 Remote config -------------------- [remote] type = s3 provider = AWS env_auth = false access_key_id = XXX secret_access_key = YYY region = us-east-1 endpoint = location_constraint = acl = private server_side_encryption = storage_class = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d>
    
-
    
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-### --update and --use-server-modtime ###
-
-As noted below, the modified time is stored on metadata on the object. It is
-used by default for all operations that require checking the time a file was
-last updated. It allows rclone to treat the remote more like a true filesystem,
-but it is inefficient because it requires an extra API call to retrieve the
-metadata.
-
-For many operations, the time the object was last uploaded to the remote is
-sufficient to determine if it is "dirty". By using `--update` along with
-`--use-server-modtime`, you can avoid the extra API call and simply upload
-files whose local modtime is newer than the time it was last uploaded.
-
-### Modified time ###
-
-The modified time is stored as metadata on the object as
-`X-Amz-Meta-Mtime` as floating point since the epoch accurate to 1 ns.
-
-If the modification time needs to be updated rclone will attempt to perform a server
-side copy to update the modification if the object can be copied in a single part.
-In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive
-storage the object will be uploaded rather than copied.
-
-### Cleanup ###
-
-If you run `rclone cleanup s3:bucket` then it will remove all pending
-multipart uploads older than 24 hours. You can use the `-i` flag to
-see exactly what it will do. If you want more control over the expiry
-date then run `rclone backend cleanup s3:bucket -o max-age=1h` to
-expire all uploads older than one hour. You can use `rclone backend
-list-multipart-uploads s3:bucket` to see the pending multipart
-uploads.
-
-#### Restricted filename characters
-
-S3 allows any valid UTF-8 string as a key.
-
-Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), as
-they can't be used in XML.
-
-The following characters are replaced since these are problematic when
-dealing with the REST API:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| /         | 0x2F  | ／           |
-
-The encoding will also encode these file names as they don't seem to
-work with the SDK properly:
-
-| File name | Replacement |
-| --------- |:-----------:|
-| .         | ．          |
-| ..        | ．．         |
-
-### Multipart uploads ###
-
-rclone supports multipart uploads with S3 which means that it can
-upload files bigger than 5GB.
-
-Note that files uploaded *both* with multipart upload *and* through
-crypt remotes do not have MD5 sums.
-
-rclone switches from single part uploads to multipart uploads at the
-point specified by `--s3-upload-cutoff`.  This can be a maximum of 5GB
-and a minimum of 0 (ie always upload multipart files).
-
-The chunk sizes used in the multipart upload are specified by
-`--s3-chunk-size` and the number of chunks uploaded concurrently is
-specified by `--s3-upload-concurrency`.
-
-Multipart uploads will use `--transfers` * `--s3-upload-concurrency` *
-`--s3-chunk-size` extra memory.  Single part uploads to not use extra
-memory.
-
-Single part transfers can be faster than multipart transfers or slower
-depending on your latency from S3 - the more latency, the more likely
-single part transfers will be faster.
-
-Increasing `--s3-upload-concurrency` will increase throughput (8 would
-be a sensible value) and increasing `--s3-chunk-size` also increases
-throughput (16M would be sensible).  Increasing either of these will
-use more memory.  The default values are high enough to gain most of
-the possible performance without using too much memory.
-
-
-### Buckets and Regions ###
-
-With Amazon S3 you can list buckets (`rclone lsd`) using any region,
-but you can only access the content of a bucket from the region it was
-created in.  If you attempt to access a bucket from the wrong region,
-you will get an error, `incorrect region, the bucket is not in 'XXX'
-region`.
-
-### Authentication ###
-
-There are a number of ways to supply `rclone` with a set of AWS
-credentials, with and without using the environment.
-
-The different authentication methods are tried in this order:
-
- - Directly in the rclone configuration file (`env_auth = false` in the config file):
-   - `access_key_id` and `secret_access_key` are required.
-   - `session_token` can be optionally set when using AWS STS.
- - Runtime configuration (`env_auth = true` in the config file):
-   - Export the following environment variables before running `rclone`:
-     - Access Key ID: `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY`
-     - Secret Access Key: `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY`
-     - Session Token: `AWS_SESSION_TOKEN` (optional)
-   - Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html):
-     - Profile files are standard files used by AWS CLI tools
-     - By default it will use the profile in your home directory (eg `~/.aws/credentials` on unix based systems) file and the "default" profile, to change set these environment variables:
-         - `AWS_SHARED_CREDENTIALS_FILE` to control which file.
-         - `AWS_PROFILE` to control which profile to use.
-   - Or, run `rclone` in an ECS task with an IAM role (AWS only).
-   - Or, run `rclone` on an EC2 instance with an IAM role (AWS only).
-   - Or, run `rclone` in an EKS pod with an IAM role that is associated with a service account (AWS only).
-
-If none of these option actually end up providing `rclone` with AWS
-credentials then S3 interaction will be non-authenticated (see below).
-
-### S3 Permissions ###
-
-When using the `sync` subcommand of `rclone` the following minimum
-permissions are required to be available on the bucket being written to:
-
-* `ListBucket`
-* `DeleteObject`
-* `GetObject`
-* `PutObject`
-* `PutObjectACL`
-
-When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required.
-
-Example policy:
-
    
-
    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" }, "Action": [ "s3:ListBucket", "s3:DeleteObject", "s3:GetObject", "s3:PutObject", "s3:PutObjectAcl" ], "Resource": [ "arn:aws:s3:::BUCKET_NAME/*", "arn:aws:s3:::BUCKET_NAME" ] }, { "Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": "arn:aws:s3:::*" }
    
-] }
    
-
    
-Notes on above:
-
-1. This is a policy that can be used when creating bucket. It assumes
-   that `USER_NAME` has been created.
-2. The Resource entry must include both resource ARNs, as one implies
-   the bucket and the other implies the bucket's objects.
-
-For reference, [here's an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b)
-that will generate one or more buckets that will work with `rclone sync`.
-
-### Key Management System (KMS) ###
-
-If you are using server side encryption with KMS then you will find
-you can't transfer small objects.  As a work-around you can use the
-`--ignore-checksum` flag.
-
-A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824).
-
-### Glacier and Glacier Deep Archive ###
-
-You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html).
-The bucket can still be synced or copied into normally, but if rclone
-tries to access data from the glacier storage class you will see an error like below.
-
-    2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file
-
-In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html)
-the object(s) in question before using rclone.
-
-Note that rclone only speaks the S3 API it does not speak the Glacier
-Vault API, so rclone cannot directly access Glacier Vaults.
-
-
-### Standard Options
-
-Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).
-
-#### --s3-provider
-
+remote> /mnt/storage/backup
+Remote config
+--------------------
+[remote]
+remote = /mnt/storage/backup
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+Current remotes:
+
+Name                 Type
+====                 ====
+remote               alias
+
+e) Edit existing remote
+n) New remote
+d) Delete remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+e/n/d/r/c/s/q> q
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level in /mnt/storage/backup
    
+
    rclone lsd remote:
    
+
    List all the files in /mnt/storage/backup
    
+
    rclone ls remote:
    
+
    Copy another local directory to the alias directory called source
    
+
    rclone copy /home/source remote:source
    
+
    Standard Options
    
+
    Here are the standard options specific to alias (Alias for an existing remote).
    
+
    --alias-remote
    
+
    Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_ALIAS_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Amazon Drive
    
+
    Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers.
    
+
    Status
    
+
    Important: rclone supports Amazon Drive only if you have your own set of API keys. Unfortunately the Amazon Drive developer program is now closed to new entries so if you don't already have your own set of keys you will not be able to use rclone with Amazon Drive.
    
+
    For the history on why rclone no longer has a set of Amazon Drive API keys see the forum.
    
+
    If you happen to know anyone who works at Amazon then please ask them to re-instate rclone into the Amazon Drive developer program - thanks!
    
+
    Setup
    
+
    The initial setup for Amazon Drive involves getting a token from Amazon which you need to do in your browser. rclone config walks you through it.
    
+
    The configuration process for Amazon Drive may involve using an oauth proxy. This is used to keep the Amazon credentials out of the source code. The proxy runs in Google's very secure App Engine environment and doesn't store any credentials which pass through it.
    
+
    Since rclone doesn't currently have its own Amazon Drive credentials so you will either need to have your own client_id and client_secret with Amazon Drive, or use a third party oauth proxy in which case you will need to enter client_id, client_secret, auth_url and token_url.
    
+
    Note also if you are not using Amazon's auth_url and token_url, (ie you filled in something for those) then if setting up on a remote machine you can only use the copying the config method of configuration - rclone authorize will not work.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon Drive
+   \ "amazon cloud drive"
+[snip]
+Storage> amazon cloud drive
+Amazon Application Client Id - required.
+client_id> your client ID goes here
+Amazon Application Client Secret - required.
+client_secret> your client secret goes here
+Auth server URL - leave blank to use Amazon's.
+auth_url> Optional auth URL
+Token server url - leave blank to use Amazon's.
+token_url> Optional token URL
+Remote config
+Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config.
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+client_id = your client ID goes here
+client_secret = your client secret goes here
+auth_url = Optional auth URL
+token_url = Optional token URL
+token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    See the remote setup docs for how to set it up on a machine with no Internet browser available.
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Amazon. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your Amazon Drive
    
+
    rclone lsd remote:
    
+
    List all the files in your Amazon Drive
    
+
    rclone ls remote:
    
+
    To copy a local directory to an Amazon Drive directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Modified time and MD5SUMs
    
+
    Amazon Drive doesn't allow modification times to be changed via the API so these won't be accurate or used for syncing.
    
+
    It does store MD5SUMs so for a more accurate sync, you can use the --checksum flag.
    
+
    Restricted filename characters
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Deleting files
    
+
    Any files you delete with rclone will end up in the trash. Amazon don't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Amazon's apps or via the Amazon Drive website. As of November 17, 2016, files are automatically deleted by Amazon from the trash after 30 days.
    
+
    Using with non .com Amazon accounts
    
+
    Let's say you usually use amazon.co.uk. When you authenticate with rclone it will take you to an amazon.com page to log in. Your amazon.co.uk email and password should work here just fine.
    
+
    Standard Options
    
+
    Here are the standard options specific to amazon cloud drive (Amazon Drive).
    
+
    --acd-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_ACD_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_ACD_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to amazon cloud drive (Amazon Drive).
    
+
    --acd-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_ACD_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_ACD_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_ACD_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-checkpoint
    
+
    Checkpoint for internal polling (debug).
    
+
      
+
    • Config: checkpoint
      • 
+
    • Env Var: RCLONE_ACD_CHECKPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --acd-upload-wait-per-gb
    
+
    Additional time per GB to wait after a failed complete upload to see if it appears.
    
+
    Sometimes Amazon Drive gives an error when a file has been fully uploaded but the file appears anyway after a little while. This happens sometimes for files over 1GB in size and nearly every time for files bigger than 10GB. This parameter controls the time rclone waits for the file to appear.
    
+
    The default value for this parameter is 3 minutes per GB, so by default it will wait 3 minutes for every GB uploaded to see if the file appears.
    
+
    You can disable this feature by setting it to 0. This may cause conflict errors as rclone retries the failed upload but the file will most likely appear correctly eventually.
    
+
    These values were determined empirically by observing lots of uploads of big files for a range of file sizes.
    
+
    Upload with the "-v" flag to see more info about what rclone is doing in this situation.
    
+
      
+
    • Config: upload_wait_per_gb
      • 
+
    • Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB
      • 
+
    • Type: Duration
      • 
+
    • Default: 3m0s
      • 
+
    
+
+
    Files >= this size will be downloaded via their tempLink.
    
+
    Files this size or more will be downloaded via their "tempLink". This is to work around a problem with Amazon Drive which blocks downloads of files bigger than about 10GB. The default for this is 9GB which shouldn't need to be changed.
    
+
    To download files above this threshold, rclone requests a "tempLink" which downloads the file through a temporary URL directly from the underlying S3 storage.
    
+
      
+
    • Config: templink_threshold
      • 
+
    • Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 9G
      • 
+
    
+
    --acd-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_ACD_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    Note that Amazon Drive is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    Amazon Drive has rate limiting so you may notice errors in the sync (429 errors). rclone will automatically retry the sync up to 3 times by default (see --retries flag) which should hopefully work around this problem.
    
+
    Amazon Drive has an internal limit of file sizes that can be uploaded to the service. This limit is not officially published, but all files larger than this will fail.
    
+
    At the time of writing (Jan 2016) is in the area of 50GB per file. This means that larger files are likely to fail.
    
+
    Unfortunately there is no way for rclone to see that this failure is because of file size, so it will retry the operation, as any other failure. To avoid this problem, use --max-size 50000M option to limit the maximum size of uploaded files. Note that --max-size does not split files into segments, it only ignores files over this size.
    
+
    rclone about is not supported by the Amazon Drive backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.
    
+
    See List of backends that do not support rclone about See rclone about
    
+
    Amazon S3 Storage Providers
    
+
    The S3 backend can be used with a number of different providers:
    
+
      
+
    • AWS S3
      • 
+
    • Alibaba Cloud (Aliyun) Object Storage System (OSS)
      • 
+
    • Ceph
      • 
+
    • DigitalOcean Spaces
      • 
+
    • Dreamhost
      • 
+
    • IBM COS S3
      • 
+
    • Minio
      • 
+
    • Scaleway
      • 
+
    • StackPath
      • 
+
    • Tencent Cloud Object Storage (COS)
      • 
+
    • Wasabi
      • 
+
    
+
    Paths are specified as remote:bucket (or remote: for the lsd command.) You may put subdirectories in too, e.g. remote:bucket/path/to/dir.
    
+
    Once you have made a remote (see the provider specific section above) you can use it like this:
    
+
    See all buckets
    
+
    rclone lsd remote:
    
+
    Make a new bucket
    
+
    rclone mkdir remote:bucket
    
+
    List the contents of a bucket
    
+
    rclone ls remote:bucket
    
+
    Sync /home/local/directory to the remote bucket, deleting any excess files in the bucket.
    
+
    rclone sync -i /home/local/directory remote:bucket
    
+
    AWS S3
    
+
    Here is an example of making an s3 configuration. First run
    
+
    rclone config
    
+
    This will guide you through an interactive setup process.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS
+   \ "s3"
+[snip]
+Storage> s3
 Choose your S3 provider.
-
-- Config:      provider
-- Env Var:     RCLONE_S3_PROVIDER
-- Type:        string
-- Default:     ""
-- Examples:
-    - "AWS"
-        - Amazon Web Services (AWS) S3
-    - "Alibaba"
-        - Alibaba Cloud Object Storage System (OSS) formerly Aliyun
-    - "Ceph"
-        - Ceph Object Storage
-    - "DigitalOcean"
-        - Digital Ocean Spaces
-    - "Dreamhost"
-        - Dreamhost DreamObjects
-    - "IBMCOS"
-        - IBM COS S3
-    - "Minio"
-        - Minio Object Storage
-    - "Netease"
-        - Netease Object Storage (NOS)
-    - "Scaleway"
-        - Scaleway Object Storage
-    - "StackPath"
-        - StackPath Object Storage
-    - "Wasabi"
-        - Wasabi Object Storage
-    - "Other"
-        - Any other S3 compatible provider
-
-#### --s3-env-auth
-
-Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
-Only applies if access_key_id and secret_access_key is blank.
-
-- Config:      env_auth
-- Env Var:     RCLONE_S3_ENV_AUTH
-- Type:        bool
-- Default:     false
-- Examples:
-    - "false"
-        - Enter AWS credentials in the next step
-    - "true"
-        - Get AWS credentials from the environment (env vars or IAM)
-
-#### --s3-access-key-id
-
-AWS Access Key ID.
-Leave blank for anonymous access or runtime credentials.
-
-- Config:      access_key_id
-- Env Var:     RCLONE_S3_ACCESS_KEY_ID
-- Type:        string
-- Default:     ""
-
-#### --s3-secret-access-key
-
-AWS Secret Access Key (password)
-Leave blank for anonymous access or runtime credentials.
-
-- Config:      secret_access_key
-- Env Var:     RCLONE_S3_SECRET_ACCESS_KEY
-- Type:        string
-- Default:     ""
-
-#### --s3-region
-
+Choose a number from below, or type in your own value
+ 1 / Amazon Web Services (AWS) S3
+   \ "AWS"
+ 2 / Ceph Object Storage
+   \ "Ceph"
+ 3 / Digital Ocean Spaces
+   \ "DigitalOcean"
+ 4 / Dreamhost DreamObjects
+   \ "Dreamhost"
+ 5 / IBM COS S3
+   \ "IBMCOS"
+ 6 / Minio Object Storage
+   \ "Minio"
+ 7 / Wasabi Object Storage
+   \ "Wasabi"
+ 8 / Any other S3 compatible provider
+   \ "Other"
+provider> 1
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID - leave blank for anonymous access or runtime credentials.
+access_key_id> XXX
+AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
+secret_access_key> YYY
 Region to connect to.
-
-- Config:      region
-- Env Var:     RCLONE_S3_REGION
-- Type:        string
-- Default:     ""
-- Examples:
-    - "us-east-1"
-        - The default endpoint - a good choice if you are unsure.
-        - US Region, Northern Virginia or Pacific Northwest.
-        - Leave location constraint empty.
-    - "us-east-2"
-        - US East (Ohio) Region
-        - Needs location constraint us-east-2.
-    - "us-west-2"
-        - US West (Oregon) Region
-        - Needs location constraint us-west-2.
-    - "us-west-1"
-        - US West (Northern California) Region
-        - Needs location constraint us-west-1.
-    - "ca-central-1"
-        - Canada (Central) Region
-        - Needs location constraint ca-central-1.
-    - "eu-west-1"
-        - EU (Ireland) Region
-        - Needs location constraint EU or eu-west-1.
-    - "eu-west-2"
-        - EU (London) Region
-        - Needs location constraint eu-west-2.
-    - "eu-north-1"
-        - EU (Stockholm) Region
-        - Needs location constraint eu-north-1.
-    - "eu-central-1"
-        - EU (Frankfurt) Region
-        - Needs location constraint eu-central-1.
-    - "ap-southeast-1"
-        - Asia Pacific (Singapore) Region
-        - Needs location constraint ap-southeast-1.
-    - "ap-southeast-2"
-        - Asia Pacific (Sydney) Region
-        - Needs location constraint ap-southeast-2.
-    - "ap-northeast-1"
-        - Asia Pacific (Tokyo) Region
-        - Needs location constraint ap-northeast-1.
-    - "ap-northeast-2"
-        - Asia Pacific (Seoul)
-        - Needs location constraint ap-northeast-2.
-    - "ap-south-1"
-        - Asia Pacific (Mumbai)
-        - Needs location constraint ap-south-1.
-    - "ap-east-1"
-        - Asia Patific (Hong Kong) Region
-        - Needs location constraint ap-east-1.
-    - "sa-east-1"
-        - South America (Sao Paulo) Region
-        - Needs location constraint sa-east-1.
-
-#### --s3-region
-
-Region to connect to.
-
-- Config:      region
-- Env Var:     RCLONE_S3_REGION
-- Type:        string
-- Default:     ""
-- Examples:
-    - "nl-ams"
-        - Amsterdam, The Netherlands
-    - "fr-par"
-        - Paris, France
-
-#### --s3-region
-
-Region to connect to.
-Leave blank if you are using an S3 clone and you don't have a region.
-
-- Config:      region
-- Env Var:     RCLONE_S3_REGION
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Use this if unsure. Will use v4 signatures and an empty region.
-    - "other-v2-signature"
-        - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.
-
-#### --s3-endpoint
-
+Choose a number from below, or type in your own value
+   / The default endpoint - a good choice if you are unsure.
+ 1 | US Region, Northern Virginia, or Pacific Northwest.
+   | Leave location constraint empty.
+   \ "us-east-1"
+   / US East (Ohio) Region
+ 2 | Needs location constraint us-east-2.
+   \ "us-east-2"
+   / US West (Oregon) Region
+ 3 | Needs location constraint us-west-2.
+   \ "us-west-2"
+   / US West (Northern California) Region
+ 4 | Needs location constraint us-west-1.
+   \ "us-west-1"
+   / Canada (Central) Region
+ 5 | Needs location constraint ca-central-1.
+   \ "ca-central-1"
+   / EU (Ireland) Region
+ 6 | Needs location constraint EU or eu-west-1.
+   \ "eu-west-1"
+   / EU (London) Region
+ 7 | Needs location constraint eu-west-2.
+   \ "eu-west-2"
+   / EU (Frankfurt) Region
+ 8 | Needs location constraint eu-central-1.
+   \ "eu-central-1"
+   / Asia Pacific (Singapore) Region
+ 9 | Needs location constraint ap-southeast-1.
+   \ "ap-southeast-1"
+   / Asia Pacific (Sydney) Region
+10 | Needs location constraint ap-southeast-2.
+   \ "ap-southeast-2"
+   / Asia Pacific (Tokyo) Region
+11 | Needs location constraint ap-northeast-1.
+   \ "ap-northeast-1"
+   / Asia Pacific (Seoul)
+12 | Needs location constraint ap-northeast-2.
+   \ "ap-northeast-2"
+   / Asia Pacific (Mumbai)
+13 | Needs location constraint ap-south-1.
+   \ "ap-south-1"
+   / Asia Pacific (Hong Kong) Region
+14 | Needs location constraint ap-east-1.
+   \ "ap-east-1"
+   / South America (Sao Paulo) Region
+15 | Needs location constraint sa-east-1.
+   \ "sa-east-1"
+region> 1
 Endpoint for S3 API.
 Leave blank if using AWS to use the default endpoint for the region.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-
-#### --s3-endpoint
-
-Endpoint for IBM COS S3 API.
-Specify if using an IBM COS On Premise.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "s3.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Endpoint
-    - "s3.dal.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Dallas Endpoint
-    - "s3.wdc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Washington DC Endpoint
-    - "s3.sjc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region San Jose Endpoint
-    - "s3.private.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Private Endpoint
-    - "s3.private.dal.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Dallas Private Endpoint
-    - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region Washington DC Private Endpoint
-    - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud"
-        - US Cross Region San Jose Private Endpoint
-    - "s3.us-east.cloud-object-storage.appdomain.cloud"
-        - US Region East Endpoint
-    - "s3.private.us-east.cloud-object-storage.appdomain.cloud"
-        - US Region East Private Endpoint
-    - "s3.us-south.cloud-object-storage.appdomain.cloud"
-        - US Region South Endpoint
-    - "s3.private.us-south.cloud-object-storage.appdomain.cloud"
-        - US Region South Private Endpoint
-    - "s3.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Endpoint
-    - "s3.fra.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Frankfurt Endpoint
-    - "s3.mil.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Milan Endpoint
-    - "s3.ams.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Amsterdam Endpoint
-    - "s3.private.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Private Endpoint
-    - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Frankfurt Private Endpoint
-    - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Milan Private Endpoint
-    - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud"
-        - EU Cross Region Amsterdam Private Endpoint
-    - "s3.eu-gb.cloud-object-storage.appdomain.cloud"
-        - Great Britain Endpoint
-    - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud"
-        - Great Britain Private Endpoint
-    - "s3.eu-de.cloud-object-storage.appdomain.cloud"
-        - EU Region DE Endpoint
-    - "s3.private.eu-de.cloud-object-storage.appdomain.cloud"
-        - EU Region DE Private Endpoint
-    - "s3.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Endpoint
-    - "s3.tok.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Tokyo Endpoint
-    - "s3.hkg.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional HongKong Endpoint
-    - "s3.seo.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Seoul Endpoint
-    - "s3.private.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Private Endpoint
-    - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Tokyo Private Endpoint
-    - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional HongKong Private Endpoint
-    - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud"
-        - APAC Cross Regional Seoul Private Endpoint
-    - "s3.jp-tok.cloud-object-storage.appdomain.cloud"
-        - APAC Region Japan Endpoint
-    - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud"
-        - APAC Region Japan Private Endpoint
-    - "s3.au-syd.cloud-object-storage.appdomain.cloud"
-        - APAC Region Australia Endpoint
-    - "s3.private.au-syd.cloud-object-storage.appdomain.cloud"
-        - APAC Region Australia Private Endpoint
-    - "s3.ams03.cloud-object-storage.appdomain.cloud"
-        - Amsterdam Single Site Endpoint
-    - "s3.private.ams03.cloud-object-storage.appdomain.cloud"
-        - Amsterdam Single Site Private Endpoint
-    - "s3.che01.cloud-object-storage.appdomain.cloud"
-        - Chennai Single Site Endpoint
-    - "s3.private.che01.cloud-object-storage.appdomain.cloud"
-        - Chennai Single Site Private Endpoint
-    - "s3.mel01.cloud-object-storage.appdomain.cloud"
-        - Melbourne Single Site Endpoint
-    - "s3.private.mel01.cloud-object-storage.appdomain.cloud"
-        - Melbourne Single Site Private Endpoint
-    - "s3.osl01.cloud-object-storage.appdomain.cloud"
-        - Oslo Single Site Endpoint
-    - "s3.private.osl01.cloud-object-storage.appdomain.cloud"
-        - Oslo Single Site Private Endpoint
-    - "s3.tor01.cloud-object-storage.appdomain.cloud"
-        - Toronto Single Site Endpoint
-    - "s3.private.tor01.cloud-object-storage.appdomain.cloud"
-        - Toronto Single Site Private Endpoint
-    - "s3.seo01.cloud-object-storage.appdomain.cloud"
-        - Seoul Single Site Endpoint
-    - "s3.private.seo01.cloud-object-storage.appdomain.cloud"
-        - Seoul Single Site Private Endpoint
-    - "s3.mon01.cloud-object-storage.appdomain.cloud"
-        - Montreal Single Site Endpoint
-    - "s3.private.mon01.cloud-object-storage.appdomain.cloud"
-        - Montreal Single Site Private Endpoint
-    - "s3.mex01.cloud-object-storage.appdomain.cloud"
-        - Mexico Single Site Endpoint
-    - "s3.private.mex01.cloud-object-storage.appdomain.cloud"
-        - Mexico Single Site Private Endpoint
-    - "s3.sjc04.cloud-object-storage.appdomain.cloud"
-        - San Jose Single Site Endpoint
-    - "s3.private.sjc04.cloud-object-storage.appdomain.cloud"
-        - San Jose Single Site Private Endpoint
-    - "s3.mil01.cloud-object-storage.appdomain.cloud"
-        - Milan Single Site Endpoint
-    - "s3.private.mil01.cloud-object-storage.appdomain.cloud"
-        - Milan Single Site Private Endpoint
-    - "s3.hkg02.cloud-object-storage.appdomain.cloud"
-        - Hong Kong Single Site Endpoint
-    - "s3.private.hkg02.cloud-object-storage.appdomain.cloud"
-        - Hong Kong Single Site Private Endpoint
-    - "s3.par01.cloud-object-storage.appdomain.cloud"
-        - Paris Single Site Endpoint
-    - "s3.private.par01.cloud-object-storage.appdomain.cloud"
-        - Paris Single Site Private Endpoint
-    - "s3.sng01.cloud-object-storage.appdomain.cloud"
-        - Singapore Single Site Endpoint
-    - "s3.private.sng01.cloud-object-storage.appdomain.cloud"
-        - Singapore Single Site Private Endpoint
-
-#### --s3-endpoint
-
-Endpoint for OSS API.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "oss-cn-hangzhou.aliyuncs.com"
-        - East China 1 (Hangzhou)
-    - "oss-cn-shanghai.aliyuncs.com"
-        - East China 2 (Shanghai)
-    - "oss-cn-qingdao.aliyuncs.com"
-        - North China 1 (Qingdao)
-    - "oss-cn-beijing.aliyuncs.com"
-        - North China 2 (Beijing)
-    - "oss-cn-zhangjiakou.aliyuncs.com"
-        - North China 3 (Zhangjiakou)
-    - "oss-cn-huhehaote.aliyuncs.com"
-        - North China 5 (Huhehaote)
-    - "oss-cn-shenzhen.aliyuncs.com"
-        - South China 1 (Shenzhen)
-    - "oss-cn-hongkong.aliyuncs.com"
-        - Hong Kong (Hong Kong)
-    - "oss-us-west-1.aliyuncs.com"
-        - US West 1 (Silicon Valley)
-    - "oss-us-east-1.aliyuncs.com"
-        - US East 1 (Virginia)
-    - "oss-ap-southeast-1.aliyuncs.com"
-        - Southeast Asia Southeast 1 (Singapore)
-    - "oss-ap-southeast-2.aliyuncs.com"
-        - Asia Pacific Southeast 2 (Sydney)
-    - "oss-ap-southeast-3.aliyuncs.com"
-        - Southeast Asia Southeast 3 (Kuala Lumpur)
-    - "oss-ap-southeast-5.aliyuncs.com"
-        - Asia Pacific Southeast 5 (Jakarta)
-    - "oss-ap-northeast-1.aliyuncs.com"
-        - Asia Pacific Northeast 1 (Japan)
-    - "oss-ap-south-1.aliyuncs.com"
-        - Asia Pacific South 1 (Mumbai)
-    - "oss-eu-central-1.aliyuncs.com"
-        - Central Europe 1 (Frankfurt)
-    - "oss-eu-west-1.aliyuncs.com"
-        - West Europe (London)
-    - "oss-me-east-1.aliyuncs.com"
-        - Middle East 1 (Dubai)
-
-#### --s3-endpoint
-
-Endpoint for Scaleway Object Storage.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "s3.nl-ams.scw.cloud"
-        - Amsterdam Endpoint
-    - "s3.fr-par.scw.cloud"
-        - Paris Endpoint
-
-#### --s3-endpoint
-
-Endpoint for StackPath Object Storage.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "s3.us-east-2.stackpathstorage.com"
-        - US East Endpoint
-    - "s3.us-west-1.stackpathstorage.com"
-        - US West Endpoint
-    - "s3.eu-central-1.stackpathstorage.com"
-        - EU Endpoint
-
-#### --s3-endpoint
-
-Endpoint for S3 API.
-Required when using an S3 clone.
-
-- Config:      endpoint
-- Env Var:     RCLONE_S3_ENDPOINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "objects-us-east-1.dream.io"
-        - Dream Objects endpoint
-    - "nyc3.digitaloceanspaces.com"
-        - Digital Ocean Spaces New York 3
-    - "ams3.digitaloceanspaces.com"
-        - Digital Ocean Spaces Amsterdam 3
-    - "sgp1.digitaloceanspaces.com"
-        - Digital Ocean Spaces Singapore 1
-    - "s3.wasabisys.com"
-        - Wasabi US East endpoint
-    - "s3.us-west-1.wasabisys.com"
-        - Wasabi US West endpoint
-    - "s3.eu-central-1.wasabisys.com"
-        - Wasabi EU Central endpoint
-
-#### --s3-location-constraint
-
-Location constraint - must be set to match the Region.
-Used when creating buckets only.
-
-- Config:      location_constraint
-- Env Var:     RCLONE_S3_LOCATION_CONSTRAINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Empty for US Region, Northern Virginia or Pacific Northwest.
-    - "us-east-2"
-        - US East (Ohio) Region.
-    - "us-west-2"
-        - US West (Oregon) Region.
-    - "us-west-1"
-        - US West (Northern California) Region.
-    - "ca-central-1"
-        - Canada (Central) Region.
-    - "eu-west-1"
-        - EU (Ireland) Region.
-    - "eu-west-2"
-        - EU (London) Region.
-    - "eu-north-1"
-        - EU (Stockholm) Region.
-    - "EU"
-        - EU Region.
-    - "ap-southeast-1"
-        - Asia Pacific (Singapore) Region.
-    - "ap-southeast-2"
-        - Asia Pacific (Sydney) Region.
-    - "ap-northeast-1"
-        - Asia Pacific (Tokyo) Region.
-    - "ap-northeast-2"
-        - Asia Pacific (Seoul)
-    - "ap-south-1"
-        - Asia Pacific (Mumbai)
-    - "ap-east-1"
-        - Asia Pacific (Hong Kong)
-    - "sa-east-1"
-        - South America (Sao Paulo) Region.
-
-#### --s3-location-constraint
-
-Location constraint - must match endpoint when using IBM Cloud Public.
-For on-prem COS, do not make a selection from this list, hit enter
-
-- Config:      location_constraint
-- Env Var:     RCLONE_S3_LOCATION_CONSTRAINT
-- Type:        string
-- Default:     ""
-- Examples:
-    - "us-standard"
-        - US Cross Region Standard
-    - "us-vault"
-        - US Cross Region Vault
-    - "us-cold"
-        - US Cross Region Cold
-    - "us-flex"
-        - US Cross Region Flex
-    - "us-east-standard"
-        - US East Region Standard
-    - "us-east-vault"
-        - US East Region Vault
-    - "us-east-cold"
-        - US East Region Cold
-    - "us-east-flex"
-        - US East Region Flex
-    - "us-south-standard"
-        - US South Region Standard
-    - "us-south-vault"
-        - US South Region Vault
-    - "us-south-cold"
-        - US South Region Cold
-    - "us-south-flex"
-        - US South Region Flex
-    - "eu-standard"
-        - EU Cross Region Standard
-    - "eu-vault"
-        - EU Cross Region Vault
-    - "eu-cold"
-        - EU Cross Region Cold
-    - "eu-flex"
-        - EU Cross Region Flex
-    - "eu-gb-standard"
-        - Great Britain Standard
-    - "eu-gb-vault"
-        - Great Britain Vault
-    - "eu-gb-cold"
-        - Great Britain Cold
-    - "eu-gb-flex"
-        - Great Britain Flex
-    - "ap-standard"
-        - APAC Standard
-    - "ap-vault"
-        - APAC Vault
-    - "ap-cold"
-        - APAC Cold
-    - "ap-flex"
-        - APAC Flex
-    - "mel01-standard"
-        - Melbourne Standard
-    - "mel01-vault"
-        - Melbourne Vault
-    - "mel01-cold"
-        - Melbourne Cold
-    - "mel01-flex"
-        - Melbourne Flex
-    - "tor01-standard"
-        - Toronto Standard
-    - "tor01-vault"
-        - Toronto Vault
-    - "tor01-cold"
-        - Toronto Cold
-    - "tor01-flex"
-        - Toronto Flex
-
-#### --s3-location-constraint
-
-Location constraint - must be set to match the Region.
-Leave blank if not sure. Used when creating buckets only.
-
-- Config:      location_constraint
-- Env Var:     RCLONE_S3_LOCATION_CONSTRAINT
-- Type:        string
-- Default:     ""
-
-#### --s3-acl
-
-Canned ACL used when creating buckets and storing or copying objects.
-
-This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.
-
+endpoint> 
+Location constraint - must be set to match the Region. Used when creating buckets only.
+Choose a number from below, or type in your own value
+ 1 / Empty for US Region, Northern Virginia, or Pacific Northwest.
+   \ ""
+ 2 / US East (Ohio) Region.
+   \ "us-east-2"
+ 3 / US West (Oregon) Region.
+   \ "us-west-2"
+ 4 / US West (Northern California) Region.
+   \ "us-west-1"
+ 5 / Canada (Central) Region.
+   \ "ca-central-1"
+ 6 / EU (Ireland) Region.
+   \ "eu-west-1"
+ 7 / EU (London) Region.
+   \ "eu-west-2"
+ 8 / EU Region.
+   \ "EU"
+ 9 / Asia Pacific (Singapore) Region.
+   \ "ap-southeast-1"
+10 / Asia Pacific (Sydney) Region.
+   \ "ap-southeast-2"
+11 / Asia Pacific (Tokyo) Region.
+   \ "ap-northeast-1"
+12 / Asia Pacific (Seoul)
+   \ "ap-northeast-2"
+13 / Asia Pacific (Mumbai)
+   \ "ap-south-1"
+14 / Asia Pacific (Hong Kong)
+   \ "ap-east-1"
+15 / South America (Sao Paulo) Region.
+   \ "sa-east-1"
+location_constraint> 1
+Canned ACL used when creating buckets and/or storing objects in S3.
 For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
-
-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
-
+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.
-
-- Config:      server_side_encryption
-- Env Var:     RCLONE_S3_SERVER_SIDE_ENCRYPTION
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-    - "AES256"
-        - AES256
-    - "aws:kms"
-        - aws:kms
-
-#### --s3-sse-kms-key-id
-
-If using KMS ID you must provide the ARN of Key.
-
-- Config:      sse_kms_key_id
-- Env Var:     RCLONE_S3_SSE_KMS_KEY_ID
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-    - "arn:aws:kms:us-east-1:*"
-        - arn:aws:kms:*
-
-#### --s3-storage-class
-
-The storage class to use when storing new objects in S3.
-
-- Config:      storage_class
-- Env Var:     RCLONE_S3_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "STANDARD"
-        - Standard storage class
-    - "REDUCED_REDUNDANCY"
-        - Reduced redundancy storage class
-    - "STANDARD_IA"
-        - Standard Infrequent Access storage class
-    - "ONEZONE_IA"
-        - One Zone Infrequent Access storage class
-    - "GLACIER"
-        - Glacier storage class
-    - "DEEP_ARCHIVE"
-        - Glacier Deep Archive storage class
-    - "INTELLIGENT_TIERING"
-        - Intelligent-Tiering storage class
-
-#### --s3-storage-class
-
-The storage class to use when storing new objects in OSS.
-
-- Config:      storage_class
-- Env Var:     RCLONE_S3_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "STANDARD"
-        - Standard storage class
-    - "GLACIER"
-        - Archive storage mode.
-    - "STANDARD_IA"
-        - Infrequent access storage mode.
-
-#### --s3-storage-class
-
-The storage class to use when storing new objects in S3.
-
-- Config:      storage_class
-- Env Var:     RCLONE_S3_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "STANDARD"
-        - The Standard class for any upload; suitable for on-demand content like streaming or CDN.
-    - "GLACIER"
-        - Archived storage; prices are lower, but it needs to be restored first to be accessed.
-
-### Advanced Options
-
-Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)).
-
-#### --s3-bucket-acl
-
-Canned ACL used when creating buckets.
-
-For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
-
-Note that this ACL is applied when only when creating buckets.  If it
-isn't set then "acl" is used instead.
-
-- Config:      bucket_acl
-- Env Var:     RCLONE_S3_BUCKET_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "private"
-        - Owner gets FULL_CONTROL. No one else has access rights (default).
-    - "public-read"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ access.
-    - "public-read-write"
-        - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
-        - Granting this on a bucket is generally not recommended.
-    - "authenticated-read"
-        - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
-
-#### --s3-sse-customer-algorithm
-
-If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
-
-- Config:      sse_customer_algorithm
-- Env Var:     RCLONE_S3_SSE_CUSTOMER_ALGORITHM
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-    - "AES256"
-        - AES256
-
-#### --s3-sse-customer-key
-
-If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
-
-- Config:      sse_customer_key
-- Env Var:     RCLONE_S3_SSE_CUSTOMER_KEY
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-
-#### --s3-sse-customer-key-md5
-
-If using SSE-C you must provide the secret encryption key MD5 checksum.
-
-- Config:      sse_customer_key_md5
-- Env Var:     RCLONE_S3_SSE_CUSTOMER_KEY_MD5
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - None
-
-#### --s3-upload-cutoff
-
-Cutoff for switching to chunked upload
-
-Any files larger than this will be uploaded in chunks of chunk_size.
-The minimum is 0 and the maximum is 5GB.
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_S3_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     200M
-
-#### --s3-chunk-size
-
-Chunk size to use for uploading.
-
-When uploading files larger than upload_cutoff or files with unknown
-size (eg from "rclone rcat" or uploaded with "rclone mount" or google
-photos or google docs) they will be uploaded as multipart uploads
-using this chunk size.
-
-Note that "--s3-upload-concurrency" chunks of this size are buffered
-in memory per transfer.
-
-If you are transferring large files over high speed links and you have
-enough memory, then increasing this will speed up the transfers.
-
-Rclone will automatically increase the chunk size when uploading a
-large file of known size to stay below the 10,000 chunks limit.
-
-Files of unknown size are uploaded with the configured
-chunk_size. Since the default chunk size is 5MB and there can be at
-most 10,000 chunks, this means that by default the maximum size of
-file you can stream upload is 48GB.  If you wish to stream upload
-larger files then you will need to increase chunk_size.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_S3_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     5M
-
-#### --s3-max-upload-parts
-
-Maximum number of parts in a multipart upload.
-
-This option defines the maximum number of multipart chunks to use
-when doing a multipart upload.
-
-This can be useful if a service does not support the AWS S3
-specification of 10,000 chunks.
-
-Rclone will automatically increase the chunk size when uploading a
-large file of a known size to stay below this number of chunks limit.
-
-
-- Config:      max_upload_parts
-- Env Var:     RCLONE_S3_MAX_UPLOAD_PARTS
-- Type:        int
-- Default:     10000
-
-#### --s3-copy-cutoff
-
-Cutoff for switching to multipart copy
-
-Any files larger than this that need to be server side copied will be
-copied in chunks of this size.
-
-The minimum is 0 and the maximum is 5GB.
-
-- Config:      copy_cutoff
-- Env Var:     RCLONE_S3_COPY_CUTOFF
-- Type:        SizeSuffix
-- Default:     4.656G
-
-#### --s3-disable-checksum
-
-Don't store MD5 checksum with object metadata
-
-Normally rclone will calculate the MD5 checksum of the input before
-uploading it so it can add it to metadata on the object. This is great
-for data integrity checking but can cause long delays for large files
-to start uploading.
-
-- Config:      disable_checksum
-- Env Var:     RCLONE_S3_DISABLE_CHECKSUM
-- Type:        bool
-- Default:     false
-
-#### --s3-shared-credentials-file
-
-Path to the shared credentials file
-
-If env_auth = true then rclone can use a shared credentials file.
-
-If this variable is empty rclone will look for the
-"AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty
-it will default to the current user's home directory.
-
-    Linux/OSX: "$HOME/.aws/credentials"
-    Windows:   "%USERPROFILE%\.aws\credentials"
-
-
-- Config:      shared_credentials_file
-- Env Var:     RCLONE_S3_SHARED_CREDENTIALS_FILE
-- Type:        string
-- Default:     ""
-
-#### --s3-profile
-
-Profile to use in the shared credentials file
-
-If env_auth = true then rclone can use a shared credentials file. This
-variable controls which profile is used in that file.
-
-If empty it will default to the environment variable "AWS_PROFILE" or
-"default" if that environment variable is also not set.
-
-
-- Config:      profile
-- Env Var:     RCLONE_S3_PROFILE
-- Type:        string
-- Default:     ""
-
-#### --s3-session-token
-
-An AWS session token
-
-- Config:      session_token
-- Env Var:     RCLONE_S3_SESSION_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --s3-upload-concurrency
-
-Concurrency for multipart uploads.
-
-This is the number of chunks of the same file that are uploaded
-concurrently.
-
-If you are uploading small numbers of large file over high speed link
-and these uploads do not fully utilize your bandwidth, then increasing
-this may help to speed up the transfers.
-
-- Config:      upload_concurrency
-- Env Var:     RCLONE_S3_UPLOAD_CONCURRENCY
-- Type:        int
-- Default:     4
-
-#### --s3-force-path-style
-
-If true use path style access if false use virtual hosted style.
-
-If this is true (the default) then rclone will use path style access,
-if false then rclone will use virtual path style. See [the AWS S3
-docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)
-for more info.
-
-Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to
-false - rclone will do this automatically based on the provider
-setting.
-
-- Config:      force_path_style
-- Env Var:     RCLONE_S3_FORCE_PATH_STYLE
-- Type:        bool
-- Default:     true
-
-#### --s3-v2-auth
-
-If true use v2 authentication.
-
-If this is false (the default) then rclone will use v4 authentication.
-If it is set then rclone will use v2 authentication.
-
-Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH.
-
-- Config:      v2_auth
-- Env Var:     RCLONE_S3_V2_AUTH
-- Type:        bool
-- Default:     false
-
-#### --s3-use-accelerate-endpoint
-
-If true use the AWS S3 accelerated endpoint.
-
-See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html)
-
-- Config:      use_accelerate_endpoint
-- Env Var:     RCLONE_S3_USE_ACCELERATE_ENDPOINT
-- Type:        bool
-- Default:     false
-
-#### --s3-leave-parts-on-error
-
-If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
-
-It should be set to true for resuming uploads across different sessions.
-
-WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.
-
-
-- Config:      leave_parts_on_error
-- Env Var:     RCLONE_S3_LEAVE_PARTS_ON_ERROR
-- Type:        bool
-- Default:     false
-
-#### --s3-list-chunk
-
-Size of listing chunk (response list for each ListObject S3 request).
-
-This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification.
-Most services truncate the response list to 1000 objects even if requested more than that.
-In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html).
-In Ceph, this can be increased with the "rgw list buckets max chunk" option.
-
-
-- Config:      list_chunk
-- Env Var:     RCLONE_S3_LIST_CHUNK
-- Type:        int
-- Default:     1000
-
-#### --s3-no-check-bucket
-
-If set don't attempt to check the bucket exists or create it
-
-This can be useful when trying to minimise the number of transactions
-rclone does if you know the bucket exists already.
-
-
-- Config:      no_check_bucket
-- Env Var:     RCLONE_S3_NO_CHECK_BUCKET
-- Type:        bool
-- Default:     false
-
-#### --s3-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_S3_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,InvalidUtf8,Dot
-
-#### --s3-memory-pool-flush-time
-
-How often internal memory buffer pools will be flushed.
-Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations.
-This option controls how often unused buffers will be removed from the pool.
-
-- Config:      memory_pool_flush_time
-- Env Var:     RCLONE_S3_MEMORY_POOL_FLUSH_TIME
-- Type:        Duration
-- Default:     1m0s
-
-#### --s3-memory-pool-use-mmap
-
-Whether to use mmap buffers in internal memory pool.
-
-- Config:      memory_pool_use_mmap
-- Env Var:     RCLONE_S3_MEMORY_POOL_USE_MMAP
-- Type:        bool
-- Default:     false
-
-### Backend commands
-
-Here are the commands specific to the s3 backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### restore
-
-Restore objects from GLACIER to normal storage
-
-    rclone backend restore remote: [options] [<arguments>+]
-
-This command can be used to restore one or more objects from GLACIER
-to normal storage.
-
-Usage Examples:
-
-    rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]
-    rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]
-    rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]
-
-This flag also obeys the filters. Test first with -i/--interactive or --dry-run flags
-
-    rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard
-
-All the objects shown will be marked for restore, then
-
-    rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard
-
-It returns a list of status dictionaries with Remote and Status
-keys. The Status will be OK if it was successfull or an error message
-if not.
-
-    [
+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> 
    
+
    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.
    
+
    Note that reading this from the object takes an additional HEAD request as the metadata isn't returned in object listings.
    
+
    Reducing costs
    
+
    Avoiding HEAD requests to read the modification time
    
+
    By default rclone will use the modification time of objects stored in S3 for syncing. This is stored in object metadata which unfortunately takes an extra HEAD request to read which can be expensive (in time and money).
    
+
    The modification time 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 on S3 because it requires an extra API call to retrieve the metadata.
    
+
    The extra API calls can be avoided when syncing (using rclone sync or rclone copy) in a few different ways, each with its own tradeoffs.
    
+
      
+
    • --size-only
+
        
+
      • Only checks the size of files.
        • 
+
      • Uses no extra transactions.
        • 
+
      • If the file doesn't change size then rclone won't detect it has changed.
        • 
+
      • rclone sync --size-only /path/to/source s3:bucket
        • 
+
      • 
+
    • --checksum
+
        
+
      • Checks the size and MD5 checksum of files.
        • 
+
      • Uses no extra transactions.
        • 
+
      • The most accurate detection of changes possible.
        • 
+
      • Will cause the source to read an MD5 checksum which, if it is a local disk, will cause lots of disk activity.
        • 
+
      • If the source and destination are both S3 this is the recommended flag to use for maximum efficiency.
        • 
+
      • rclone sync --checksum /path/to/source s3:bucket
        • 
+
      • 
+
    • --update --use-server-modtime
+
        
+
      • Uses no extra transactions.
        • 
+
      • Modification time becomes the time the object was uploaded.
        • 
+
      • For many operations this is sufficient to determine if it needs uploading.
        • 
+
      • Using --update along with --use-server-modtime, avoids the extra API call and uploads files whose local modification time is newer than the time it was last uploaded.
        • 
+
      • Files created with timestamps in the past will be missed by the sync.
        • 
+
      • rclone sync --update --use-server-modtime /path/to/source s3:bucket
        • 
+
      • 
+
    
+
    These flags can and should be used in combination with --fast-list - see below.
    
+
    If using rclone mount or any command using the VFS (eg rclone serve) commands then you might want to consider using the VFS flag --no-modtime which will stop rclone reading the modification time for every object. You could also use --use-server-modtime if you are happy with the modification times of the objects being the time of upload.
    
+
    Avoiding GET requests to read directory listings
    
+
    Rclone's default directory traversal is to process each directory individually. This takes one API call per directory. Using the --fast-list flag will read all info about the the objects into memory first using a smaller number of API calls (one per 1000 objects). See the rclone docs for more details.
    
+
    rclone sync --fast-list --checksum /path/to/source s3:bucket
    
+
    --fast-list trades off API transactions for memory use. As a rough guide rclone uses 1k of memory per object stored, so using --fast-list on a sync of a million objects will use roughly 1 GB of RAM.
    
+
    If you are only copying a small number of files into a big repository then using --no-traverse is a good idea. This finds objects directly instead of through directory listings. You can do a "top-up" sync very cheaply by using --max-age and --no-traverse to copy only recent files, eg
    
+
    rclone copy --min-age 24h --no-traverse /path/to/source s3:bucket
    
+
    You'd then do a full rclone sync less often.
    
+
    Note that --fast-list isn't required in the top-up sync.
    
+
    Hashes
    
+
    For small objects which weren't uploaded as multipart uploads (objects sized below --s3-upload-cutoff if uploaded with rclone) rclone uses the ETag: header as an MD5 checksum.
    
+
    However for objects which were uploaded as multipart uploads or with server side encryption (SSE-AWS or SSE-C) the ETag header is no longer the MD5 sum of the data, so rclone adds an additional piece of metadata X-Amz-Meta-Md5chksum which is a base64 encoded MD5 hash (in the same format as is required for Content-MD5).
    
+
    For large objects, calculating this hash can take some time so the addition of this hash can be disabled with --s3-disable-checksum. This will mean that these objects do not have an MD5 checksum.
    
+
    Note that reading this from the object takes an additional HEAD request as the metadata isn't returned in object listings.
    
+
    Cleanup
    
+
    If you run rclone cleanup s3:bucket then it will remove all pending multipart uploads older than 24 hours. You can use the -i flag to see exactly what it will do. If you want more control over the expiry date then run rclone backend cleanup s3:bucket -o max-age=1h to expire all uploads older than one hour. You can use rclone backend list-multipart-uploads s3:bucket to see the pending multipart uploads.
    
+
    Restricted filename characters
    
+
    S3 allows any valid UTF-8 string as a key.
    
+
    Invalid UTF-8 bytes will be replaced, as they can't be used in XML.
    
+
    The following characters are replaced since these are problematic when dealing with the REST API:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    NUL0x00␀
    /0x2F／
    
+
    The encoding will also encode these file names as they don't seem to work with the SDK properly:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    File nameReplacement
    .．
    ..．．
    
+
    Multipart uploads
    
+
    rclone supports multipart uploads with S3 which means that it can upload files bigger than 5GB.
    
+
    Note that files uploaded both with multipart upload and through crypt remotes do not have MD5 sums.
    
+
    rclone switches from single part uploads to multipart uploads at the point specified by --s3-upload-cutoff. This can be a maximum of 5GB and a minimum of 0 (ie always upload multipart files).
    
+
    The chunk sizes used in the multipart upload are specified by --s3-chunk-size and the number of chunks uploaded concurrently is specified by --s3-upload-concurrency.
    
+
    Multipart uploads will use --transfers * --s3-upload-concurrency * --s3-chunk-size extra memory. Single part uploads to not use extra memory.
    
+
    Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 - the more latency, the more likely single part transfers will be faster.
    
+
    Increasing --s3-upload-concurrency will increase throughput (8 would be a sensible value) and increasing --s3-chunk-size also increases throughput (16M would be sensible). Increasing either of these will use more memory. The default values are high enough to gain most of the possible performance without using too much memory.
    
+
    Buckets and Regions
    
+
    With Amazon S3 you can list buckets (rclone lsd) using any region, but you can only access the content of a bucket from the region it was created in. If you attempt to access a bucket from the wrong region, you will get an error, incorrect region, the bucket is not in 'XXX' region.
    
+
    Authentication
    
+
    There are a number of ways to supply rclone with a set of AWS credentials, with and without using the environment.
    
+
    The different authentication methods are tried in this order:
    
+
      
+
    • Directly in the rclone configuration file (env_auth = false in the config file):
+
        
+
      • access_key_id and secret_access_key are required.
        • 
+
      • session_token can be optionally set when using AWS STS.
        • 
+
      • 
+
    • Runtime configuration (env_auth = true in the config file):
+
        
+
      • Export the following environment variables before running rclone:
+
          
+
        • Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY
          • 
+
        • Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY
          • 
+
        • Session Token: AWS_SESSION_TOKEN (optional)
          • 
+
        • 
+
      • Or, use a named profile:
+
          
+
        • Profile files are standard files used by AWS CLI tools
          • 
+
        • By default it will use the profile in your home directory (e.g. ~/.aws/credentials on unix based systems) file and the "default" profile, to change set these environment variables:
+
            
+
          • AWS_SHARED_CREDENTIALS_FILE to control which file.
            • 
+
          • AWS_PROFILE to control which profile to use.
            • 
+
          • 
+
        • 
+
      • Or, run rclone in an ECS task with an IAM role (AWS only).
        • 
+
      • Or, run rclone on an EC2 instance with an IAM role (AWS only).
        • 
+
      • Or, run rclone in an EKS pod with an IAM role that is associated with a service account (AWS only).
        • 
+
      • 
+
    
+
    If none of these option actually end up providing rclone with AWS credentials then S3 interaction will be non-authenticated (see below).
    
+
    S3 Permissions
    
+
    When using the sync subcommand of rclone the following minimum permissions are required to be available on the bucket being written to:
    
+
      
+
    • ListBucket
      • 
+
    • DeleteObject
      • 
+
    • GetObject
      • 
+
    • PutObject
      • 
+
    • PutObjectACL
      • 
+
    
+
    When using the lsd subcommand, the ListAllMyBuckets permission is required.
    
+
    Example policy:
    
+
    {
+    "Version": "2012-10-17",
+    "Statement": [
         {
-            "Status": "OK",
-            "Path": "test.txt"
+            "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"
+            ]
         },
         {
-            "Status": "OK",
-            "Path": "test/file4.txt"
-        }
+            "Effect": "Allow",
+            "Action": "s3:ListAllMyBuckets",
+            "Resource": "arn:aws:s3:::*"
+        }   
     ]
-
-
-
-Options:
-
-- "description": The optional description for the job.
-- "lifetime": Lifetime of the active copy in days
-- "priority": Priority of restore: Standard|Expedited|Bulk
-
-#### list-multipart-uploads
-
-List the unfinished multipart uploads
-
-    rclone backend list-multipart-uploads remote: [options] [<arguments>+]
-
-This command lists the unfinished multipart uploads in JSON format.
-
-    rclone backend list-multipart s3:bucket/path/to/object
-
-It returns a dictionary of buckets with values as lists of unfinished
-multipart uploads.
-
-You can call it with no bucket in which case it lists all bucket, with
-a bucket or with a bucket and path.
-
+}
    
+
    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 must make sure rclone is configured with server_side_encryption = aws:kms otherwise you will find you can't transfer small objects - these will create checksum errors.
    
+
    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 Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS).
    
+
    --s3-provider
    
+
    Choose your S3 provider.
    
+
      
+
    • Config: provider
      • 
+
    • Env Var: RCLONE_S3_PROVIDER
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "AWS"
+
          
+
        • Amazon Web Services (AWS) S3
          • 
+
        • 
+
      • "Alibaba"
+
          
+
        • Alibaba Cloud Object Storage System (OSS) formerly Aliyun
          • 
+
        • 
+
      • "Ceph"
+
          
+
        • Ceph Object Storage
          • 
+
        • 
+
      • "DigitalOcean"
+
          
+
        • Digital Ocean Spaces
          • 
+
        • 
+
      • "Dreamhost"
+
          
+
        • Dreamhost DreamObjects
          • 
+
        • 
+
      • "IBMCOS"
+
          
+
        • IBM COS S3
          • 
+
        • 
+
      • "Minio"
+
          
+
        • Minio Object Storage
          • 
+
        • 
+
      • "Netease"
+
          
+
        • Netease Object Storage (NOS)
          • 
+
        • 
+
      • "Scaleway"
+
          
+
        • Scaleway Object Storage
          • 
+
        • 
+
      • "StackPath"
+
          
+
        • StackPath Object Storage
          • 
+
        • 
+
      • "TencentCOS"
+
          
+
        • Tencent Cloud Object Storage (COS)
          • 
+
        • 
+
      • "Wasabi"
+
          
+
        • Wasabi Object Storage
          • 
+
        • 
+
      • "Other"
+
          
+
        • Any other S3 compatible provider
          • 
+
        • 
+
      • 
+
    
+
    --s3-env-auth
    
+
    Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
    
+
      
+
    • Config: env_auth
      • 
+
    • Env Var: RCLONE_S3_ENV_AUTH
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    • Examples:
+
        
+
      • "false"
+
          
+
        • Enter AWS credentials in the next step
          • 
+
        • 
+
      • "true"
+
          
+
        • Get AWS credentials from the environment (env vars or IAM)
          • 
+
        • 
+
      • 
+
    
+
    --s3-access-key-id
    
+
    AWS Access Key ID. Leave blank for anonymous access or runtime credentials.
    
+
      
+
    • Config: access_key_id
      • 
+
    • Env Var: RCLONE_S3_ACCESS_KEY_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-secret-access-key
    
+
    AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials.
    
+
      
+
    • Config: secret_access_key
      • 
+
    • Env Var: RCLONE_S3_SECRET_ACCESS_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-region
    
+
    Region to connect to.
    
+
      
+
    • Config: region
      • 
+
    • Env Var: RCLONE_S3_REGION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "us-east-1"
+
          
+
        • The default endpoint - a good choice if you are unsure.
          • 
+
        • US Region, Northern Virginia, or Pacific Northwest.
          • 
+
        • Leave location constraint empty.
          • 
+
        • 
+
      • "us-east-2"
+
          
+
        • US East (Ohio) Region
          • 
+
        • Needs location constraint us-east-2.
          • 
+
        • 
+
      • "us-west-1"
+
          
+
        • US West (Northern California) Region
          • 
+
        • Needs location constraint us-west-1.
          • 
+
        • 
+
      • "us-west-2"
+
          
+
        • US West (Oregon) Region
          • 
+
        • Needs location constraint us-west-2.
          • 
+
        • 
+
      • "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-west-3"
+
          
+
        • EU (Paris) Region
          • 
+
        • Needs location constraint eu-west-3.
          • 
+
        • 
+
      • "eu-north-1"
+
          
+
        • EU (Stockholm) Region
          • 
+
        • Needs location constraint eu-north-1.
          • 
+
        • 
+
      • "eu-south-1"
+
          
+
        • EU (Milan) Region
          • 
+
        • Needs location constraint eu-south-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-northeast-3"
+
          
+
        • Asia Pacific (Osaka-Local)
          • 
+
        • Needs location constraint ap-northeast-3.
          • 
+
        • 
+
      • "ap-south-1"
+
          
+
        • Asia Pacific (Mumbai)
          • 
+
        • Needs location constraint ap-south-1.
          • 
+
        • 
+
      • "ap-east-1"
+
          
+
        • Asia Pacific (Hong Kong) Region
          • 
+
        • Needs location constraint ap-east-1.
          • 
+
        • 
+
      • "sa-east-1"
+
          
+
        • South America (Sao Paulo) Region
          • 
+
        • Needs location constraint sa-east-1.
          • 
+
        • 
+
      • "me-south-1"
+
          
+
        • Middle East (Bahrain) Region
          • 
+
        • Needs location constraint me-south-1.
          • 
+
        • 
+
      • "af-south-1"
+
          
+
        • Africa (Cape Town) Region
          • 
+
        • Needs location constraint af-south-1.
          • 
+
        • 
+
      • "cn-north-1"
+
          
+
        • China (Beijing) Region
          • 
+
        • Needs location constraint cn-north-1.
          • 
+
        • 
+
      • "cn-northwest-1"
+
          
+
        • China (Ningxia) Region
          • 
+
        • Needs location constraint cn-northwest-1.
          • 
+
        • 
+
      • "us-gov-east-1"
+
          
+
        • AWS GovCloud (US-East) Region
          • 
+
        • Needs location constraint us-gov-east-1.
          • 
+
        • 
+
      • "us-gov-west-1"
+
          
+
        • AWS GovCloud (US) Region
          • 
+
        • Needs location constraint us-gov-west-1.
          • 
+
        • 
+
      • 
+
    
+
    --s3-region
    
+
    Region to connect to.
    
+
      
+
    • Config: region
      • 
+
    • Env Var: RCLONE_S3_REGION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "nl-ams"
+
          
+
        • Amsterdam, The Netherlands
          • 
+
        • 
+
      • "fr-par"
+
          
+
        • Paris, France
          • 
+
        • 
+
      • 
+
    
+
    --s3-region
    
+
    Region to connect to. Leave blank if you are using an S3 clone and you don't have a region.
    
+
      
+
    • Config: region
      • 
+
    • Env Var: RCLONE_S3_REGION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Use this if unsure. Will use v4 signatures and an empty region.
          • 
+
        • 
+
      • "other-v2-signature"
+
          
+
        • Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH.
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "s3.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Endpoint
          • 
+
        • 
+
      • "s3.dal.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Dallas Endpoint
          • 
+
        • 
+
      • "s3.wdc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Washington DC Endpoint
          • 
+
        • 
+
      • "s3.sjc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region San Jose Endpoint
          • 
+
        • 
+
      • "s3.private.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Private Endpoint
          • 
+
        • 
+
      • "s3.private.dal.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Dallas Private Endpoint
          • 
+
        • 
+
      • "s3.private.wdc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region Washington DC Private Endpoint
          • 
+
        • 
+
      • "s3.private.sjc.us.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Cross Region San Jose Private Endpoint
          • 
+
        • 
+
      • "s3.us-east.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region East Endpoint
          • 
+
        • 
+
      • "s3.private.us-east.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region East Private Endpoint
          • 
+
        • 
+
      • "s3.us-south.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region South Endpoint
          • 
+
        • 
+
      • "s3.private.us-south.cloud-object-storage.appdomain.cloud"
+
          
+
        • US Region South Private Endpoint
          • 
+
        • 
+
      • "s3.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Endpoint
          • 
+
        • 
+
      • "s3.fra.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Frankfurt Endpoint
          • 
+
        • 
+
      • "s3.mil.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Milan Endpoint
          • 
+
        • 
+
      • "s3.ams.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Amsterdam Endpoint
          • 
+
        • 
+
      • "s3.private.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Private Endpoint
          • 
+
        • 
+
      • "s3.private.fra.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Frankfurt Private Endpoint
          • 
+
        • 
+
      • "s3.private.mil.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Milan Private Endpoint
          • 
+
        • 
+
      • "s3.private.ams.eu.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Cross Region Amsterdam Private Endpoint
          • 
+
        • 
+
      • "s3.eu-gb.cloud-object-storage.appdomain.cloud"
+
          
+
        • Great Britain Endpoint
          • 
+
        • 
+
      • "s3.private.eu-gb.cloud-object-storage.appdomain.cloud"
+
          
+
        • Great Britain Private Endpoint
          • 
+
        • 
+
      • "s3.eu-de.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Region DE Endpoint
          • 
+
        • 
+
      • "s3.private.eu-de.cloud-object-storage.appdomain.cloud"
+
          
+
        • EU Region DE Private Endpoint
          • 
+
        • 
+
      • "s3.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Endpoint
          • 
+
        • 
+
      • "s3.tok.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Tokyo Endpoint
          • 
+
        • 
+
      • "s3.hkg.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional HongKong Endpoint
          • 
+
        • 
+
      • "s3.seo.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Seoul Endpoint
          • 
+
        • 
+
      • "s3.private.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Private Endpoint
          • 
+
        • 
+
      • "s3.private.tok.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Tokyo Private Endpoint
          • 
+
        • 
+
      • "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional HongKong Private Endpoint
          • 
+
        • 
+
      • "s3.private.seo.ap.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Cross Regional Seoul Private Endpoint
          • 
+
        • 
+
      • "s3.jp-tok.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Japan Endpoint
          • 
+
        • 
+
      • "s3.private.jp-tok.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Japan Private Endpoint
          • 
+
        • 
+
      • "s3.au-syd.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Australia Endpoint
          • 
+
        • 
+
      • "s3.private.au-syd.cloud-object-storage.appdomain.cloud"
+
          
+
        • APAC Region Australia Private Endpoint
          • 
+
        • 
+
      • "s3.ams03.cloud-object-storage.appdomain.cloud"
+
          
+
        • Amsterdam Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.ams03.cloud-object-storage.appdomain.cloud"
+
          
+
        • Amsterdam Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.che01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Chennai Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.che01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Chennai Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mel01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Melbourne Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mel01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Melbourne Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.osl01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Oslo Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.osl01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Oslo Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.tor01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Toronto Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.tor01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Toronto Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.seo01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Seoul Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.seo01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Seoul Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mon01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Montreal Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mon01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Montreal Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mex01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Mexico Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mex01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Mexico Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.sjc04.cloud-object-storage.appdomain.cloud"
+
          
+
        • San Jose Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.sjc04.cloud-object-storage.appdomain.cloud"
+
          
+
        • San Jose Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.mil01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Milan Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.mil01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Milan Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.hkg02.cloud-object-storage.appdomain.cloud"
+
          
+
        • Hong Kong Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.hkg02.cloud-object-storage.appdomain.cloud"
+
          
+
        • Hong Kong Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.par01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Paris Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.par01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Paris Single Site Private Endpoint
          • 
+
        • 
+
      • "s3.sng01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Singapore Single Site Endpoint
          • 
+
        • 
+
      • "s3.private.sng01.cloud-object-storage.appdomain.cloud"
+
          
+
        • Singapore Single Site Private Endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for OSS API.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "oss-cn-hangzhou.aliyuncs.com"
+
          
+
        • East China 1 (Hangzhou)
          • 
+
        • 
+
      • "oss-cn-shanghai.aliyuncs.com"
+
          
+
        • East China 2 (Shanghai)
          • 
+
        • 
+
      • "oss-cn-qingdao.aliyuncs.com"
+
          
+
        • North China 1 (Qingdao)
          • 
+
        • 
+
      • "oss-cn-beijing.aliyuncs.com"
+
          
+
        • North China 2 (Beijing)
          • 
+
        • 
+
      • "oss-cn-zhangjiakou.aliyuncs.com"
+
          
+
        • North China 3 (Zhangjiakou)
          • 
+
        • 
+
      • "oss-cn-huhehaote.aliyuncs.com"
+
          
+
        • North China 5 (Huhehaote)
          • 
+
        • 
+
      • "oss-cn-shenzhen.aliyuncs.com"
+
          
+
        • South China 1 (Shenzhen)
          • 
+
        • 
+
      • "oss-cn-hongkong.aliyuncs.com"
+
          
+
        • Hong Kong (Hong Kong)
          • 
+
        • 
+
      • "oss-us-west-1.aliyuncs.com"
+
          
+
        • US West 1 (Silicon Valley)
          • 
+
        • 
+
      • "oss-us-east-1.aliyuncs.com"
+
          
+
        • US East 1 (Virginia)
          • 
+
        • 
+
      • "oss-ap-southeast-1.aliyuncs.com"
+
          
+
        • Southeast Asia Southeast 1 (Singapore)
          • 
+
        • 
+
      • "oss-ap-southeast-2.aliyuncs.com"
+
          
+
        • Asia Pacific Southeast 2 (Sydney)
          • 
+
        • 
+
      • "oss-ap-southeast-3.aliyuncs.com"
+
          
+
        • Southeast Asia Southeast 3 (Kuala Lumpur)
          • 
+
        • 
+
      • "oss-ap-southeast-5.aliyuncs.com"
+
          
+
        • Asia Pacific Southeast 5 (Jakarta)
          • 
+
        • 
+
      • "oss-ap-northeast-1.aliyuncs.com"
+
          
+
        • Asia Pacific Northeast 1 (Japan)
          • 
+
        • 
+
      • "oss-ap-south-1.aliyuncs.com"
+
          
+
        • Asia Pacific South 1 (Mumbai)
          • 
+
        • 
+
      • "oss-eu-central-1.aliyuncs.com"
+
          
+
        • Central Europe 1 (Frankfurt)
          • 
+
        • 
+
      • "oss-eu-west-1.aliyuncs.com"
+
          
+
        • West Europe (London)
          • 
+
        • 
+
      • "oss-me-east-1.aliyuncs.com"
+
          
+
        • Middle East 1 (Dubai)
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for Scaleway Object Storage.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "s3.nl-ams.scw.cloud"
+
          
+
        • Amsterdam Endpoint
          • 
+
        • 
+
      • "s3.fr-par.scw.cloud"
+
          
+
        • Paris Endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for StackPath Object Storage.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "s3.us-east-2.stackpathstorage.com"
+
          
+
        • US East Endpoint
          • 
+
        • 
+
      • "s3.us-west-1.stackpathstorage.com"
+
          
+
        • US West Endpoint
          • 
+
        • 
+
      • "s3.eu-central-1.stackpathstorage.com"
+
          
+
        • EU Endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for Tencent COS API.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "cos.ap-beijing.myqcloud.com"
+
          
+
        • Beijing Region.
          • 
+
        • 
+
      • "cos.ap-nanjing.myqcloud.com"
+
          
+
        • Nanjing Region.
          • 
+
        • 
+
      • "cos.ap-shanghai.myqcloud.com"
+
          
+
        • Shanghai Region.
          • 
+
        • 
+
      • "cos.ap-guangzhou.myqcloud.com"
+
          
+
        • Guangzhou Region.
          • 
+
        • 
+
      • "cos.ap-nanjing.myqcloud.com"
+
          
+
        • Nanjing Region.
          • 
+
        • 
+
      • "cos.ap-chengdu.myqcloud.com"
+
          
+
        • Chengdu Region.
          • 
+
        • 
+
      • "cos.ap-chongqing.myqcloud.com"
+
          
+
        • Chongqing Region.
          • 
+
        • 
+
      • "cos.ap-hongkong.myqcloud.com"
+
          
+
        • Hong Kong (China) Region.
          • 
+
        • 
+
      • "cos.ap-singapore.myqcloud.com"
+
          
+
        • Singapore Region.
          • 
+
        • 
+
      • "cos.ap-mumbai.myqcloud.com"
+
          
+
        • Mumbai Region.
          • 
+
        • 
+
      • "cos.ap-seoul.myqcloud.com"
+
          
+
        • Seoul Region.
          • 
+
        • 
+
      • "cos.ap-bangkok.myqcloud.com"
+
          
+
        • Bangkok Region.
          • 
+
        • 
+
      • "cos.ap-tokyo.myqcloud.com"
+
          
+
        • Tokyo Region.
          • 
+
        • 
+
      • "cos.na-siliconvalley.myqcloud.com"
+
          
+
        • Silicon Valley Region.
          • 
+
        • 
+
      • "cos.na-ashburn.myqcloud.com"
+
          
+
        • Virginia Region.
          • 
+
        • 
+
      • "cos.na-toronto.myqcloud.com"
+
          
+
        • Toronto Region.
          • 
+
        • 
+
      • "cos.eu-frankfurt.myqcloud.com"
+
          
+
        • Frankfurt Region.
          • 
+
        • 
+
      • "cos.eu-moscow.myqcloud.com"
+
          
+
        • Moscow Region.
          • 
+
        • 
+
      • "cos.accelerate.myqcloud.com"
+
          
+
        • Use Tencent COS Accelerate Endpoint.
          • 
+
        • 
+
      • 
+
    
+
    --s3-endpoint
    
+
    Endpoint for S3 API. Required when using an S3 clone.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_S3_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "objects-us-east-1.dream.io"
+
          
+
        • Dream Objects endpoint
          • 
+
        • 
+
      • "nyc3.digitaloceanspaces.com"
+
          
+
        • Digital Ocean Spaces New York 3
          • 
+
        • 
+
      • "ams3.digitaloceanspaces.com"
+
          
+
        • Digital Ocean Spaces Amsterdam 3
          • 
+
        • 
+
      • "sgp1.digitaloceanspaces.com"
+
          
+
        • Digital Ocean Spaces Singapore 1
          • 
+
        • 
+
      • "s3.wasabisys.com"
+
          
+
        • Wasabi US East endpoint
          • 
+
        • 
+
      • "s3.us-west-1.wasabisys.com"
+
          
+
        • Wasabi US West endpoint
          • 
+
        • 
+
      • "s3.eu-central-1.wasabisys.com"
+
          
+
        • Wasabi EU Central endpoint
          • 
+
        • 
+
      • 
+
    
+
    --s3-location-constraint
    
+
    Location constraint - must be set to match the Region. Used when creating buckets only.
    
+
      
+
    • Config: location_constraint
      • 
+
    • Env Var: RCLONE_S3_LOCATION_CONSTRAINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Empty for US Region, Northern Virginia, or Pacific Northwest.
          • 
+
        • 
+
      • "us-east-2"
+
          
+
        • US East (Ohio) Region.
          • 
+
        • 
+
      • "us-west-1"
+
          
+
        • US West (Northern California) Region.
          • 
+
        • 
+
      • "us-west-2"
+
          
+
        • US West (Oregon) Region.
          • 
+
        • 
+
      • "ca-central-1"
+
          
+
        • Canada (Central) Region.
          • 
+
        • 
+
      • "eu-west-1"
+
          
+
        • EU (Ireland) Region.
          • 
+
        • 
+
      • "eu-west-2"
+
          
+
        • EU (London) Region.
          • 
+
        • 
+
      • "eu-west-3"
+
          
+
        • EU (Paris) Region.
          • 
+
        • 
+
      • "eu-north-1"
+
          
+
        • EU (Stockholm) Region.
          • 
+
        • 
+
      • "eu-south-1"
+
          
+
        • EU (Milan) 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) Region.
          • 
+
        • 
+
      • "ap-northeast-3"
+
          
+
        • Asia Pacific (Osaka-Local) Region.
          • 
+
        • 
+
      • "ap-south-1"
+
          
+
        • Asia Pacific (Mumbai) Region.
          • 
+
        • 
+
      • "ap-east-1"
+
          
+
        • Asia Pacific (Hong Kong) Region.
          • 
+
        • 
+
      • "sa-east-1"
+
          
+
        • South America (Sao Paulo) Region.
          • 
+
        • 
+
      • "me-south-1"
+
          
+
        • Middle East (Bahrain) Region.
          • 
+
        • 
+
      • "af-south-1"
+
          
+
        • Africa (Cape Town) Region.
          • 
+
        • 
+
      • "cn-north-1"
+
          
+
        • China (Beijing) Region
          • 
+
        • 
+
      • "cn-northwest-1"
+
          
+
        • China (Ningxia) Region.
          • 
+
        • 
+
      • "us-gov-east-1"
+
          
+
        • AWS GovCloud (US-East) Region.
          • 
+
        • 
+
      • "us-gov-west-1"
+
          
+
        • AWS GovCloud (US) Region.
          • 
+
        • 
+
      • 
+
    
+
    --s3-location-constraint
    
+
    Location constraint - must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter
    
+
      
+
    • Config: location_constraint
      • 
+
    • Env Var: RCLONE_S3_LOCATION_CONSTRAINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "us-standard"
+
          
+
        • US Cross Region Standard
          • 
+
        • 
+
      • "us-vault"
+
          
+
        • US Cross Region Vault
          • 
+
        • 
+
      • "us-cold"
+
          
+
        • US Cross Region Cold
          • 
+
        • 
+
      • "us-flex"
+
          
+
        • US Cross Region Flex
          • 
+
        • 
+
      • "us-east-standard"
+
          
+
        • US East Region Standard
          • 
+
        • 
+
      • "us-east-vault"
+
          
+
        • US East Region Vault
          • 
+
        • 
+
      • "us-east-cold"
+
          
+
        • US East Region Cold
          • 
+
        • 
+
      • "us-east-flex"
+
          
+
        • US East Region Flex
          • 
+
        • 
+
      • "us-south-standard"
+
          
+
        • US South Region Standard
          • 
+
        • 
+
      • "us-south-vault"
+
          
+
        • US South Region Vault
          • 
+
        • 
+
      • "us-south-cold"
+
          
+
        • US South Region Cold
          • 
+
        • 
+
      • "us-south-flex"
+
          
+
        • US South Region Flex
          • 
+
        • 
+
      • "eu-standard"
+
          
+
        • EU Cross Region Standard
          • 
+
        • 
+
      • "eu-vault"
+
          
+
        • EU Cross Region Vault
          • 
+
        • 
+
      • "eu-cold"
+
          
+
        • EU Cross Region Cold
          • 
+
        • 
+
      • "eu-flex"
+
          
+
        • EU Cross Region Flex
          • 
+
        • 
+
      • "eu-gb-standard"
+
          
+
        • Great Britain Standard
          • 
+
        • 
+
      • "eu-gb-vault"
+
          
+
        • Great Britain Vault
          • 
+
        • 
+
      • "eu-gb-cold"
+
          
+
        • Great Britain Cold
          • 
+
        • 
+
      • "eu-gb-flex"
+
          
+
        • Great Britain Flex
          • 
+
        • 
+
      • "ap-standard"
+
          
+
        • APAC Standard
          • 
+
        • 
+
      • "ap-vault"
+
          
+
        • APAC Vault
          • 
+
        • 
+
      • "ap-cold"
+
          
+
        • APAC Cold
          • 
+
        • 
+
      • "ap-flex"
+
          
+
        • APAC Flex
          • 
+
        • 
+
      • "mel01-standard"
+
          
+
        • Melbourne Standard
          • 
+
        • 
+
      • "mel01-vault"
+
          
+
        • Melbourne Vault
          • 
+
        • 
+
      • "mel01-cold"
+
          
+
        • Melbourne Cold
          • 
+
        • 
+
      • "mel01-flex"
+
          
+
        • Melbourne Flex
          • 
+
        • 
+
      • "tor01-standard"
+
          
+
        • Toronto Standard
          • 
+
        • 
+
      • "tor01-vault"
+
          
+
        • Toronto Vault
          • 
+
        • 
+
      • "tor01-cold"
+
          
+
        • Toronto Cold
          • 
+
        • 
+
      • "tor01-flex"
+
          
+
        • Toronto Flex
          • 
+
        • 
+
      • 
+
    
+
    --s3-location-constraint
    
+
    Location constraint - must be set to match the Region. Leave blank if not sure. Used when creating buckets only.
    
+
      
+
    • Config: location_constraint
      • 
+
    • Env Var: RCLONE_S3_LOCATION_CONSTRAINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-acl
    
+
    Canned ACL used when creating buckets and storing or copying objects.
    
+
    This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.
    
+
    For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
    
+
    Note that this ACL is applied when server-side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one.
    
+
      
+
    • Config: acl
      • 
+
    • Env Var: RCLONE_S3_ACL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • "default"
+
          
+
        • Owner gets Full_CONTROL. No one else has access rights (default).
          • 
+
        • 
+
      • "private"
+
          
+
        • Owner gets FULL_CONTROL. No one else has access rights (default).
          • 
+
        • 
+
      • "public-read"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ access.
          • 
+
        • 
+
      • "public-read-write"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access.
          • 
+
        • Granting this on a bucket is generally not recommended.
          • 
+
        • 
+
      • "authenticated-read"
+
          
+
        • Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access.
          • 
+
        • 
+
      • "bucket-owner-read"
+
          
+
        • Object owner gets FULL_CONTROL. Bucket owner gets READ access.
          • 
+
        • If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
          • 
+
        • 
+
      • "bucket-owner-full-control"
+
          
+
        • Both the object owner and the bucket owner get FULL_CONTROL over the object.
          • 
+
        • If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.
          • 
+
        • 
+
      • "private"
+
          
+
        • Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
          • 
+
        • 
+
      • "public-read"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
          • 
+
        • 
+
      • "public-read-write"
+
          
+
        • Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
          • 
+
        • 
+
      • "authenticated-read"
+
          
+
        • Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
          • 
+
        • 
+
      • 
+
    
+
    --s3-server-side-encryption
    
+
    The server-side encryption algorithm used when storing this object in S3.
    
+
      
+
    • Config: server_side_encryption
      • 
+
    • Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • "AES256"
+
          
+
        • AES256
          • 
+
        • 
+
      • "aws:kms"
+
          
+
        • aws:kms
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-kms-key-id
    
+
    If using KMS ID you must provide the ARN of Key.
    
+
      
+
    • Config: sse_kms_key_id
      • 
+
    • Env Var: RCLONE_S3_SSE_KMS_KEY_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • "arn:aws:kms:us-east-1:*"
+
          
+
        • arn:aws:kms:*
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in S3.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • Standard storage class
          • 
+
        • 
+
      • "REDUCED_REDUNDANCY"
+
          
+
        • Reduced redundancy storage class
          • 
+
        • 
+
      • "STANDARD_IA"
+
          
+
        • Standard Infrequent Access storage class
          • 
+
        • 
+
      • "ONEZONE_IA"
+
          
+
        • One Zone Infrequent Access storage class
          • 
+
        • 
+
      • "GLACIER"
+
          
+
        • Glacier storage class
          • 
+
        • 
+
      • "DEEP_ARCHIVE"
+
          
+
        • Glacier Deep Archive storage class
          • 
+
        • 
+
      • "INTELLIGENT_TIERING"
+
          
+
        • Intelligent-Tiering storage class
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in OSS.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • Standard storage class
          • 
+
        • 
+
      • "GLACIER"
+
          
+
        • Archive storage mode.
          • 
+
        • 
+
      • "STANDARD_IA"
+
          
+
        • Infrequent access storage mode.
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in Tencent COS.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • Standard storage class
          • 
+
        • 
+
      • "ARCHIVE"
+
          
+
        • Archive storage mode.
          • 
+
        • 
+
      • "STANDARD_IA"
+
          
+
        • Infrequent access storage mode.
          • 
+
        • 
+
      • 
+
    
+
    --s3-storage-class
    
+
    The storage class to use when storing new objects in S3.
    
+
      
+
    • Config: storage_class
      • 
+
    • Env Var: RCLONE_S3_STORAGE_CLASS
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • Default
          • 
+
        • 
+
      • "STANDARD"
+
          
+
        • The Standard class for any upload; suitable for on-demand content like streaming or CDN.
          • 
+
        • 
+
      • "GLACIER"
+
          
+
        • Archived storage; prices are lower, but it needs to be restored first to be accessed.
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS).
    
+
    --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-requester-pays
    
+
    Enables requester pays option when interacting with S3 bucket.
    
+
      
+
    • Config: requester_pays
      • 
+
    • Env Var: RCLONE_S3_REQUESTER_PAYS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-sse-customer-algorithm
    
+
    If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
    
+
      
+
    • Config: sse_customer_algorithm
      • 
+
    • Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • "AES256"
+
          
+
        • AES256
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-customer-key
    
+
    If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data.
    
+
      
+
    • Config: sse_customer_key
      • 
+
    • Env Var: RCLONE_S3_SSE_CUSTOMER_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • 
+
    
+
    --s3-sse-customer-key-md5
    
+
    If using SSE-C you may provide the secret encryption key MD5 checksum (optional).
    
+
    If you leave it blank, this is calculated automatically from the sse_customer_key provided.
    
+
      
+
    • Config: sse_customer_key_md5
      • 
+
    • Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    • Examples:
+
        
+
      • ""
+
          
+
        • None
          • 
+
        • 
+
      • 
+
    
+
    --s3-upload-cutoff
    
+
    Cutoff for switching to chunked upload
    
+
    Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5GB.
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_S3_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 200M
      • 
+
    
+
    --s3-chunk-size
    
+
    Chunk size to use for uploading.
    
+
    When uploading files larger than upload_cutoff or files with unknown size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google photos or google docs) they will be uploaded as multipart uploads using this chunk size.
    
+
    Note that "--s3-upload-concurrency" chunks of this size are buffered in memory per transfer.
    
+
    If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers.
    
+
    Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit.
    
+
    Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5MB and there can be at most 10,000 chunks, this means that by default the maximum size of a file you can stream upload is 48GB. If you wish to stream upload larger files then you will need to increase chunk_size.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_S3_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 5M
      • 
+
    
+
    --s3-max-upload-parts
    
+
    Maximum number of parts in a multipart upload.
    
+
    This option defines the maximum number of multipart chunks to use when doing a multipart upload.
    
+
    This can be useful if a service does not support the AWS S3 specification of 10,000 chunks.
    
+
    Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit.
    
+
      
+
    • Config: max_upload_parts
      • 
+
    • Env Var: RCLONE_S3_MAX_UPLOAD_PARTS
      • 
+
    • Type: int
      • 
+
    • Default: 10000
      • 
+
    
+
    --s3-copy-cutoff
    
+
    Cutoff for switching to multipart copy
    
+
    Any files larger than this that need to be server-side copied will be copied in chunks of this size.
    
+
    The minimum is 0 and the maximum is 5GB.
    
+
      
+
    • Config: copy_cutoff
      • 
+
    • Env Var: RCLONE_S3_COPY_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 4.656G
      • 
+
    
+
    --s3-disable-checksum
    
+
    Don't store MD5 checksum with object metadata
    
+
    Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.
    
+
      
+
    • Config: disable_checksum
      • 
+
    • Env Var: RCLONE_S3_DISABLE_CHECKSUM
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-shared-credentials-file
    
+
    Path to the shared credentials file
    
+
    If env_auth = true then rclone can use a shared credentials file.
    
+
    If this variable is empty rclone will look for the "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it will default to the current user's home directory.
    
+
    Linux/OSX: "$HOME/.aws/credentials"
+Windows:   "%USERPROFILE%\.aws\credentials"
    
+
      
+
    • Config: shared_credentials_file
      • 
+
    • Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-profile
    
+
    Profile to use in the shared credentials file
    
+
    If env_auth = true then rclone can use a shared credentials file. This variable controls which profile is used in that file.
    
+
    If empty it will default to the environment variable "AWS_PROFILE" or "default" if that environment variable is also not set.
    
+
      
+
    • Config: profile
      • 
+
    • Env Var: RCLONE_S3_PROFILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-session-token
    
+
    An AWS session token
    
+
      
+
    • Config: session_token
      • 
+
    • Env Var: RCLONE_S3_SESSION_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --s3-upload-concurrency
    
+
    Concurrency for multipart uploads.
    
+
    This is the number of chunks of the same file that are uploaded concurrently.
    
+
    If you are uploading small numbers of large files over high-speed links 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 (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting.
    
+
      
+
    • Config: force_path_style
      • 
+
    • Env Var: RCLONE_S3_FORCE_PATH_STYLE
      • 
+
    • Type: bool
      • 
+
    • Default: true
      • 
+
    
+
    --s3-v2-auth
    
+
    If true use v2 authentication.
    
+
    If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.
    
+
    Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH.
    
+
      
+
    • Config: v2_auth
      • 
+
    • Env Var: RCLONE_S3_V2_AUTH
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-use-accelerate-endpoint
    
+
    If true use the AWS S3 accelerated endpoint.
    
+
    See: AWS S3 Transfer acceleration
    
+
      
+
    • Config: use_accelerate_endpoint
      • 
+
    • Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-leave-parts-on-error
    
+
    If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.
    
+
    It should be set to true for resuming uploads across different sessions.
    
+
    WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.
    
+
      
+
    • Config: leave_parts_on_error
      • 
+
    • Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-list-chunk
    
+
    Size of listing chunk (response list for each ListObject S3 request).
    
+
    This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. Most services truncate the response list to 1000 objects even if requested more than that. In AWS S3 this is a global maximum and cannot be changed, see AWS S3. In Ceph, this can be increased with the "rgw list buckets max chunk" option.
    
+
      
+
    • Config: list_chunk
      • 
+
    • Env Var: RCLONE_S3_LIST_CHUNK
      • 
+
    • Type: int
      • 
+
    • Default: 1000
      • 
+
    
+
    --s3-no-check-bucket
    
+
    If set, don't attempt to check the bucket exists or create it
    
+
    This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already.
    
+
    It can also be needed if the user you are using does not have bucket creation permissions. Before v1.52.0 this would have passed silently due to a bug.
    
+
      
+
    • Config: no_check_bucket
      • 
+
    • Env Var: RCLONE_S3_NO_CHECK_BUCKET
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-no-head
    
+
    If set, don't HEAD uploaded objects to check integrity
    
+
    This can be useful when trying to minimise the number of transactions rclone does.
    
+
    Setting it means that if rclone receives a 200 OK message after uploading an object with PUT then it will assume that it got uploaded properly.
    
+
    In particular it will assume:
    
+
      
+
    • the metadata, including modtime, storage class and content type was as uploaded
      • 
+
    • the size was as uploaded
      • 
+
    
+
    It reads the following items from the response for a single part PUT:
    
+
      
+
    • the MD5SUM
      • 
+
    • The uploaded date
      • 
+
    
+
    For multipart uploads these items aren't read.
    
+
    If an source object of unknown length is uploaded then rclone will do a HEAD request.
    
+
    Setting this flag increases the chance for undetected upload failures, in particular an incorrect size, so it isn't recommended for normal operation. In practice the chance of an undetected upload failure is very small even with this flag.
    
+
      
+
    • Config: no_head
      • 
+
    • Env Var: RCLONE_S3_NO_HEAD
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_S3_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,InvalidUtf8,Dot
      • 
+
    
+
    --s3-memory-pool-flush-time
    
+
    How often internal memory buffer pools will be flushed. Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. This option controls how often unused buffers will be removed from the pool.
    
+
      
+
    • Config: memory_pool_flush_time
      • 
+
    • Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 1m0s
      • 
+
    
+
    --s3-memory-pool-use-mmap
    
+
    Whether to use mmap buffers in internal memory pool.
    
+
      
+
    • Config: memory_pool_use_mmap
      • 
+
    • Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --s3-disable-http2
    
+
    Disable usage of http2 for S3 backends
    
+
    There is currently an unsolved issue with the s3 (specifically minio) backend and HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be disabled here. When the issue is solved this flag will be removed.
    
+
    See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631
    
+
      
+
    • Config: disable_http2
      • 
+
    • Env Var: RCLONE_S3_DISABLE_HTTP2
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Backend commands
    
+
    Here are the commands specific to the s3 backend.
    
+
    Run them with
    
+
    rclone backend COMMAND remote:
    
+
    The help below will explain what arguments each command takes.
    
+
    See the "rclone backend" command for more info on how to pass options and arguments.
    
+
    These can be run on a running backend using the rc command backend/command.
    
+
    restore
    
+
    Restore objects from GLACIER to normal storage
    
+
    rclone backend restore remote: [options] [<arguments>+]
    
+
    This command can be used to restore one or more objects from GLACIER to normal storage.
    
+
    Usage Examples:
    
+
    rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]
+rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]
+rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]
    
+
    This flag also obeys the filters. Test first with -i/--interactive or --dry-run flags
    
+
    rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard
    
+
    All the objects shown will be marked for restore, then
    
+
    rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard
    
+
    It returns a list of status dictionaries with Remote and Status keys. The Status will be OK if it was successful or an error message if not.
    
+
    [
     {
-      "rclone": [
-        {
-          "Initiated": "2020-06-26T14:20:36Z",
-          "Initiator": {
-            "DisplayName": "XXX",
-            "ID": "arn:aws:iam::XXX:user/XXX"
-          },
-          "Key": "KEY",
-          "Owner": {
-            "DisplayName": null,
-            "ID": "XXX"
-          },
-          "StorageClass": "STANDARD",
-          "UploadId": "XXX"
-        }
-      ],
-      "rclone-1000files": [],
-      "rclone-dst": []
+        "Status": "OK",
+        "Path": "test.txt"
+    },
+    {
+        "Status": "OK",
+        "Path": "test/file4.txt"
     }
+]
    
+
    Options:
    
+
      
+
    • "description": The optional description for the job.
      • 
+
    • "lifetime": Lifetime of the active copy in days
      • 
+
    • "priority": Priority of restore: Standard|Expedited|Bulk
      • 
+
    
+
    list-multipart-uploads
    
+
    List the unfinished multipart uploads
    
+
    rclone backend list-multipart-uploads remote: [options] [<arguments>+]
    
+
    This command lists the unfinished multipart uploads in JSON format.
    
+
    rclone backend list-multipart s3:bucket/path/to/object
    
+
    It returns a dictionary of buckets with values as lists of unfinished multipart uploads.
    
+
    You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path.
    
+
    {
+  "rclone": [
+    {
+      "Initiated": "2020-06-26T14:20:36Z",
+      "Initiator": {
+        "DisplayName": "XXX",
+        "ID": "arn:aws:iam::XXX:user/XXX"
+      },
+      "Key": "KEY",
+      "Owner": {
+        "DisplayName": null,
+        "ID": "XXX"
+      },
+      "StorageClass": "STANDARD",
+      "UploadId": "XXX"
+    }
+  ],
+  "rclone-1000files": [],
+  "rclone-dst": []
+}
    
+
    cleanup
    
+
    Remove unfinished multipart uploads.
    
+
    rclone backend cleanup remote: [options] [<arguments>+]
    
+
    This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours.
    
+
    Note that you can use -i/--dry-run with this command to see what it would do.
    
+
    rclone backend cleanup s3:bucket/path/to/object
+rclone backend cleanup -o max-age=7w s3:bucket/path/to/object
    
+
    Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
    
+
    Options:
    
+
      
+
    • "max-age": Max age of upload to delete
      • 
+
    
+
    Anonymous access to public buckets
    
+
    If you want to use rclone to access a public bucket, configure with a blank access_key_id and secret_access_key. Your config should end up looking like this:
    
+
    [anons3]
+type = s3
+provider = AWS
+env_auth = false
+access_key_id = 
+secret_access_key = 
+region = us-east-1
+endpoint = 
+location_constraint = 
+acl = private
+server_side_encryption = 
+storage_class = 
    
+
    Then use it as normal with the name of the public bucket, e.g.
    
+
    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, e.g. 10.2.x Jewel, then you may need to supply the parameter --s3-upload-cutoff 0 or put this in the config file as upload_cutoff 0 to work around a bug which causes uploading of small files to fail.
    
+
    Note also that Ceph sometimes puts / in the passwords it gives users. If you read the secret access key using the command line tools you will get a JSON blob with the / escaped as \/. Make sure you only write / in the secret access key.
    
+
    Eg the dump from Ceph looks something like this (irrelevant keys removed).
    
+
    {
+    "user_id": "xxx",
+    "display_name": "xxxx",
+    "keys": [
+        {
+            "user": "xxx",
+            "access_key": "xxxxxx",
+            "secret_key": "xxxxxx\/xxxx"
+        }
+    ],
+}
    
+
    Because this is a json dump, it is encoding the / as \/, so if you use the secret key as xxxxxx/xxxx it will work fine.
    
+
    Dreamhost
    
+
    Dreamhost DreamObjects is an object storage system based on CEPH.
    
+
    To use rclone with Dreamhost, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config:
    
+
    [dreamobjects]
+type = s3
+provider = DreamHost
+env_auth = false
+access_key_id = your_access_key
+secret_access_key = your_secret_key
+region =
+endpoint = objects-us-west-1.dream.io
+location_constraint =
+acl = private
+server_side_encryption =
+storage_class =
    
+
    DigitalOcean Spaces
    
+
    Spaces is an S3-interoperable object storage service from cloud provider DigitalOcean.
    
+
    To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "Applications & API" page of the DigitalOcean control panel. They will be needed when prompted by rclone config for your access_key_id and secret_access_key.
    
+
    When prompted for a region or location_constraint, press enter to use the default value. The region must be included in the endpoint setting (e.g. nyc3.digitaloceanspaces.com). The default values can be used for other settings.
    
+
    Going through the whole process of creating a new remote by running rclone config, each prompt should be answered as shown below:
    
+
    Storage> s3
+env_auth> 1
+access_key_id> YOUR_ACCESS_KEY
+secret_access_key> YOUR_SECRET_KEY
+region>
+endpoint> nyc3.digitaloceanspaces.com
+location_constraint>
+acl>
+storage_class>
    
+
    The resulting configuration file should look like:
    
+
    [spaces]
+type = s3
+provider = DigitalOcean
+env_auth = false
+access_key_id = YOUR_ACCESS_KEY
+secret_access_key = YOUR_SECRET_KEY
+region =
+endpoint = nyc3.digitaloceanspaces.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
    
+
    Once configured, you can create a new Space and begin copying files. For example:
    
+
    rclone mkdir spaces:my-new-space
+rclone copy /path/to/files spaces:my-new-space
    
+
    IBM COS (S3)
    
+
    Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage)
    
+
    To configure access to IBM COS S3, follow the steps below:
    
+
      
+
    1. Run rclone config and select n for a new remote.
      2. 
+
    
+
        2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults
+    No remotes found - make a new one
+    n) New remote
+    s) Set configuration password
+    q) Quit config
+    n/s/q> n
    
+
      
+
    1. Enter the name for the configuration
      2. 
+
    
+
        name> <YOUR NAME>
    
+
      
+
    1. Select "s3" storage.
      2. 
+
    
+
    Choose a number from below, or type in your own value
+    1 / Alias for an existing remote
+    \ "alias"
+    2 / Amazon Drive
+    \ "amazon cloud drive"
+    3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS)
+    \ "s3"
+    4 / Backblaze B2
+    \ "b2"
+[snip]
+    23 / http Connection
+    \ "http"
+Storage> 3
    
+
      
+
    1. Select IBM COS as the S3 Storage Provider.
      2. 
+
    
+
    Choose the S3 provider.
+Choose a number from below, or type in your own value
+     1 / Choose this option to configure Storage to AWS S3
+       \ "AWS"
+     2 / Choose this option to configure Storage to Ceph Systems
+     \ "Ceph"
+     3 /  Choose this option to configure Storage to Dreamhost
+     \ "Dreamhost"
+   4 / Choose this option to the configure Storage to IBM COS S3
+     \ "IBMCOS"
+     5 / Choose this option to the configure Storage to Minio
+     \ "Minio"
+     Provider>4
    
+
      
+
    1. Enter the Access Key and Secret.
      2. 
+
    
+
        AWS Access Key ID - leave blank for anonymous access or runtime credentials.
+    access_key_id> <>
+    AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
+    secret_access_key> <>
    
+
      
+
    1. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an endpoint 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 (Storage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.
      2. 
+
    
+
    Canned ACL used when creating buckets and/or storing objects in S3.
+For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Choose a number from below, or type in your own value
+      1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
+      \ "private"
+      2  / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
+      \ "public-read"
+      3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
+      \ "public-read-write"
+      4  / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
+      \ "authenticated-read"
+acl> 1
    
+
      
+
    1. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this
      2. 
+
    
+
        [xxx]
+    type = s3
+    Provider = IBMCOS
+    access_key_id = xxx
+    secret_access_key = yyy
+    endpoint = s3-api.us-geo.objectstorage.softlayer.net
+    location_constraint = us-standard
+    acl = private
    
+
      
+
    1. Execute rclone commands
      2. 
+
    
+
        1)  Create a bucket.
+        rclone mkdir IBM-COS-XREGION:newbucket
+    2)  List available buckets.
+        rclone lsd IBM-COS-XREGION:
+        -1 2017-11-08 21:16:22        -1 test
+        -1 2018-02-14 20:16:39        -1 newbucket
+    3)  List contents of a bucket.
+        rclone ls IBM-COS-XREGION:newbucket
+        18685952 test.exe
+    4)  Copy a file from local to remote.
+        rclone copy /Users/file.txt IBM-COS-XREGION:newbucket
+    5)  Copy a file from remote to local.
+        rclone copy IBM-COS-XREGION:newbucket/file.txt .
+    6)  Delete a file on remote.
+        rclone delete IBM-COS-XREGION:newbucket/file.txt
    
+
    Minio
    
+
    Minio is an object storage server built for cloud application developers and devops.
    
+
    It is very easy to install and provides an S3 compatible server which can be used by rclone.
    
+
    To use it, install Minio following the instructions here.
    
+
    When it configures itself Minio will print something like this
    
+
    Endpoint:  http://192.168.1.106:9000  http://172.23.0.1:9000
+AccessKey: USWUXHGYZQYFYFFIT3RE
+SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+Region:    us-east-1
+SQS ARNs:  arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis
 
+Browser Access:
+   http://192.168.1.106:9000  http://172.23.0.1:9000
 
+Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
+   $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
 
-#### cleanup
+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
 
-Remove unfinished multipart uploads.
+Drive Capacity: 26 GiB Free, 165 GiB Total
    
+
    These details need to go into rclone config like this. Note that it is important to put the region in as stated above.
    
+
    env_auth> 1
+access_key_id> USWUXHGYZQYFYFFIT3RE
+secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+region> us-east-1
+endpoint> http://192.168.1.106:9000
+location_constraint>
+server_side_encryption>
    
+
    Which makes the config file look like this
    
+
    [minio]
+type = s3
+provider = Minio
+env_auth = false
+access_key_id = USWUXHGYZQYFYFFIT3RE
+secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
+region = us-east-1
+endpoint = http://192.168.1.106:9000
+location_constraint =
+server_side_encryption =
    
+
    So once set up, for example to copy files into a bucket
    
+
    rclone copy /path/to/files minio:bucket
    
+
    Scaleway
    
+
    Scaleway The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool.
    
+
    Scaleway provides an S3 interface which can be configured for use with rclone like this:
    
+
    [scaleway]
+type = s3
+provider = Scaleway
+env_auth = false
+endpoint = s3.nl-ams.scw.cloud
+access_key_id = SCWXXXXXXXXXXXXXX
+secret_access_key = 1111111-2222-3333-44444-55555555555555
+region = nl-ams
+location_constraint =
+acl = private
+server_side_encryption =
+storage_class =
    
+
    Wasabi
    
+
    Wasabi is a cloud-based object storage service for a broad range of applications and use cases. Wasabi is designed for individuals and organizations that require a high-performance, reliable, and secure data storage infrastructure at minimal cost.
    
+
    Wasabi provides an S3 interface which can be configured for use with rclone like this.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+n/s> n
+name> wasabi
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Amazon S3 (also Dreamhost, Ceph, Minio)
+   \ "s3"
+[snip]
+Storage> s3
+Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank.
+Choose a number from below, or type in your own value
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID - leave blank for anonymous access or runtime credentials.
+access_key_id> YOURACCESSKEY
+AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
+secret_access_key> YOURSECRETACCESSKEY
+Region to connect to.
+Choose a number from below, or type in your own value
+   / The default endpoint - a good choice if you are unsure.
+ 1 | US Region, Northern Virginia, or Pacific Northwest.
+   | Leave location constraint empty.
+   \ "us-east-1"
+[snip]
+region> us-east-1
+Endpoint for S3 API.
+Leave blank if using AWS to use the default endpoint for the region.
+Specify if using an S3 clone such as Ceph.
+endpoint> s3.wasabisys.com
+Location constraint - must be set to match the Region. Used when creating buckets only.
+Choose a number from below, or type in your own value
+ 1 / Empty for US Region, Northern Virginia, or Pacific Northwest.
+   \ ""
+[snip]
+location_constraint>
+Canned ACL used when creating buckets and/or storing objects in S3.
+For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+Choose a number from below, or type in your own value
+ 1 / Owner gets FULL_CONTROL. No one else has access rights (default).
+   \ "private"
+[snip]
+acl>
+The server-side encryption algorithm used when storing this object in S3.
+Choose a number from below, or type in your own value
+ 1 / None
+   \ ""
+ 2 / AES256
+   \ "AES256"
+server_side_encryption>
+The storage class to use when storing objects in S3.
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+ 2 / Standard storage class
+   \ "STANDARD"
+ 3 / Reduced redundancy storage class
+   \ "REDUCED_REDUNDANCY"
+ 4 / Standard Infrequent Access storage class
+   \ "STANDARD_IA"
+storage_class>
+Remote config
+--------------------
+[wasabi]
+env_auth = false
+access_key_id = YOURACCESSKEY
+secret_access_key = YOURSECRETACCESSKEY
+region = us-east-1
+endpoint = s3.wasabisys.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    This will leave the config file looking like this.
    
+
    [wasabi]
+type = s3
+provider = Wasabi
+env_auth = false
+access_key_id = YOURACCESSKEY
+secret_access_key = YOURSECRETACCESSKEY
+region =
+endpoint = s3.wasabisys.com
+location_constraint =
+acl =
+server_side_encryption =
+storage_class =
    
+
    Alibaba OSS
    
+
    Here is an example of making an Alibaba Cloud (Aliyun) OSS configuration. First run:
    
+
    rclone config
    
+
    This will guide you through an interactive setup process.
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> oss
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+[snip]
+ 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS
+   \ "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.
 
-    rclone backend cleanup remote: [options] [<arguments>+]
-
-This command removes unfinished multipart uploads of age greater than
-max-age which defaults to 24 hours.
-
-Note that you can use -i/--dry-run with this command to see what it
-would do.
-
-    rclone backend cleanup s3:bucket/path/to/object
-    rclone backend cleanup -o max-age=7w s3:bucket/path/to/object
-
-Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.
-
-
-Options:
-
-- "max-age": Max age of upload to delete
-
-
-
-### Anonymous access to public buckets ###
-
-If you want to use rclone to access a public bucket, configure with a
-blank `access_key_id` and `secret_access_key`.  Your config should end
-up looking like this:
-
    
-
    [anons3] type = s3 provider = AWS env_auth = false access_key_id = secret_access_key = region = us-east-1 endpoint = location_constraint = acl = private server_side_encryption = storage_class =
    
-
    
-Then use it as normal with the name of the public bucket, eg
-
-    rclone lsd anons3:1000genomes
-
-You will be able to list and copy data but not upload it.
-
-### Ceph ###
-
-[Ceph](https://ceph.com/) is an open source unified, distributed
-storage system designed for excellent performance, reliability and
-scalability.  It has an S3 compatible object storage interface.
-
-To use rclone with Ceph, configure as above but leave the region blank
-and set the endpoint.  You should end up with something like this in
-your config:
-
-
    
-
    [ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX secret_access_key = YYY region = endpoint = https://ceph.endpoint.example.com location_constraint = acl = server_side_encryption = storage_class =
    
-
    
-If you are using an older version of CEPH, eg 10.2.x Jewel, then you
-may need to supply the parameter `--s3-upload-cutoff 0` or put this in
-the config file as `upload_cutoff 0` to work around a bug which causes
-uploading of small files to fail.
-
-Note also that Ceph sometimes puts `/` in the passwords it gives
-users.  If you read the secret access key using the command line tools
-you will get a JSON blob with the `/` escaped as `\/`.  Make sure you
-only write `/` in the secret access key.
-
-Eg the dump from Ceph looks something like this (irrelevant keys
-removed).
-
    
-
    { "user_id": "xxx", "display_name": "xxxx", "keys": [ { "user": "xxx", "access_key": "xxxxxx", "secret_key": "xxxxxx/xxxx" } ], }
    
-
    
-Because this is a json dump, it is encoding the `/` as `\/`, so if you
-use the secret key as `xxxxxx/xxxx`  it will work fine.
-
-### Dreamhost ###
-
-Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is
-an object storage system based on CEPH.
-
-To use rclone with Dreamhost, configure as above but leave the region blank
-and set the endpoint.  You should end up with something like this in
-your config:
-
    
-
    [dreamobjects] type = s3 provider = DreamHost env_auth = false access_key_id = your_access_key secret_access_key = your_secret_key region = endpoint = objects-us-west-1.dream.io location_constraint = acl = private server_side_encryption = storage_class =
    
-
    
-### DigitalOcean Spaces ###
-
-[Spaces](https://www.digitalocean.com/products/object-storage/) is an [S3-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean.
-
-To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when prompted by `rclone config` for your `access_key_id` and `secret_access_key`.
-
-When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The default values can be used for other settings.
-
-Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below:
-
    
-
    Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY secret_access_key> YOUR_SECRET_KEY region> endpoint> nyc3.digitaloceanspaces.com location_constraint> acl> storage_class>
    
-
    
-The resulting configuration file should look like:
-
    
-
    [spaces] type = s3 provider = DigitalOcean env_auth = false access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY region = endpoint = nyc3.digitaloceanspaces.com location_constraint = acl = server_side_encryption = storage_class =
    
-
    
-Once configured, you can create a new Space and begin copying files. For example:
-
    
-
    rclone mkdir spaces:my-new-space rclone copy /path/to/files spaces:my-new-space
    
-
    
-### IBM COS (S3) ###
-
-Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage)
-
-To configure access to IBM COS S3, follow the steps below:
-
-1. Run rclone config and select n for a new remote.
    
-
    2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults
+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
    
+
    Tencent COS
    
+
    Tencent Cloud Object Storage (COS) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost.
    
+
    To configure access to Tencent COS, follow the steps below:
    
+
      
+
    1. Run rclone config and select n for a new remote.
      2. 
+
    
+
    rclone config
 No remotes found - make a new one
 n) New remote
 s) Set configuration password
 q) Quit config
 n/s/q> n
    
-
    
-2. Enter the name for the configuration
    
-
    name> <YOUR NAME>
    
-
    
-3. Select "s3" storage.
    
-
    Choose a number from below, or type in your own value 1 / Alias for an existing remote  "alias" 2 / Amazon Drive  "amazon cloud drive" 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS)  "s3" 4 / Backblaze B2  "b2" [snip] 23 / http Connection  "http" Storage> 3
    
-
    
-4. Select IBM COS as the S3 Storage Provider.
    
-
    Choose the S3 provider. Choose a number from below, or type in your own value 1 / Choose this option to configure Storage to AWS S3  "AWS" 2 / Choose this option to configure Storage to Ceph Systems  "Ceph" 3 / Choose this option to configure Storage to Dreamhost  "Dreamhost" 4 / Choose this option to the configure Storage to IBM COS S3  "IBMCOS" 5 / Choose this option to the configure Storage to Minio  "Minio" Provider>4
    
-
    
-5. Enter the Access Key and Secret.
    
-
    AWS Access Key ID - leave blank for anonymous access or runtime credentials.
-access_key_id> <>
-AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.
-secret_access_key> <>
    
-
    
-6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address.
    
-
    Endpoint for IBM COS S3 API.
-Specify if using an IBM COS On Premise.
+
      
+
    1. Give the name of the configuration. For example, name it 'cos'.
      2. 
+
    
+
    name> cos
    
+
      
+
    1. Select s3 storage.
      2. 
+
    
+
    Choose a number from below, or type in your own value
+1 / 1Fichier
+   \ "fichier"
+ 2 / Alias for an existing remote
+   \ "alias"
+ 3 / Amazon Drive
+   \ "amazon cloud drive"
+ 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS
+   \ "s3"
+[snip]
+Storage> s3
    
+
      
+
    1. Select TencentCOS provider.
      2. 
+
    
+
    Choose a number from below, or type in your own value
+1 / Amazon Web Services (AWS) S3
+   \ "AWS"
+[snip]
+11 / Tencent Cloud Object Storage (COS)
+   \ "TencentCOS"
+[snip]
+provider> TencentCOS
    
+
      
+
    1. Enter your SecretId and SecretKey of Tencent Cloud.
      2. 
+
    
+
    Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
+Only applies if access_key_id and secret_access_key is blank.
+Enter a boolean value (true or false). Press Enter for the default ("false").
 Choose a number from below, or type in your own value
- 1 / US Cross Region Endpoint
-   \ "s3-api.us-geo.objectstorage.softlayer.net"
- 2 / US Cross Region Dallas Endpoint
-   \ "s3-api.dal.us-geo.objectstorage.softlayer.net"
- 3 / US Cross Region Washington DC Endpoint
-   \ "s3-api.wdc-us-geo.objectstorage.softlayer.net"
- 4 / US Cross Region San Jose Endpoint
-   \ "s3-api.sjc-us-geo.objectstorage.softlayer.net"
- 5 / US Cross Region Private Endpoint
-   \ "s3-api.us-geo.objectstorage.service.networklayer.com"
- 6 / US Cross Region Dallas Private Endpoint
-   \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com"
- 7 / US Cross Region Washington DC Private Endpoint
-   \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com"
- 8 / US Cross Region San Jose Private Endpoint
-   \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com"
- 9 / US Region East Endpoint
-   \ "s3.us-east.objectstorage.softlayer.net"
-10 / US Region East Private Endpoint
-   \ "s3.us-east.objectstorage.service.networklayer.com"
-11 / US Region South Endpoint
    
-
    [snip] 34 / Toronto Single Site Private Endpoint  "s3.tor01.objectstorage.service.networklayer.com" endpoint>1
    
-
    
-
-7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter
    
-
     1 / US Cross Region Standard
-   \ "us-standard"
- 2 / US Cross Region Vault
-   \ "us-vault"
- 3 / US Cross Region Cold
-   \ "us-cold"
- 4 / US Cross Region Flex
-   \ "us-flex"
- 5 / US East Region Standard
-   \ "us-east-standard"
- 6 / US East Region Vault
-   \ "us-east-vault"
- 7 / US East Region Cold
-   \ "us-east-cold"
- 8 / US East Region Flex
-   \ "us-east-flex"
- 9 / US South Region Standard
-   \ "us-south-standard"
-10 / US South Region Vault
-   \ "us-south-vault"
    
-
    [snip] 32 / Toronto Flex  "tor01-flex" location_constraint>1
    
-
    
-9. Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.
    
-
    Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS  "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS  "public-read" 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS  "public-read-write" 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS  "authenticated-read" acl> 1
    
-
    
-
-12. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this
    
-
    [xxx]
+ 1 / Enter AWS credentials in the next step
+   \ "false"
+ 2 / Get AWS credentials from the environment (env vars or IAM)
+   \ "true"
+env_auth> 1
+AWS Access Key ID.
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default ("").
+access_key_id> AKIDxxxxxxxxxx
+AWS Secret Access Key (password)
+Leave blank for anonymous access or runtime credentials.
+Enter a string value. Press Enter for the default ("").
+secret_access_key> xxxxxxxxxxx
    
+
      
+
    1. Select endpoint for Tencent COS. This is the standard endpoint for different region.
      2. 
+
    
+
     1 / Beijing Region.
+   \ "cos.ap-beijing.myqcloud.com"
+ 2 / Nanjing Region.
+   \ "cos.ap-nanjing.myqcloud.com"
+ 3 / Shanghai Region.
+   \ "cos.ap-shanghai.myqcloud.com"
+ 4 / Guangzhou Region.
+   \ "cos.ap-guangzhou.myqcloud.com"
+[snip]
+endpoint> 4
    
+
      
+
    1. Choose acl and storage class.
      2. 
+
    
+
    Note that this ACL is applied when server-side copying objects as S3
+doesn't copy the ACL from the source but rather writes a fresh one.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Owner gets Full_CONTROL. No one else has access rights (default).
+   \ "default"
+[snip]
+acl> 1
+The storage class to use when storing new objects in Tencent COS.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Default
+   \ ""
+[snip]
+storage_class> 1
+Edit advanced config? (y/n)
+y) Yes
+n) No (default)
+y/n> n
+Remote config
+--------------------
+[cos]
 type = s3
-Provider = IBMCOS
+provider = TencentCOS
+env_auth = false
 access_key_id = xxx
-secret_access_key = yyy
-endpoint = s3-api.us-geo.objectstorage.softlayer.net
-location_constraint = us-standard
-acl = private
    
-
    
-13. Execute rclone commands
    
-
    1)  Create a bucket.
-    rclone mkdir IBM-COS-XREGION:newbucket
-2)  List available buckets.
-    rclone lsd IBM-COS-XREGION:
-    -1 2017-11-08 21:16:22        -1 test
-    -1 2018-02-14 20:16:39        -1 newbucket
-3)  List contents of a bucket.
-    rclone ls IBM-COS-XREGION:newbucket
-    18685952 test.exe
-4)  Copy a file from local to remote.
-    rclone copy /Users/file.txt IBM-COS-XREGION:newbucket
-5)  Copy a file from remote to local.
-    rclone copy IBM-COS-XREGION:newbucket/file.txt .
-6)  Delete a file on remote.
-    rclone delete IBM-COS-XREGION:newbucket/file.txt
    
-
    
-### Minio ###
-
-[Minio](https://minio.io/) is an object storage server built for cloud application developers and devops.
-
-It is very easy to install and provides an S3 compatible server which can be used by rclone.
-
-To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio-quickstart-guide).
-
-When it configures itself Minio will print something like this
-
    
-
    Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 Region: us-east-1 SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis
    
-
    Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000
    
-
    Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
    
-
    Object API (Amazon S3 compatible): Go: https://docs.minio.io/docs/golang-client-quickstart-guide Java: https://docs.minio.io/docs/java-client-quickstart-guide Python: https://docs.minio.io/docs/python-client-quickstart-guide JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide
    
-
    Drive Capacity: 26 GiB Free, 165 GiB Total
    
-
    
-These details need to go into `rclone config` like this.  Note that it
-is important to put the region in as stated above.
-
    
-
    env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us-east-1 endpoint> http://192.168.1.106:9000 location_constraint> server_side_encryption>
    
-
    
-Which makes the config file look like this
-
    
-
    [minio] type = s3 provider = Minio env_auth = false access_key_id = USWUXHGYZQYFYFFIT3RE secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us-east-1 endpoint = http://192.168.1.106:9000 location_constraint = server_side_encryption =
    
-
    
-So once set up, for example to copy files into a bucket
-
    
-
    rclone copy /path/to/files minio:bucket
    
-
    
-### Scaleway {#scaleway}
-
-[Scaleway](https://www.scaleway.com/object-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos.
-Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool.
-
-Scaleway provides an S3 interface which can be configured for use with rclone like this:
-
    
-
    [scaleway] type = s3 provider = Scaleway env_auth = false endpoint = s3.nl-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key = 1111111-2222-3333-44444-55555555555555 region = nl-ams location_constraint = acl = private server_side_encryption = storage_class =
    
-
    
-### Wasabi ###
-
-[Wasabi](https://wasabi.com) is a cloud-based object storage service for a
-broad range of applications and use cases. Wasabi is designed for
-individuals and organizations that require a high-performance,
-reliable, and secure data storage infrastructure at minimal cost.
-
-Wasabi provides an S3 interface which can be configured for use with
-rclone like this.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password n/s> n name> wasabi Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Amazon S3 (also Dreamhost, Ceph, Minio)  "s3" [snip] Storage> s3 Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step  "false" 2 / Get AWS credentials from the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. access_key_id> YOURACCESSKEY AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. secret_access_key> YOURSECRETACCESSKEY Region to connect to. Choose a number from below, or type in your own value / The default endpoint - a good choice if you are unsure. 1 | US Region, Northern Virginia or Pacific Northwest. | Leave location constraint empty.  "us-east-1" [snip] region> us-east-1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. Specify if using an S3 clone such as Ceph. endpoint> s3.wasabisys.com Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value 1 / Empty for US Region, Northern Virginia or Pacific Northwest.  "" [snip] location_constraint> Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default).  "private" [snip] acl> The server-side encryption algorithm used when storing this object in S3. Choose a number from below, or type in your own value 1 / None  "" 2 / AES256  "AES256" server_side_encryption> The storage class to use when storing objects in S3. Choose a number from below, or type in your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 / Reduced redundancy storage class  "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access storage class  "STANDARD_IA" storage_class> Remote config -------------------- [wasabi] env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = us-east-1 endpoint = s3.wasabisys.com location_constraint = acl = server_side_encryption = storage_class = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-This will leave the config file looking like this.
-
    
-
    [wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint = s3.wasabisys.com location_constraint = acl = server_side_encryption = storage_class =
    
-
    
-### Alibaba OSS {#alibaba-oss}
-
-Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/)
-configuration.  First run:
-
-    rclone config
-
-This will guide you through an interactive setup process.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> oss Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)  "s3" [snip] Storage> s3 Choose your S3 provider. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Amazon Web Services (AWS) S3  "AWS" 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun  "Alibaba" 3 / Ceph Object Storage  "Ceph" [snip] provider> Alibaba Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Enter a boolean value (true or false). Press Enter for the default ("false"). Choose a number from below, or type in your own value 1 / Enter AWS credentials in the next step  "false" 2 / Get AWS credentials from the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID. Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (""). access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank for anonymous access or runtime credentials. Enter a string value. Press Enter for the default (""). secret_access_key> secretaccesskey Endpoint for OSS API. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / East China 1 (Hangzhou)  "oss-cn-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai)  "oss-cn-shanghai.aliyuncs.com" 3 / North China 1 (Qingdao)  "oss-cn-qingdao.aliyuncs.com" [snip] endpoint> 1 Canned ACL used when creating buckets and storing or copying objects.
    
-
    Note that this ACL is applied when server side copying objects as S3 doesn't copy the ACL from the source but rather writes a fresh one. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Owner gets FULL_CONTROL. No one else has access rights (default).  "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access.  "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. [snip] acl> 1 The storage class to use when storing new objects in OSS. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 / Archive storage mode.  "GLACIER" 4 / Infrequent access storage mode.  "STANDARD_IA" storage_class> 1 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [oss] type = s3 provider = Alibaba env_auth = false access_key_id = accesskeyid secret_access_key = secretaccesskey endpoint = oss-cn-hangzhou.aliyuncs.com acl = private storage_class = Standard -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-### Netease NOS  ###
-
-For Netease NOS configure as per the configurator `rclone config`
-setting the provider `Netease`.  This will automatically set
-`force_path_style = false` which is necessary for it to run properly.
-
- Backblaze B2
-----------------------------------------
-
-B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/).
-
-Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
-command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
-
-Here is an example of making a b2 configuration.  First run
-
-    rclone config
-
-This will guide you through an interactive setup process.  To authenticate
-you will either need your Account ID (a short hex number) and Master
-Application Key (a long hex number) OR an Application Key, which is the
-recommended method. See below for further details on generating and using
-an Application Key.
-
    
-
    No remotes found - make a new one n) New remote q) Quit config n/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Backblaze B2  "b2" [snip] Storage> b2 Account ID or Application Key ID account> 123456789abc Application Key key> 0123456789abcdef0123456789abcdef0123456789 Endpoint for the service - leave blank normally. endpoint> Remote config -------------------- [remote] account = 123456789abc key = 0123456789abcdef0123456789abcdef0123456789 endpoint = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-This remote is called `remote` and can now be used like this
-
-See all buckets
-
-    rclone lsd remote:
-
-Create a new bucket
-
-    rclone mkdir remote:bucket
-
-List the contents of a bucket
-
-    rclone ls remote:bucket
-
-Sync `/home/local/directory` to the remote bucket, deleting any
-excess files in the bucket.
-
-    rclone sync -i /home/local/directory remote:bucket
-
-### Application Keys ###
-
-B2 supports multiple [Application Keys for different access permission
-to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html).
-
-You can use these with rclone too; you will need to use rclone version 1.43
-or later.
-
-Follow Backblaze's docs to create an Application Key with the required
-permission and add the `applicationKeyId` as the `account` and the
-`Application Key` itself as the `key`.
-
-Note that you must put the _applicationKeyId_ as the `account` – you
-can't use the master Account ID.  If you try then B2 will return 401
-errors.
-
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-### Modified time ###
-
-The modified time is stored as metadata on the object as
-`X-Bz-Info-src_last_modified_millis` as milliseconds since 1970-01-01
-in the Backblaze standard.  Other tools should be able to use this as
-a modified time.
-
-Modified times are used in syncing and are fully supported. Note that
-if a modification time needs to be updated on an object then it will
-create a new version of the object.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \         | 0x5C  | ＼           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-Note that in 2020-05 Backblaze started allowing \ characters in file
-names. Rclone hasn't changed its encoding as this could cause syncs to
-re-transfer files. If you want rclone not to replace \ then see the
-`--b2-encoding` flag below and remove the `BackSlash` from the
-string. This can be set in the config.
-
-### SHA1 checksums ###
-
-The SHA1 checksums of the files are checked on upload and download and
-will be used in the syncing process.
-
-Large files (bigger than the limit in `--b2-upload-cutoff`) which are
-uploaded in chunks will store their SHA1 on the object as
-`X-Bz-Info-large_file_sha1` as recommended by Backblaze.
-
-For a large file to be uploaded with an SHA1 checksum, the source
-needs to support SHA1 checksums. The local disk supports SHA1
-checksums so large file transfers from local disk will have an SHA1.
-See [the overview](https://rclone.org/overview/#features) for exactly which remotes
-support SHA1.
-
-Sources which don't support SHA1, in particular `crypt` will upload
-large files without SHA1 checksums.  This may be fixed in the future
-(see [#1767](https://github.com/rclone/rclone/issues/1767)).
-
-Files sizes below `--b2-upload-cutoff` will always have an SHA1
-regardless of the source.
-
-### Transfers ###
-
-Backblaze recommends that you do lots of transfers simultaneously for
-maximum speed.  In tests from my SSD equipped laptop the optimum
-setting is about `--transfers 32` though higher numbers may be used
-for a slight speed improvement. The optimum number for you may vary
-depending on your hardware, how big the files are, how much you want
-to load your computer, etc.  The default of `--transfers 4` is
-definitely too low for Backblaze B2 though.
-
-Note that uploading big files (bigger than 200 MB by default) will use
-a 96 MB RAM buffer by default.  There can be at most `--transfers` of
-these in use at any moment, so this sets the upper limit on the memory
-used.
-
-### Versions ###
-
-When rclone uploads a new version of a file it creates a [new version
-of it](https://www.backblaze.com/b2/docs/file_versions.html).
-Likewise when you delete a file, the old version will be marked hidden
-and still be available.  Conversely, you may opt in to a "hard delete"
-of files with the `--b2-hard-delete` flag which would permanently remove
-the file instead of hiding it.
-
-Old versions of files, where available, are visible using the 
-`--b2-versions` flag.
-
-**NB** Note that `--b2-versions` does not work with crypt at the
-moment [#1627](https://github.com/rclone/rclone/issues/1627). Using
-[--backup-dir](https://rclone.org/docs/#backup-dir-dir) with rclone is the recommended
-way of working around this.
-
-If you wish to remove all the old versions then you can use the
-`rclone cleanup remote:bucket` command which will delete all the old
-versions of files, leaving the current ones intact.  You can also
-supply a path and only old versions under that path will be deleted,
-eg `rclone cleanup remote:bucket/path/to/stuff`.
-
-Note that `cleanup` will remove partially uploaded files from the bucket
-if they are more than a day old.
-
-When you `purge` a bucket, the current and the old versions will be
-deleted then the bucket will be deleted.
-
-However `delete` will cause the current versions of the files to
-become hidden old versions.
-
-Here is a session showing the listing and retrieval of an old
-version followed by a `cleanup` of the old versions.
-
-Show current version and all the versions with `--b2-versions` flag.
-
    
-
    $ rclone -q ls b2:cleanup-test 9 one.txt
    
-
    $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt
    
-
    
-Retrieve an old version
-
    
-
    $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp
    
-
    $ ls -l /tmp/one-v2016-07-04-141003-000.txt -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt
    
-
    
-Clean up all the old versions and show that they've gone.
-
    
-
    $ rclone -q cleanup b2:cleanup-test
    
-
    $ rclone -q ls b2:cleanup-test 9 one.txt
    
-
    $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt
    
-
    
-### Data usage ###
-
-It is useful to know how many requests are sent to the server in different scenarios.
-
-All copy commands send the following 4 requests:
-
    
-
    /b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket /b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names
    
-
    
-The `b2_list_file_names` request will be sent once for every 1k files
-in the remote path, providing the checksum and modification time of
-the listed files. As of version 1.33 issue
-[#818](https://github.com/rclone/rclone/issues/818) causes extra requests
-to be sent when using B2 with Crypt. When a copy operation does not
-require any files to be uploaded, no more requests will be sent.
-
-Uploading files that do not require chunking, will send 2 requests per
-file upload:
-
    
-
    /b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/
    
-
    
-Uploading files requiring chunking, will send 2 requests (one each to
-start and finish the upload) and another 2 requests for each chunk:
-
    
-
    /b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url /b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file
    
-
    
-#### Versions ####
-
-Versions can be viewed with the `--b2-versions` flag. When it is set
-rclone will show and act on older versions of files.  For example
-
-Listing without `--b2-versions`
-
    
-
    $ rclone -q ls b2:cleanup-test 9 one.txt
    
-
    
-And with
-
    
-
    $ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 one-v2016-07-02-155621-000.txt
    
-
    
-Showing that the current version is unchanged but older versions can
-be seen.  These have the UTC date that they were uploaded to the
-server to the nearest millisecond appended to them.
-
-Note that when using `--b2-versions` no file write operations are
-permitted, so you can't upload files or delete them.
-
-### B2 and rclone link ###
-
-Rclone supports generating file share links for private B2 buckets.
-They can either be for a file for example:
-
    
-
    ./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx
    
-
    
-or if run on a directory you will get:
-
    
-
    ./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx
    
-
    
-you can then use the authorization token (the part of the url from the
- `?Authorization=` on) on any file path under that directory. For example:
-
    
-
    https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx
    
-
    
-
-### Standard Options
-
-Here are the standard options specific to b2 (Backblaze B2).
-
-#### --b2-account
-
+secret_access_key = xxx
+endpoint = cos.ap-guangzhou.myqcloud.com
+acl = default
+--------------------
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+Current remotes:
+
+Name                 Type
+====                 ====
+cos                  s3
    
+
    Netease NOS
    
+
    For Netease NOS configure as per the configurator rclone config setting the provider Netease. This will automatically set force_path_style = false which is necessary for it to run properly.
    
+
    Limitations
    
+
    rclone about is not supported by the S3 backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.
    
+
    See List of backends that do not support rclone about See rclone about
    
+
    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, e.g. remote:bucket/path/to/dir.
    
+
    Here is an example of making a b2 configuration. First run
    
+
    rclone config
    
+
    This will guide you through an interactive setup process. To authenticate you will either need your Account ID (a short hex number) and Master Application Key (a long hex number) OR an Application Key, which is the recommended method. See below for further details on generating and using an Application Key.
    
+
    No remotes found - make a new one
+n) New remote
+q) Quit config
+n/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Backblaze B2
+   \ "b2"
+[snip]
+Storage> b2
 Account ID or Application Key ID
-
-- Config:      account
-- Env Var:     RCLONE_B2_ACCOUNT
-- Type:        string
-- Default:     ""
-
-#### --b2-key
-
+account> 123456789abc
 Application Key
+key> 0123456789abcdef0123456789abcdef0123456789
+Endpoint for the service - leave blank normally.
+endpoint>
+Remote config
+--------------------
+[remote]
+account = 123456789abc
+key = 0123456789abcdef0123456789abcdef0123456789
+endpoint =
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    This remote is called remote and can now be used like this
    
+
    See all buckets
    
+
    rclone lsd remote:
    
+
    Create a new bucket
    
+
    rclone mkdir remote:bucket
    
+
    List the contents of a bucket
    
+
    rclone ls remote:bucket
    
+
    Sync /home/local/directory to the remote bucket, deleting any excess files in the bucket.
    
+
    rclone sync -i /home/local/directory remote:bucket
    
+
    Application Keys
    
+
    B2 supports multiple Application Keys for different access permission to B2 Buckets.
    
+
    You can use these with rclone too; you will need to use rclone version 1.43 or later.
    
+
    Follow Backblaze's docs to create an Application Key with the required permission and add the applicationKeyId as the account and the Application Key itself as the key.
    
+
    Note that you must put the applicationKeyId as the account – you can't use the master Account ID. If you try then B2 will return 401 errors.
    
+
    --fast-list
    
+
    This remote supports --fast-list which allows you to use fewer transactions in exchange for more memory. See the rclone docs for more details.
    
+
    Modified time
    
+
    The modified time is stored as metadata on the object as X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time.
    
+
    Modified times are used in syncing and are fully supported. Note that if a modification time needs to be updated on an object then it will create a new version of the object.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    \0x5C＼
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Note that in 2020-05 Backblaze started allowing  characters in file names. Rclone hasn't changed its encoding as this could cause syncs to re-transfer files. If you want rclone not to replace  then see the --b2-encoding flag below and remove the BackSlash from the string. This can be set in the config.
    
+
    SHA1 checksums
    
+
    The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.
    
+
    Large files (bigger than the limit in --b2-upload-cutoff) which are uploaded in chunks will store their SHA1 on the object as X-Bz-Info-large_file_sha1 as recommended by Backblaze.
    
+
    For a large file to be uploaded with an SHA1 checksum, the source needs to support SHA1 checksums. The local disk supports SHA1 checksums so large file transfers from local disk will have an SHA1. See the overview for exactly which remotes support SHA1.
    
+
    Sources which don't support SHA1, in particular crypt will upload large files without SHA1 checksums. This may be fixed in the future (see #1767).
    
+
    Files sizes below --b2-upload-cutoff will always have an SHA1 regardless of the source.
    
+
    Transfers
    
+
    Backblaze recommends that you do lots of transfers simultaneously for maximum speed. In tests from my SSD equipped laptop the optimum setting is about --transfers 32 though higher numbers may be used for a slight speed improvement. The optimum number for you may vary depending on your hardware, how big the files are, how much you want to load your computer, etc. The default of --transfers 4 is definitely too low for Backblaze B2 though.
    
+
    Note that uploading big files (bigger than 200 MB by default) will use a 96 MB RAM buffer by default. There can be at most --transfers of these in use at any moment, so this sets the upper limit on the memory used.
    
+
    Versions
    
+
    When rclone uploads a new version of a file it creates a new version of it. Likewise when you delete a file, the old version will be marked hidden and still be available. Conversely, you may opt in to a "hard delete" of files with the --b2-hard-delete flag which would permanently remove the file instead of hiding it.
    
+
    Old versions of files, where available, are visible using the --b2-versions flag.
    
+
    NB Note that --b2-versions does not work with crypt at the moment #1627. Using --backup-dir with rclone is the recommended way of working around this.
    
+
    If you wish to remove all the old versions then you can use the rclone cleanup remote:bucket command which will delete all the old versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, e.g. rclone cleanup remote:bucket/path/to/stuff.
    
+
    Note that cleanup will remove partially uploaded files from the bucket if they are more than a day old.
    
+
    When you purge a bucket, the current and the old versions will be deleted then the bucket will be deleted.
    
+
    However delete will cause the current versions of the files to become hidden old versions.
    
+
    Here is a session showing the listing and retrieval of an old version followed by a cleanup of the old versions.
    
+
    Show current version and all the versions with --b2-versions flag.
    
+
    $ rclone -q ls b2:cleanup-test
+        9 one.txt
 
-- Config:      key
-- Env Var:     RCLONE_B2_KEY
-- Type:        string
-- Default:     ""
+$ rclone -q --b2-versions ls b2:cleanup-test
+        9 one.txt
+        8 one-v2016-07-04-141032-000.txt
+       16 one-v2016-07-04-141003-000.txt
+       15 one-v2016-07-02-155621-000.txt
    
+
    Retrieve an old version
    
+
    $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp
 
-#### --b2-hard-delete
+$ ls -l /tmp/one-v2016-07-04-141003-000.txt
+-rw-rw-r-- 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt
    
+
    Clean up all the old versions and show that they've gone.
    
+
    $ rclone -q cleanup b2:cleanup-test
 
-Permanently delete files on remote removal, otherwise hide files.
+$ rclone -q ls b2:cleanup-test
+        9 one.txt
 
-- Config:      hard_delete
-- Env Var:     RCLONE_B2_HARD_DELETE
-- Type:        bool
-- Default:     false
-
-### Advanced Options
-
-Here are the advanced options specific to b2 (Backblaze B2).
-
-#### --b2-endpoint
-
-Endpoint for the service.
-Leave blank normally.
-
-- Config:      endpoint
-- Env Var:     RCLONE_B2_ENDPOINT
-- Type:        string
-- Default:     ""
-
-#### --b2-test-mode
-
-A flag string for X-Bz-Test-Mode header for debugging.
-
-This is for debugging purposes only. Setting it to one of the strings
-below will cause b2 to return specific errors:
-
-  * "fail_some_uploads"
-  * "expire_some_account_authorization_tokens"
-  * "force_cap_exceeded"
-
-These will be set in the "X-Bz-Test-Mode" header which is documented
-in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html).
-
-- Config:      test_mode
-- Env Var:     RCLONE_B2_TEST_MODE
-- Type:        string
-- Default:     ""
-
-#### --b2-versions
-
-Include old versions in directory listings.
-Note that when using this no file write operations are permitted,
-so you can't upload files or delete them.
-
-- Config:      versions
-- Env Var:     RCLONE_B2_VERSIONS
-- Type:        bool
-- Default:     false
-
-#### --b2-upload-cutoff
-
-Cutoff for switching to chunked upload.
-
-Files above this size will be uploaded in chunks of "--b2-chunk-size".
-
-This value should be set no larger than 4.657GiB (== 5GB).
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_B2_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     200M
-
-#### --b2-copy-cutoff
-
-Cutoff for switching to multipart copy
-
-Any files larger than this that need to be server side copied will be
-copied in chunks of this size.
-
-The minimum is 0 and the maximum is 4.6GB.
-
-- Config:      copy_cutoff
-- Env Var:     RCLONE_B2_COPY_CUTOFF
-- Type:        SizeSuffix
-- Default:     4G
-
-#### --b2-chunk-size
-
-Upload chunk size. Must fit in memory.
-
-When uploading large files, chunk the file into this size.  Note that
-these chunks are buffered in memory and there might a maximum of
-"--transfers" chunks in progress at once.  5,000,000 Bytes is the
-minimum size.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_B2_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     96M
-
-#### --b2-disable-checksum
-
-Disable checksums for large (> upload cutoff) files
-
-Normally rclone will calculate the SHA1 checksum of the input before
-uploading it so it can add it to metadata on the object. This is great
-for data integrity checking but can cause long delays for large files
-to start uploading.
-
-- Config:      disable_checksum
-- Env Var:     RCLONE_B2_DISABLE_CHECKSUM
-- Type:        bool
-- Default:     false
-
-#### --b2-download-url
-
-Custom endpoint for downloads.
-
-This is usually set to a Cloudflare CDN URL as Backblaze offers
-free egress for data downloaded through the Cloudflare network.
-This is probably only useful for a public bucket.
-Leave blank if you want to use the endpoint provided by Backblaze.
-
-- Config:      download_url
-- Env Var:     RCLONE_B2_DOWNLOAD_URL
-- Type:        string
-- Default:     ""
-
-#### --b2-download-auth-duration
-
-Time before the authorization token will expire in s or suffix ms|s|m|h|d.
-
-The duration before the download authorization token will expire.
-The minimum value is 1 second. The maximum value is one week.
-
-- Config:      download_auth_duration
-- Env Var:     RCLONE_B2_DOWNLOAD_AUTH_DURATION
-- Type:        Duration
-- Default:     1w
-
-#### --b2-memory-pool-flush-time
-
-How often internal memory buffer pools will be flushed.
-Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations.
-This option controls how often unused buffers will be removed from the pool.
-
-- Config:      memory_pool_flush_time
-- Env Var:     RCLONE_B2_MEMORY_POOL_FLUSH_TIME
-- Type:        Duration
-- Default:     1m0s
-
-#### --b2-memory-pool-use-mmap
-
-Whether to use mmap buffers in internal memory pool.
-
-- Config:      memory_pool_use_mmap
-- Env Var:     RCLONE_B2_MEMORY_POOL_USE_MMAP
-- Type:        bool
-- Default:     false
-
-#### --b2-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_B2_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
-
-
-
- Box
------------------------------------------
-
-Paths are specified as `remote:path`
-
-Paths may be as deep as required, eg `remote:directory/subdirectory`.
-
-The initial setup for Box involves getting a token from Box which you
-can do either in your browser, or with a config.json downloaded from Box
-to use JWT authentication.  `rclone config` walks you through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
+$ rclone -q --b2-versions ls b2:cleanup-test
+        9 one.txt
    
+
    Data usage
    
+
    It is useful to know how many requests are sent to the server in different scenarios.
    
+
    All copy commands send the following 4 requests:
    
+
    /b2api/v1/b2_authorize_account
+/b2api/v1/b2_create_bucket
+/b2api/v1/b2_list_buckets
+/b2api/v1/b2_list_file_names
    
+
    The b2_list_file_names request will be sent once for every 1k files in the remote path, providing the checksum and modification time of the listed files. As of version 1.33 issue #818 causes extra requests to be sent when using B2 with Crypt. When a copy operation does not require any files to be uploaded, no more requests will be sent.
    
+
    Uploading files that do not require chunking, will send 2 requests per file upload:
    
+
    /b2api/v1/b2_get_upload_url
+/b2api/v1/b2_upload_file/
    
+
    Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk:
    
+
    /b2api/v1/b2_start_large_file
+/b2api/v1/b2_get_upload_part_url
+/b2api/v1/b2_upload_part/
+/b2api/v1/b2_finish_large_file
    
+
    Versions
    
+
    Versions can be viewed with the --b2-versions flag. When it is set rclone will show and act on older versions of files. For example
    
+
    Listing without --b2-versions
    
+
    $ rclone -q ls b2:cleanup-test
+        9 one.txt
    
+
    And with
    
+
    $ rclone -q --b2-versions ls b2:cleanup-test
+        9 one.txt
+        8 one-v2016-07-04-141032-000.txt
+       16 one-v2016-07-04-141003-000.txt
+       15 one-v2016-07-02-155621-000.txt
    
+
    Showing that the current version is unchanged but older versions can be seen. These have the UTC date that they were uploaded to the server to the nearest millisecond appended to them.
    
+
    Note that when using --b2-versions no file write operations are permitted, so you can't upload files or delete them.
    
+
+
    Rclone supports generating file share links for private B2 buckets. They can either be for a file for example:
    
+
    ./rclone link B2:bucket/path/to/file.txt
+https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx
 
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Box  "box" [snip] Storage> box Box App Client Id - leave blank normally. client_id> Box App Client Secret - leave blank normally. client_secret> Box App config.json location Leave blank normally. Enter a string value. Press Enter for the default (""). box_config_file> Box App Primary Access Token Leave blank normally. Enter a string value. Press Enter for the default (""). access_token>
    
-
    Enter a string value. Press Enter for the default ("user"). Choose a number from below, or type in your own value 1 / Rclone should act on behalf of a user  "user" 2 / Rclone should act on behalf of a service account  "enterprise" box_sub_type> Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] client_id = client_secret = token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
-machine with no Internet browser available.
-
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Box. This only runs from the moment it opens
-your browser to the moment you get back the verification code.  This
-is on `http://127.0.0.1:53682/` and this it may require you to unblock
-it temporarily if you are running a host firewall.
-
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your Box
-
-    rclone lsd remote:
-
-List all the files in your Box
-
-    rclone ls remote:
-
-To copy a local directory to an Box directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Using rclone with an Enterprise account with SSO ###
-
-If you have an "Enterprise" account type with Box with single sign on
-(SSO), you need to create a password to use Box with rclone. This can
-be done at your Enterprise Box account by going to Settings, "Account"
-Tab, and then set the password in the "Authentication" field.
-
-Once you have done this, you can setup your Enterprise Box account
-using the same procedure detailed above in the, using the password you
-have just set.
-
-### Invalid refresh token ###
-
-According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens):
-
-> Each refresh_token is valid for one use in 60 days.
-
-This means that if you
-
-  * Don't use the box remote for 60 days
-  * Copy the config file with a box refresh token in and use it in two places
-  * Get an error on a token refresh
-
-then rclone will return an error which includes the text `Invalid
-refresh token`.
-
-To fix this you will need to use oauth2 again to update the refresh
-token.  You can use the methods in [the remote setup
-docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the
-config file method, you should not use that remote on the computer you
-did the authentication on.
-
-Here is how to do it.
+
    or if run on a directory you will get:
    
+
    ./rclone link B2:bucket/path
+https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx
    
+
    you can then use the authorization token (the part of the url from the ?Authorization= on) on any file path under that directory. For example:
    
+
    https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx
+https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx
+https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx
 
    
-
    $ rclone config Current remotes:
    
-
    Name Type ==== ==== remote box
    
-
      
-
    1. Edit existing remote
      2. 
-
    2. New remote
      3. 
-
    3. Delete remote
      4. 
-
    4. Rename remote
      5. 
-
    5. Copy remote
      6. 
-
    6. Set configuration password
      7. 
-
    7. Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in an existing value 1 > remote remote> remote -------------------- [remote] type = box token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} -------------------- Edit remote Value "client_id" = "" Edit? (y/n)>
      8. 
-
    8. Yes
      9. 
-
    9. No y/n> n Value "client_secret" = "" Edit? (y/n)>
      10. 
-
    10. Yes
      11. 
-
    11. No y/n> n Remote config Already have a token - refresh?
      12. 
-
    12. Yes
      13. 
-
    13. No y/n> y Use auto config?
      14. 
-
    
+
    Standard Options
    
+
    Here are the standard options specific to b2 (Backblaze B2).
    
+
    --b2-account
    
+
    Account ID or Application Key ID
    
 
      
-
    • Say Y if not sure
      • 
-
    • Say N if you are working on a remote or headless machine
      • 
+
    • Config: account
      • 
+
    • Env Var: RCLONE_B2_ACCOUNT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
 
    
-
      
-
    1. Yes
      2. 
-
    2. No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = box token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} --------------------
      3. 
-
    3. Yes this is OK
      4. 
-
    4. Edit this remote
      5. 
-
    5. Delete this remote y/e/d> y
      6. 
-
    
-
    
-### Modified time and hashes ###
-
-Box allows modification times to be set on objects accurate to 1
-second.  These will be used to detect whether objects need syncing or
-not.
-
-Box supports SHA1 type hashes, so you can use the `--checksum`
-flag.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \         | 0x5C  | ＼           |
-
-File names can also not end with the following characters.
-These only get replaced if they are the last character in the name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-### Transfers ###
-
-For files above 50MB rclone will use a chunked transfer.  Rclone will
-upload up to `--transfers` chunks at the same time (shared among all
-the multipart uploads).  Chunks are buffered in memory and are
-normally 8MB so increasing `--transfers` will increase memory use.
-
-### Deleting files ###
-
-Depending on the enterprise settings for your user, the item will
-either be actually deleted from Box or moved to the trash.
-
-Emptying the trash is supported via the rclone however cleanup command
-however this deletes every trashed file and folder individually so it
-may take a very long time. 
-Emptying the trash via the  WebUI does not have this limitation 
-so it is advised to empty the trash via the WebUI.
-
-### Root folder ID ###
-
-You can set the `root_folder_id` for rclone.  This is the directory
-(identified by its `Folder ID`) that rclone considers to be the root
-of your Box drive.
-
-Normally you will leave this blank and rclone will determine the
-correct root to use itself.
-
-However you can set this to restrict rclone to a specific folder
-hierarchy.
-
-In order to do this you will have to find the `Folder ID` of the
-directory you wish rclone to display.  This will be the last segment
-of the URL when you open the relevant folder in the Box web
-interface.
-
-So if the folder you want rclone to use has a URL which looks like
-`https://app.box.com/folder/11xxxxxxxxx8`
-in the browser, then you use `11xxxxxxxxx8` as
-the `root_folder_id` in the config.
-
-
-### Standard Options
-
-Here are the standard options specific to box (Box).
-
-#### --box-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_BOX_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --box-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_BOX_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-#### --box-box-config-file
-
+
    --b2-key
    
+
    Application Key
    
+
      
+
    • Config: key
      • 
+
    • Env Var: RCLONE_B2_KEY
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-hard-delete
    
+
    Permanently delete files on remote removal, otherwise hide files.
    
+
      
+
    • Config: hard_delete
      • 
+
    • Env Var: RCLONE_B2_HARD_DELETE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to b2 (Backblaze B2).
    
+
    --b2-endpoint
    
+
    Endpoint for the service. Leave blank normally.
    
+
      
+
    • Config: endpoint
      • 
+
    • Env Var: RCLONE_B2_ENDPOINT
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-test-mode
    
+
    A flag string for X-Bz-Test-Mode header for debugging.
    
+
    This is for debugging purposes only. Setting it to one of the strings below will cause b2 to return specific errors:
    
+
      
+
    • "fail_some_uploads"
      • 
+
    • "expire_some_account_authorization_tokens"
      • 
+
    • "force_cap_exceeded"
      • 
+
    
+
    These will be set in the "X-Bz-Test-Mode" header which is documented in the b2 integrations checklist.
    
+
      
+
    • Config: test_mode
      • 
+
    • Env Var: RCLONE_B2_TEST_MODE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-versions
    
+
    Include old versions in directory listings. Note that when using this no file write operations are permitted, so you can't upload files or delete them.
    
+
      
+
    • Config: versions
      • 
+
    • Env Var: RCLONE_B2_VERSIONS
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --b2-upload-cutoff
    
+
    Cutoff for switching to chunked upload.
    
+
    Files above this size will be uploaded in chunks of "--b2-chunk-size".
    
+
    This value should be set no larger than 4.657GiB (== 5GB).
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_B2_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 200M
      • 
+
    
+
    --b2-copy-cutoff
    
+
    Cutoff for switching to multipart copy
    
+
    Any files larger than this that need to be server-side copied will be copied in chunks of this size.
    
+
    The minimum is 0 and the maximum is 4.6GB.
    
+
      
+
    • Config: copy_cutoff
      • 
+
    • Env Var: RCLONE_B2_COPY_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 4G
      • 
+
    
+
    --b2-chunk-size
    
+
    Upload chunk size. Must fit in memory.
    
+
    When uploading large files, chunk the file into this size. Note that these chunks are buffered in memory and there might a maximum of "--transfers" chunks in progress at once. 5,000,000 Bytes is the minimum size.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_B2_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 96M
      • 
+
    
+
    --b2-disable-checksum
    
+
    Disable checksums for large (> upload cutoff) files
    
+
    Normally rclone will calculate the SHA1 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.
    
+
      
+
    • Config: disable_checksum
      • 
+
    • Env Var: RCLONE_B2_DISABLE_CHECKSUM
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --b2-download-url
    
+
    Custom endpoint for downloads.
    
+
    This is usually set to a Cloudflare CDN URL as Backblaze offers free egress for data downloaded through the Cloudflare network. Rclone works with private buckets by sending an "Authorization" header. If the custom endpoint rewrites the requests for authentication, e.g., in Cloudflare Workers, this header needs to be handled properly. Leave blank if you want to use the endpoint provided by Backblaze.
    
+
      
+
    • Config: download_url
      • 
+
    • Env Var: RCLONE_B2_DOWNLOAD_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --b2-download-auth-duration
    
+
    Time before the authorization token will expire in s or suffix ms|s|m|h|d.
    
+
    The duration before the download authorization token will expire. The minimum value is 1 second. The maximum value is one week.
    
+
      
+
    • Config: download_auth_duration
      • 
+
    • Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION
      • 
+
    • Type: Duration
      • 
+
    • Default: 1w
      • 
+
    
+
    --b2-memory-pool-flush-time
    
+
    How often internal memory buffer pools will be flushed. Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. This option controls how often unused buffers will be removed from the pool.
    
+
      
+
    • Config: memory_pool_flush_time
      • 
+
    • Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 1m0s
      • 
+
    
+
    --b2-memory-pool-use-mmap
    
+
    Whether to use mmap buffers in internal memory pool.
    
+
      
+
    • Config: memory_pool_use_mmap
      • 
+
    • Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --b2-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_B2_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    rclone about is not supported by the B2 backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.
    
+
    See List of backends that do not support rclone about See rclone about
    
+
    Box
    
+
    Paths are specified as remote:path
    
+
    Paths may be as deep as required, e.g. remote:directory/subdirectory.
    
+
    The initial setup for Box involves getting a token from Box which you can do either in your browser, or with a config.json downloaded from Box to use JWT authentication. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Box
+   \ "box"
+[snip]
+Storage> box
+Box App Client Id - leave blank normally.
+client_id> 
+Box App Client Secret - leave blank normally.
+client_secret>
 Box App config.json location
 Leave blank normally.
-
-Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
-
-
-- Config:      box_config_file
-- Env Var:     RCLONE_BOX_BOX_CONFIG_FILE
-- Type:        string
-- Default:     ""
-
-#### --box-access-token
-
+Enter a string value. Press Enter for the default ("").
+box_config_file>
 Box App Primary Access Token
 Leave blank normally.
-
-- Config:      access_token
-- Env Var:     RCLONE_BOX_ACCESS_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --box-box-sub-type
-
-
-
-- Config:      box_sub_type
-- Env Var:     RCLONE_BOX_BOX_SUB_TYPE
-- Type:        string
-- Default:     "user"
-- Examples:
-    - "user"
-        - Rclone should act on behalf of a user
-    - "enterprise"
-        - Rclone should act on behalf of a service account
-
-### Advanced Options
-
-Here are the advanced options specific to box (Box).
-
-#### --box-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_BOX_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --box-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_BOX_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --box-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_BOX_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --box-root-folder-id
-
-Fill in for rclone to use a non root folder as its starting point.
-
-- Config:      root_folder_id
-- Env Var:     RCLONE_BOX_ROOT_FOLDER_ID
-- Type:        string
-- Default:     "0"
-
-#### --box-upload-cutoff
-
-Cutoff for switching to multipart upload (>= 50MB).
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_BOX_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     50M
-
-#### --box-commit-retries
-
-Max number of times to try committing a multipart file.
-
-- Config:      commit_retries
-- Env Var:     RCLONE_BOX_COMMIT_RETRIES
-- Type:        int
-- Default:     100
-
-#### --box-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_BOX_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
-
-
-
-### Limitations ###
-
-Note that Box is case insensitive so you can't have a file called
-"Hello.doc" and one called "hello.doc".
-
-Box file names can't have the `\` character in.  rclone maps this to
-and from an identical looking unicode equivalent `＼`.
-
-Box only supports filenames up to 255 characters in length.
-
- Cache (BETA)
------------------------------------------
-
-The `cache` remote wraps another existing remote and stores file structure
-and its data for long running tasks like `rclone mount`.
-
-## Status
-
-The cache backend code is working but it currently doesn't
-have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren't getting fixed.
-
-The cache backend is due to be phased out in favour of the VFS caching
-layer eventually which is more tightly integrated into rclone.
-
-Until this happens we recommend only using the cache backend if you
-find you can't work without it. There are many docs online describing
-the use of the cache backend to minimize API hits and by-and-large
-these are out of date and the cache backend isn't needed in those
-scenarios any more.
-
-## Setup
-
-To get started you just need to have an existing remote which can be configured
-with `cache`.
-
-Here is an example of how to make a remote called `test-cache`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> test-cache Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Cache a remote  "cache" [snip] Storage> cache Remote to cache. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). remote> local:/test Optional: The URL of the Plex server plex_url> http://127.0.0.1:32400 Optional: The username of the Plex user plex_username> dummyusername Optional: The password of the Plex user y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> y Enter the password: password: Confirm the password: password: The size of a chunk. Lower value good for slow connections but can affect seamless reading. Default: 5M Choose a number from below, or type in your own value 1 / 1MB  "1m" 2 / 5 MB  "5M" 3 / 10 MB  "10M" chunk_size> 2 How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. Accepted units are: "s", "m", "h". Default: 5m Choose a number from below, or type in your own value 1 / 1 hour  "1h" 2 / 24 hours  "24h" 3 / 24 hours  "48h" info_age> 2 The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. Default: 10G Choose a number from below, or type in your own value 1 / 500 MB  "500M" 2 / 1 GB  "1G" 3 / 10 GB  "10G" chunk_total_size> 3 Remote config -------------------- [test-cache] remote = local:/test plex_url = http://127.0.0.1:32400 plex_username = dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age = 48h chunk_total_size = 10G
    
-
    
-You can then use it like this,
-
-List directories in top level of your drive
-
-    rclone lsd test-cache:
-
-List all the files in your drive
-
-    rclone ls test-cache:
-
-To start a cached mount
-
-    rclone mount --allow-other test-cache: /var/tmp/test-cache
-
-### Write Features ###
-
-### Offline uploading ###
-
-In an effort to make writing through cache more reliable, the backend 
-now supports this feature which can be activated by specifying a
-`cache-tmp-upload-path`.
-
-A files goes through these states when using this feature:
-
-1. An upload is started (usually by copying a file on the cache remote)
-2. When the copy to the temporary location is complete the file is part 
-of the cached remote and looks and behaves like any other file (reading included)
-3. After `cache-tmp-wait-time` passes and the file is next in line, `rclone move` 
-is used to move the file to the cloud provider
-4. Reading the file still works during the upload but most modifications on it will be prohibited
-5. Once the move is complete the file is unlocked for modifications as it
-becomes as any other regular file
-6. If the file is being read through `cache` when it's actually
-deleted from the temporary path then `cache` will simply swap the source
-to the cloud provider without interrupting the reading (small blip can happen though)
-
-Files are uploaded in sequence and only one file is uploaded at a time.
-Uploads will be stored in a queue and be processed based on the order they were added.
-The queue and the temporary storage is persistent across restarts but
-can be cleared on startup with the `--cache-db-purge` flag.
-
-### Write Support ###
-
-Writes are supported through `cache`.
-One caveat is that a mounted cache remote does not add any retry or fallback
-mechanism to the upload operation. This will depend on the implementation
-of the wrapped remote. Consider using `Offline uploading` for reliable writes.
-
-One special case is covered with `cache-writes` which will cache the file
-data at the same time as the upload when it is enabled making it available
-from the cache store immediately once the upload is finished.
-
-### Read Features ###
-
-#### Multiple connections ####
-
-To counter the high latency between a local PC where rclone is running
-and cloud providers, the cache remote can split multiple requests to the
-cloud provider for smaller file chunks and combines them together locally
-where they can be available almost immediately before the reader usually
-needs them.
-
-This is similar to buffering when media files are played online. Rclone
-will stay around the current marker but always try its best to stay ahead
-and prepare the data before.
-
-#### Plex Integration ####
-
-There is a direct integration with Plex which allows cache to detect during reading
-if the file is in playback or not. This helps cache to adapt how it queries
-the cloud provider depending on what is needed for.
-
-Scans will have a minimum amount of workers (1) while in a confirmed playback cache
-will deploy the configured number of workers.
-
-This integration opens the doorway to additional performance improvements
-which will be explored in the near future.
-
-**Note:** If Plex options are not configured, `cache` will function with its
-configured options without adapting any of its settings.
-
-How to enable? Run `rclone config` and add all the Plex options (endpoint, username
-and password) in your remote and it will be automatically enabled.
-
-Affected settings:
-- `cache-workers`: _Configured value_ during confirmed playback or _1_ all the other times
-
-##### Certificate Validation #####
-
-When the Plex server is configured to only accept secure connections, it is
-possible to use `.plex.direct` URLs to ensure certificate validation succeeds.
-These URLs are used by Plex internally to connect to the Plex server securely.
-
-The format for these URLs is the following:
-
-https://ip-with-dots-replaced.server-hash.plex.direct:32400/
-
-The `ip-with-dots-replaced` part can be any IPv4 address, where the dots
-have been replaced with dashes, e.g. `127.0.0.1` becomes `127-0-0-1`.
-
-To get the `server-hash` part, the easiest way is to visit
-
-https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token
-
-This page will list all the available Plex servers for your account
-with at least one `.plex.direct` link for each. Copy one URL and replace
-the IP address with the desired address. This can be used as the
-`plex_url` value.
-
-### Known issues ###
-
-#### Mount and --dir-cache-time ####
-
---dir-cache-time controls the first layer of directory caching which works at the mount layer.
-Being an independent caching mechanism from the `cache` backend, it will manage its own entries
-based on the configured time.
-
-To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct
-one, try to set `--dir-cache-time` to a lower time than `--cache-info-age`. Default values are
-already configured in this way. 
-
-#### Windows support - Experimental ####
-
-There are a couple of issues with Windows `mount` functionality that still require some investigations.
-It should be considered as experimental thus far as fixes come in for this OS.
-
-Most of the issues seem to be related to the difference between filesystems
-on Linux flavors and Windows as cache is heavily dependent on them.
-
-Any reports or feedback on how cache behaves on this OS is greatly appreciated.
- 
-- https://github.com/rclone/rclone/issues/1935
-- https://github.com/rclone/rclone/issues/1907
-- https://github.com/rclone/rclone/issues/1834 
-
-#### Risk of throttling ####
-
-Future iterations of the cache backend will make use of the pooling functionality
-of the cloud provider to synchronize and at the same time make writing through it
-more tolerant to failures. 
-
-There are a couple of enhancements in track to add these but in the meantime
-there is a valid concern that the expiring cache listings can lead to cloud provider
-throttles or bans due to repeated queries on it for very large mounts.
-
-Some recommendations:
-- don't use a very small interval for entry information (`--cache-info-age`)
-- while writes aren't yet optimised, you can still write through `cache` which gives you the advantage
-of adding the file in the cache at the same time if configured to do so.
-
-Future enhancements:
-
-- https://github.com/rclone/rclone/issues/1937
-- https://github.com/rclone/rclone/issues/1936 
-
-#### cache and crypt ####
-
-One common scenario is to keep your data encrypted in the cloud provider
-using the `crypt` remote. `crypt` uses a similar technique to wrap around
-an existing remote and handles this translation in a seamless way.
-
-There is an issue with wrapping the remotes in this order:
-**cloud remote** -> **crypt** -> **cache**
-
-During testing, I experienced a lot of bans with the remotes in this order.
-I suspect it might be related to how crypt opens files on the cloud provider
-which makes it think we're downloading the full file instead of small chunks.
-Organizing the remotes in this order yields better results:
-**cloud remote** -> **cache** -> **crypt**
-
-#### absolute remote paths ####
-
-`cache` can not differentiate between relative and absolute paths for the wrapped remote.
-Any path given in the `remote` config setting and on the command line will be passed to
-the wrapped remote as is, but for storing the chunks on disk the path will be made
-relative by removing any leading `/` character.
-
-This behavior is irrelevant for most backend types, but there are backends where a leading `/`
-changes the effective directory, e.g. in the `sftp` backend paths starting with a `/` are
-relative to the root of the SSH server and paths without are relative to the user home directory.
-As a result `sftp:bin` and `sftp:/bin` will share the same cache folder, even if they represent
-a different directory on the SSH server.
-
-### Cache and Remote Control (--rc) ###
-Cache supports the new `--rc` mode in rclone and can be remote controlled through the following end points:
-By default, the listener is disabled if you do not add the flag.
-
-### rc cache/expire
-Purge a remote from the cache backend. Supports either a directory or a file.
-It supports both encrypted and unencrypted file names if cache is wrapped by crypt.
-
-Params:
-  - **remote** = path to remote **(required)**
-  - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_
-
-
-### Standard Options
-
-Here are the standard options specific to cache (Cache a remote).
-
-#### --cache-remote
-
+Enter a string value. Press Enter for the default ("").
+access_token>
+
+Enter a string value. Press Enter for the default ("user").
+Choose a number from below, or type in your own value
+ 1 / Rclone should act on behalf of a user
+   \ "user"
+ 2 / Rclone should act on behalf of a service account
+   \ "enterprise"
+box_sub_type>
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+client_id = 
+client_secret = 
+token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    See the remote setup docs for how to set it up on a machine with no Internet browser available.
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your Box
    
+
    rclone lsd remote:
    
+
    List all the files in your Box
    
+
    rclone ls remote:
    
+
    To copy a local directory to an Box directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Using rclone with an Enterprise account with SSO
    
+
    If you have an "Enterprise" account type with Box with single sign on (SSO), you need to create a password to use Box with rclone. This can be done at your Enterprise Box account by going to Settings, "Account" Tab, and then set the password in the "Authentication" field.
    
+
    Once you have done this, you can setup your Enterprise Box account using the same procedure detailed above in the, using the password you have just set.
    
+
    Invalid refresh token
    
+
    According to the box docs:
    
+
    
+
    Each refresh_token is valid for one use in 60 days.
    
+
    
+
    This means that if you
    
+
      
+
    • Don't use the box remote for 60 days
      • 
+
    • Copy the config file with a box refresh token in and use it in two places
      • 
+
    • Get an error on a token refresh
      • 
+
    
+
    then rclone will return an error which includes the text Invalid refresh token.
    
+
    To fix this you will need to use oauth2 again to update the refresh token. You can use the methods in the remote setup docs, bearing in mind that if you use the copy the config file method, you should not use that remote on the computer you did the authentication on.
    
+
    Here is how to do it.
    
+
    $ rclone config
+Current remotes:
+
+Name                 Type
+====                 ====
+remote               box
+
+e) Edit existing remote
+n) New remote
+d) Delete remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+e/n/d/r/c/s/q> e
+Choose a number from below, or type in an existing value
+ 1 > remote
+remote> remote
+--------------------
+[remote]
+type = box
+token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"}
+--------------------
+Edit remote
+Value "client_id" = ""
+Edit? (y/n)>
+y) Yes
+n) No
+y/n> n
+Value "client_secret" = ""
+Edit? (y/n)>
+y) Yes
+n) No
+y/n> n
+Remote config
+Already have a token - refresh?
+y) Yes
+n) No
+y/n> y
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+type = box
+token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Modified time and hashes
    
+
    Box allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.
    
+
    Box supports SHA1 type hashes, so you can use the --checksum flag.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    \0x5C＼
    
+
    File names can also not end with the following characters. These only get replaced if they are the last character in the name:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    CharacterValueReplacement
    SP0x20␠
    
+
    Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON strings.
    
+
    Transfers
    
+
    For files above 50MB rclone will use a chunked transfer. Rclone will upload up to --transfers chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 8MB so increasing --transfers will increase memory use.
    
+
    Deleting files
    
+
    Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash.
    
+
    Emptying the trash is supported via the rclone however cleanup command however this deletes every trashed file and folder individually so it may take a very long time. Emptying the trash via the WebUI does not have this limitation so it is advised to empty the trash via the WebUI.
    
+
    Root folder ID
    
+
    You can set the root_folder_id for rclone. This is the directory (identified by its Folder ID) that rclone considers to be the root of your Box drive.
    
+
    Normally you will leave this blank and rclone will determine the correct root to use itself.
    
+
    However you can set this to restrict rclone to a specific folder hierarchy.
    
+
    In order to do this you will have to find the Folder ID of the directory you wish rclone to display. This will be the last segment of the URL when you open the relevant folder in the Box web interface.
    
+
    So if the folder you want rclone to use has a URL which looks like https://app.box.com/folder/11xxxxxxxxx8 in the browser, then you use 11xxxxxxxxx8 as the root_folder_id in the config.
    
+
    Standard Options
    
+
    Here are the standard options specific to box (Box).
    
+
    --box-client-id
    
+
    OAuth Client Id Leave blank normally.
    
+
      
+
    • Config: client_id
      • 
+
    • Env Var: RCLONE_BOX_CLIENT_ID
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-client-secret
    
+
    OAuth Client Secret Leave blank normally.
    
+
      
+
    • Config: client_secret
      • 
+
    • Env Var: RCLONE_BOX_CLIENT_SECRET
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-box-config-file
    
+
    Box App config.json location Leave blank normally.
    
+
    Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.
    
+
      
+
    • Config: box_config_file
      • 
+
    • Env Var: RCLONE_BOX_BOX_CONFIG_FILE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-access-token
    
+
    Box App Primary Access Token Leave blank normally.
    
+
      
+
    • Config: access_token
      • 
+
    • Env Var: RCLONE_BOX_ACCESS_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-box-sub-type
    
+
      
+
    • Config: box_sub_type
      • 
+
    • Env Var: RCLONE_BOX_BOX_SUB_TYPE
      • 
+
    • Type: string
      • 
+
    • Default: "user"
      • 
+
    • Examples:
+
        
+
      • "user"
+
          
+
        • Rclone should act on behalf of a user
          • 
+
        • 
+
      • "enterprise"
+
          
+
        • Rclone should act on behalf of a service account
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to box (Box).
    
+
    --box-token
    
+
    OAuth Access Token as a JSON blob.
    
+
      
+
    • Config: token
      • 
+
    • Env Var: RCLONE_BOX_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-auth-url
    
+
    Auth server URL. Leave blank to use the provider defaults.
    
+
      
+
    • Config: auth_url
      • 
+
    • Env Var: RCLONE_BOX_AUTH_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-token-url
    
+
    Token server url. Leave blank to use the provider defaults.
    
+
      
+
    • Config: token_url
      • 
+
    • Env Var: RCLONE_BOX_TOKEN_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --box-root-folder-id
    
+
    Fill in for rclone to use a non root folder as its starting point.
    
+
      
+
    • Config: root_folder_id
      • 
+
    • Env Var: RCLONE_BOX_ROOT_FOLDER_ID
      • 
+
    • Type: string
      • 
+
    • Default: "0"
      • 
+
    
+
    --box-upload-cutoff
    
+
    Cutoff for switching to multipart upload (>= 50MB).
    
+
      
+
    • Config: upload_cutoff
      • 
+
    • Env Var: RCLONE_BOX_UPLOAD_CUTOFF
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 50M
      • 
+
    
+
    --box-commit-retries
    
+
    Max number of times to try committing a multipart file.
    
+
      
+
    • Config: commit_retries
      • 
+
    • Env Var: RCLONE_BOX_COMMIT_RETRIES
      • 
+
    • Type: int
      • 
+
    • Default: 100
      • 
+
    
+
    --box-encoding
    
+
    This sets the encoding for the backend.
    
+
    See: the encoding section in the overview for more info.
    
+
      
+
    • Config: encoding
      • 
+
    • Env Var: RCLONE_BOX_ENCODING
      • 
+
    • Type: MultiEncoder
      • 
+
    • Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot
      • 
+
    
+
    Limitations
    
+
    Note that Box is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    Box file names can't have the \ character in. rclone maps this to and from an identical looking unicode equivalent ＼ (U+FF3C Fullwidth Reverse Solidus).
    
+
    Box only supports filenames up to 255 characters in length.
    
+
    rclone about is not supported by the Box backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.
    
+
    See List of backends that do not support rclone about See rclone about
    
+
    Cache (BETA)
    
+
    The cache remote wraps another existing remote and stores file structure and its data for long running tasks like rclone mount.
    
+
    Status
    
+
    The cache backend code is working but it currently doesn't have a maintainer so there are outstanding bugs which aren't getting fixed.
    
+
    The cache backend is due to be phased out in favour of the VFS caching layer eventually which is more tightly integrated into rclone.
    
+
    Until this happens we recommend only using the cache backend if you find you can't work without it. There are many docs online describing the use of the cache backend to minimize API hits and by-and-large these are out of date and the cache backend isn't needed in those scenarios any more.
    
+
    Setup
    
+
    To get started you just need to have an existing remote which can be configured with cache.
    
+
    Here is an example of how to make a remote called test-cache. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+r) Rename remote
+c) Copy remote
+s) Set configuration password
+q) Quit config
+n/r/c/s/q> n
+name> test-cache
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / Cache a remote
+   \ "cache"
+[snip]
+Storage> cache
 Remote to cache.
-Normally should contain a ':' and a path, eg "myremote:path/to/dir",
+Normally should contain a ':' and a path, e.g. "myremote:path/to/dir",
 "myremote:bucket" or maybe "myremote:" (not recommended).
-
-- Config:      remote
-- Env Var:     RCLONE_CACHE_REMOTE
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-url
-
-The URL of the Plex server
-
-- Config:      plex_url
-- Env Var:     RCLONE_CACHE_PLEX_URL
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-username
-
-The username of the Plex user
-
-- Config:      plex_username
-- Env Var:     RCLONE_CACHE_PLEX_USERNAME
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-password
-
-The password of the Plex user
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      plex_password
-- Env Var:     RCLONE_CACHE_PLEX_PASSWORD
-- Type:        string
-- Default:     ""
-
-#### --cache-chunk-size
-
-The size of a chunk (partial file data).
-
-Use lower numbers for slower connections. If the chunk size is
-changed, any downloaded chunks will be invalid and cache-chunk-path
-will need to be cleared or unexpected EOF errors will occur.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_CACHE_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     5M
-- Examples:
-    - "1m"
-        - 1MB
-    - "5M"
-        - 5 MB
-    - "10M"
-        - 10 MB
-
-#### --cache-info-age
-
-How long to cache file structure information (directory listings, file size, times etc). 
-If all write operations are done through the cache then you can safely make
-this value very large as the cache store will also be updated in real time.
-
-- Config:      info_age
-- Env Var:     RCLONE_CACHE_INFO_AGE
-- Type:        Duration
-- Default:     6h0m0s
-- Examples:
-    - "1h"
-        - 1 hour
-    - "24h"
-        - 24 hours
-    - "48h"
-        - 48 hours
-
-#### --cache-chunk-total-size
-
-The total size that the chunks can take up on the local disk.
-
-If the cache exceeds this value then it will start to delete the
-oldest chunks until it goes under this value.
-
-- Config:      chunk_total_size
-- Env Var:     RCLONE_CACHE_CHUNK_TOTAL_SIZE
-- Type:        SizeSuffix
-- Default:     10G
-- Examples:
-    - "500M"
-        - 500 MB
-    - "1G"
-        - 1 GB
-    - "10G"
-        - 10 GB
-
-### Advanced Options
-
-Here are the advanced options specific to cache (Cache a remote).
-
-#### --cache-plex-token
-
-The plex token for authentication - auto set normally
-
-- Config:      plex_token
-- Env Var:     RCLONE_CACHE_PLEX_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --cache-plex-insecure
-
-Skip all certificate verification when connecting to the Plex server
-
-- Config:      plex_insecure
-- Env Var:     RCLONE_CACHE_PLEX_INSECURE
-- Type:        string
-- Default:     ""
-
-#### --cache-db-path
-
-Directory to store file structure metadata DB.
-The remote name is used as the DB file name.
-
-- Config:      db_path
-- Env Var:     RCLONE_CACHE_DB_PATH
-- Type:        string
-- Default:     "$HOME/.cache/rclone/cache-backend"
-
-#### --cache-chunk-path
-
-Directory to cache chunk files.
-
-Path to where partial file data (chunks) are stored locally. The remote
-name is appended to the final path.
-
-This config follows the "--cache-db-path". If you specify a custom
-location for "--cache-db-path" and don't specify one for "--cache-chunk-path"
-then "--cache-chunk-path" will use the same path as "--cache-db-path".
-
-- Config:      chunk_path
-- Env Var:     RCLONE_CACHE_CHUNK_PATH
-- Type:        string
-- Default:     "$HOME/.cache/rclone/cache-backend"
-
-#### --cache-db-purge
-
-Clear all the cached data for this remote on start.
-
-- Config:      db_purge
-- Env Var:     RCLONE_CACHE_DB_PURGE
-- Type:        bool
-- Default:     false
-
-#### --cache-chunk-clean-interval
-
-How often should the cache perform cleanups of the chunk storage.
-The default value should be ok for most people. If you find that the
-cache goes over "cache-chunk-total-size" too often then try to lower
-this value to force it to perform cleanups more often.
-
-- Config:      chunk_clean_interval
-- Env Var:     RCLONE_CACHE_CHUNK_CLEAN_INTERVAL
-- Type:        Duration
-- Default:     1m0s
-
-#### --cache-read-retries
-
-How many times to retry a read from a cache storage.
-
-Since reading from a cache stream is independent from downloading file
-data, readers can get to a point where there's no more data in the
-cache.  Most of the times this can indicate a connectivity issue if
-cache isn't able to provide file data anymore.
-
-For really slow connections, increase this to a point where the stream is
-able to provide data but your experience will be very stuttering.
-
-- Config:      read_retries
-- Env Var:     RCLONE_CACHE_READ_RETRIES
-- Type:        int
-- Default:     10
-
-#### --cache-workers
-
-How many workers should run in parallel to download chunks.
-
-Higher values will mean more parallel processing (better CPU needed)
-and more concurrent requests on the cloud provider.  This impacts
-several aspects like the cloud provider API limits, more stress on the
-hardware that rclone runs on but it also means that streams will be
-more fluid and data will be available much more faster to readers.
-
-**Note**: If the optional Plex integration is enabled then this
-setting will adapt to the type of reading performed and the value
-specified here will be used as a maximum number of workers to use.
-
-- Config:      workers
-- Env Var:     RCLONE_CACHE_WORKERS
-- Type:        int
-- Default:     4
-
-#### --cache-chunk-no-memory
-
-Disable the in-memory cache for storing chunks during streaming.
-
-By default, cache will keep file data during streaming in RAM as well
-to provide it to readers as fast as possible.
-
-This transient data is evicted as soon as it is read and the number of
-chunks stored doesn't exceed the number of workers. However, depending
-on other settings like "cache-chunk-size" and "cache-workers" this footprint
-can increase if there are parallel streams too (multiple files being read
-at the same time).
-
-If the hardware permits it, use this feature to provide an overall better
-performance during streaming but it can also be disabled if RAM is not
-available on the local machine.
-
-- Config:      chunk_no_memory
-- Env Var:     RCLONE_CACHE_CHUNK_NO_MEMORY
-- Type:        bool
-- Default:     false
-
-#### --cache-rps
-
-Limits the number of requests per second to the source FS (-1 to disable)
-
-This setting places a hard limit on the number of requests per second
-that cache will be doing to the cloud provider remote and try to
-respect that value by setting waits between reads.
-
-If you find that you're getting banned or limited on the cloud
-provider through cache and know that a smaller number of requests per
-second will allow you to work with it then you can use this setting
-for that.
-
-A good balance of all the other settings should make this setting
-useless but it is available to set for more special cases.
-
-**NOTE**: This will limit the number of requests during streams but
-other API calls to the cloud provider like directory listings will
-still pass.
-
-- Config:      rps
-- Env Var:     RCLONE_CACHE_RPS
-- Type:        int
-- Default:     -1
-
-#### --cache-writes
-
-Cache file data on writes through the FS
-
-If you need to read files immediately after you upload them through
-cache you can enable this flag to have their data stored in the
-cache store at the same time during upload.
-
-- Config:      writes
-- Env Var:     RCLONE_CACHE_WRITES
-- Type:        bool
-- Default:     false
-
-#### --cache-tmp-upload-path
-
-Directory to keep temporary files until they are uploaded.
-
-This is the path where cache will use as a temporary storage for new
-files that need to be uploaded to the cloud provider.
-
-Specifying a value will enable this feature. Without it, it is
-completely disabled and files will be uploaded directly to the cloud
-provider
-
-- Config:      tmp_upload_path
-- Env Var:     RCLONE_CACHE_TMP_UPLOAD_PATH
-- Type:        string
-- Default:     ""
-
-#### --cache-tmp-wait-time
-
-How long should files be stored in local cache before being uploaded
-
-This is the duration that a file must wait in the temporary location
-_cache-tmp-upload-path_ before it is selected for upload.
-
-Note that only one file is uploaded at a time and it can take longer
-to start the upload if a queue formed for this purpose.
-
-- Config:      tmp_wait_time
-- Env Var:     RCLONE_CACHE_TMP_WAIT_TIME
-- Type:        Duration
-- Default:     15s
-
-#### --cache-db-wait-time
-
-How long to wait for the DB to be available - 0 is unlimited
-
-Only one process can have the DB open at any one time, so rclone waits
-for this duration for the DB to become available before it gives an
-error.
-
-If you set it to 0 then it will wait forever.
-
-- Config:      db_wait_time
-- Env Var:     RCLONE_CACHE_DB_WAIT_TIME
-- Type:        Duration
-- Default:     1s
-
-### Backend commands
-
-Here are the commands specific to the cache backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### stats
-
-Print stats on the cache backend in JSON format.
-
-    rclone backend stats remote: [options] [<arguments>+]
-
-
-
-Chunker (BETA)
-----------------------------------------
-
-The `chunker` overlay transparently splits large files into smaller chunks
-during upload to wrapped remote and transparently assembles them back
-when the file is downloaded. This allows to effectively overcome size limits
-imposed by storage providers.
-
-To use it, first set up the underlying remote following the configuration
-instructions for that remote. You can also use a local pathname instead of
-a remote.
-
-First check your chosen remote is working - we'll call it `remote:path` here.
-Note that anything inside `remote:path` will be chunked and anything outside
-won't. This means that if you are using a bucket based remote (eg S3, B2, swift)
-then you should probably put the bucket in the remote `s3:bucket`.
-
-Now configure `chunker` using `rclone config`. We will call this one `overlay`
-to separate it from the `remote` itself.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> overlay Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Transparently chunk/split large files  "chunker" [snip] Storage> chunker Remote to chunk/unchunk. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). Enter a string value. Press Enter for the default (""). remote> remote:path Files larger than chunk size will be split in chunks. Enter a size with suffix k,M,G,T. Press Enter for the default ("2G"). chunk_size> 100M Choose how chunker handles hash sums. All modes but "none" require metadata. Enter a string value. Press Enter for the default ("md5"). Choose a number from below, or type in your own value 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise  "none" 2 / MD5 for composite files  "md5" 3 / SHA1 for composite files  "sha1" 4 / MD5 for all files  "md5all" 5 / SHA1 for all files  "sha1all" 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported  "md5quick" 7 / Similar to "md5quick" but prefers SHA1 over MD5  "sha1quick" hash_type> md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -------------------- [overlay] type = chunker remote = remote:bucket chunk_size = 100M hash_type = md5 -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-### Specifying the remote
-
-In normal use, make sure the remote has a `:` in. If you specify the remote
-without a `:` then rclone will use a local directory of that name.
-So if you use a remote of `/path/to/secret/files` then rclone will
-chunk stuff in that directory. If you use a remote of `name` then rclone
-will put files in a directory called `name` in the current directory.
-
-
-### Chunking
-
-When rclone starts a file upload, chunker checks the file size. If it
-doesn't exceed the configured chunk size, chunker will just pass the file
-to the wrapped remote. If a file is large, chunker will transparently cut
-data in pieces with temporary names and stream them one by one, on the fly.
-Each data chunk will contain the specified number of bytes, except for the
-last one which may have less data. If file size is unknown in advance
-(this is called a streaming upload), chunker will internally create
-a temporary copy, record its size and repeat the above process.
-
-When upload completes, temporary chunk files are finally renamed.
-This scheme guarantees that operations can be run in parallel and look
-from outside as atomic.
-A similar method with hidden temporary chunks is used for other operations
-(copy/move/rename etc). If an operation fails, hidden chunks are normally
-destroyed, and the target composite file stays intact.
-
-When a composite file download is requested, chunker transparently
-assembles it by concatenating data chunks in order. As the split is trivial
-one could even manually concatenate data chunks together to obtain the
-original content.
-
-When the `list` rclone command scans a directory on wrapped remote,
-the potential chunk files are accounted for, grouped and assembled into
-composite directory entries. Any temporary chunks are hidden.
-
-List and other commands can sometimes come across composite files with
-missing or invalid chunks, eg. shadowed by like-named directory or
-another file. This usually means that wrapped file system has been directly
-tampered with or damaged. If chunker detects a missing chunk it will
-by default print warning, skip the whole incomplete group of chunks but
-proceed with current command.
-You can set the `--chunker-fail-hard` flag to have commands abort with
-error message in such cases.
-
-
-#### Chunk names
-
-The default chunk name format is `*.rclone_chunk.###`, hence by default
-chunk names are `BIG_FILE_NAME.rclone_chunk.001`,
-`BIG_FILE_NAME.rclone_chunk.002` etc. You can configure another name format
-using the `name_format` configuration file option. The format uses asterisk
-`*` as a placeholder for the base file name and one or more consecutive
-hash characters `#` as a placeholder for sequential chunk number.
-There must be one and only one asterisk. The number of consecutive hash
-characters defines the minimum length of a string representing a chunk number.
-If decimal chunk number has less digits than the number of hashes, it is
-left-padded by zeros. If the decimal string is longer, it is left intact.
-By default numbering starts from 1 but there is another option that allows
-user to start from 0, eg. for compatibility with legacy software.
-
-For example, if name format is `big_*-##.part` and original file name is
-`data.txt` and numbering starts from 0, then the first chunk will be named
-`big_data.txt-00.part`, the 99th chunk will be `big_data.txt-98.part`
-and the 302nd chunk will become `big_data.txt-301.part`.
-
-Note that `list` assembles composite directory entries only when chunk names
-match the configured format and treats non-conforming file names as normal
-non-chunked files.
-
-
-### Metadata
-
-Besides data chunks chunker will by default create metadata object for
-a composite file. The object is named after the original file.
-Chunker allows user to disable metadata completely (the `none` format).
-Note that metadata is normally not created for files smaller than the
-configured chunk size. This may change in future rclone releases.
-
-#### Simple JSON metadata format
-
-This is the default format. It supports hash sums and chunk validation
-for composite files. Meta objects carry the following fields:
-
-- `ver`     - version of format, currently `1`
-- `size`    - total size of composite file
-- `nchunks` - number of data chunks in file
-- `md5`     - MD5 hashsum of composite file (if present)
-- `sha1`    - SHA1 hashsum (if present)
-
-There is no field for composite file name as it's simply equal to the name
-of meta object on the wrapped remote. Please refer to respective sections
-for details on hashsums and modified time handling.
-
-#### No metadata
-
-You can disable meta objects by setting the meta format option to `none`.
-In this mode chunker will scan directory for all files that follow
-configured chunk name format, group them by detecting chunks with the same
-base name and show group names as virtual composite files.
-This method is more prone to missing chunk errors (especially missing
-last chunk) than format with metadata enabled.
-
-
-### Hashsums
-
-Chunker supports hashsums only when a compatible metadata is present.
-Hence, if you choose metadata format of `none`, chunker will report hashsum
-as `UNSUPPORTED`.
-
-Please note that by default metadata is stored only for composite files.
-If a file is smaller than configured chunk size, chunker will transparently
-redirect hash requests to wrapped remote, so support depends on that.
-You will see the empty string as a hashsum of requested type for small
-files if the wrapped remote doesn't support it.
-
-Many storage backends support MD5 and SHA1 hash types, so does chunker.
-With chunker you can choose one or another but not both.
-MD5 is set by default as the most supported type.
-Since chunker keeps hashes for composite files and falls back to the
-wrapped remote hash for non-chunked ones, we advise you to choose the same
-hash type as supported by wrapped remote so that your file listings
-look coherent.
-
-If your storage backend does not support MD5 or SHA1 but you need consistent
-file hashing, configure chunker with `md5all` or `sha1all`. These two modes
-guarantee given hash for all files. If wrapped remote doesn't support it,
-chunker will then add metadata to all files, even small. However, this can
-double the amount of small files in storage and incur additional service charges.
-You can even use chunker to force md5/sha1 support in any other remote
-at expense of sidecar meta objects by setting eg. `chunk_type=sha1all`
-to force hashsums and `chunk_size=1P` to effectively disable chunking.
-
-Normally, when a file is copied to chunker controlled remote, chunker
-will ask the file source for compatible file hash and revert to on-the-fly
-calculation if none is found. This involves some CPU overhead but provides
-a guarantee that given hashsum is available. Also, chunker will reject
-a server-side copy or move operation if source and destination hashsum
-types are different resulting in the extra network bandwidth, too.
-In some rare cases this may be undesired, so chunker provides two optional
-choices: `sha1quick` and `md5quick`. If the source does not support primary
-hash type and the quick mode is enabled, chunker will try to fall back to
-the secondary type. This will save CPU and bandwidth but can result in empty
-hashsums at destination. Beware of consequences: the `sync` command will
-revert (sometimes silently) to time/size comparison if compatible hashsums
-between source and target are not found.
-
-
-### Modified time
-
-Chunker stores modification times using the wrapped remote so support
-depends on that. For a small non-chunked file the chunker overlay simply
-manipulates modification time of the wrapped remote file.
-For a composite file with metadata chunker will get and set
-modification time of the metadata object on the wrapped remote.
-If file is chunked but metadata format is `none` then chunker will
-use modification time of the first data chunk.
-
-
-### Migrations
-
-The idiomatic way to migrate to a different chunk size, hash type or
-chunk naming scheme is to:
-
-- Collect all your chunked files under a directory and have your
-  chunker remote point to it.
-- Create another directory (most probably on the same cloud storage)
-  and configure a new remote with desired metadata format,
-  hash type, chunk naming etc.
-- Now run `rclone sync -i oldchunks: newchunks:` and all your data
-  will be transparently converted in transfer.
-  This may take some time, yet chunker will try server-side
-  copy if possible.
-- After checking data integrity you may remove configuration section
-  of the old remote.
-
-If rclone gets killed during a long operation on a big composite file,
-hidden temporary chunks may stay in the directory. They will not be
-shown by the `list` command but will eat up your account quota.
-Please note that the `deletefile` command deletes only active
-chunks of a file. As a workaround, you can use remote of the wrapped
-file system to see them.
-An easy way to get rid of hidden garbage is to copy littered directory
-somewhere using the chunker remote and purge the original directory.
-The `copy` command will copy only active chunks while the `purge` will
-remove everything including garbage.
-
-
-### Caveats and Limitations
-
-Chunker requires wrapped remote to support server side `move` (or `copy` +
-`delete`) operations, otherwise it will explicitly refuse to start.
-This is because it internally renames temporary chunk files to their final
-names when an operation completes successfully.
-
-Chunker encodes chunk number in file name, so with default `name_format`
-setting it adds 17 characters. Also chunker adds 7 characters of temporary
-suffix during operations. Many file systems limit base file name without path
-by 255 characters. Using rclone's crypt remote as a base file system limits
-file name by 143 characters. Thus, maximum name length is 231 for most files
-and 119 for chunker-over-crypt. A user in need can change name format to
-eg. `*.rcc##` and save 10 characters (provided at most 99 chunks per file).
-
-Note that a move implemented using the copy-and-delete method may incur
-double charging with some cloud storage providers.
-
-Chunker will not automatically rename existing chunks when you run
-`rclone config` on a live remote and change the chunk name format.
-Beware that in result of this some files which have been treated as chunks
-before the change can pop up in directory listings as normal files
-and vice versa. The same warning holds for the chunk size.
-If you desperately need to change critical chunking settings, you should
-run data migration as described above.
-
-If wrapped remote is case insensitive, the chunker overlay will inherit
-that property (so you can't have a file called "Hello.doc" and "hello.doc"
-in the same directory).
-
-
-
-### Standard Options
-
-Here are the standard options specific to chunker (Transparently chunk/split large files).
-
-#### --chunker-remote
-
+remote> local:/test
+Optional: The URL of the Plex server
+plex_url> http://127.0.0.1:32400
+Optional: The username of the Plex user
+plex_username> dummyusername
+Optional: The password of the Plex user
+y) Yes type in my own password
+g) Generate random password
+n) No leave this optional password blank
+y/g/n> y
+Enter the password:
+password:
+Confirm the password:
+password:
+The size of a chunk. Lower value good for slow connections but can affect seamless reading.
+Default: 5M
+Choose a number from below, or type in your own value
+ 1 / 1MB
+   \ "1m"
+ 2 / 5 MB
+   \ "5M"
+ 3 / 10 MB
+   \ "10M"
+chunk_size> 2
+How much time should object info (file size, file hashes, etc.) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache.
+Accepted units are: "s", "m", "h".
+Default: 5m
+Choose a number from below, or type in your own value
+ 1 / 1 hour
+   \ "1h"
+ 2 / 24 hours
+   \ "24h"
+ 3 / 24 hours
+   \ "48h"
+info_age> 2
+The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted.
+Default: 10G
+Choose a number from below, or type in your own value
+ 1 / 500 MB
+   \ "500M"
+ 2 / 1 GB
+   \ "1G"
+ 3 / 10 GB
+   \ "10G"
+chunk_total_size> 3
+Remote config
+--------------------
+[test-cache]
+remote = local:/test
+plex_url = http://127.0.0.1:32400
+plex_username = dummyusername
+plex_password = *** ENCRYPTED ***
+chunk_size = 5M
+info_age = 48h
+chunk_total_size = 10G
    
+
    You can then use it like this,
    
+
    List directories in top level of your drive
    
+
    rclone lsd test-cache:
    
+
    List all the files in your drive
    
+
    rclone ls test-cache:
    
+
    To start a cached mount
    
+
    rclone mount --allow-other test-cache: /var/tmp/test-cache
    
+
    Write Features
    
+
    Offline uploading
    
+
    In an effort to make writing through cache more reliable, the backend now supports this feature which can be activated by specifying a cache-tmp-upload-path.
    
+
    A files goes through these states when using this feature:
    
+
      
+
    1. An upload is started (usually by copying a file on the cache remote)
      2. 
+
    2. When the copy to the temporary location is complete the file is part of the cached remote and looks and behaves like any other file (reading included)
      3. 
+
    3. After cache-tmp-wait-time passes and the file is next in line, rclone move is used to move the file to the cloud provider
      4. 
+
    4. Reading the file still works during the upload but most modifications on it will be prohibited
      5. 
+
    5. Once the move is complete the file is unlocked for modifications as it becomes as any other regular file
      6. 
+
    6. If the file is being read through cache when it's actually deleted from the temporary path then cache will simply swap the source to the cloud provider without interrupting the reading (small blip can happen though)
      7. 
+
    
+
    Files are uploaded in sequence and only one file is uploaded at a time. Uploads will be stored in a queue and be processed based on the order they were added. The queue and the temporary storage is persistent across restarts but can be cleared on startup with the --cache-db-purge flag.
    
+
    Write Support
    
+
    Writes are supported through cache. One caveat is that a mounted cache remote does not add any retry or fallback mechanism to the upload operation. This will depend on the implementation of the wrapped remote. Consider using Offline uploading for reliable writes.
    
+
    One special case is covered with cache-writes which will cache the file data at the same time as the upload when it is enabled making it available from the cache store immediately once the upload is finished.
    
+
    Read Features
    
+
    Multiple connections
    
+
    To counter the high latency between a local PC where rclone is running and cloud providers, the cache remote can split multiple requests to the cloud provider for smaller file chunks and combines them together locally where they can be available almost immediately before the reader usually needs them.
    
+
    This is similar to buffering when media files are played online. Rclone will stay around the current marker but always try its best to stay ahead and prepare the data before.
    
+
    Plex Integration
    
+
    There is a direct integration with Plex which allows cache to detect during reading if the file is in playback or not. This helps cache to adapt how it queries the cloud provider depending on what is needed for.
    
+
    Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers.
    
+
    This integration opens the doorway to additional performance improvements which will be explored in the near future.
    
+
    Note: If Plex options are not configured, cache will function with its configured options without adapting any of its settings.
    
+
    How to enable? Run rclone config and add all the Plex options (endpoint, username and password) in your remote and it will be automatically enabled.
    
+
    Affected settings: - cache-workers: Configured value during confirmed playback or 1 all the other times
    
+
    Certificate Validation
    
+
    When the Plex server is configured to only accept secure connections, it is possible to use .plex.direct URLs to ensure certificate validation succeeds. These URLs are used by Plex internally to connect to the Plex server securely.
    
+
    The format for these URLs is the following:
    
+
    https://ip-with-dots-replaced.server-hash.plex.direct:32400/
    
+
    The ip-with-dots-replaced part can be any IPv4 address, where the dots have been replaced with dashes, e.g. 127.0.0.1 becomes 127-0-0-1.
    
+
    To get the server-hash part, the easiest way is to visit
    
+
    https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token
    
+
    This page will list all the available Plex servers for your account with at least one .plex.direct link for each. Copy one URL and replace the IP address with the desired address. This can be used as the plex_url value.
    
+
    Known issues
    
+
    Mount and --dir-cache-time
    
+
    --dir-cache-time controls the first layer of directory caching which works at the mount layer. Being an independent caching mechanism from the cache backend, it will manage its own entries based on the configured time.
    
+
    To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct one, try to set --dir-cache-time to a lower time than --cache-info-age. Default values are already configured in this way.
    
+
    Windows support - Experimental
    
+
    There are a couple of issues with Windows mount functionality that still require some investigations. It should be considered as experimental thus far as fixes come in for this OS.
    
+
    Most of the issues seem to be related to the difference between filesystems on Linux flavors and Windows as cache is heavily dependent on them.
    
+
    Any reports or feedback on how cache behaves on this OS is greatly appreciated.
    
+
      
+
    • https://github.com/rclone/rclone/issues/1935
      • 
+
    • https://github.com/rclone/rclone/issues/1907
      • 
+
    • https://github.com/rclone/rclone/issues/1834
      • 
+
    
+
    Risk of throttling
    
+
    Future iterations of the cache backend will make use of the pooling functionality of the cloud provider to synchronize and at the same time make writing through it more tolerant to failures.
    
+
    There are a couple of enhancements in track to add these but in the meantime there is a valid concern that the expiring cache listings can lead to cloud provider throttles or bans due to repeated queries on it for very large mounts.
    
+
    Some recommendations: - don't use a very small interval for entry information (--cache-info-age) - while writes aren't yet optimised, you can still write through cache which gives you the advantage of adding the file in the cache at the same time if configured to do so.
    
+
    Future enhancements:
    
+
      
+
    • https://github.com/rclone/rclone/issues/1937
      • 
+
    • https://github.com/rclone/rclone/issues/1936
      • 
+
    
+
    cache and crypt
    
+
    One common scenario is to keep your data encrypted in the cloud provider using the crypt remote. crypt uses a similar technique to wrap around an existing remote and handles this translation in a seamless way.
    
+
    There is an issue with wrapping the remotes in this order: cloud remote -> crypt -> cache
    
+
    During testing, I experienced a lot of bans with the remotes in this order. I suspect it might be related to how crypt opens files on the cloud provider which makes it think we're downloading the full file instead of small chunks. Organizing the remotes in this order yields better results: cloud remote -> cache -> crypt
    
+
    absolute remote paths
    
+
    cache can not differentiate between relative and absolute paths for the wrapped remote. Any path given in the remote config setting and on the command line will be passed to the wrapped remote as is, but for storing the chunks on disk the path will be made relative by removing any leading / character.
    
+
    This behavior is irrelevant for most backend types, but there are backends where a leading / changes the effective directory, e.g. in the sftp backend paths starting with a / are relative to the root of the SSH server and paths without are relative to the user home directory. As a result sftp:bin and sftp:/bin will share the same cache folder, even if they represent a different directory on the SSH server.
    
+
    Cache and Remote Control (--rc)
    
+
    Cache supports the new --rc mode in rclone and can be remote controlled through the following end points: By default, the listener is disabled if you do not add the flag.
    
+
    rc cache/expire
    
+
    Purge a remote from the cache backend. Supports either a directory or a file. It supports both encrypted and unencrypted file names if cache is wrapped by crypt.
    
+
    Params: - remote = path to remote (required) - withData = true/false to delete cached data (chunks) as well (optional, false by default)
    
+
    Standard Options
    
+
    Here are the standard options specific to cache (Cache a remote).
    
+
    --cache-remote
    
+
    Remote to cache. Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_CACHE_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-url
    
+
    The URL of the Plex server
    
+
      
+
    • Config: plex_url
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_URL
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-username
    
+
    The username of the Plex user
    
+
      
+
    • Config: plex_username
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_USERNAME
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-password
    
+
    The password of the Plex user
    
+
    NB Input to this must be obscured - see rclone obscure.
    
+
      
+
    • Config: plex_password
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_PASSWORD
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-chunk-size
    
+
    The size of a chunk (partial file data).
    
+
    Use lower numbers for slower connections. If the chunk size is changed, any downloaded chunks will be invalid and cache-chunk-path will need to be cleared or unexpected EOF errors will occur.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 5M
      • 
+
    • Examples:
+
        
+
      • "1m"
+
          
+
        • 1MB
          • 
+
        • 
+
      • "5M"
+
          
+
        • 5 MB
          • 
+
        • 
+
      • "10M"
+
          
+
        • 10 MB
          • 
+
        • 
+
      • 
+
    
+
    --cache-info-age
    
+
    How long to cache file structure information (directory listings, file size, times, etc.). If all write operations are done through the cache then you can safely make this value very large as the cache store will also be updated in real time.
    
+
      
+
    • Config: info_age
      • 
+
    • Env Var: RCLONE_CACHE_INFO_AGE
      • 
+
    • Type: Duration
      • 
+
    • Default: 6h0m0s
      • 
+
    • Examples:
+
        
+
      • "1h"
+
          
+
        • 1 hour
          • 
+
        • 
+
      • "24h"
+
          
+
        • 24 hours
          • 
+
        • 
+
      • "48h"
+
          
+
        • 48 hours
          • 
+
        • 
+
      • 
+
    
+
    --cache-chunk-total-size
    
+
    The total size that the chunks can take up on the local disk.
    
+
    If the cache exceeds this value then it will start to delete the oldest chunks until it goes under this value.
    
+
      
+
    • Config: chunk_total_size
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 10G
      • 
+
    • Examples:
+
        
+
      • "500M"
+
          
+
        • 500 MB
          • 
+
        • 
+
      • "1G"
+
          
+
        • 1 GB
          • 
+
        • 
+
      • "10G"
+
          
+
        • 10 GB
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to cache (Cache a remote).
    
+
    --cache-plex-token
    
+
    The plex token for authentication - auto set normally
    
+
      
+
    • Config: plex_token
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_TOKEN
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-plex-insecure
    
+
    Skip all certificate verification when connecting to the Plex server
    
+
      
+
    • Config: plex_insecure
      • 
+
    • Env Var: RCLONE_CACHE_PLEX_INSECURE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-db-path
    
+
    Directory to store file structure metadata DB. The remote name is used as the DB file name.
    
+
      
+
    • Config: db_path
      • 
+
    • Env Var: RCLONE_CACHE_DB_PATH
      • 
+
    • Type: string
      • 
+
    • Default: "$HOME/.cache/rclone/cache-backend"
      • 
+
    
+
    --cache-chunk-path
    
+
    Directory to cache chunk files.
    
+
    Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path.
    
+
    This config follows the "--cache-db-path". If you specify a custom location for "--cache-db-path" and don't specify one for "--cache-chunk-path" then "--cache-chunk-path" will use the same path as "--cache-db-path".
    
+
      
+
    • Config: chunk_path
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_PATH
      • 
+
    • Type: string
      • 
+
    • Default: "$HOME/.cache/rclone/cache-backend"
      • 
+
    
+
    --cache-db-purge
    
+
    Clear all the cached data for this remote on start.
    
+
      
+
    • Config: db_purge
      • 
+
    • Env Var: RCLONE_CACHE_DB_PURGE
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --cache-chunk-clean-interval
    
+
    How often should the cache perform cleanups of the chunk storage. The default value should be ok for most people. If you find that the cache goes over "cache-chunk-total-size" too often then try to lower this value to force it to perform cleanups more often.
    
+
      
+
    • Config: chunk_clean_interval
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL
      • 
+
    • Type: Duration
      • 
+
    • Default: 1m0s
      • 
+
    
+
    --cache-read-retries
    
+
    How many times to retry a read from a cache storage.
    
+
    Since reading from a cache stream is independent from downloading file data, readers can get to a point where there's no more data in the cache. Most of the times this can indicate a connectivity issue if cache isn't able to provide file data anymore.
    
+
    For really slow connections, increase this to a point where the stream is able to provide data but your experience will be very stuttering.
    
+
      
+
    • Config: read_retries
      • 
+
    • Env Var: RCLONE_CACHE_READ_RETRIES
      • 
+
    • Type: int
      • 
+
    • Default: 10
      • 
+
    
+
    --cache-workers
    
+
    How many workers should run in parallel to download chunks.
    
+
    Higher values will mean more parallel processing (better CPU needed) and more concurrent requests on the cloud provider. This impacts several aspects like the cloud provider API limits, more stress on the hardware that rclone runs on but it also means that streams will be more fluid and data will be available much more faster to readers.
    
+
    Note: If the optional Plex integration is enabled then this setting will adapt to the type of reading performed and the value specified here will be used as a maximum number of workers to use.
    
+
      
+
    • Config: workers
      • 
+
    • Env Var: RCLONE_CACHE_WORKERS
      • 
+
    • Type: int
      • 
+
    • Default: 4
      • 
+
    
+
    --cache-chunk-no-memory
    
+
    Disable the in-memory cache for storing chunks during streaming.
    
+
    By default, cache will keep file data during streaming in RAM as well to provide it to readers as fast as possible.
    
+
    This transient data is evicted as soon as it is read and the number of chunks stored doesn't exceed the number of workers. However, depending on other settings like "cache-chunk-size" and "cache-workers" this footprint can increase if there are parallel streams too (multiple files being read at the same time).
    
+
    If the hardware permits it, use this feature to provide an overall better performance during streaming but it can also be disabled if RAM is not available on the local machine.
    
+
      
+
    • Config: chunk_no_memory
      • 
+
    • Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --cache-rps
    
+
    Limits the number of requests per second to the source FS (-1 to disable)
    
+
    This setting places a hard limit on the number of requests per second that cache will be doing to the cloud provider remote and try to respect that value by setting waits between reads.
    
+
    If you find that you're getting banned or limited on the cloud provider through cache and know that a smaller number of requests per second will allow you to work with it then you can use this setting for that.
    
+
    A good balance of all the other settings should make this setting useless but it is available to set for more special cases.
    
+
    NOTE: This will limit the number of requests during streams but other API calls to the cloud provider like directory listings will still pass.
    
+
      
+
    • Config: rps
      • 
+
    • Env Var: RCLONE_CACHE_RPS
      • 
+
    • Type: int
      • 
+
    • Default: -1
      • 
+
    
+
    --cache-writes
    
+
    Cache file data on writes through the FS
    
+
    If you need to read files immediately after you upload them through cache you can enable this flag to have their data stored in the cache store at the same time during upload.
    
+
      
+
    • Config: writes
      • 
+
    • Env Var: RCLONE_CACHE_WRITES
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    
+
    --cache-tmp-upload-path
    
+
    Directory to keep temporary files until they are uploaded.
    
+
    This is the path where cache will use as a temporary storage for new files that need to be uploaded to the cloud provider.
    
+
    Specifying a value will enable this feature. Without it, it is completely disabled and files will be uploaded directly to the cloud provider
    
+
      
+
    • Config: tmp_upload_path
      • 
+
    • Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --cache-tmp-wait-time
    
+
    How long should files be stored in local cache before being uploaded
    
+
    This is the duration that a file must wait in the temporary location cache-tmp-upload-path before it is selected for upload.
    
+
    Note that only one file is uploaded at a time and it can take longer to start the upload if a queue formed for this purpose.
    
+
      
+
    • Config: tmp_wait_time
      • 
+
    • Env Var: RCLONE_CACHE_TMP_WAIT_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 15s
      • 
+
    
+
    --cache-db-wait-time
    
+
    How long to wait for the DB to be available - 0 is unlimited
    
+
    Only one process can have the DB open at any one time, so rclone waits for this duration for the DB to become available before it gives an error.
    
+
    If you set it to 0 then it will wait forever.
    
+
      
+
    • Config: db_wait_time
      • 
+
    • Env Var: RCLONE_CACHE_DB_WAIT_TIME
      • 
+
    • Type: Duration
      • 
+
    • Default: 1s
      • 
+
    
+
    Backend commands
    
+
    Here are the commands specific to the cache backend.
    
+
    Run them with
    
+
    rclone backend COMMAND remote:
    
+
    The help below will explain what arguments each command takes.
    
+
    See the "rclone backend" command for more info on how to pass options and arguments.
    
+
    These can be run on a running backend using the rc command backend/command.
    
+
    stats
    
+
    Print stats on the cache backend in JSON format.
    
+
    rclone backend stats remote: [options] [<arguments>+]
    
+
    Chunker (BETA)
    
+
    The chunker overlay transparently splits large files into smaller chunks during upload to wrapped remote and transparently assembles them back when the file is downloaded. This allows to effectively overcome size limits imposed by storage providers.
    
+
    To use it, first set up the underlying remote following the configuration instructions for that remote. You can also use a local pathname instead of a remote.
    
+
    First check your chosen remote is working - we'll call it remote:path here. Note that anything inside remote:path will be chunked and anything outside won't. This means that if you are using a bucket based remote (e.g. 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",
+Normally should contain a ':' and a path, e.g. "myremote:path/to/dir",
 "myremote:bucket" or maybe "myremote:" (not recommended).
-
-- Config:      remote
-- Env Var:     RCLONE_CHUNKER_REMOTE
-- Type:        string
-- Default:     ""
-
-#### --chunker-chunk-size
-
+Enter a string value. Press Enter for the default ("").
+remote> remote:path
 Files larger than chunk size will be split in chunks.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_CHUNKER_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     2G
-
-#### --chunker-hash-type
-
+Enter a size with suffix k,M,G,T. Press Enter for the default ("2G").
+chunk_size> 100M
 Choose how chunker handles hash sums. All modes but "none" require metadata.
-
-- Config:      hash_type
-- Env Var:     RCLONE_CHUNKER_HASH_TYPE
-- Type:        string
-- Default:     "md5"
-- Examples:
-    - "none"
-        - Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise
-    - "md5"
-        - MD5 for composite files
-    - "sha1"
-        - SHA1 for composite files
-    - "md5all"
-        - MD5 for all files
-    - "sha1all"
-        - SHA1 for all files
-    - "md5quick"
-        - Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
-    - "sha1quick"
-        - Similar to "md5quick" but prefers SHA1 over MD5
-
-### Advanced Options
-
-Here are the advanced options specific to chunker (Transparently chunk/split large files).
-
-#### --chunker-name-format
-
-String format of chunk file names.
-The two placeholders are: base file name (*) and chunk number (#...).
-There must be one and only one asterisk and one or more consecutive hash characters.
-If chunk number has less digits than the number of hashes, it is left-padded by zeros.
-If there are more digits in the number, they are left as is.
-Possible chunk files are ignored if their name does not match given format.
-
-- Config:      name_format
-- Env Var:     RCLONE_CHUNKER_NAME_FORMAT
-- Type:        string
-- Default:     "*.rclone_chunk.###"
-
-#### --chunker-start-from
-
-Minimum valid chunk number. Usually 0 or 1.
-By default chunk numbers start from 1.
-
-- Config:      start_from
-- Env Var:     RCLONE_CHUNKER_START_FROM
-- Type:        int
-- Default:     1
-
-#### --chunker-meta-format
-
-Format of the metadata object or "none". By default "simplejson".
-Metadata is a small JSON file named after the composite file.
-
-- Config:      meta_format
-- Env Var:     RCLONE_CHUNKER_META_FORMAT
-- Type:        string
-- Default:     "simplejson"
-- Examples:
-    - "none"
-        - Do not use metadata files at all. Requires hash type "none".
-    - "simplejson"
-        - Simple JSON supports hash sums and chunk validation.
-        - It has the following fields: ver, size, nchunks, md5, sha1.
-
-#### --chunker-fail-hard
-
-Choose how chunker should handle files with missing or invalid chunks.
-
-- Config:      fail_hard
-- Env Var:     RCLONE_CHUNKER_FAIL_HARD
-- Type:        bool
-- Default:     false
-- Examples:
-    - "true"
-        - Report errors and abort current command.
-    - "false"
-        - Warn user, skip incomplete file and proceed.
-
-
-
-##  Citrix ShareFile
-
-[Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business.
-
-The initial setup for Citrix ShareFile involves getting a token from
-Citrix ShareFile which you can in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value XX / Citrix Sharefile  "sharefile" Storage> sharefile ** See help for sharefile backend at: https://rclone.org/sharefile/ **
    
-
    ID of the root folder
    
-
    Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID). Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Access the Personal Folders. (Default)  "" 2 / Access the Favorites folder.  "favorites" 3 / Access all the shared folders.  "allshared" 4 / Access all the individual connectors.  "connectors" 5 / Access the home, favorites, and shared folders as well as the connectors.  "top" root_folder_id> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = sharefile endpoint = https://XXX.sharefile.com token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a
-machine with no Internet browser available.
-
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Citrix ShareFile. This only runs from the moment it opens
-your browser to the moment you get back the verification code.  This
-is on `http://127.0.0.1:53682/` and this it may require you to unblock
-it temporarily if you are running a host firewall.
-
-Once configured you can then use `rclone` like this,
-
-List directories in top level of your ShareFile
-
-    rclone lsd remote:
-
-List all the files in your ShareFile
-
-    rclone ls remote:
-
-To copy a local directory to an ShareFile directory called backup
-
-    rclone copy /home/source remote:backup
-
-Paths may be as deep as required, eg `remote:directory/subdirectory`.
-
-### Modified time and hashes ###
-
-ShareFile allows modification times to be set on objects accurate to 1
-second.  These will be used to detect whether objects need syncing or
-not.
-
-ShareFile supports MD5 type hashes, so you can use the `--checksum`
-flag.
-
-### Transfers ###
-
-For files above 128MB rclone will use a chunked transfer.  Rclone will
-upload up to `--transfers` chunks at the same time (shared among all
-the multipart uploads).  Chunks are buffered in memory and are
-normally 64MB so increasing `--transfers` will increase memory use.
-
-### Limitations ###
-
-Note that ShareFile is case insensitive so you can't have a file called
-"Hello.doc" and one called "hello.doc".
-
-ShareFile only supports filenames up to 256 characters in length.
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| \\        | 0x5C  | ＼           |
-| *         | 0x2A  | ＊           |
-| <         | 0x3C  | ＜           |
-| >         | 0x3E  | ＞           |
-| ?         | 0x3F  | ？           |
-| :         | 0x3A  | ：           |
-| \|        | 0x7C  | ｜           |
-| "         | 0x22  | ＂           |
-
-File names can also not start or end with the following characters.
-These only get replaced if they are the first or last character in the
-name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-| .         | 0x2E  | ．           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to sharefile (Citrix Sharefile).
-
-#### --sharefile-root-folder-id
+Enter a string value. Press Enter for the default ("md5").
+Choose a number from below, or type in your own value
+ 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise
+   \ "none"
+ 2 / MD5 for composite files
+   \ "md5"
+ 3 / SHA1 for composite files
+   \ "sha1"
+ 4 / MD5 for all files
+   \ "md5all"
+ 5 / SHA1 for all files
+   \ "sha1all"
+ 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
+   \ "md5quick"
+ 7 / Similar to "md5quick" but prefers SHA1 over MD5
+   \ "sha1quick"
+hash_type> md5
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+--------------------
+[overlay]
+type = chunker
+remote = remote:bucket
+chunk_size = 100M
+hash_type = md5
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    
+
    Specifying the remote
    
+
    In normal use, make sure the remote has a : in. If you specify the remote without a : then rclone will use a local directory of that name. So if you use a remote of /path/to/secret/files then rclone will chunk stuff in that directory. If you use a remote of name then rclone will put files in a directory called name in the current directory.
    
+
    Chunking
    
+
    When rclone starts a file upload, chunker checks the file size. If it doesn't exceed the configured chunk size, chunker will just pass the file to the wrapped remote. If a file is large, chunker will transparently cut data in pieces with temporary names and stream them one by one, on the fly. Each data chunk will contain the specified number of bytes, except for the last one which may have less data. If file size is unknown in advance (this is called a streaming upload), chunker will internally create a temporary copy, record its size and repeat the above process.
    
+
    When upload completes, temporary chunk files are finally renamed. This scheme guarantees that operations can be run in parallel and look from outside as atomic. A similar method with hidden temporary chunks is used for other operations (copy/move/rename, etc.). If an operation fails, hidden chunks are normally destroyed, and the target composite file stays intact.
    
+
    When a composite file download is requested, chunker transparently assembles it by concatenating data chunks in order. As the split is trivial one could even manually concatenate data chunks together to obtain the original content.
    
+
    When the list rclone command scans a directory on wrapped remote, the potential chunk files are accounted for, grouped and assembled into composite directory entries. Any temporary chunks are hidden.
    
+
    List and other commands can sometimes come across composite files with missing or invalid chunks, e.g. shadowed by like-named directory or another file. This usually means that wrapped file system has been directly tampered with or damaged. If chunker detects a missing chunk it will by default print warning, skip the whole incomplete group of chunks but proceed with current command. You can set the --chunker-fail-hard flag to have commands abort with error message in such cases.
    
+
    Chunk names
    
+
    The default chunk name format is *.rclone_chunk.###, hence by default chunk names are BIG_FILE_NAME.rclone_chunk.001, BIG_FILE_NAME.rclone_chunk.002 etc. You can configure another name format using the name_format configuration file option. The format uses asterisk * as a placeholder for the base file name and one or more consecutive hash characters # as a placeholder for sequential chunk number. There must be one and only one asterisk. The number of consecutive hash characters defines the minimum length of a string representing a chunk number. If decimal chunk number has less digits than the number of hashes, it is left-padded by zeros. If the decimal string is longer, it is left intact. By default numbering starts from 1 but there is another option that allows user to start from 0, e.g. for compatibility with legacy software.
    
+
    For example, if name format is big_*-##.part and original file name is data.txt and numbering starts from 0, then the first chunk will be named big_data.txt-00.part, the 99th chunk will be big_data.txt-98.part and the 302nd chunk will become big_data.txt-301.part.
    
+
    Note that list assembles composite directory entries only when chunk names match the configured format and treats non-conforming file names as normal non-chunked files.
    
+
    Metadata
    
+
    Besides data chunks chunker will by default create metadata object for a composite file. The object is named after the original file. Chunker allows user to disable metadata completely (the none format). Note that metadata is normally not created for files smaller than the configured chunk size. This may change in future rclone releases.
    
+
    Simple JSON metadata format
    
+
    This is the default format. It supports hash sums and chunk validation for composite files. Meta objects carry the following fields:
    
+
      
+
    • ver - version of format, currently 1
      • 
+
    • size - total size of composite file
      • 
+
    • nchunks - number of data chunks in file
      • 
+
    • md5 - MD5 hashsum of composite file (if present)
      • 
+
    • sha1 - SHA1 hashsum (if present)
      • 
+
    
+
    There is no field for composite file name as it's simply equal to the name of meta object on the wrapped remote. Please refer to respective sections for details on hashsums and modified time handling.
    
+
    No metadata
    
+
    You can disable meta objects by setting the meta format option to none. In this mode chunker will scan directory for all files that follow configured chunk name format, group them by detecting chunks with the same base name and show group names as virtual composite files. This method is more prone to missing chunk errors (especially missing last chunk) than format with metadata enabled.
    
+
    Hashsums
    
+
    Chunker supports hashsums only when a compatible metadata is present. Hence, if you choose metadata format of none, chunker will report hashsum as UNSUPPORTED.
    
+
    Please note that by default metadata is stored only for composite files. If a file is smaller than configured chunk size, chunker will transparently redirect hash requests to wrapped remote, so support depends on that. You will see the empty string as a hashsum of requested type for small files if the wrapped remote doesn't support it.
    
+
    Many storage backends support MD5 and SHA1 hash types, so does chunker. With chunker you can choose one or another but not both. MD5 is set by default as the most supported type. Since chunker keeps hashes for composite files and falls back to the wrapped remote hash for non-chunked ones, we advise you to choose the same hash type as supported by wrapped remote so that your file listings look coherent.
    
+
    If your storage backend does not support MD5 or SHA1 but you need consistent file hashing, configure chunker with md5all or sha1all. These two modes guarantee given hash for all files. If wrapped remote doesn't support it, chunker will then add metadata to all files, even small. However, this can double the amount of small files in storage and incur additional service charges. You can even use chunker to force md5/sha1 support in any other remote at expense of sidecar meta objects by setting e.g. chunk_type=sha1all to force hashsums and chunk_size=1P to effectively disable chunking.
    
+
    Normally, when a file is copied to chunker controlled remote, chunker will ask the file source for compatible file hash and revert to on-the-fly calculation if none is found. This involves some CPU overhead but provides a guarantee that given hashsum is available. Also, chunker will reject a server-side copy or move operation if source and destination hashsum types are different resulting in the extra network bandwidth, too. In some rare cases this may be undesired, so chunker provides two optional choices: sha1quick and md5quick. If the source does not support primary hash type and the quick mode is enabled, chunker will try to fall back to the secondary type. This will save CPU and bandwidth but can result in empty hashsums at destination. Beware of consequences: the sync command will revert (sometimes silently) to time/size comparison if compatible hashsums between source and target are not found.
    
+
    Modified time
    
+
    Chunker stores modification times using the wrapped remote so support depends on that. For a small non-chunked file the chunker overlay simply manipulates modification time of the wrapped remote file. For a composite file with metadata chunker will get and set modification time of the metadata object on the wrapped remote. If file is chunked but metadata format is none then chunker will use modification time of the first data chunk.
    
+
    Migrations
    
+
    The idiomatic way to migrate to a different chunk size, hash type or chunk naming scheme is to:
    
+
      
+
    • Collect all your chunked files under a directory and have your chunker remote point to it.
      • 
+
    • Create another directory (most probably on the same cloud storage) and configure a new remote with desired metadata format, hash type, chunk naming etc.
      • 
+
    • Now run rclone sync -i oldchunks: newchunks: and all your data will be transparently converted in transfer. This may take some time, yet chunker will try server-side copy if possible.
      • 
+
    • After checking data integrity you may remove configuration section of the old remote.
      • 
+
    
+
    If rclone gets killed during a long operation on a big composite file, hidden temporary chunks may stay in the directory. They will not be shown by the list command but will eat up your account quota. Please note that the deletefile command deletes only active chunks of a file. As a workaround, you can use remote of the wrapped file system to see them. An easy way to get rid of hidden garbage is to copy littered directory somewhere using the chunker remote and purge the original directory. The copy command will copy only active chunks while the purge will remove everything including garbage.
    
+
    Caveats and Limitations
    
+
    Chunker requires wrapped remote to support server-side move (or copy + delete) operations, otherwise it will explicitly refuse to start. This is because it internally renames temporary chunk files to their final names when an operation completes successfully.
    
+
    Chunker encodes chunk number in file name, so with default name_format setting it adds 17 characters. Also chunker adds 7 characters of temporary suffix during operations. Many file systems limit base file name without path by 255 characters. Using rclone's crypt remote as a base file system limits file name by 143 characters. Thus, maximum name length is 231 for most files and 119 for chunker-over-crypt. A user in need can change name format to e.g. *.rcc## and save 10 characters (provided at most 99 chunks per file).
    
+
    Note that a move implemented using the copy-and-delete method may incur double charging with some cloud storage providers.
    
+
    Chunker will not automatically rename existing chunks when you run rclone config on a live remote and change the chunk name format. Beware that in result of this some files which have been treated as chunks before the change can pop up in directory listings as normal files and vice versa. The same warning holds for the chunk size. If you desperately need to change critical chunking settings, you should run data migration as described above.
    
+
    If wrapped remote is case insensitive, the chunker overlay will inherit that property (so you can't have a file called "Hello.doc" and "hello.doc" in the same directory).
    
+
    Chunker included in rclone releases up to v1.54 can sometimes fail to detect metadata produced by recent versions of rclone. We recommend users to keep rclone up-to-date to avoid data corruption.
    
+
    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, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).
    
+
      
+
    • Config: remote
      • 
+
    • Env Var: RCLONE_CHUNKER_REMOTE
      • 
+
    • Type: string
      • 
+
    • Default: ""
      • 
+
    
+
    --chunker-chunk-size
    
+
    Files larger than chunk size will be split in chunks.
    
+
      
+
    • Config: chunk_size
      • 
+
    • Env Var: RCLONE_CHUNKER_CHUNK_SIZE
      • 
+
    • Type: SizeSuffix
      • 
+
    • Default: 2G
      • 
+
    
+
    --chunker-hash-type
    
+
    Choose how chunker handles hash sums. All modes but "none" require metadata.
    
+
      
+
    • Config: hash_type
      • 
+
    • Env Var: RCLONE_CHUNKER_HASH_TYPE
      • 
+
    • Type: string
      • 
+
    • Default: "md5"
      • 
+
    • Examples:
+
        
+
      • "none"
+
          
+
        • Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise
          • 
+
        • 
+
      • "md5"
+
          
+
        • MD5 for composite files
          • 
+
        • 
+
      • "sha1"
+
          
+
        • SHA1 for composite files
          • 
+
        • 
+
      • "md5all"
+
          
+
        • MD5 for all files
          • 
+
        • 
+
      • "sha1all"
+
          
+
        • SHA1 for all files
          • 
+
        • 
+
      • "md5quick"
+
          
+
        • Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported
          • 
+
        • 
+
      • "sha1quick"
+
          
+
        • Similar to "md5quick" but prefers SHA1 over MD5
          • 
+
        • 
+
      • 
+
    
+
    Advanced Options
    
+
    Here are the advanced options specific to chunker (Transparently chunk/split large files).
    
+
    --chunker-name-format
    
+
    String format of chunk file names. The two placeholders are: base file name (*) and chunk number (#...). There must be one and only one asterisk and one or more consecutive hash characters. If chunk number has less digits than the number of hashes, it is left-padded by zeros. If there are more digits in the number, they are left as is. Possible chunk files are ignored if their name does not match given format.
    
+
      
+
    • Config: name_format
      • 
+
    • Env Var: RCLONE_CHUNKER_NAME_FORMAT
      • 
+
    • Type: string
      • 
+
    • Default: "*.rclone_chunk.###"
      • 
+
    
+
    --chunker-start-from
    
+
    Minimum valid chunk number. Usually 0 or 1. By default chunk numbers start from 1.
    
+
      
+
    • Config: start_from
      • 
+
    • Env Var: RCLONE_CHUNKER_START_FROM
      • 
+
    • Type: int
      • 
+
    • Default: 1
      • 
+
    
+
    --chunker-meta-format
    
+
    Format of the metadata object or "none". By default "simplejson". Metadata is a small JSON file named after the composite file.
    
+
      
+
    • Config: meta_format
      • 
+
    • Env Var: RCLONE_CHUNKER_META_FORMAT
      • 
+
    • Type: string
      • 
+
    • Default: "simplejson"
      • 
+
    • Examples:
+
        
+
      • "none"
+
          
+
        • Do not use metadata files at all. Requires hash type "none".
          • 
+
        • 
+
      • "simplejson"
+
          
+
        • Simple JSON supports hash sums and chunk validation.
          • 
+
        • It has the following fields: ver, size, nchunks, md5, sha1.
          • 
+
        • 
+
      • 
+
    
+
    --chunker-fail-hard
    
+
    Choose how chunker should handle files with missing or invalid chunks.
    
+
      
+
    • Config: fail_hard
      • 
+
    • Env Var: RCLONE_CHUNKER_FAIL_HARD
      • 
+
    • Type: bool
      • 
+
    • Default: false
      • 
+
    • Examples:
+
        
+
      • "true"
+
          
+
        • Report errors and abort current command.
          • 
+
        • 
+
      • "false"
+
          
+
        • Warn user, skip incomplete file and proceed.
          • 
+
        • 
+
      • 
+
    
+
    Citrix ShareFile
    
+
    Citrix ShareFile is a secure file sharing and transfer service aimed as business.
    
+
    The initial setup for Citrix ShareFile involves getting a token from Citrix ShareFile which you can in your browser. rclone config walks you through it.
    
+
    Here is an example of how to make a remote called remote. First run:
    
+
     rclone config
    
+
    This will guide you through an interactive setup process:
    
+
    No remotes found - make a new one
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+name> remote
+Type of storage to configure.
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+XX / Citrix Sharefile
+   \ "sharefile"
+Storage> sharefile
+** See help for sharefile backend at: https://rclone.org/sharefile/ **
 
 ID of the root folder
 
 Leave blank to access "Personal Folders".  You can use one of the
 standard values here or any folder ID (long hex number ID).
-
-- Config:      root_folder_id
-- Env Var:     RCLONE_SHAREFILE_ROOT_FOLDER_ID
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Access the Personal Folders. (Default)
-    - "favorites"
-        - Access the Favorites folder.
-    - "allshared"
-        - Access all the shared folders.
-    - "connectors"
-        - Access all the individual connectors.
-    - "top"
-        - Access the home, favorites, and shared folders as well as the connectors.
-
-### Advanced Options
-
-Here are the advanced options specific to sharefile (Citrix Sharefile).
-
-#### --sharefile-upload-cutoff
-
-Cutoff for switching to multipart upload.
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_SHAREFILE_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     128M
-
-#### --sharefile-chunk-size
-
-Upload chunk size. Must a power of 2 >= 256k.
-
-Making this larger will improve performance, but note that each chunk
-is buffered in memory one per transfer.
-
-Reducing this will reduce memory usage but decrease performance.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_SHAREFILE_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     64M
-
-#### --sharefile-endpoint
-
-Endpoint for API calls.
-
-This is usually auto discovered as part of the oauth process, but can
-be set manually to something like: https://XXX.sharefile.com
-
-
-- Config:      endpoint
-- Env Var:     RCLONE_SHAREFILE_ENDPOINT
-- Type:        string
-- Default:     ""
-
-#### --sharefile-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_SHAREFILE_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot
-
-
-
-Crypt
-----------------------------------------
-
-The `crypt` remote encrypts and decrypts another remote.
-
-To use it first set up the underlying remote following the config
-instructions for that remote.  You can also use a local pathname
-instead of a remote which will encrypt and decrypt from that directory
-which might be useful for encrypting onto a USB stick for example.
-
-First check your chosen remote is working - we'll call it
-`remote:path` in these docs.  Note that anything inside `remote:path`
-will be encrypted and anything outside won't.  This means that if you
-are using a bucket based remote (eg S3, B2, swift) then you should
-probably put the bucket in the remote `s3:bucket`. If you just use
-`s3:` then rclone will make encrypted bucket names too (if using file
-name encryption) which may or may not be what you want.
-
-Now configure `crypt` using `rclone config`. We will call this one
-`secret` to differentiate it from the `remote`.
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n
    
-name> secret Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Encrypt/Decrypt a remote  "crypt" [snip] Storage> crypt Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). remote> remote:path How to encrypt the filenames. Choose a number from below, or type in your own value 1 / Don't encrypt the file names. Adds a ".bin" extension only.  "off" 2 / Encrypt the filenames see the docs for the details.  "standard" 3 / Very simple filename obfuscation.  "obfuscate" filename_encryption> 2 Option to either encrypt directory names or leave them intact. Choose a number from below, or type in your own value 1 / Encrypt directory names.  "true" 2 / Don't encrypt directory names, leave them intact.  "false" filename_encryption> 1 Password or pass phrase for encryption. y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. y) Yes type in my own password g) Generate random password n) No leave this optional password blank y/g/n> g Password strength in bits. 64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ Use this password? y) Yes n) No y/n> y Remote config -------------------- [secret] remote = remote:path filename_encryption = standard password = *** ENCRYPTED  password2 =  ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-**Important** The password is stored in the config file is lightly
-obscured so it isn't immediately obvious what it is.  It is in no way
-secure unless you use config file encryption.
-
-A long passphrase is recommended, or you can use a random one.
-
-The obscured password is created by using AES-CTR with a static key, with
-the salt stored verbatim at the beginning of the obscured password. This
-static key is shared by between all versions of rclone.
-
-If you reconfigure rclone with the same passwords/passphrases
-elsewhere it will be compatible, but the obscured version will be different
-due to the different salt.
-
-Note that rclone does not encrypt
-
-  * file length - this can be calculated within 16 bytes
-  * modification time - used for syncing
-
-## Specifying the remote ##
-
-In normal use, make sure the remote has a `:` in. If you specify the
-remote without a `:` then rclone will use a local directory of that
-name.  So if you use a remote of `/path/to/secret/files` then rclone
-will encrypt stuff to that directory.  If you use a remote of `name`
-then rclone will put files in a directory called `name` in the current
-directory.
-
-If you specify the remote as `remote:path/to/dir` then rclone will
-store encrypted files in `path/to/dir` on the remote. If you are using
-file name encryption, then when you save files to
-`secret:subdir/subfile` this will store them in the unencrypted path
-`path/to/dir` but the `subdir/subpath` bit will be encrypted.
-
-Note that unless you want encrypted bucket names (which are difficult
-to manage because you won't know what directory they represent in web
-interfaces etc), you should probably specify a bucket, eg
-`remote:secretbucket` when using bucket based remotes such as S3,
-Swift, Hubic, B2, GCS.
-
-## Example ##
-
-To test I made a little directory of files using "standard" file name
-encryption.
-
    
-
    plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── file3.txt └── subsubdir └── file4.txt
    
-
    
-Copy these to the remote and list them back
-
    
-
    $ rclone -q copy plaintext secret: $ rclone -q ls secret: 7 file1.txt 6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 subdir/file3.txt
    
-
    
-Now see what that looked like when encrypted
-
    
-
    $ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 v05749mltvv1tf4onltun46gls 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps
    
-
    
-Note that this retains the directory structure which means you can do this
-
    
-
    $ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 subsubdir/file4.txt
    
-
    
-If don't use file name encryption then the remote will look like this
-- note the `.bin` extensions added to prevent the cloud provider
-attempting to interpret the data.
-
    
-
    $ rclone -q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin
    
-
    
-### File name encryption modes ###
-
-Here are some of the features of the file name encryption modes
-
-Off
-
-  * doesn't hide file names or directory structure
-  * allows for longer file names (~246 characters)
-  * can use sub paths and copy single files
-
-Standard
-
-  * file names encrypted
-  * file names can't be as long (~143 characters)
-  * can use sub paths and copy single files
-  * directory structure visible
-  * identical files names will have identical uploaded names
-  * can use shortcuts to shorten the directory recursion
-
-Obfuscation
-
-This is a simple "rotate" of the filename, with each file having a rot
-distance based on the filename. We store the distance at the beginning
-of the filename. So a file called "hello" may become "53.jgnnq".
-
-This is not a strong encryption of filenames, but it may stop automated
-scanning tools from picking up on filename patterns. As such it's an
-intermediate between "off" and "standard". The advantage is that it
-allows for longer path segment names.
-
-There is a possibility with some unicode based filenames that the
-obfuscation is weak and may map lower case characters to upper case
-equivalents.  You can not rely on this for strong protection.
-
-  * file names very lightly obfuscated
-  * file names can be longer than standard encryption
-  * can use sub paths and copy single files
-  * directory structure visible
-  * identical files names will have identical uploaded names
-
-Cloud storage systems have various limits on file name length and
-total path length which you are more likely to hit using "Standard"
-file name encryption.  If you keep your file names to below 156
-characters in length then you should be OK on all providers.
-
-There may be an even more secure file name encryption mode in the
-future which will address the long file name problem.
-
-### Directory name encryption ###
-Crypt offers the option of encrypting dir names or leaving them intact.
-There are two options:
-
-True
-
-Encrypts the whole file path including directory names
-Example:
-`1/12/123.txt` is encrypted to
-`p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0`
-
-False
-
-Only encrypts file names, skips directory names
-Example:
-`1/12/123.txt` is encrypted to
-`1/12/qgm4avr35m5loi1th53ato71v0`
-
-
-### Modified time and hashes ###
-
-Crypt stores modification times using the underlying remote so support
-depends on that.
-
-Hashes are not stored for crypt.  However the data integrity is
-protected by an extremely strong crypto authenticator.
-
-Note that you should use the `rclone cryptcheck` command to check the
-integrity of a crypted remote instead of `rclone check` which can't
-check the checksums properly.
-
-
-### Standard Options
-
-Here are the standard options specific to crypt (Encrypt/Decrypt a remote).
-
-#### --crypt-remote
-
-Remote to encrypt/decrypt.
-Normally should contain a ':' and a path, eg "myremote:path/to/dir",
-"myremote:bucket" or maybe "myremote:" (not recommended).
-
-- Config:      remote
-- Env Var:     RCLONE_CRYPT_REMOTE
-- Type:        string
-- Default:     ""
-
-#### --crypt-filename-encryption
-
-How to encrypt the filenames.
-
-- Config:      filename_encryption
-- Env Var:     RCLONE_CRYPT_FILENAME_ENCRYPTION
-- Type:        string
-- Default:     "standard"
-- Examples:
-    - "standard"
-        - Encrypt the filenames see the docs for the details.
-    - "obfuscate"
-        - Very simple filename obfuscation.
-    - "off"
-        - Don't encrypt the file names.  Adds a ".bin" extension only.
-
-#### --crypt-directory-name-encryption
-
-Option to either encrypt directory names or leave them intact.
-
-NB If filename_encryption is "off" then this option will do nothing.
-
-- Config:      directory_name_encryption
-- Env Var:     RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION
-- Type:        bool
-- Default:     true
-- Examples:
-    - "true"
-        - Encrypt directory names.
-    - "false"
-        - Don't encrypt directory names, leave them intact.
-
-#### --crypt-password
-
-Password or pass phrase for encryption.
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      password
-- Env Var:     RCLONE_CRYPT_PASSWORD
-- Type:        string
-- Default:     ""
-
-#### --crypt-password2
-
-Password or pass phrase for salt. Optional but recommended.
-Should be different to the previous password.
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      password2
-- Env Var:     RCLONE_CRYPT_PASSWORD2
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to crypt (Encrypt/Decrypt a remote).
-
-#### --crypt-server-side-across-configs
-
-Allow server side operations (eg copy) to work across different crypt configs.
-
-Normally this option is not what you want, but if you have two crypts
-pointing to the same backend you can use it.
-
-This can be used, for example, to change file name encryption type
-without re-uploading all the data. Just make two crypt backends
-pointing to two different directories with the single changed
-parameter and use rclone move to move the files between the crypt
-remotes.
-
-- Config:      server_side_across_configs
-- Env Var:     RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS
-- Type:        bool
-- Default:     false
-
-#### --crypt-show-mapping
-
-For all files listed show how the names encrypt.
-
-If this flag is set then for each file that the remote is asked to
-list, it will log (at level INFO) a line stating the decrypted file
-name and the encrypted file name.
-
-This is so you can work out which encrypted names are which decrypted
-names just in case you need to do something with the encrypted file
-names, or for debugging purposes.
-
-- Config:      show_mapping
-- Env Var:     RCLONE_CRYPT_SHOW_MAPPING
-- Type:        bool
-- Default:     false
-
-### Backend commands
-
-Here are the commands specific to the crypt backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### encode
-
-Encode the given filename(s)
-
-    rclone backend encode remote: [options] [<arguments>+]
-
-This encodes the filenames given as arguments returning a list of
-strings of the encoded results.
-
-Usage Example:
-
-    rclone backend encode crypt: file1 [file2...]
-    rclone rc backend/command command=encode fs=crypt: file1 [file2...]
-
-
-#### decode
-
-Decode the given filename(s)
-
-    rclone backend decode remote: [options] [<arguments>+]
-
-This decodes the filenames given as arguments returning a list of
-strings of the decoded results. It will return an error if any of the
-inputs are invalid.
-
-Usage Example:
-
-    rclone backend decode crypt: encryptedfile1 [encryptedfile2...]
-    rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]
-
-
-
-
-## Backing up a crypted remote ##
-
-If you wish to backup a crypted remote, it is recommended that you use
-`rclone sync` on the encrypted files, and make sure the passwords are
-the same in the new encrypted remote.
-
-This will have the following advantages
-
-  * `rclone sync` will check the checksums while copying
-  * you can use `rclone check` between the encrypted remotes
-  * you don't decrypt and encrypt unnecessarily
-
-For example, let's say you have your original remote at `remote:` with
-the encrypted version at `eremote:` with path `remote:crypt`.  You
-would then set up the new remote `remote2:` and then the encrypted
-version `eremote2:` with path `remote2:crypt` using the same passwords
-as `eremote:`.
-
-To sync the two remotes you would do
-
-    rclone sync -i remote:crypt remote2:crypt
-
-And to check the integrity you would do
-
-    rclone check remote:crypt remote2:crypt
-
-## File formats ##
-
-### File encryption ###
-
-Files are encrypted 1:1 source file to destination object.  The file
-has a header and is divided into chunks.
-
-#### Header ####
-
-  * 8 bytes magic string `RCLONE\x00\x00`
-  * 24 bytes Nonce (IV)
-
-The initial nonce is generated from the operating systems crypto
-strong random number generator.  The nonce is incremented for each
-chunk read making sure each nonce is unique for each block written.
-The chance of a nonce being re-used is minuscule.  If you wrote an
-exabyte of data (10¹⁸ bytes) you would have a probability of
-approximately 2×10⁻³² of re-using a nonce.
-
-#### Chunk ####
-
-Each chunk will contain 64kB of data, except for the last one which
-may have less data.  The data chunk is in standard NACL secretbox
-format. Secretbox uses XSalsa20 and Poly1305 to encrypt and
-authenticate messages.
-
-Each chunk contains:
-
-  * 16 Bytes of Poly1305 authenticator
-  * 1 - 65536 bytes XSalsa20 encrypted data
-
-64k chunk size was chosen as the best performing chunk size (the
-authenticator takes too much time below this and the performance drops
-off due to cache effects above this).  Note that these chunks are
-buffered in memory so they can't be too big.
-
-This uses a 32 byte (256 bit key) key derived from the user password.
-
-#### Examples ####
-
-1 byte file will encrypt to
-
-  * 32 bytes header
-  * 17 bytes data chunk
-
-49 bytes total
-
-1MB (1048576 bytes) file will encrypt to
-
-  * 32 bytes header
-  * 16 chunks of 65568 bytes
-
-1049120 bytes total (a 0.05% overhead).  This is the overhead for big
-files.
-
-### Name encryption ###
-
-File names are encrypted segment by segment - the path is broken up
-into `/` separated strings and these are encrypted individually.
-
-File segments are padded using PKCS#7 to a multiple of 16 bytes
-before encryption.
-
-They are then encrypted with EME using AES with 256 bit key. EME
-(ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003
-paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway.
-
-This makes for deterministic encryption which is what we want - the
-same filename must encrypt to the same thing otherwise we can't find
-it on the cloud storage system.
-
-This means that
-
-  * filenames with the same name will encrypt the same
-  * filenames which start the same won't have a common prefix
-
-This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of
-which are derived from the user password.
-
-After encryption they are written out using a modified version of
-standard `base32` encoding as described in RFC4648.  The standard
-encoding is modified in two ways:
-
-  * it becomes lower case (no-one likes upper case filenames!)
-  * we strip the padding character `=`
-
-`base32` is used rather than the more efficient `base64` so rclone can be
-used on case insensitive remotes (eg Windows, Amazon Drive).
-
-### Key derivation ###
-
-Rclone uses `scrypt` with parameters `N=16384, r=8, p=1` with an
-optional user supplied salt (password2) to derive the 32+32+16 = 80
-bytes of key material required.  If the user doesn't supply a salt
-then rclone uses an internal one.
-
-`scrypt` makes it impractical to mount a dictionary attack on rclone
-encrypted data.  For full protection against this you should always use
-a salt.
-
- Dropbox
----------------------------------
-
-Paths are specified as `remote:path`
-
-Dropbox paths may be as deep as required, eg
-`remote:directory/subdirectory`.
-
-The initial setup for dropbox involves getting a token from Dropbox
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
      
-
    1. New remote
      2. 
-
    2. Delete remote
      3. 
-
    3. Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Dropbox  "dropbox" [snip] Storage> dropbox Dropbox App Key - leave blank normally. app_key> Dropbox App Secret - leave blank normally. app_secret> Remote config Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX -------------------- [remote] app_key = app_secret = token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX --------------------
      4. 
-
    4. Yes this is OK
      5. 
-
    5. Edit this remote
      6. 
-
    6. Delete this remote y/e/d> y
      7. 
-
    
-
    
-You can then use it like this,
-
-List directories in top level of your dropbox
-
-    rclone lsd remote:
-
-List all the files in your dropbox
-
-    rclone ls remote:
-
-To copy a local directory to a dropbox directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Dropbox for business ###
-
-Rclone supports Dropbox for business and Team Folders.
-
-When using Dropbox for business `remote:` and `remote:path/to/file`
-will refer to your personal folder.
-
-If you wish to see Team Folders you must use a leading `/` in the
-path, so `rclone lsd remote:/` will refer to the root and show you all
-Team Folders and your User Folder.
-
-You can then use team folders like this `remote:/TeamFolder` and
-`remote:/TeamFolder/path/to/file`.
-
-A leading `/` for a Dropbox personal account will do nothing, but it
-will take an extra HTTP transaction so it should be avoided.
-
-### Modified time and Hashes ###
-
-Dropbox supports modified times, but the only way to set a
-modification time is to re-upload the file.
-
-This means that if you uploaded your data with an older version of
-rclone which didn't support the v2 API and modified times, rclone will
-decide to upload all your old data to fix the modification times.  If
-you don't want this to happen use `--size-only` or `--checksum` flag
-to stop it.
-
-Dropbox supports [its own hash
-type](https://www.dropbox.com/developers/reference/content-hash) which
-is checked for all transfers.
-
-#### Restricted filename characters
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| /         | 0x2F  | ／           |
-| DEL       | 0x7F  | ␡           |
-| \         | 0x5C  | ＼           |
-
-File names can also not end with the following characters.
-These only get replaced if they are the last character in the name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to dropbox (Dropbox).
-
-#### --dropbox-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_DROPBOX_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --dropbox-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_DROPBOX_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-### Advanced Options
-
-Here are the advanced options specific to dropbox (Dropbox).
-
-#### --dropbox-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_DROPBOX_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --dropbox-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_DROPBOX_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --dropbox-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_DROPBOX_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --dropbox-chunk-size
-
-Upload chunk size. (< 150M).
-
-Any files larger than this will be uploaded in chunks of this size.
-
-Note that chunks are buffered in memory (one at a time) so rclone can
-deal with retries.  Setting this larger will increase the speed
-slightly (at most 10% for 128MB in tests) at the cost of using more
-memory.  It can be set smaller if you are tight on memory.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_DROPBOX_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     48M
-
-#### --dropbox-impersonate
-
-Impersonate this user when using a business account.
-
-- Config:      impersonate
-- Env Var:     RCLONE_DROPBOX_IMPERSONATE
-- Type:        string
-- Default:     ""
-
-#### --dropbox-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_DROPBOX_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot
-
-
-
-### Limitations ###
-
-Note that Dropbox is case insensitive so you can't have a file called
-"Hello.doc" and one called "hello.doc".
-
-There are some file names such as `thumbs.db` which Dropbox can't
-store.  There is a full list of them in the ["Ignored Files" section
-of this document](https://www.dropbox.com/en/help/145).  Rclone will
-issue an error message `File name disallowed - not uploading` if it
-attempts to upload one of those file names, but the sync won't fail.
-
-Some errors may occur if you try to sync copyright-protected files
-because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that
-prevents this sort of file being downloaded. This will return the error `ERROR :
-/path/to/your/file: Failed to copy: failed to open source object:
-path/restricted_content/.`
-
-If you have more than 10,000 files in a directory then `rclone purge
-dropbox:dir` will return the error `Failed to purge: There are too
-many files involved in this operation`.  As a work-around do an
-`rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir`.
-
-### Get your own Dropbox App ID ###
-
-When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users.
-
-Here is how to create your own Dropbox App ID for rclone:
-
-1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not
-to be the same account as the Dropbox you want to access)
-
-2. Choose an API => Usually this should be `Dropbox API`
-
-3. Choose the type of access you want to use => `Full Dropbox` or `App Folder`
-
-4. Name your App. The app name is global, so you can't use `rclone` for example
-
-5. Click the button `Create App`
-
-5. Fill `Redirect URIs` as `http://localhost:53682/`
-
-6. Find the `App key` and `App secret` Use these values in rclone config to add a new remote or edit an existing remote.
-
- FTP
-------------------------------
-
-FTP is the File Transfer Protocol. FTP support is provided using the
-[github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp)
-package.
-
-Paths are specified as `remote:path`. If the path does not begin with
-a `/` it is relative to the home directory of the user.  An empty path
-`remote:` refers to the user's home directory.
-
-Here is an example of making an FTP configuration.  First run
-
-    rclone config
-
-This will guide you through an interactive setup process. An FTP remote only
-needs a host together with and a username and a password. With anonymous FTP
-server, you will need to use `anonymous` as username and your email address as
-the password.
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / FTP Connection  "ftp" [snip] Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ **
    
-
    FTP host to connect to Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value 1 / Connect to ftp.example.com  "ftp.example.com" host> ftp.example.com FTP username, leave blank for current username, ncw Enter a string value. Press Enter for the default (""). user> FTP port, leave blank to use default (21) Enter a string value. Press Enter for the default (""). port> FTP password y) Yes type in my own password g) Generate random password y/g> y Enter the password: password: Confirm the password: password: Use FTP over TLS (Implicit) Enter a boolean value (true or false). Press Enter for the default ("false"). tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). Press Enter for the default ("false"). explicit_tls> Remote config -------------------- [remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-This remote is called `remote` and can now be used like this
-
-See all directories in the home directory
-
-    rclone lsd remote:
-
-Make a new directory
-
-    rclone mkdir remote:path/to/directory
-
-List the contents of a directory
-
-    rclone ls remote:path/to/directory
-
-Sync `/home/local/directory` to the remote directory, deleting any
-excess files in the directory.
-
-    rclone sync -i /home/local/directory remote:directory
-
-### Modified time ###
-
-FTP does not support modified times.  Any times you see on the server
-will be time of upload.
-
-### Checksums ###
-
-FTP does not support any checksums.
-
-### Usage without a config file ###
-
-An example how to use the ftp remote without a config file:
-
-    rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy`
-
-#### Restricted filename characters
-
-In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters)
-the following characters are also replaced:
-
-File names can also not end with the following characters.
-These only get replaced if they are the last character in the name:
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| SP        | 0x20  | ␠           |
-
-Note that not all FTP servers can have all characters in file names, for example:
-
-| FTP Server| Forbidden characters |
-| --------- |:--------------------:|
-| proftpd   | `*`                  |
-| pureftpd  | `\ [ ]`              |
-
-### Implicit TLS ###
-
-FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled
-in the config for the remote. The default FTPS port is `990` so the
-port will likely have to be explicitly set in the config for the remote.
-
-
-### Standard Options
-
-Here are the standard options specific to ftp (FTP Connection).
-
-#### --ftp-host
-
-FTP host to connect to
-
-- Config:      host
-- Env Var:     RCLONE_FTP_HOST
-- Type:        string
-- Default:     ""
-- Examples:
-    - "ftp.example.com"
-        - Connect to ftp.example.com
-
-#### --ftp-user
-
-FTP username, leave blank for current username, $USER
-
-- Config:      user
-- Env Var:     RCLONE_FTP_USER
-- Type:        string
-- Default:     ""
-
-#### --ftp-port
-
-FTP port, leave blank to use default (21)
-
-- Config:      port
-- Env Var:     RCLONE_FTP_PORT
-- Type:        string
-- Default:     ""
-
-#### --ftp-pass
-
-FTP password
-
-**NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/).
-
-- Config:      pass
-- Env Var:     RCLONE_FTP_PASS
-- Type:        string
-- Default:     ""
-
-#### --ftp-tls
-
-Use FTPS over TLS (Implicit)
-When using implicit FTP over TLS the client will connect using TLS
-right from the start, which in turn breaks the compatibility with
-non-TLS-aware servers. This is usually served over port 990 rather
-than port 21. Cannot be used in combination with explicit FTP.
-
-- Config:      tls
-- Env Var:     RCLONE_FTP_TLS
-- Type:        bool
-- Default:     false
-
-#### --ftp-explicit-tls
-
-Use FTP over TLS (Explicit)
-When using explicit FTP over TLS the client explicitly request
-security from the server in order to upgrade a plain text connection
-to an encrypted one. Cannot be used in combination with implicit FTP.
-
-- Config:      explicit_tls
-- Env Var:     RCLONE_FTP_EXPLICIT_TLS
-- Type:        bool
-- Default:     false
-
-### Advanced Options
-
-Here are the advanced options specific to ftp (FTP Connection).
-
-#### --ftp-concurrency
-
-Maximum number of FTP simultaneous connections, 0 for unlimited
-
-- Config:      concurrency
-- Env Var:     RCLONE_FTP_CONCURRENCY
-- Type:        int
-- Default:     0
-
-#### --ftp-no-check-certificate
-
-Do not verify the TLS certificate of the server
-
-- Config:      no_check_certificate
-- Env Var:     RCLONE_FTP_NO_CHECK_CERTIFICATE
-- Type:        bool
-- Default:     false
-
-#### --ftp-disable-epsv
-
-Disable using EPSV even if server advertises support
-
-- Config:      disable_epsv
-- Env Var:     RCLONE_FTP_DISABLE_EPSV
-- Type:        bool
-- Default:     false
-
-#### --ftp-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_FTP_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,Del,Ctl,RightSpace,Dot
-
-
-
-### Limitations ###
-
-Note that FTP does have its own implementation of : `--dump headers`,
-`--dump bodies`, `--dump auth` for debugging which isn't the same as
-the HTTP based backends - it has less fine grained control.
-
-Note that `--timeout` isn't supported (but `--contimeout` is).
-
-Note that `--bind` isn't supported.
-
-FTP could support server side move but doesn't yet.
-
-Note that the ftp backend does not support the `ftp_proxy` environment
-variable yet.
-
- Google Cloud Storage
--------------------------------------------------
-
-Paths are specified as `remote:bucket` (or `remote:` for the `lsd`
-command.)  You may put subdirectories in too, eg `remote:bucket/path/to/dir`.
-
-The initial setup for google cloud storage involves getting a token from Google Cloud Storage
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
      
-
    1. New remote
      2. 
-
    2. Delete remote
      3. 
-
    3. Quit config e/n/d/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Cloud Storage (this is not Google Drive)  "google cloud storage" [snip] Storage> google cloud storage Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Project number optional - needed only for list/create/delete buckets - see your developer console. project_number> 12345678 Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Access Control List for new objects. Choose a number from below, or type in your own value 1 / Object owner gets OWNER access, and all Authenticated Users get READER access.  "authenticatedRead" 2 / Object owner gets OWNER access, and project team owners get OWNER access.  "bucketOwnerFullControl" 3 / Object owner gets OWNER access, and project team owners get READER access.  "bucketOwnerRead" 4 / Object owner gets OWNER access [default if left blank].  "private" 5 / Object owner gets OWNER access, and project team members get access according to their roles.  "projectPrivate" 6 / Object owner gets OWNER access, and all Users get READER access.  "publicRead" object_acl> 4 Access Control List for new buckets. Choose a number from below, or type in your own value 1 / Project team owners get OWNER access, and all Authenticated Users get READER access.  "authenticatedRead" 2 / Project team owners get OWNER access [default if left blank].  "private" 3 / Project team members get access according to their roles.  "projectPrivate" 4 / Project team owners get OWNER access, and all Users get READER access.  "publicRead" 5 / Project team owners get OWNER access, and all Users get WRITER access.  "publicReadWrite" bucket_acl> 2 Location for the newly created buckets. Choose a number from below, or type in your own value 1 / Empty for default location (US).  "" 2 / Multi-regional location for Asia.  "asia" 3 / Multi-regional location for Europe.  "eu" 4 / Multi-regional location for United States.  "us" 5 / Taiwan.  "asia-east1" 6 / Tokyo.  "asia-northeast1" 7 / Singapore.  "asia-southeast1" 8 / Sydney.  "australia-southeast1" 9 / Belgium.  "europe-west1" 10 / London.  "europe-west2" 11 / Iowa.  "us-central1" 12 / South Carolina.  "us-east1" 13 / Northern Virginia.  "us-east4" 14 / Oregon.  "us-west1" location> 12 The storage class to use when storing objects in Google Cloud Storage. Choose a number from below, or type in your own value 1 / Default  "" 2 / Multi-regional storage class  "MULTI_REGIONAL" 3 / Regional storage class  "REGIONAL" 4 / Nearline storage class  "NEARLINE" 5 / Coldline storage class  "COLDLINE" 6 / Durable reduced availability storage class  "DURABLE_REDUCED_AVAILABILITY" storage_class> 5 Remote config Use auto config?
      4. 
-
    
-
      
-
    • Say Y if not sure
      • 
-
    • Say N if you are working on a remote or headless machine or Y didn't work
      • 
-
    
-
      
-
    1. Yes
      2. 
-
    2. No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code -------------------- [remote] type = google cloud storage client_id = client_secret = token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} project_number = 12345678 object_acl = private bucket_acl = private --------------------
      3. 
-
    3. Yes this is OK
      4. 
-
    4. Edit this remote
      5. 
-
    5. Delete this remote y/e/d> y
      6. 
-
    
-
    
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Google if you use auto config mode. This only
-runs from the moment it opens your browser to the moment you get back
-the verification code.  This is on `http://127.0.0.1:53682/` and this
-it may require you to unblock it temporarily if you are running a host
-firewall, or use manual mode.
-
-This remote is called `remote` and can now be used like this
-
-See all the buckets in your project
-
-    rclone lsd remote:
-
-Make a new bucket
-
-    rclone mkdir remote:bucket
-
-List the contents of a bucket
-
-    rclone ls remote:bucket
-
-Sync `/home/local/directory` to the remote bucket, deleting any excess
-files in the bucket.
-
-    rclone sync -i /home/local/directory remote:bucket
-
-### Service Account support ###
-
-You can set up rclone with Google Cloud Storage in an unattended mode,
-i.e. not tied to a specific end-user Google account. This is useful
-when you want to synchronise files onto machines that don't have
-actively logged-in users, for example build machines.
-
-To get credentials for Google Cloud Platform
-[IAM Service Accounts](https://cloud.google.com/iam/docs/service-accounts),
-please head to the
-[Service Account](https://console.cloud.google.com/permissions/serviceaccounts)
-section of the Google Developer Console. Service Accounts behave just
-like normal `User` permissions in
-[Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access-control),
-so you can limit their access (e.g. make them read only). After
-creating an account, a JSON file containing the Service Account's
-credentials will be downloaded onto your machines. These credentials
-are what rclone will use for authentication.
-
-To use a Service Account instead of OAuth2 token flow, enter the path
-to your Service Account credentials at the `service_account_file`
-prompt and rclone won't use the browser based authentication
-flow. If you'd rather stuff the contents of the credentials file into
-the rclone config file, you can set `service_account_credentials` with
-the actual contents of the file instead, or set the equivalent
-environment variable.
-
-### Anonymous Access ###
-
-For downloads of objects that permit public access you can configure rclone
-to use anonymous access by setting `anonymous` to `true`.
-With unauthorized access you can't write or create files but only read or list
-those buckets and objects that have public read access.
-
-### Application Default Credentials ###
-
-If no other source of credentials is provided, rclone will fall back
-to
-[Application Default Credentials](https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials)
-this is useful both when you already have configured authentication
-for your developer account, or in production when running on a google
-compute host. Note that if running in docker, you may need to run
-additional commands on your google compute machine -
-[see this page](https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper).
-
-Note that in the case application default credentials are used, there
-is no need to explicitly configure a project number.
-
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-### Custom upload headers ###
-
-You can set custom upload headers with the `--header-upload`
-flag. Google Cloud Storage supports the headers as described in the
-[working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata)
-
-- Cache-Control
-- Content-Disposition
-- Content-Encoding
-- Content-Language
-- Content-Type
-- X-Goog-Meta-
-
-Eg `--header-upload "Content-Type text/potato"`
-
-Note that the last of these is for setting custom metadata in the form
-`--header-upload "x-goog-meta-key: value"`
-
-### Modified time ###
-
-Google google cloud storage stores md5sums natively and rclone stores
-modification times as metadata on the object, under the "mtime" key in
-RFC3339 format accurate to 1ns.
-
-#### Restricted filename characters
-
-| Character | Value | Replacement |
-| --------- |:-----:|:-----------:|
-| NUL       | 0x00  | ␀           |
-| LF        | 0x0A  | ␊           |
-| CR        | 0x0D  | ␍           |
-| /         | 0x2F  | ／          |
-
-Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-
-### Standard Options
-
-Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
-
-#### --gcs-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_GCS_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --gcs-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_GCS_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-#### --gcs-project-number
-
-Project number.
-Optional - needed only for list/create/delete buckets - see your developer console.
-
-- Config:      project_number
-- Env Var:     RCLONE_GCS_PROJECT_NUMBER
-- Type:        string
-- Default:     ""
-
-#### --gcs-service-account-file
-
-Service Account Credentials JSON file path
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
-
-
-- Config:      service_account_file
-- Env Var:     RCLONE_GCS_SERVICE_ACCOUNT_FILE
-- Type:        string
-- Default:     ""
-
-#### --gcs-service-account-credentials
-
-Service Account Credentials JSON blob
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-- Config:      service_account_credentials
-- Env Var:     RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS
-- Type:        string
-- Default:     ""
-
-#### --gcs-anonymous
-
-Access public buckets and objects without credentials
-Set to 'true' if you just want to download files and don't configure credentials.
-
-- Config:      anonymous
-- Env Var:     RCLONE_GCS_ANONYMOUS
-- Type:        bool
-- Default:     false
-
-#### --gcs-object-acl
-
-Access Control List for new objects.
-
-- Config:      object_acl
-- Env Var:     RCLONE_GCS_OBJECT_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "authenticatedRead"
-        - Object owner gets OWNER access, and all Authenticated Users get READER access.
-    - "bucketOwnerFullControl"
-        - Object owner gets OWNER access, and project team owners get OWNER access.
-    - "bucketOwnerRead"
-        - Object owner gets OWNER access, and project team owners get READER access.
-    - "private"
-        - Object owner gets OWNER access [default if left blank].
-    - "projectPrivate"
-        - Object owner gets OWNER access, and project team members get access according to their roles.
-    - "publicRead"
-        - Object owner gets OWNER access, and all Users get READER access.
-
-#### --gcs-bucket-acl
-
-Access Control List for new buckets.
-
-- Config:      bucket_acl
-- Env Var:     RCLONE_GCS_BUCKET_ACL
-- Type:        string
-- Default:     ""
-- Examples:
-    - "authenticatedRead"
-        - Project team owners get OWNER access, and all Authenticated Users get READER access.
-    - "private"
-        - Project team owners get OWNER access [default if left blank].
-    - "projectPrivate"
-        - Project team members get access according to their roles.
-    - "publicRead"
-        - Project team owners get OWNER access, and all Users get READER access.
-    - "publicReadWrite"
-        - Project team owners get OWNER access, and all Users get WRITER access.
-
-#### --gcs-bucket-policy-only
-
-Access checks should use bucket-level IAM policies.
-
-If you want to upload objects to a bucket with Bucket Policy Only set
-then you will need to set this.
-
-When it is set, rclone:
-
-- ignores ACLs set on buckets
-- ignores ACLs set on objects
-- creates buckets with Bucket Policy Only set
-
-Docs: https://cloud.google.com/storage/docs/bucket-policy-only
-
-
-- Config:      bucket_policy_only
-- Env Var:     RCLONE_GCS_BUCKET_POLICY_ONLY
-- Type:        bool
-- Default:     false
-
-#### --gcs-location
-
-Location for the newly created buckets.
-
-- Config:      location
-- Env Var:     RCLONE_GCS_LOCATION
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Empty for default location (US).
-    - "asia"
-        - Multi-regional location for Asia.
-    - "eu"
-        - Multi-regional location for Europe.
-    - "us"
-        - Multi-regional location for United States.
-    - "asia-east1"
-        - Taiwan.
-    - "asia-east2"
-        - Hong Kong.
-    - "asia-northeast1"
-        - Tokyo.
-    - "asia-south1"
-        - Mumbai.
-    - "asia-southeast1"
-        - Singapore.
-    - "australia-southeast1"
-        - Sydney.
-    - "europe-north1"
-        - Finland.
-    - "europe-west1"
-        - Belgium.
-    - "europe-west2"
-        - London.
-    - "europe-west3"
-        - Frankfurt.
-    - "europe-west4"
-        - Netherlands.
-    - "us-central1"
-        - Iowa.
-    - "us-east1"
-        - South Carolina.
-    - "us-east4"
-        - Northern Virginia.
-    - "us-west1"
-        - Oregon.
-    - "us-west2"
-        - California.
-
-#### --gcs-storage-class
-
-The storage class to use when storing objects in Google Cloud Storage.
-
-- Config:      storage_class
-- Env Var:     RCLONE_GCS_STORAGE_CLASS
-- Type:        string
-- Default:     ""
-- Examples:
-    - ""
-        - Default
-    - "MULTI_REGIONAL"
-        - Multi-regional storage class
-    - "REGIONAL"
-        - Regional storage class
-    - "NEARLINE"
-        - Nearline storage class
-    - "COLDLINE"
-        - Coldline storage class
-    - "ARCHIVE"
-        - Archive storage class
-    - "DURABLE_REDUCED_AVAILABILITY"
-        - Durable reduced availability storage class
-
-### Advanced Options
-
-Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
-
-#### --gcs-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_GCS_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --gcs-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_GCS_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --gcs-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_GCS_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --gcs-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_GCS_ENCODING
-- Type:        MultiEncoder
-- Default:     Slash,CrLf,InvalidUtf8,Dot
-
-
-
- Google Drive
------------------------------------------
-
-Paths are specified as `drive:path`
-
-Drive paths may be as deep as required, eg `drive:directory/subdirectory`.
-
-The initial setup for drive involves getting a token from Google drive
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote r) Rename remote c) Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n name> remote Type of storage to configure. Choose a number from below, or type in your own value [snip] XX / Google Drive  "drive" [snip] Storage> drive Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. client_secret> Scope that rclone should use when requesting access from drive. Choose a number from below, or type in your own value 1 / Full access all files, excluding Application Data Folder.  "drive" 2 / Read-only access to file metadata and file contents.  "drive.readonly" / Access to files created by rclone only. 3 | These are visible in the drive website. | File authorization is revoked when the user deauthorizes the app.  "drive.file" / Allows read and write access to the Application Data folder. 4 | This is not visible in the drive website.  "drive.appfolder" / Allows read-only access to file metadata but 5 | does not allow any access to read or download file content.  "drive.metadata.readonly" scope> 1 ID of the root folder - leave blank normally. Fill in to access "Computers" folders. (see docs). root_folder_id> Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. service_account_file> Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine or Y didn't work y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code Configure this as a team drive? y) Yes n) No y/n> n -------------------- [remote] client_id = client_secret = scope = drive root_folder_id = service_account_file = token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-Note that rclone runs a webserver on your local machine to collect the
-token as returned from Google if you use auto config mode. This only
-runs from the moment it opens your browser to the moment you get back
-the verification code.  This is on `http://127.0.0.1:53682/` and this
-it may require you to unblock it temporarily if you are running a host
-firewall, or use manual mode.
-
-You can then use it like this,
-
-List directories in top level of your drive
-
-    rclone lsd remote:
-
-List all the files in your drive
-
-    rclone ls remote:
-
-To copy a local directory to a drive directory called backup
-
-    rclone copy /home/source remote:backup
-
-### Scopes ###
-
-Rclone allows you to select which scope you would like for rclone to
-use.  This changes what type of token is granted to rclone.  [The
-scopes are defined
-here](https://developers.google.com/drive/v3/web/about-auth).
-
-The scope are
-
-#### drive ####
-
-This is the default scope and allows full access to all files, except
-for the Application Data Folder (see below).
-
-Choose this one if you aren't sure.
-
-#### drive.readonly ####
-
-This allows read only access to all files.  Files may be listed and
-downloaded but not uploaded, renamed or deleted.
-
-#### drive.file ####
-
-With this scope rclone can read/view/modify only those files and
-folders it creates.
-
-So if you uploaded files to drive via the web interface (or any other
-means) they will not be visible to rclone.
-
-This can be useful if you are using rclone to backup data and you want
-to be sure confidential data on your drive is not visible to rclone.
-
-Files created with this scope are visible in the web interface.
-
-#### drive.appfolder ####
-
-This gives rclone its own private area to store files.  Rclone will
-not be able to see any other files on your drive and you won't be able
-to see rclone's files from the web interface either.
-
-#### drive.metadata.readonly ####
-
-This allows read only access to file names only.  It does not allow
-rclone to download or upload data, or rename or delete files or
-directories.
-
-### Root folder ID ###
-
-You can set the `root_folder_id` for rclone.  This is the directory
-(identified by its `Folder ID`) that rclone considers to be the root
-of your drive.
-
-Normally you will leave this blank and rclone will determine the
-correct root to use itself.
-
-However you can set this to restrict rclone to a specific folder
-hierarchy or to access data within the "Computers" tab on the drive
-web interface (where files from Google's Backup and Sync desktop
-program go).
-
-In order to do this you will have to find the `Folder ID` of the
-directory you wish rclone to display.  This will be the last segment
-of the URL when you open the relevant folder in the drive web
-interface.
-
-So if the folder you want rclone to use has a URL which looks like
-`https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh`
-in the browser, then you use `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` as
-the `root_folder_id` in the config.
-
-**NB** folders under the "Computers" tab seem to be read only (drive
-gives a 500 error) when using rclone.
-
-There doesn't appear to be an API to discover the folder IDs of the
-"Computers" tab - please contact us if you know otherwise!
-
-Note also that rclone can't access any data under the "Backups" tab on
-the google drive web interface yet.
-
-### Service Account support ###
-
-You can set up rclone with Google Drive in an unattended mode,
-i.e. not tied to a specific end-user Google account. This is useful
-when you want to synchronise files onto machines that don't have
-actively logged-in users, for example build machines.
-
-To use a Service Account instead of OAuth2 token flow, enter the path
-to your Service Account credentials at the `service_account_file`
-prompt during `rclone config` and rclone won't use the browser based
-authentication flow. If you'd rather stuff the contents of the
-credentials file into the rclone config file, you can set
-`service_account_credentials` with the actual contents of the file
-instead, or set the equivalent environment variable.
-
-#### Use case - Google Apps/G-suite account and individual Drive ####
-
-Let's say that you are the administrator of a Google Apps (old) or
-G-suite account.
-The goal is to store data on an individual's Drive account, who IS
-a member of the domain.
-We'll call the domain **example.com**, and the user
-**foo@example.com**.
-
-There's a few steps we need to go through to accomplish this:
-
-##### 1. Create a service account for example.com #####
-  - To create a service account and obtain its credentials, go to the
-[Google Developer Console](https://console.developers.google.com).
-  - You must have a project - create one if you don't.
-  - Then go to "IAM & admin" -> "Service Accounts".
-  - Use the "Create Credentials" button. Fill in "Service account name"
-with something that identifies your client. "Role" can be empty.
-  - Tick "Furnish a new private key" - select "Key type JSON".
-  - Tick "Enable G Suite Domain-wide Delegation". This option makes
-"impersonation" possible, as documented here:
-[Delegating domain-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority)
-  - These credentials are what rclone will use for authentication.
-If you ever need to remove access, press the "Delete service
-account key" button.
-
-##### 2. Allowing API access to example.com Google Drive #####
-  - Go to example.com's admin console
-  - Go into "Security" (or use the search bar)
-  - Select "Show more" and then "Advanced settings"
-  - Select "Manage API client access" in the "Authentication" section
-  - In the "Client Name" field enter the service account's
-"Client ID" - this can be found in the Developer Console under
-"IAM & Admin" -> "Service Accounts", then "View Client ID" for
-the newly created service account.
-It is a ~21 character numerical string.
-  - In the next field, "One or More API Scopes", enter
-`https://www.googleapis.com/auth/drive`
-to grant access to Google Drive specifically.
-
-##### 3. Configure rclone, assuming a new install #####
-
    
-
    rclone config
    
-
    n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select the number shown for Google Drive client_id> # Can be left blank client_secret> # Can be left blank scope> # Select your scope, 1 for example root_folder_id> # Can be left blank service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # Auto config, y
    
-
    
-##### 4. Verify that it's working #####
-  - `rclone -v --drive-impersonate foo@example.com lsf gdrive:backup`
-  - The arguments do:
-    - `-v` - verbose logging
-    - `--drive-impersonate foo@example.com` - this is what does
-the magic, pretending to be user foo.
-    - `lsf` - list files in a parsing friendly way
-    - `gdrive:backup` - use the remote called gdrive, work in
-the folder named backup.
-
-Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using `--drive-impersonate`, do this instead:
-  - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1
-  - use rclone without specifying the `--drive-impersonate` option, like this:
-        `rclone -v foo@example.com lsf gdrive:backup`
-
-
-### Team drives ###
-
-If you want to configure the remote to point to a Google Team Drive
-then answer `y` to the question `Configure this as a team drive?`.
-
-This will fetch the list of Team Drives from google and allow you to
-configure which one you want to use.  You can also type in a team
-drive ID if you prefer.
-
-For example:
-
    
-
    Configure this as a team drive? y) Yes n) No y/n> y Fetching team drive list... Choose a number from below, or type in your own value 1 / Rclone Test  "xxxxxxxxxxxxxxxxxxxx" 2 / Rclone Test 2  "yyyyyyyyyyyyyyyyyyyy" 3 / Rclone Test 3  "zzzzzzzzzzzzzzzzzzzz" Enter a Team Drive ID> 1 -------------------- [remote] client_id = client_secret = token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} team_drive = xxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y
    
-
    
-### --fast-list ###
-
-This remote supports `--fast-list` which allows you to use fewer
-transactions in exchange for more memory. See the [rclone
-docs](https://rclone.org/docs/#fast-list) for more details.
-
-It does this by combining multiple `list` calls into a single API request.
-
-This works by combining many `'%s' in parents` filters into one expression.
-To list the contents of directories a, b and c, the following requests will be send by the regular `List` function:
    
-
    trashed=false and 'a' in parents trashed=false and 'b' in parents trashed=false and 'c' in parents
    
-
    These can now be combined into a single request:
    
-
    trashed=false and ('a' in parents or 'b' in parents or 'c' in parents)
    
-
    
-The implementation of `ListR` will put up to 50 `parents` filters into one request.
-It will  use the `--checkers` value to specify the number of requests to run in parallel.
-
-In tests, these batch requests were up to 20x faster than the regular method.
-Running the following command against different sized folders gives:
    
-
    rclone lsjson -vv -R --checkers=6 gdrive:folder
    
-
    
-small folder (220 directories, 700 files):
-
-- without `--fast-list`: 38s
-- with `--fast-list`: 10s
-
-large folder (10600 directories, 39000 files):
-
-- without `--fast-list`: 22:05 min
-- with `--fast-list`: 58s
-
-### Modified time ###
-
-Google drive stores modification times accurate to 1 ms.
-
-#### Restricted filename characters
-
-Only Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8),
-as they can't be used in JSON strings.
-
-In contrast to other backends, `/` can also be used in names and `.`
-or `..` are valid names.
-
-### Revisions ###
-
-Google drive stores revisions of files.  When you upload a change to
-an existing file to google drive using rclone it will create a new
-revision of that file.
-
-Revisions follow the standard google policy which at time of writing
-was
-
-  * They are deleted after 30 days or 100 revisions (whatever comes first).
-  * They do not count towards a user storage quota.
-
-### Deleting files ###
-
-By default rclone will send all files to the trash when deleting
-files.  If deleting them permanently is required then use the
-`--drive-use-trash=false` flag, or set the equivalent environment
-variable.
-
-### Shortcuts ###
-
-In March 2020 Google introduced a new feature in Google Drive called
-[drive shortcuts](https://support.google.com/drive/answer/9700156)
-([API](https://developers.google.com/drive/api/v3/shortcuts)). These
-will (by September 2020) [replace the ability for files or folders to
-be in multiple folders at once](https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models).
-
-Shortcuts are files that link to other files on Google Drive somewhat
-like a symlink in unix, except they point to the underlying file data
-(eg the inode in unix terms) so they don't break if the source is
-renamed or moved about.
-
-Be default rclone treats these as follows.
-
-For shortcuts pointing to files:
-
-- When listing a file shortcut appears as the destination file.
-- When downloading the contents of the destination file is downloaded.
-- When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut.
-- When server side moving (renaming) the shortcut is renamed, not the destination file.
-- When server side copying the shortcut is copied, not the contents of the shortcut.
-- When deleting the shortcut is deleted not the linked file.
-- When setting the modification time, the modification time of the linked file will be set.
-
-For shortcuts pointing to folders:
-
-- When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders)
-- When downloading the contents of the linked folder and sub contents are downloaded
-- When uploading to a shortcut folder the file will be placed in the linked folder
-- When server side moving (renaming) the shortcut is renamed, not the destination folder
-- When server side copying the contents of the linked folder is copied, not the shortcut.
-- When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder.
-- **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted.
-
-The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts.  
-
-Shortcuts can be completely ignored with the `--drive-skip-shortcuts` flag
-or the corresponding `skip_shortcuts` configuration setting.
-
-### Emptying trash ###
-
-If you wish to empty your trash you can use the `rclone cleanup remote:`
-command which will permanently delete all your trashed files. This command
-does not take any path arguments.
-
-Note that Google Drive takes some time (minutes to days) to empty the
-trash even though the command returns within a few seconds.  No output
-is echoed, so there will be no confirmation even using -v or -vv.
-
-### Quota information ###
-
-To view your current quota you can use the `rclone about remote:`
-command which will display your usage limit (quota), the usage in Google
-Drive, the size of all files in the Trash and the space used by other
-Google services such as Gmail. This command does not take any path
-arguments.
-
-#### Import/Export of google documents ####
-
-Google documents can be exported from and uploaded to Google Drive.
-
-When rclone downloads a Google doc it chooses a format to download
-depending upon the `--drive-export-formats` setting.
-By default the export formats are `docx,xlsx,pptx,svg` which are a
-sensible default for an editable document.
-
-When choosing a format, rclone runs down the list provided in order
-and chooses the first file format the doc can be exported as from the
-list. If the file can't be exported to a format on the formats list,
-then rclone will choose a format from the default list.
-
-If you prefer an archive copy then you might use `--drive-export-formats
-pdf`, or if you prefer openoffice/libreoffice formats you might use
-`--drive-export-formats ods,odt,odp`.
-
-Note that rclone adds the extension to the google doc, so if it is
-called `My Spreadsheet` on google docs, it will be exported as `My
-Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc.
-
-When importing files into Google Drive, rclone will convert all
-files with an extension in `--drive-import-formats` to their
-associated document type.
-rclone will not convert any files by default, since the conversion
-is lossy process.
-
-The conversion must result in a file with the same extension when
-the `--drive-export-formats` rules are applied to the uploaded document.
-
-Here are some examples for allowed and prohibited conversions.
-
-| export-formats | import-formats | Upload Ext | Document Ext | Allowed |
-| -------------- | -------------- | ---------- | ------------ | ------- |
-| odt | odt | odt | odt | Yes |
-| odt | docx,odt | odt | odt | Yes |
-|  | docx | docx | docx | Yes |
-|  | odt | odt | docx | No |
-| odt,docx | docx,odt | docx | odt | No |
-| docx,odt | docx,odt | docx | docx | Yes |
-| docx,odt | docx,odt | odt | docx | No |
-
-This limitation can be disabled by specifying `--drive-allow-import-name-change`.
-When using this flag, rclone can convert multiple files types resulting
-in the same document type at once, eg with `--drive-import-formats docx,odt,txt`,
-all files having these extension would result in a document represented as a docx file.
-This brings the additional risk of overwriting a document, if multiple files
-have the same stem. Many rclone operations will not handle this name change
-in any way. They assume an equal name when copying files and might copy the
-file again or delete them when the name changes. 
-
-Here are the possible export extensions with their corresponding mime types.
-Most of these can also be used for importing, but there more that are not
-listed here. Some of these additional ones might only be available when
-the operating system provides the correct MIME type entries.
-
-This list can be changed by Google Drive at any time and might not
-represent the currently available conversions.
-
-| Extension | Mime Type | Description |
-| --------- |-----------| ------------|
-| csv  | text/csv | Standard CSV format for Spreadsheets |
-| docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Office Document |
-| epub | application/epub+zip | E-book format |
-| html | text/html | An HTML Document |
-| jpg  | image/jpeg | A JPEG Image File |
-| json | application/vnd.google-apps.script+json | JSON Text Format |
-| odp  | application/vnd.oasis.opendocument.presentation | Openoffice Presentation |
-| ods  | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet |
-| ods  | application/x-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet |
-| odt  | application/vnd.oasis.opendocument.text | Openoffice Document |
-| pdf  | application/pdf | Adobe PDF Format |
-| png  | image/png | PNG Image Format|
-| pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation | Microsoft Office Powerpoint |
-| rtf  | application/rtf | Rich Text Format |
-| svg  | image/svg+xml | Scalable Vector Graphics Format |
-| tsv  | text/tab-separated-values | Standard TSV format for spreadsheets |
-| txt  | text/plain | Plain Text |
-| xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet |
-| zip  | application/zip | A ZIP file of HTML, Images CSS |
-
-Google documents can also be exported as link files. These files will
-open a browser window for the Google Docs website of that document
-when opened. The link file extension has to be specified as a
-`--drive-export-formats` parameter. They will match all available
-Google Documents.
-
-| Extension | Description | OS Support |
-| --------- | ----------- | ---------- |
-| desktop | freedesktop.org specified desktop entry | Linux |
-| link.html | An HTML Document with a redirect | All |
-| url | INI style link file | macOS, Windows |
-| webloc | macOS specific XML format | macOS |
-
-
-### Standard Options
-
-Here are the standard options specific to drive (Google Drive).
-
-#### --drive-client-id
-
-OAuth Client Id
-Leave blank normally.
-
-- Config:      client_id
-- Env Var:     RCLONE_DRIVE_CLIENT_ID
-- Type:        string
-- Default:     ""
-
-#### --drive-client-secret
-
-OAuth Client Secret
-Leave blank normally.
-
-- Config:      client_secret
-- Env Var:     RCLONE_DRIVE_CLIENT_SECRET
-- Type:        string
-- Default:     ""
-
-#### --drive-scope
-
-Scope that rclone should use when requesting access from drive.
-
-- Config:      scope
-- Env Var:     RCLONE_DRIVE_SCOPE
-- Type:        string
-- Default:     ""
-- Examples:
-    - "drive"
-        - Full access all files, excluding Application Data Folder.
-    - "drive.readonly"
-        - Read-only access to file metadata and file contents.
-    - "drive.file"
-        - Access to files created by rclone only.
-        - These are visible in the drive website.
-        - File authorization is revoked when the user deauthorizes the app.
-    - "drive.appfolder"
-        - Allows read and write access to the Application Data folder.
-        - This is not visible in the drive website.
-    - "drive.metadata.readonly"
-        - Allows read-only access to file metadata but
-        - does not allow any access to read or download file content.
-
-#### --drive-root-folder-id
-
-ID of the root folder
-Leave blank normally.
-
-Fill in to access "Computers" folders (see docs), or for rclone to use
-a non root folder as its starting point.
-
-
-- Config:      root_folder_id
-- Env Var:     RCLONE_DRIVE_ROOT_FOLDER_ID
-- Type:        string
-- Default:     ""
-
-#### --drive-service-account-file
-
-Service Account Credentials JSON file path 
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
-
-
-- Config:      service_account_file
-- Env Var:     RCLONE_DRIVE_SERVICE_ACCOUNT_FILE
-- Type:        string
-- Default:     ""
-
-#### --drive-alternate-export
-
-Deprecated: no longer needed
-
-- Config:      alternate_export
-- Env Var:     RCLONE_DRIVE_ALTERNATE_EXPORT
-- Type:        bool
-- Default:     false
-
-### Advanced Options
-
-Here are the advanced options specific to drive (Google Drive).
-
-#### --drive-token
-
-OAuth Access Token as a JSON blob.
-
-- Config:      token
-- Env Var:     RCLONE_DRIVE_TOKEN
-- Type:        string
-- Default:     ""
-
-#### --drive-auth-url
-
-Auth server URL.
-Leave blank to use the provider defaults.
-
-- Config:      auth_url
-- Env Var:     RCLONE_DRIVE_AUTH_URL
-- Type:        string
-- Default:     ""
-
-#### --drive-token-url
-
-Token server url.
-Leave blank to use the provider defaults.
-
-- Config:      token_url
-- Env Var:     RCLONE_DRIVE_TOKEN_URL
-- Type:        string
-- Default:     ""
-
-#### --drive-service-account-credentials
-
-Service Account Credentials JSON blob
-Leave blank normally.
-Needed only if you want use SA instead of interactive login.
-
-- Config:      service_account_credentials
-- Env Var:     RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS
-- Type:        string
-- Default:     ""
-
-#### --drive-team-drive
-
-ID of the Team Drive
-
-- Config:      team_drive
-- Env Var:     RCLONE_DRIVE_TEAM_DRIVE
-- Type:        string
-- Default:     ""
-
-#### --drive-auth-owner-only
-
-Only consider files owned by the authenticated user.
-
-- Config:      auth_owner_only
-- Env Var:     RCLONE_DRIVE_AUTH_OWNER_ONLY
-- Type:        bool
-- Default:     false
-
-#### --drive-use-trash
-
-Send files to the trash instead of deleting permanently.
-Defaults to true, namely sending files to the trash.
-Use `--drive-use-trash=false` to delete files permanently instead.
-
-- Config:      use_trash
-- Env Var:     RCLONE_DRIVE_USE_TRASH
-- Type:        bool
-- Default:     true
-
-#### --drive-skip-gdocs
-
-Skip google documents in all listings.
-If given, gdocs practically become invisible to rclone.
-
-- Config:      skip_gdocs
-- Env Var:     RCLONE_DRIVE_SKIP_GDOCS
-- Type:        bool
-- Default:     false
-
-#### --drive-skip-checksum-gphotos
-
-Skip MD5 checksum on Google photos and videos only.
-
-Use this if you get checksum errors when transferring Google photos or
-videos.
-
-Setting this flag will cause Google photos and videos to return a
-blank MD5 checksum.
-
-Google photos are identified by being in the "photos" space.
-
-Corrupted checksums are caused by Google modifying the image/video but
-not updating the checksum.
-
-- Config:      skip_checksum_gphotos
-- Env Var:     RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS
-- Type:        bool
-- Default:     false
-
-#### --drive-shared-with-me
-
-Only show files that are shared with me.
-
-Instructs rclone to operate on your "Shared with me" folder (where
-Google Drive lets you access the files and folders others have shared
-with you).
-
-This works both with the "list" (lsd, lsl, etc) and the "copy"
-commands (copy, sync, etc), and with all other commands too.
-
-- Config:      shared_with_me
-- Env Var:     RCLONE_DRIVE_SHARED_WITH_ME
-- Type:        bool
-- Default:     false
-
-#### --drive-trashed-only
-
-Only show files that are in the trash.
-This will show trashed files in their original directory structure.
-
-- Config:      trashed_only
-- Env Var:     RCLONE_DRIVE_TRASHED_ONLY
-- Type:        bool
-- Default:     false
-
-#### --drive-starred-only
-
-Only show files that are starred.
-
-- Config:      starred_only
-- Env Var:     RCLONE_DRIVE_STARRED_ONLY
-- Type:        bool
-- Default:     false
-
-#### --drive-formats
-
-Deprecated: see export_formats
-
-- Config:      formats
-- Env Var:     RCLONE_DRIVE_FORMATS
-- Type:        string
-- Default:     ""
-
-#### --drive-export-formats
-
-Comma separated list of preferred formats for downloading Google docs.
-
-- Config:      export_formats
-- Env Var:     RCLONE_DRIVE_EXPORT_FORMATS
-- Type:        string
-- Default:     "docx,xlsx,pptx,svg"
-
-#### --drive-import-formats
-
-Comma separated list of preferred formats for uploading Google docs.
-
-- Config:      import_formats
-- Env Var:     RCLONE_DRIVE_IMPORT_FORMATS
-- Type:        string
-- Default:     ""
-
-#### --drive-allow-import-name-change
-
-Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.
-
-- Config:      allow_import_name_change
-- Env Var:     RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE
-- Type:        bool
-- Default:     false
-
-#### --drive-use-created-date
-
-Use file created date instead of modified date.,
-
-Useful when downloading data and you want the creation date used in
-place of the last modified date.
-
-**WARNING**: This flag may have some unexpected consequences.
-
-When uploading to your drive all files will be overwritten unless they
-haven't been modified since their creation. And the inverse will occur
-while downloading.  This side effect can be avoided by using the
-"--checksum" flag.
-
-This feature was implemented to retain photos capture date as recorded
-by google photos. You will first need to check the "Create a Google
-Photos folder" option in your google drive settings. You can then copy
-or move the photos locally and use the date the image was taken
-(created) set as the modification date.
-
-- Config:      use_created_date
-- Env Var:     RCLONE_DRIVE_USE_CREATED_DATE
-- Type:        bool
-- Default:     false
-
-#### --drive-use-shared-date
-
-Use date file was shared instead of modified date.
-
-Note that, as with "--drive-use-created-date", this flag may have
-unexpected consequences when uploading/downloading files.
-
-If both this flag and "--drive-use-created-date" are set, the created
-date is used.
-
-- Config:      use_shared_date
-- Env Var:     RCLONE_DRIVE_USE_SHARED_DATE
-- Type:        bool
-- Default:     false
-
-#### --drive-list-chunk
-
-Size of listing chunk 100-1000. 0 to disable.
-
-- Config:      list_chunk
-- Env Var:     RCLONE_DRIVE_LIST_CHUNK
-- Type:        int
-- Default:     1000
-
-#### --drive-impersonate
-
-Impersonate this user when using a service account.
-
-- Config:      impersonate
-- Env Var:     RCLONE_DRIVE_IMPERSONATE
-- Type:        string
-- Default:     ""
-
-#### --drive-upload-cutoff
-
-Cutoff for switching to chunked upload
-
-- Config:      upload_cutoff
-- Env Var:     RCLONE_DRIVE_UPLOAD_CUTOFF
-- Type:        SizeSuffix
-- Default:     8M
-
-#### --drive-chunk-size
-
-Upload chunk size. Must a power of 2 >= 256k.
-
-Making this larger will improve performance, but note that each chunk
-is buffered in memory one per transfer.
-
-Reducing this will reduce memory usage but decrease performance.
-
-- Config:      chunk_size
-- Env Var:     RCLONE_DRIVE_CHUNK_SIZE
-- Type:        SizeSuffix
-- Default:     8M
-
-#### --drive-acknowledge-abuse
-
-Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
-
-If downloading a file returns the error "This file has been identified
-as malware or spam and cannot be downloaded" with the error code
-"cannotDownloadAbusiveFile" then supply this flag to rclone to
-indicate you acknowledge the risks of downloading the file and rclone
-will download it anyway.
-
-- Config:      acknowledge_abuse
-- Env Var:     RCLONE_DRIVE_ACKNOWLEDGE_ABUSE
-- Type:        bool
-- Default:     false
-
-#### --drive-keep-revision-forever
-
-Keep new head revision of each file forever.
-
-- Config:      keep_revision_forever
-- Env Var:     RCLONE_DRIVE_KEEP_REVISION_FOREVER
-- Type:        bool
-- Default:     false
-
-#### --drive-size-as-quota
-
-Show sizes as storage quota usage, not actual size.
-
-Show the size of a file as the storage quota used. This is the
-current version plus any older versions that have been set to keep
-forever.
-
-**WARNING**: This flag may have some unexpected consequences.
-
-It is not recommended to set this flag in your config - the
-recommended usage is using the flag form --drive-size-as-quota when
-doing rclone ls/lsl/lsf/lsjson/etc only.
-
-If you do use this flag for syncing (not recommended) then you will
-need to use --ignore size also.
-
-- Config:      size_as_quota
-- Env Var:     RCLONE_DRIVE_SIZE_AS_QUOTA
-- Type:        bool
-- Default:     false
-
-#### --drive-v2-download-min-size
-
-If Object's are greater, use drive v2 API to download.
-
-- Config:      v2_download_min_size
-- Env Var:     RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE
-- Type:        SizeSuffix
-- Default:     off
-
-#### --drive-pacer-min-sleep
-
-Minimum time to sleep between API calls.
-
-- Config:      pacer_min_sleep
-- Env Var:     RCLONE_DRIVE_PACER_MIN_SLEEP
-- Type:        Duration
-- Default:     100ms
-
-#### --drive-pacer-burst
-
-Number of API calls to allow without sleeping.
-
-- Config:      pacer_burst
-- Env Var:     RCLONE_DRIVE_PACER_BURST
-- Type:        int
-- Default:     100
-
-#### --drive-server-side-across-configs
-
-Allow server side operations (eg copy) to work across different drive configs.
-
-This can be useful if you wish to do a server side copy between two
-different Google drives.  Note that this isn't enabled by default
-because it isn't easy to tell if it will work between any two
-configurations.
-
-- Config:      server_side_across_configs
-- Env Var:     RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS
-- Type:        bool
-- Default:     false
-
-#### --drive-disable-http2
-
-Disable drive using http2
-
-There is currently an unsolved issue with the google drive backend and
-HTTP/2.  HTTP/2 is therefore disabled by default for the drive backend
-but can be re-enabled here.  When the issue is solved this flag will
-be removed.
-
-See: https://github.com/rclone/rclone/issues/3631
-
-
-
-- Config:      disable_http2
-- Env Var:     RCLONE_DRIVE_DISABLE_HTTP2
-- Type:        bool
-- Default:     true
-
-#### --drive-stop-on-upload-limit
-
-Make upload limit errors be fatal
-
-At the time of writing it is only possible to upload 750GB of data to
-Google Drive a day (this is an undocumented limit). When this limit is
-reached Google Drive produces a slightly different error message. When
-this flag is set it causes these errors to be fatal.  These will stop
-the in-progress sync.
-
-Note that this detection is relying on error message strings which
-Google don't document so it may break in the future.
-
-See: https://github.com/rclone/rclone/issues/3857
-
-
-- Config:      stop_on_upload_limit
-- Env Var:     RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT
-- Type:        bool
-- Default:     false
-
-#### --drive-skip-shortcuts
-
-If set skip shortcut files
-
-Normally rclone dereferences shortcut files making them appear as if
-they are the original file (see [the shortcuts section](#shortcuts)).
-If this flag is set then rclone will ignore shortcut files completely.
-
-
-- Config:      skip_shortcuts
-- Env Var:     RCLONE_DRIVE_SKIP_SHORTCUTS
-- Type:        bool
-- Default:     false
-
-#### --drive-encoding
-
-This sets the encoding for the backend.
-
-See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info.
-
-- Config:      encoding
-- Env Var:     RCLONE_DRIVE_ENCODING
-- Type:        MultiEncoder
-- Default:     InvalidUtf8
-
-### Backend commands
-
-Here are the commands specific to the drive backend.
-
-Run them with
-
-    rclone backend COMMAND remote:
-
-The help below will explain what arguments each command takes.
-
-See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more
-info on how to pass options and arguments.
-
-These can be run on a running backend using the rc command
-[backend/command](https://rclone.org/rc/#backend/command).
-
-#### get
-
-Get command for fetching the drive config parameters
-
-    rclone backend get remote: [options] [<arguments>+]
-
-This is a get command which will be used to fetch the various drive config parameters
-
-Usage Examples:
-
-    rclone backend get drive: [-o service_account_file] [-o chunk_size]
-    rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]
-
-
-Options:
-
-- "chunk_size": show the current upload chunk size
-- "service_account_file": show the current service account file
-
-#### set
-
-Set command for updating the drive config parameters
-
-    rclone backend set remote: [options] [<arguments>+]
-
-This is a set command which will be used to update the various drive config parameters
-
-Usage Examples:
-
-    rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
-    rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]
-
-
-Options:
-
-- "chunk_size": update the current upload chunk size
-- "service_account_file": update the current service account file
-
-#### shortcut
-
-Create shortcuts from files or directories
-
-    rclone backend shortcut remote: [options] [<arguments>+]
-
-This command creates shortcuts from files or directories.
-
-Usage:
-
-    rclone backend shortcut drive: source_item destination_shortcut
-    rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut
-
-In the first example this creates a shortcut from the "source_item"
-which can be a file or a directory to the "destination_shortcut". The
-"source_item" and the "destination_shortcut" should be relative paths
-from "drive:"
-
-In the second example this creates a shortcut from the "source_item"
-relative to "drive:" to the "destination_shortcut" relative to
-"drive2:". This may fail with a permission error if the user
-authenticated with "drive2:" can't read files from "drive:".
-
-
-Options:
-
-- "target": optional target remote for the shortcut destination
-
-#### drives
-
-List the shared drives available to this account
-
-    rclone backend drives remote: [options] [<arguments>+]
-
-This command lists the shared drives (teamdrives) available to this
-account.
-
-Usage:
-
-    rclone backend drives drive:
-
-This will return a JSON list of objects like this
-
-    [
-        {
-            "id": "0ABCDEF-01234567890",
-            "kind": "drive#teamDrive",
-            "name": "My Drive"
-        },
-        {
-            "id": "0ABCDEFabcdefghijkl",
-            "kind": "drive#teamDrive",
-            "name": "Test Drive"
-        }
-    ]
-
-
-
-#### untrash
-
-Untrash files and directories
-
-    rclone backend untrash remote: [options] [<arguments>+]
-
-This command untrashes all the files and directories in the directory
-passed in recursively.
-
-Usage:
-
-This takes an optional directory to trash which make this easier to
-use via the API.
-
-    rclone backend untrash drive:directory
-    rclone backend -i untrash drive:directory subdir
-
-Use the -i flag to see what would be restored before restoring it.
-
-Result:
-
-    {
-        "Untrashed": 17,
-        "Errors": 0
-    }
-
-
-
-
-### Limitations ###
-
-Drive has quite a lot of rate limiting.  This causes rclone to be
-limited to transferring about 2 files per second only.  Individual
-files may be transferred much faster at 100s of MBytes/s but lots of
-small files can take a long time.
-
-Server side copies are also subject to a separate rate limit. If you
-see User rate limit exceeded errors, wait at least 24 hours and retry.
-You can disable server side copies with `--disable copy` to download
-and upload the files if you prefer.
-
-#### Limitations of Google Docs ####
-
-Google docs will appear as size -1 in `rclone ls` and as size 0 in
-anything which uses the VFS layer, eg `rclone mount`, `rclone serve`.
-
-This is because rclone can't find out the size of the Google docs
-without downloading them.
-
-Google docs will transfer correctly with `rclone sync`, `rclone copy`
-etc as rclone knows to ignore the size when doing the transfer.
-
-However an unfortunate consequence of this is that you may not be able
-to download Google docs using `rclone mount`. If it doesn't work you
-will get a 0 sized file.  If you try again the doc may gain its
-correct size and be downloadable. Whether it will work on not depends
-on the application accessing the mount and the OS you are running -
-experiment to find out if it does work for you!
-
-### Duplicated files ###
-
-Sometimes, for no reason I've been able to track down, drive will
-duplicate a file that rclone uploads.  Drive unlike all the other
-remotes can have duplicated files.
-
-Duplicated files cause problems with the syncing and you will see
-messages in the log about duplicates.
-
-Use `rclone dedupe` to fix duplicated files.
-
-Note that this isn't just a problem with rclone, even Google Photos on
-Android duplicates files on drive sometimes.
-
-### Rclone appears to be re-copying files it shouldn't ###
-
-The most likely cause of this is the duplicated file issue above - run
-`rclone dedupe` and check your logs for duplicate object or directory
-messages.
-
-This can also be caused by a delay/caching on google drive's end when
-comparing directory listings. Specifically with team drives used in
-combination with --fast-list. Files that were uploaded recently may
-not appear on the directory list sent to rclone when using --fast-list.
-
-Waiting a moderate period of time between attempts (estimated to be
-approximately 1 hour) and/or not using --fast-list both seem to be
-effective in preventing the problem.
-
-### Making your own client_id ###
-
-When you use rclone with Google drive in its default configuration you
-are using rclone's client_id.  This is shared between all the rclone
-users.  There is a global rate limit on the number of queries per
-second that each client_id can do set by Google.  rclone already has a
-high quota and I will continue to make sure it is high enough by
-contacting Google.
-
-It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower.
-
-Here is how to create your own Google Drive client ID for rclone:
-
-1. Log into the [Google API
-Console](https://console.developers.google.com/) with your Google
-account. It doesn't matter what Google account you use. (It need not
-be the same account as the Google Drive you want to access)
-
-2. Select a project or create a new project.
-
-3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the
-"Google Drive API".
-
-4. Click "Credentials" in the left-side panel (not "Create
-credentials", which opens the wizard), then "Create credentials"
-
-5. If you already configured an "Oauth Consent Screen", then skip
-to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button 
-(near the top right corner of the right panel), then select "External"
-and click on "CREATE"; on the next screen, enter an "Application name"
-("rclone" is OK) then click on "Save" (all other data is optional). 
-Click again on "Credentials" on the left panel to go back to the 
-"Credentials" screen.
-
-(PS: if you are a GSuite user, you could also select "Internal" instead
-of "External" above, but this has not been tested/documented so far). 
-
-6.  Click on the "+ CREATE CREDENTIALS" button at the top of the screen,
-then select "OAuth client ID".
-
-7. Choose an application type of "Desktop app" if you using a Google account or "Other" if 
-you using a GSuite account and click "Create". (the default name is fine)
-
-8. It will show you a client ID and client secret.  Use these values
-in rclone config to add a new remote or edit an existing remote.
-
-Be aware that, due to the "enhanced security" recently introduced by
-Google, you are theoretically expected to "submit your app for verification"
-and then wait a few weeks(!) for their response; in practice, you can go right
-ahead and use the client ID and client secret with rclone, the only issue will
-be a very scary confirmation screen shown when you connect via your browser 
-for rclone to be able to get its token-id (but as this only happens during 
-the remote configuration, it's not such a big deal). 
-
-(Thanks to @balazer on github for these instructions.)
-
-Sometimes, creation of an OAuth consent in Google API Console fails due to an error message
-“The request failed because changes to one of the field of the resource is not supported”.
-As a convenient workaround, the necessary Google Drive API key can be created on the
-[Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page.
-Just push the Enable the Drive API button to receive the Client ID and Secret.
-Note that it will automatically create a new project in the API Console.
-
- Google Photos
--------------------------------------------------
-
-The rclone backend for [Google Photos](https://www.google.com/photos/about/) is
-a specialized backend for transferring photos and videos to and from
-Google Photos.
-
-**NB** The Google Photos API which rclone uses has quite a few
-limitations, so please read the [limitations section](#limitations)
-carefully to make sure it is suitable for your use.
-
-## Configuring Google Photos
-
-The initial setup for google cloud storage involves getting a token from Google Photos
-which you need to do in your browser.  `rclone config` walks you
-through it.
-
-Here is an example of how to make a remote called `remote`.  First run:
-
-     rclone config
-
-This will guide you through an interactive setup process:
-
    
-
    No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n name> remote Type of storage to configure. Enter a string value. Press Enter for the default (""). Choose a number from below, or type in your own value [snip] XX / Google Photos  "google photos" [snip] Storage> google photos ** See help for google photos backend at: https://rclone.org/googlephotos/ **
    
-
    Google Application Client Id Leave blank normally. Enter a string value. Press Enter for the default (""). client_id> Google Application Client Secret Leave blank normally. Enter a string value. Press Enter for the default (""). client_secret> Set to make the Google Photos backend read only.
    
-
    If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. Enter a boolean value (true or false). Press Enter for the default ("false"). read_only> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config Use auto config? * Say Y if not sure * Say N if you are working on a remote or headless machine y) Yes n) No y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code
    
-
    *** IMPORTANT: All media items uploaded to Google Photos with rclone *** are stored in full resolution at original quality. These uploads *** will count towards storage in your Google Account.
    
-
---
+Enter a string value. Press Enter for the default ("").
+Choose a number from below, or type in your own value
+ 1 / Access the Personal Folders. (Default)
+   \ ""
+ 2 / Access the Favorites folder.
+   \ "favorites"
+ 3 / Access all the shared folders.
+   \ "allshared"
+ 4 / Access all the individual connectors.
+   \ "connectors"
+ 5 / Access the home, favorites, and shared folders as well as the connectors.
+   \ "top"
+root_folder_id> 
+Edit advanced config? (y/n)
+y) Yes
+n) No
+y/n> n
+Remote config
+Use auto config?
+ * Say Y if not sure
+ * Say N if you are working on a remote or headless machine
+y) Yes
+n) No
+y/n> y
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+--------------------
+[remote]
+type = sharefile
+endpoint = https://XXX.sharefile.com
+token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"}
+--------------------
+y) Yes this is OK
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+
    See the remote setup docs for how to set it up on a machine with no Internet browser available.
    
+
    Note that rclone runs a webserver on your local machine to collect the token as returned from Citrix ShareFile. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this it may require you to unblock it temporarily if you are running a host firewall.
    
+
    Once configured you can then use rclone like this,
    
+
    List directories in top level of your ShareFile
    
+
    rclone lsd remote:
    
+
    List all the files in your ShareFile
    
+
    rclone ls remote:
    
+
    To copy a local directory to an ShareFile directory called backup
    
+
    rclone copy /home/source remote:backup
    
+
    Paths may be as deep as required, e.g. remote:directory/subdirectory.
    
+
    Modified time and hashes
    
+
    ShareFile allows modification times to be set on objects accurate to 1 second. These will be used to detect whether objects need syncing or not.
    
+
    ShareFile supports MD5 type hashes, so you can use the --checksum flag.
    
+
    Transfers
    
+
    For files above 128MB rclone will use a chunked transfer. Rclone will upload up to --transfers chunks at the same time (shared among all the multipart uploads). Chunks are buffered in memory and are normally 64MB so increasing --transfers will increase memory use.
    
+
    Limitations
    
+
    Note that ShareFile is case insensitive so you can't have a file called "Hello.doc" and one called "hello.doc".
    
+
    ShareFile only supports filenames up to 256 characters in length.
    
+
    Restricted filename characters
    
+
    In addition to the default restricted characters set the following characters are also replaced:
    
+
    


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




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

    Advanced Options

    +

    Advanced Options

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

    --hubic-token

    OAuth Access Token as a JSON blob.

    @@ -12663,7 +14753,7 @@ y/e/d> y

    --hubic-no-chunk

    Don't chunk files during streaming upload.

    -

    When doing streaming uploads (eg using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.

    +

    When doing streaming uploads (e.g. using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.

    This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM.

    Rclone will still chunk files bigger than chunk_size when doing normal copy operations.

    -

    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

    Jottacloud is a cloud storage service provider from a Norwegian company, using its own datacenters in Norway.

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

    Paths are specified as remote:path

    -

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

    -

    Setup

    +

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

    +

    Setup

    Default Setup

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

    Legacy Setup

    -

    If you are using one of the whitelabel versions (Elgiganten, Com Hem Cloud) you may not have the option to generate a CLI token. In this case you'll have to use the legacy authentification. To to this select yes when the setup asks for legacy authentification and enter your username and password. The rest of the setup is identical to the default setup.

    +

    If you are using one of the whitelabel versions (Elgiganten, Com Hem Cloud) you may not have the option to generate a CLI token. In this case you'll have to use the legacy authentication. To to this select yes when the setup asks for legacy authentication and enter your username and password. The rest of the setup is identical to the default setup.

    +

    Telia Cloud Setup

    +

    Similar to other whitelabel versions Telia Cloud doesn't offer the option of creating a CLI token, and additionally uses a separate authentication flow where the username is generated internally. To setup rclone to use Telia Cloud, choose Telia Cloud authentication in the setup. The rest of the setup is identical to the default setup.

    +

    Example

    Here is an example of how to make a remote called remote with the default setup. First run:

    rclone config

    This will guide you through an interactive setup process:

    @@ -12718,7 +14811,7 @@ y) Yes n) No y/n> n Remote config -Use legacy authentification?. +Use legacy authentication?. This is only required for certain whitelabel versions of Jottacloud and not recommended for normal users. y) Yes n) No (default) @@ -12766,14 +14859,14 @@ y/e/d> y

    Devices and Mountpoints

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

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

    -

    --fast-list

    +

    --fast-list

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

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

    -

    Modified time and hashes

    +

    Modified time and hashes

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

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

    -

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

    -

    Restricted filename characters

    +

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

    +

    Restricted filename characters

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

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

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

    -

    Deleting files

    +

    Deleting files

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

    -

    Versions

    +

    Versions

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

    -

    Quota information

    +

    Quota information

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

    -

    Advanced Options

    +

    Advanced Options

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

    --jottacloud-md5-memory-limit

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

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

    Limitations

    +

    Limitations

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

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

    Jottacloud only supports filenames up to 255 characters in length.

    @@ -12879,7 +14972,7 @@ y/e/d> y

    Jottacloud exhibits some inconsistent behaviours regarding deleted files and folders which may cause Copy, Move and DirMove operations to previously deleted paths to fail. Emptying the trash should help in such cases.

    Koofr

    Paths are specified as remote:path

    -

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

    +

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

    The initial setup for Koofr involves creating an application password for rclone. You can do that by opening the Koofr web application, giving the password a nice name like rclone and clicking on generate.

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

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

    To copy a local directory to an Koofr directory called backup

    rclone copy /home/source remote:backup
    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

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

    -

    Standard Options

    +

    Standard Options

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

    --koofr-user

    Your Koofr user name

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

    Advanced Options

    +

    Advanced Options

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

    --koofr-endpoint

    The Koofr API endpoint to use

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

    Limitations

    +

    Limitations

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

    Mail.ru Cloud

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

    Currently it is recommended to disable 2FA on Mail.ru accounts intended for rclone until it gets eventually implemented.

    Features highlights

    -

    Configuration

    +

    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:

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

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

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

    Modified time

    +

    Modified time

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

    Hash checksums

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

    -

    Emptying Trash

    +

    Emptying Trash

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

    -

    Quota information

    +

    Quota information

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

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

    -

    Limitations

    +

    Limitations

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

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

    -

    Standard Options

    +

    Standard Options

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

    --mailru-user

    User name (usually email)

    @@ -13175,7 +15268,7 @@ y/e/d> y
  • 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.

    +

    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. It is meaningless and ineffective if source file is unique or encrypted. 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

    +

    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.

    @@ -13296,7 +15389,7 @@ y/e/d> y
  • 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

    +

    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 unknowndirs

    -

    Advanced Options

    +

    Advanced Options

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

    --mega-debug

    Output more debug from Mega.

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

    Limitations

    +

    Limitations

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

    Mega allows duplicate files which may confuse rclone.

    Memory

    The memory backend is an in RAM backend. It does not persist its data - use the local backend for that.

    -

    The memory backend behaves like a bucket based remote (eg like s3). Because it has no parameters you can just use it with the :memory: remote name.

    +

    The memory backend behaves like a bucket based remote (e.g. like s3). Because it has no parameters you can just use it with the :memory: remote name.

    You can configure it as a remote like this with rclone config too if you want to:

    No remotes found - make a new one
 n) New remote
@@ -13484,16 +15577,16 @@ y) Yes this is OK (default)
 e) Edit this remote
 d) Delete this remote
 y/e/d> y
    -

    Because the memory backend isn't persistent it is most useful for testing or with an rclone server or rclone mount, eg

    +

    Because the memory backend isn't persistent it is most useful for testing or with an rclone server or rclone mount, e.g.

    rclone mount :memory: /mnt/tmp
 rclone serve webdav :memory:
 rclone serve sftp :memory:
    -

    Modified time and hashes

    +

    Modified time and hashes

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

    -

    Restricted filename characters

    +

    Restricted filename characters

    The memory backend replaces the default restricted characters set.

    Microsoft Azure Blob Storage

    -

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

    +

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

    Here is an example of making a Microsoft Azure Blob Storage configuration. For a remote called remote. First run:

     rclone config

    This will guide you through an interactive setup process:

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

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

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

    --fast-list

    +

    --fast-list

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

    -

    Modified time

    +

    Modified time

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

    @@ -13580,8 +15673,8 @@ y/e/d> y

    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.

    +

    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, e.g. the local disk.

    Authenticating with Azure Blob Storage

    Rclone has 3 ways of authenticating with Azure Blob Storage:

    Account and Key

    @@ -13590,7 +15683,7 @@ y/e/d> y

    This can be an account level SAS URL or container level SAS URL.

    To use it leave account, key blank and fill in sas_url.

    An account level SAS URL or container level SAS URL can be obtained from the Azure portal or the Azure Storage Explorer. To get a container level SAS URL right click on a container in the Azure Blob explorer in the Azure portal.

    -

    If you use a container level SAS URL, rclone operations are permitted only on a particular container, eg

    +

    If you use a container level SAS URL, rclone operations are permitted only on a particular container, e.g.

    rclone ls azureblob:container

    You can also list the single container from the root. This will only show the container specified by the SAS URL.

    $ rclone lsd azureblob:
@@ -13598,12 +15691,7 @@ container/

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

    rclone ls azureblob:othercontainer

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

    -

    Multipart uploads

    -

    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)

    @@ -13613,6 +15701,20 @@ container/
  • Type: string
  • Default: ""
    • +

    --azureblob-service-principal-file

    +

    Path to file containing credentials for use with a service principal.

    +

    Leave blank normally. Needed only if you want to use a service principal instead of interactive login.

    +
    $ az sp create-for-rbac --name "<name>" \
+  --role "Storage Blob Data Owner" \
+  --scopes "/subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account>/blobServices/default/containers/<container>" \
+  > azure-principal.json
    +

    See Use Azure CLI to assign an Azure role for access to blob and queue data for more details.

    +

    --azureblob-key

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

    +

    --azureblob-use-msi

    +

    Use a managed service identity to authenticate (only works in Azure)

    +

    When true, use a managed service identity to authenticate to Azure Storage instead of a SAS token or account key.

    +

    If the VM(SS) on which this program is running has a system-assigned identity, it will be used by default. If the resource has no system-assigned but exactly one user-assigned identity, the user-assigned identity will be used by default. If the resource has multiple user-assigned identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, msi_client_id, or msi_mi_res_id parameters.

    +

    --azureblob-use-emulator

    Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint)

    -

    Advanced Options

    +

    Advanced Options

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

    +

    --azureblob-msi-object-id

    +

    Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified.

    + +

    --azureblob-msi-client-id

    +

    Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified.

    + +

    --azureblob-msi-mi-res-id

    +

    Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified.

    +

    --azureblob-endpoint

    Endpoint for the service Leave blank normally.

    --azureblob-upload-cutoff

    -

    Cutoff for switching to chunked upload (<= 256MB).

    +

    Cutoff for switching to chunked upload (<= 256MB). (Deprecated)

    --azureblob-chunk-size

    Upload chunk size (<= 100MB).

    @@ -13683,6 +15819,17 @@ container/
  • Type: string
  • Default: ""
    • +

    --azureblob-archive-tier-delete

    +

    Delete archive tier blobs before overwriting.

    +

    Archive tier blobs cannot be updated. So without this flag, if you attempt to update an archive tier blob, then rclone will produce the error:

    +
    can't update archive tier blob without --azureblob-archive-tier-delete
    +

    With this flag set then before rclone attempts to overwrite an archive tier blob, it will delete the existing blob before uploading its replacement. This has the potential for data loss if the upload fails (unlike updating a normal blob) and also may cost more since deleting archive tier blobs early may be chargable.

    +

    --azureblob-disable-checksum

    Don't store MD5 checksum with object metadata.

    Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.

    @@ -13717,13 +15864,15 @@ container/
  • Type: MultiEncoder
  • Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8
    • -

    Limitations

    +

    Limitations

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

    +

    rclone about is not supported by the Microsoft Azure Blob storage backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

    +

    See List of backends that do not support rclone about See rclone about

    Azure Storage Emulator Support

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

    Microsoft OneDrive

    Paths are specified as remote:path

    -

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

    +

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

    The initial setup for OneDrive involves getting a token from Microsoft 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
    @@ -13813,7 +15962,7 @@ y/e/d> y

    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://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade and then click New registration.
      2. -
    2. Enter a name for your app, choose account type Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox), 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. +
    3. Enter a name for your app, choose account type Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox), select Web in Redirect URI, then type (do not copy and paste) http://localhost:53682/ and click Register. Copy and keep the Application (client) ID under the app name for later use.
    4. Under manage select Certificates & secrets, click New client secret. Copy and keep that secret for later use.
    5. Under manage select API permissions, click Add a permission and select Microsoft Graph then select delegated permissions.
    6. Search and select the following permissions: Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, offline_access, User.Read. Once selected click Add permissions at the bottom.
      7. @@ -13823,7 +15972,7 @@ y/e/d> y

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

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

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

      -

      Restricted filename characters

      +

      Restricted filename characters

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

      @@ -13874,16 +16023,6 @@ y/e/d> y - - - - - - - - - -
      0x7C ｜
      #0x23＃
      %0x25％

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

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

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

      -

      Deleting files

      +

      Deleting files

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

      -

      Standard Options

      +

      Standard Options

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

      --onedrive-client-id

      OAuth Client Id Leave blank normally.

      @@ -13951,7 +16090,34 @@ y/e/d> y
    7. Type: string
    8. Default: ""
      9. -

      Advanced Options

      +

      --onedrive-region

      +

      Choose national cloud region for OneDrive.

      + +

      Advanced Options

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

      --onedrive-token

      OAuth Access Token as a JSON blob.

      @@ -14012,8 +16178,8 @@ y/e/d> y
    9. Default: false

      10. --onedrive-server-side-across-configs

      -

      Allow server side operations (eg copy) to work across different onedrive configs.

      -

      This can be useful if you wish to do a server side copy between two different Onedrives. Note that this isn't enabled by default because it isn't easy to tell if it will work between any two configurations.

      +

      Allow server-side operations (e.g. copy) to work across different onedrive configs.

      +

      This will only work if you are copying between two OneDrive Personal drives AND the files to copy are already shared between them. In other cases, rclone will fall back to normal copy (which will be slightly slower).

      + +

      Set the scope of the links created by the link command.

      + + +

      Set the type of the links created by the link command.

      + + +

      Set the password for links created by the link command.

      +

      At the time of writing this only works with OneDrive personal paid accounts.

      +

      --onedrive-encoding

      This sets the encoding for the backend.

      See: the encoding section in the overview for more info.

      @@ -14039,21 +16256,21 @@ y/e/d> y
    10. Config: encoding
    11. Env Var: RCLONE_ONEDRIVE_ENCODING
    12. Type: MultiEncoder
      13. -
    13. Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
      14. +
    14. Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot
      15. -

      Limitations

      +

      Limitations

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

      Naming

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

      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 size is 100GB for both OneDrive Personal and OneDrive for Business (Updated 17 June 2020).

      +

      The largest allowed file size is 250GB for both OneDrive Personal and OneDrive for Business (Updated 13 Jan 2021).

      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.

      -

      Versions

      +

      Versions

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

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

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

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

    Cleanup

    +

    Cleanup

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

    rclone cleanup -i remote:path/subdir # interactively remove all old version for path/subdir
 rclone cleanup remote:path/subdir    # unconditionally remove all old version for path/subdir
    @@ -14107,7 +16324,7 @@ Description: Due to a configuration change made by your administrator, or becaus

    If you see the error above after enabling multi-factor authentication for your account, you can fix it by refreshing your OAuth refresh token. To do that, run rclone config, and choose to edit your OneDrive backend. Then, you don't need to actually make any changes until you reach this question: Already have a token - refresh?. For this question, answer y and go through the process to refresh your token, just like the first time the backend is configured. After this, rclone should work again for this backend.

    OpenDrive

    Paths are specified as remote:path

    -

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

    +

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

    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:

    @@ -14148,9 +16365,9 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an OpenDrive directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and MD5SUMs

    +

    Modified time and MD5SUMs

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

    -

    Standard Options

    +

    Standard Options

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

    --opendrive-username

    Username

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

    Advanced Options

    +

    Advanced Options

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

    --opendrive-encoding

    This sets the encoding for the backend.

    @@ -14289,11 +16506,13 @@ y/e/d> y
  • Type: SizeSuffix
  • Default: 10M
    • -

    Limitations

    +

    Limitations

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

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

    +

    rclone about is not supported by the OpenDrive backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

    +

    See List of backends that do not support rclone about See rclone about

    QingStor

    -

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

    +

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

    Here is an example of making an QingStor configuration. First run

    rclone config

    This will guide you through an interactive setup process.

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

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

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

    --fast-list

    +

    --fast-list

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

    Multipart uploads

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

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

    Buckets and Zone

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

    -

    Authentication

    +

    Authentication

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

    -

    Standard Options

    +

    Standard Options

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

    --qingstor-env-auth

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

    @@ -14459,7 +16678,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.

    @@ -14482,7 +16701,7 @@ y/e/d> y

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

    +

    If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers.

    -

    Advanced Options

    +

    Advanced Options

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

    +

    --swift-leave-parts-on-error

    +

    If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions.

    +

    --swift-chunk-size

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

    Above this size files will be chunked into a _segments container. The default for this is 5GB which is its maximum value.

    @@ -14883,7 +17113,7 @@ rclone lsd myremote:

    --swift-no-chunk

    Don't chunk files during streaming upload.

    -

    When doing streaming uploads (eg using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.

    +

    When doing streaming uploads (e.g. using rcat or mount) setting this flag will cause the swift backend to not upload chunked files.

    This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM.

    Rclone will still chunk files bigger than chunk_size when doing normal copy operations.

    -

    Modified time

    +

    Modified time

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

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

    -

    Restricted filename characters

    +

    Restricted filename characters

    @@ -14927,18 +17157,18 @@ rclone lsd myremote:

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

    -

    Limitations

    +

    Limitations

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

    Troubleshooting

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

    Due to an oddity of the underlying swift library, it gives a "Bad Request" error rather than a more sensible error when the authentication fails for Swift.

    So this most likely means your username / password is wrong. You can investigate further with the --dump-bodies flag.

    -

    This may also be caused by specifying the region when you shouldn't have (eg OVH).

    +

    This may also be caused by specifying the region when you shouldn't have (e.g. OVH).

    Rclone gives Failed to create file system: Response didn't have storage url and auth token

    This is most likely caused by forgetting to specify your tenant when setting up a swift remote.

    pCloud

    Paths are specified as remote:path

    -

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

    +

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

    The initial setup for pCloud involves getting a token from pCloud 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
    @@ -14990,10 +17220,11 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an pCloud directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

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

    -

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

    -

    Restricted filename characters

    +

    pCloud supports MD5 and SHA1 type hashes in the US region but and SHA1 only in the EU region, so you can use the --checksum flag.

    +

    (Note that pCloud also support SHA256 in the EU region, but rclone does not have support for that yet.)

    +

    Restricted filename characters

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

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

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

    -

    Deleting files

    +

    Deleting files

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

    -

    Root folder ID

    +

    Root folder ID

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

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

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

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

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

    -

    Standard Options

    +

    Standard Options

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

    --pcloud-client-id

    OAuth Client Id Leave blank normally.

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

    Advanced Options

    +

    Advanced Options

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

    --pcloud-token

    OAuth Access Token as a JSON blob.

    @@ -15103,7 +17334,7 @@ y/e/d> y

    premiumize.me

    Paths are specified as remote:path

    -

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

    +

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

    The initial setup for premiumize.me involves getting a token from premiumize.me 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
    @@ -15153,9 +17384,9 @@ y/e/d> 
    rclone ls remote:

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

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

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

    -

    Standard Options

    +

    Standard Options

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

    --premiumizeme-api-key

    API Key.

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

    Advanced Options

    +

    Advanced Options

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

    --premiumizeme-encoding

    This sets the encoding for the backend.

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

    Limitations

    +

    Limitations

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

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

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

    put.io

    Paths are specified as remote:path

    -

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

    +

    put.io paths may be as deep as required, e.g. remote:directory/subdirectory.

    The initial setup for put.io involves getting a token from put.io 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
    @@ -15270,7 +17501,7 @@ e/n/d/r/c/s/q> q 
    rclone ls remote:

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

    rclone copy /home/source remote:backup
    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

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

    -

    Advanced Options

    +

    Advanced Options

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

    --putio-encoding

    This sets the encoding for the backend.

    @@ -15303,7 +17534,7 @@ e/n/d/r/c/s/q> q

    Seafile

    This is a backend for the Seafile storage service: - It works with both the free community edition or the professional edition. - Seafile versions 6.x and 7.x are all supported. - Encrypted libraries are also supported. - It supports 2FA enabled users

    Root mode vs Library mode

    -

    There are two distinct modes you can setup your remote: - you point your remote to the root of the server, meaning you don't specify a library during the configuration: Paths are specified as remote:library. You may put subdirectories in too, eg remote:library/path/to/dir. - you point your remote to a specific library during the configuration: Paths are specified as remote:path/to/dir. This is the recommended mode when using encrypted libraries. (This mode is possibly slightly faster than the root mode)

    +

    There are two distinct modes you can setup your remote: - you point your remote to the root of the server, meaning you don't specify a library during the configuration: Paths are specified as remote:library. You may put subdirectories in too, e.g. remote:library/path/to/dir. - you point your remote to a specific library during the configuration: Paths are specified as remote:path/to/dir. This is the recommended mode when using encrypted libraries. (This mode is possibly slightly faster than the root mode)

    Configuration in root mode

    Here is an example of making a seafile configuration for a user with no two-factor authentication. First run

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

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

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

    --fast-list

    +

    --fast-list

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

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

    Compatibility

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

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

    -

    Standard Options

    +

    Standard Options

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

    --seafile-url

    URL of seafile host to connect to

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

    Advanced Options

    +

    Advanced Options

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

    --seafile-create-library

    Should rclone create a library if it doesn't exist

    @@ -15619,7 +17850,7 @@ Choose a number from below, or type in your own value 1 / Connect to example.com \ "example.com" host> example.com -SSH username, leave blank for current username, ncw +SSH username, leave blank for current username, $USER user> sftpuser SSH port, leave blank to use default (22) port> @@ -15656,7 +17887,7 @@ y/e/d> y

    The SFTP remote supports three authentication methods:

    Key files should be PEM-encoded private key files. For instance /home/$USER/.ssh/id_rsa. Only unencrypted OpenSSH or PEM encrypted files are supported.

    @@ -15668,17 +17899,51 @@ y/e/d> y

    You can also specify key_use_agent to force the usage of an ssh-agent. In this case key_file or key_pem can also be specified to force the usage of a specific key in the ssh-agent.

    Using an ssh-agent is the only way to load encrypted OpenSSH keys at the moment.

    If you set the --sftp-ask-password option, rclone will prompt for a password when needed and no password has been configured.

    +

    If you have a certificate then you can provide the path to the public key that contains the certificate. For example:

    +
    [remote]
+type = sftp
+host = example.com
+user = sftpuser
+key_file = ~/id_rsa
+pubkey_file = ~/id_rsa-cert.pub
    +

    If you concatenate a cert with a private key then you can specify the merged file in both places.

    +

    Note: the cert must come first in the file. e.g.

    +
    cat id_rsa-cert.pub id_rsa > merged_key
    +

    Host key validation

    +

    By default rclone will not check the server's host key for validation. This can allow an attacker to replace a server with their own and if you use password authentication then this can lead to that password being exposed.

    +

    Host key matching, using standard known_hosts files can be turned on by enabling the known_hosts_file option. This can point to the file maintained by OpenSSH or can point to a unique file.

    +

    e.g.

    +
    [remote]
+type = sftp
+host = example.com
+user = sftpuser
+pass = 
+known_hosts_file = ~/.ssh/known_hosts
    +

    There are some limitations:

    + +

    If the host key provided by the server does not match the one in the file (or is missing) then the connection will be aborted and an error returned such as

    +
    NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key mismatch
    +

    or

    +
    NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key is unknown
    +

    If you see an error such as

    +
    NewFs: couldn't connect SSH: ssh: handshake failed: ssh: no authorities for hostname: example.com:22
    +

    then it is likely the server has presented a CA signed host certificate and you will need to add the appropriate @cert-authority entry.

    +

    The known_hosts_file setting can be set during rclone config as an advanced option.

    ssh-agent on macOS

    -

    Note that there seem to be various problems with using an ssh-agent on macOS due to recent changes in the OS. The most effective work-around seems to be to start an ssh-agent in each session, eg

    +

    Note that there seem to be various problems with using an ssh-agent on macOS due to recent changes in the OS. The most effective work-around seems to be to start an ssh-agent in each session, e.g.

    eval `ssh-agent -s` && ssh-add -A

    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

    @@ -15696,7 +17961,7 @@ y/e/d> y

    --sftp-user

    -

    SSH username, leave blank for current username, ncw

    +

    SSH username, leave blank for current username, $USER

    +

    --sftp-pubkey-file

    +

    Optional path to public key file.

    +

    Set this if you have a signed certificate you want to use for authentication.

    +

    Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.

    +

    --sftp-key-use-agent

    When set forces the usage of the ssh-agent.

    When key-file is also set, the ".pub" file of the specified key-file is read and only the associated key is requested from the ssh-agent. This allows to avoid Too many authentication failures for *username* errors when the ssh-agent contains many keys.

    @@ -15793,8 +18068,25 @@ y/e/d> y
  • Type: bool
  • Default: false
    • -

    Advanced Options

    +

    Advanced Options

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

    +

    --sftp-known-hosts-file

    +

    Optional path to known_hosts file.

    +

    Set this value to enable server host key validation.

    +

    Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.

    +

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

    @@ -15866,10 +18158,20 @@ y/e/d> y
  • Type: string
  • Default: ""
    • -

    Limitations

    +

    --sftp-use-fstat

    +

    If set use fstat instead of stat

    +

    Some servers limit the amount of open files and calling Stat after opening the file will throw an error from the server. Setting this flag will call Fstat instead of Stat which is called on an already open file handle.

    +

    It has been found that this helps with IBM Sterling SFTP servers which have "extractability" level set to 1 which means only 1 file can be opened at any given time.

    + +

    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.

    +

    Note that some SFTP servers (e.g. 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.

    The only ssh agent supported under Windows is Putty's pageant.

    The Go SSH library disables the use of the aes128-cbc cipher by default, due to security concerns. This can be re-enabled on a per-connection basis by setting the use_insecure_cipher setting in the configuration file to true. Further details on the insecurity of this cipher can be found [in this paper] (http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf).

    SFTP isn't supported under plan9 until this issue is fixed.

    @@ -15945,17 +18247,17 @@ y/e/d> y

    To copy a local directory to an SugarSync folder called backup

    rclone copy /home/source remote:backup

    Paths are specified as remote:path

    -

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

    +

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

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

    -

    Modified time and hashes

    +

    Modified time and hashes

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

    -

    Restricted filename characters

    +

    Restricted filename characters

    SugarSync replaces the default restricted characters set except for DEL.

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

    -

    Deleting files

    +

    Deleting files

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

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

    -

    Standard Options

    +

    Standard Options

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

    --sugarsync-app-id

    Sugarsync App ID.

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

    Advanced Options

    +

    Advanced Options

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

    --sugarsync-refresh-token

    Sugarsync refresh token

    @@ -16057,9 +18359,12 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,Ctl,InvalidUtf8,Dot
    • +

    Limitations

    +

    rclone about is not supported by the SugarSync backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

    +

    See List of backends that do not support rclone about See rclone about

    Tardigrade

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

    -

    Setup

    +

    Setup

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

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

     rclone config
    @@ -16102,7 +18407,7 @@ y) Yes this is OK (default) e) Edit this remote d) Delete this remote y/e/d> y -

    Setup with API key and passhprase

    +

    Setup with API key and passphrase

    No remotes found - make a new one
 n) New remote
 s) Set configuration password
@@ -16157,7 +18462,7 @@ e) Edit this remote
 d) Delete this remote
 y/e/d> y

    Usage

    -

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

    +

    Paths are specified as remote:bucket (or remote: for the lsf command.) You may put subdirectories in too, e.g. remote:bucket/path/to/dir.

    Once configured you can then use rclone like this.

    Create a new bucket

    Use the mkdir command to create new bucket, e.g. bucket.

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

    Or even between another cloud storage and Tardigrade.

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

    Standard Options

    +

    Standard Options

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

    --tardigrade-provider

    Choose an authentication method.

    @@ -16278,13 +18583,16 @@ y/e/d> y
  • Type: string
  • Default: ""
    • +

    Limitations

    +

    rclone about is not supported by the rclone Tardigrade backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

    +

    See List of backends that do not support rclone about See rclone about

    Union

    The union remote provides a unification similar to UnionFS using other remotes.

    -

    Paths may be as deep as required or a local path, eg remote:directory/subdirectory or /directory/subdirectory.

    +

    Paths may be as deep as required or a local path, e.g. remote:directory/subdirectory or /directory/subdirectory.

    During the initial setup with rclone config you will specify the upstream remotes as a space separated list. The upstream remotes can either be a local paths or other remotes.

    -

    Attribute :ro and :nc can be attach to the end of path to tag the remote as read only or no create, eg remote:directory/subdirectory:ro or remote:directory/subdirectory:nc.

    -

    Subfolders can be used in upstream remotes. Assume a union remote named backup with the remotes mydrive:private/backup. Invoking rclone mkdir backup:desktop is exactly the same as invoking rclone mkdir mydrive2:/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 mydrive2:/backup/../desktop.

    +

    Attribute :ro and :nc can be attach to the end of path to tag the remote as read only or no create, e.g. remote:directory/subdirectory:ro or remote:directory/subdirectory:nc.

    +

    Subfolders can be used in upstream remotes. Assume a union remote named backup with the remotes 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.

    Behavior / Policies

    The behavior of union backend is inspired by trapexit/mergerfs. All functions are grouped into 3 categories: action, create and search. These functions and categories can be assigned a policy which dictates what file or directory is chosen when performing that behavior. Any policy can be assigned to a function or category though some may not be very useful in practice. For instance: rand (random) may be useful for file creation (create) but could lead to very odd behavior if used for delete if there were more than one copy of the file.

    Function / Category classifications

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

    Setup

    +

    Setup

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

     rclone config

    This will guide you through an interactive setup process:

    @@ -16462,7 +18770,7 @@ Storage> union List of space separated upstreams. Can be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc. Enter a string value. Press Enter for the default (""). -upstreams> +upstreams> remote1:dir1 remote2:dir2 remote3:dir3 Policy to choose upstream on ACTION class. Enter a string value. Press Enter for the default ("epall"). action_policy> @@ -16479,7 +18787,7 @@ Remote config -------------------- [remote] type = union -upstreams = C:\dir1 C:\dir2 C:\dir3 +upstreams = remote1:dir1 remote2:dir2 remote3:dir3 -------------------- y) Yes this is OK e) Edit this remote @@ -16500,13 +18808,13 @@ 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 C:\dir1, C:\dir2 and C:\dir3

    +

    List directories in top level in remote1:dir1, remote2:dir2 and remote3:dir3

    rclone lsd remote:
    -

    List all the files in C:\dir1, C:\dir2 and C:\dir3

    +

    List all the files in remote1:dir1, remote2:dir2 and remote3:dir3

    rclone ls remote:
    -

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

    +

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

    rclone copy C:\source remote:source
    -

    Standard Options

    +

    Standard Options

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

    --union-upstreams

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

    @@ -16550,7 +18858,7 @@ e/n/d/r/c/s/q> q

    WebDAV

    Paths are specified as remote:path

    -

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

    +

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

    To configure the WebDAV remote you will need to have a URL for it, and a username and password. If you know what kind of system you are connecting to then rclone can enable extra features.

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

     rclone config
    @@ -16595,7 +18903,7 @@ Enter the password: password: Confirm the password: password: -Bearer token instead of user/pass (eg a Macaroon) +Bearer token instead of user/pass (e.g. a Macaroon) bearer_token> Remote config -------------------- @@ -16618,10 +18926,10 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an WebDAV directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

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

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

    -

    Standard Options

    +

    Standard Options

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

    --webdav-url

    URL of http host to connect to

    @@ -16683,14 +18991,14 @@ y/e/d> y
  • Default: ""

    • --webdav-bearer-token

    -

    Bearer token instead of user/pass (eg a Macaroon)

    +

    Bearer token instead of user/pass (e.g. a Macaroon)

    -

    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

    @@ -16706,7 +19014,7 @@ y/e/d> y

    Click on the settings cog in the bottom right of the page and this will show the WebDAV URL that rclone needs in the config step. It will look something like https://example.com/remote.php/webdav/.

    Owncloud supports modified times using the X-OC-Mtime header.

    Nextcloud

    -

    This is configured in an identical way to Owncloud. Note that Nextcloud does not support streaming of files (rcat) whereas Owncloud does. This may be fixed in the future.

    +

    This is configured in an identical way to Owncloud. Note that Nextcloud initially did not support streaming of files (rcat) whereas Owncloud did, but this seems to be fixed as of 2020-11-27 (tested with rclone v1.53.1 and Nextcloud Server v19).

    Sharepoint

    Rclone can be used with Sharepoint provided by OneDrive for Business or Office365 Education Accounts. This feature is only needed for a few of these Accounts, mostly Office365 Education ones. These accounts are sometimes not verified by the domain owner github#1975

    This means that these accounts can't be added using the official API (other Accounts should work with the "onedrive" option). However, it is possible to access them using webdav.

    @@ -16809,21 +19117,21 @@ y/e/d> y 
    rclone ls remote:directory

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

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

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

    -

    Modified time

    +

    Yandex paths may be as deep as required, e.g. 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.

    -

    Emptying Trash

    +

    Emptying Trash

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

    -

    Quota information

    +

    Quota information

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

    -

    Restricted filename characters

    +

    Restricted filename characters

    The default restricted characters set are replaced.

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

    -

    Limitations

    +

    Limitations

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

    -

    Standard Options

    +

    Standard Options

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

    --yandex-client-id

    OAuth Client Id Leave blank normally.

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

    Advanced Options

    +

    Advanced Options

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

    --yandex-token

    OAuth Access Token as a JSON blob.

    @@ -16876,19 +19184,140 @@ y/e/d> y
  • Type: MultiEncoder
  • Default: Slash,Del,Ctl,InvalidUtf8,Dot
    • +

    Zoho Workdrive

    +

    Zoho WorkDrive is a cloud storage solution created by Zoho.

    +

    Here is an example of making a zoho 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
+n/s> 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 / Zoho
+   \ "zoho"
+[snip]
+Storage> zoho
+** See help for zoho backend at: https://rclone.org/zoho/ **
+
+OAuth Client Id
+Leave blank normally.
+Enter a string value. Press Enter for the default ("").
+client_id> 
+OAuth Client Secret
+Leave blank normally.
+Enter a string value. Press Enter for the default ("").
+client_secret> 
+Edit advanced config? (y/n)
+y) Yes
+n) No (default)
+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 (default)
+n) No
+y/n> 
+If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ
+Log in and authorize rclone for access
+Waiting for code...
+Got code
+Choose a number from below, or type in your own value
+ 1 / MyTeam
+   \ "4u28602177065ff22426787a6745dba8954eb"
+Enter a Team ID> 1
+Choose a number from below, or type in your own value
+ 1 / General
+   \ "4u2869d2aa6fca04f4f2f896b6539243b85b1"
+Enter a Workspace ID> 1
+--------------------
+[remote]
+type = zoho
+token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"Zoho-oauthtoken","refresh_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","expiry":"2020-10-12T00:54:52.370275223+02:00"}
+root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+--------------------
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d>
    +

    See the remote setup docs for how to set it up on a machine with no Internet browser available.

    +

    Note that rclone runs a webserver on your local machine to collect the token as returned from Zoho Workdrive. 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,

    +

    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 -i /home/local/directory remote:directory
    +

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

    +

    Modified time

    +

    Modified times are currently not supported for Zoho Workdrive

    +

    Checksums

    +

    No checksums are supported.

    +

    Usage information

    +

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

    +

    Restricted filename characters

    +

    Only control characters and invalid UTF-8 are replaced. In addition most Unicode full-width characters are not supported at all and will be removed from filenames during upload.

    +

    Standard Options

    +

    Here are the standard options specific to zoho (Zoho).

    +

    --zoho-region

    +

    Zoho region to connect to. You'll have to use the region you organization is registered in.

    + +

    Advanced Options

    +

    Here are the advanced options specific to zoho (Zoho).

    +

    --zoho-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    +

    Local Filesystem

    -

    Local paths are specified as normal filesystem paths, eg /path/to/wherever, so

    +

    Local paths are specified as normal filesystem paths, e.g. /path/to/wherever, so

    rclone sync -i /home/source /tmp/destination

    Will sync /home/source to /tmp/destination

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

    -

    Modified time

    +

    Modified time

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

    Filenames

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

    -

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

    -

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

    +

    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 (e.g. latin1) then you can use the convmv tool to convert the filesystem to UTF-8. This tool is available in most distributions' package managers.

    +

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

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

    Restricted characters

    +

    Restricted characters

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

    @@ -17245,8 +19674,8 @@ $ tree /tmp/b 0 file1 0 file2

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

    -

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

    -

    Standard Options

    +

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

    +

    Standard Options

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

    --local-nounc

    Disable UNC (long path names) conversion on Windows

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

    Advanced Options

    +

    Advanced Options

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

    --copy-links / -L

    Follow symlinks and copy the pointed to item.

    @@ -17289,6 +19718,17 @@ $ tree /tmp/b
  • Type: bool
  • Default: false
    • + +

    Assume the Stat size of links is zero (and read them instead)

    +

    On some virtual filesystems (such ash LucidLink), reading a link size via a Stat call always returns 0. However, on unix it reads as the length of the text in the link. This may cause errors like this when syncing:

    +
    Failed to copy: corrupted on transfer: sizes differ 0 vs 13
    +

    Setting this flag causes rclone to read the link and use that as the size of the link instead of 0 which in most cases fixes the problem.

    +

    --local-no-unicode-normalization

    Don't apply unicode normalization to paths and filenames (Deprecated)

    This flag is deprecated now. Rclone no longer normalizes unicode file names, but it compares them with unicode normalization in the sync routine instead.

    @@ -17301,8 +19741,8 @@ $ tree /tmp/b

    --local-no-check-updated

    Don't check to see if the files change during upload

    Normally rclone checks the size and modification time of files as they are being uploaded and aborts with a message which starts "can't copy - source file is being updated" if the file changes during upload.

    -

    However on some file systems this modification time check may fail (eg Glusterfs #2206) so this check can be disabled with this flag.

    -

    If this flag is set, rclone will use its best efforts to transfer a file which is being updated. If the file is only having things appended to it (eg a log) then rclone will transfer the log file with the size it had the first time rclone saw it.

    +

    However on some file systems this modification time check may fail (e.g. Glusterfs #2206) so this check can be disabled with this flag.

    +

    If this flag is set, rclone will use its best efforts to transfer a file which is being updated. If the file is only having things appended to it (e.g. a log) then rclone will transfer the log file with the size it had the first time rclone saw it.

    If the file is being modified throughout (not just appended to) then the transfer may fail with a hash check failure.

    In detail, once the file has had stat() called on it for the first time we:

    -

    Backend commands

    +

    Backend commands

    Here are the commands specific to the local backend.

    Run them with

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

    • Changelog

    +

    v1.54.0 - 2021-02-02

    +

    See commits

    + +

    v1.53.4 - 2021-01-20

    +

    See commits

    + +

    v1.53.3 - 2020-11-19

    +

    See commits

    + +

    v1.53.2 - 2020-10-26

    +

    See commits

    + +

    v1.53.1 - 2020-09-13

    +

    See commits

    +

    v1.53.0 - 2020-09-02

    See commits

  • rclone check
  • B2
  • Dropbox @@ -17573,7 +20546,7 @@ $ tree /tmp/b
  • Jottacloud
  • Onedrive @@ -17639,7 +20612,7 @@ $ tree /tmp/b
  • B2
  • Drive
  • FTP @@ -18897,13 +21870,13 @@ $ tree /tmp/b
    • -
  • Make server side copy account bytes and obey --max-transfer (Nick Craig-Wood)
    • +
  • Make server-side copy account bytes and obey --max-transfer (Nick Craig-Wood)
  • Add --create-empty-src-dirs flag and default to not creating empty dirs (ishuah)
  • Add client side TLS/SSL flags --ca-cert/--client-cert/--client-key (Nick Craig-Wood)
  • Implement --suffix-keep-extension for use with --suffix (Nick Craig-Wood)
  • build:
  • serve dlna: Add connection manager service description to improve compatibility (Dan Walters)
    • @@ -18946,11 +21919,11 @@ $ tree /tmp/b
  • Drive
  • Dropbox
  • Mount
  • Bug Fixes @@ -20691,7 +23664,7 @@ $ tree /tmp/b
  • Amazon Drive
  • B2 @@ -20837,7 +23810,7 @@ $ tree /tmp/b
  • onedrive
  • amazon cloud drive
  • OneDrive
  • S3 @@ -21164,7 +24137,7 @@ $ tree /tmp/b
  • Swift
  • OneDrive

    • v1.24 - 2015-11-07

    @@ -21265,7 +24238,7 @@ $ tree /tmp/b
  • Implement --dump-headers and --dump-bodies debug flags
  • Show multiple matched commands if abbreviation too short
    • -
  • Implement server side move where possible
    • +
  • Implement server-side move where possible
  • local

    v1.09 - 2015-02-07

    @@ -21497,7 +24470,7 @@ $ tree /tmp/b
  • Project started

    • Bugs and Limitations

    -

    Limitations

    +

    Limitations

    Directory timestamps aren't preserved

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

    Rclone struggles with millions of files in a directory/bucket

    @@ -21514,7 +24487,7 @@ $ tree /tmp/b

    Frequently Asked Questions

    Do all cloud storage systems support all rclone commands

    -

    Yes they do. All the rclone commands (eg sync, copy etc) will work on all the remote storage systems.

    +

    Yes they do. All the rclone commands (e.g. sync, copy, etc.) will work on all the remote storage systems.

    Can I copy the config from one machine to another

    Sure! Rclone stores all of its config in a single file. If you want to find this file, run rclone config file which will tell you where it is.

    See the remote setup docs for more info.

    @@ -21527,15 +24500,15 @@ $ tree /tmp/b

    Eg

    rclone sync -i drive:Folder s3:bucket

    Using rclone from multiple locations at the same time

    -

    You can use rclone from multiple places at the same time if you choose different subdirectory for the output, eg

    +

    You can use rclone from multiple places at the same time if you choose different subdirectory for the output, e.g.

    Server A> rclone sync -i /tmp/whatever remote:ServerA
 Server B> rclone sync -i /tmp/whatever remote:ServerB
    -

    If you sync to the same directory then you should use rclone copy otherwise the two instances of rclone may delete each other's files, eg

    +

    If you sync to the same directory then you should use rclone copy otherwise the two instances of rclone may delete each other's files, e.g.

    Server A> rclone copy /tmp/whatever remote:Backup
 Server B> rclone copy /tmp/whatever remote:Backup
    -

    The file names you upload from Server A and Server B should be different in this case, otherwise some file systems (eg Drive) may make duplicates.

    +

    The file names you upload from Server A and Server B should be different in this case, otherwise some file systems (e.g. Drive) may make duplicates.

    Why doesn't rclone support partial transfers / binary diffs like rsync?

    -

    Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you upload as expected using alternative access methods (eg using the Google Drive web interface). There is a 1:1 mapping between files on your hard disk and objects created in the cloud storage system.

    +

    Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you upload as expected using alternative access methods (e.g. using the Google Drive web interface). There is a 1:1 mapping between files on your hard disk and objects created in the cloud storage system.

    Cloud storage systems (at least none I've come across yet) don't support partially uploading an object. You can't take an existing object, and change some bytes in the middle of it.

    It would be possible to make a sync system which stored binary diffs instead of whole objects like rclone does, but that would break the 1:1 mapping of files on your hard disk to objects in the remote cloud storage system.

    All the cloud storage systems support partial downloads of content, so it would be possible to make partial downloads work. However to make this work efficiently this would require storing a significant amount of metadata, which breaks the desired 1:1 mapping of files to objects.

    @@ -21556,7 +24529,7 @@ export HTTPS_PROXY=$http_proxy export NO_PROXY=$no_proxy

    Note that the ftp backend does not support ftp_proxy yet.

    Rclone gives x509: failed to load system roots and no roots provided error

    -

    This means that rclone can't file the SSL root certificates. Likely you are running rclone on a NAS with a cut-down Linux OS, or possibly on Solaris.

    +

    This means that rclone can't find the SSL root certificates. Likely you are running rclone on a NAS with a cut-down Linux OS, or possibly on Solaris.

    Rclone (via the Go runtime) tries to load the root certificates from these places on Linux.

    "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu/Gentoo etc.
 "/etc/pki/tls/certs/ca-bundle.crt",   // Fedora/RHEL
@@ -21784,7 +24757,7 @@ THE SOFTWARE.
  • Andres Alvarez
  • reddi1
  • Matt Tucker
    • -
  • Sebastian Bünger
    • +
  • Sebastian Bünger
  • Martin Polden
  • Alex Chen
  • Denis
    • @@ -22009,6 +24982,53 @@ THE SOFTWARE.
  • Lucas Kanashiro
  • WarpedPixel
  • Sam Edwards
    • +
  • wjielai
    • +
  • Muffin King
    • +
  • Christopher Stewart
    • +
  • Russell Cattelan
    • +
  • gyutw
    • +
  • Hekmon
    • +
  • LaSombra
    • +
  • Dov Murik
    • +
  • Ameer Dawood
    • +
  • Dan Hipschman
    • +
  • Josh Soref
    • +
  • David
    • +
  • Ingo
    • +
  • Adam Plánský
    • +
  • Manish Gupta
    • +
  • Deepak Sah
    • +
  • Marcin Zelent
    • +
  • zhucan
    • +
  • James Lim
    • +
  • Laurens Janssen
    • +
  • Bob Bagwill
    • +
  • Nathan Collins
    • +
  • lostheli
    • +
  • kelv
    • +
  • Milly
    • +
  • gtorelly
    • +
  • Brad Ackerman
    • +
  • Mitsuo Heijo
    • +
  • Claudio Bantaloukas
    • +
  • Benjamin Gustin
    • +
  • Ingo Weiss
    • +
  • Kerry Su
    • +
  • Ilyess Bachiri
    • +
  • Yury Stankevich
    • +
  • kice
    • +
  • Denis Neuling
    • +
  • Janne Johansson
    • +
  • Patrik Nordlén
    • +
  • CokeMine
    • +
  • Sơn Trần-Nguyễn
    • +
  • lluuaapp
    • +
  • Zach Kipp
    • +
  • Riccardo Iaconelli
    • +
  • Sakuragawa Misty
    • +
  • Nicolas Rueff
    • +
  • Pau Rodriguez-Estivill
    • +
  • Bob Pusateri

    • Contact the rclone project

    Forum

    diff --git a/MANUAL.md b/MANUAL.md index bac119629..95992c033 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,6 +1,6 @@ % rclone(1) User Manual % Nick Craig-Wood -% Sep 02, 2020 +% Feb 02, 2021 # Rclone syncs your files to cloud storage @@ -35,13 +35,14 @@ verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can [check](https://rclone.org/commands/rclone_check/) the integrity of your files. Where -possible, rclone employs server side transfers to minimise local +possible, rclone employs server-side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk. Virtual backends wrap local and cloud file systems to apply [encryption](https://rclone.org/crypt/), [caching](https://rclone.org/cache/), +[compression](https://rclone.org/compress/) [chunking](https://rclone.org/chunker/) and [joining](https://rclone.org/union/). @@ -84,7 +85,7 @@ Rclone helps you: - MD5, SHA1 hashes are checked at all times for file integrity - Timestamps are preserved on files - Operations can be restarted at any time - - Can be to and from network, eg two different cloud providers + - Can be to and from network, e.g. two different cloud providers - Can use multi-threaded downloads to local disk - [Copy](https://rclone.org/commands/rclone_copy/) new or changed files to cloud storage - [Sync](https://rclone.org/commands/rclone_sync/) (one way) to make a directory identical @@ -112,10 +113,12 @@ WebDAV or S3, that work out of the box.) - DigitalOcean Spaces - Dreamhost - Dropbox +- Enterprise File Fabric - FTP - Google Cloud Storage - Google Drive - Google Photos +- HDFS - HTTP - Hubic - Jottacloud @@ -146,9 +149,11 @@ WebDAV or S3, that work out of the box.) - StackPath - SugarSync - Tardigrade +- Tencent Cloud Object Storage (COS) - Wasabi - WebDAV - Yandex Disk +- Zoho WorkDrive - The local filesystem @@ -264,7 +269,7 @@ 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`. +also use version tags, e.g. `:1.49.1`, `:1.49` or `:1`. ``` $ docker pull rclone/rclone:latest @@ -337,7 +342,7 @@ kill %1 ## Install from source ## -Make sure you have at least [Go](https://golang.org/) 1.11 +Make sure you have at least [Go](https://golang.org/) 1.12 installed. [Download go](https://golang.org/dl/) if necessary. The latest release is recommended. Then @@ -361,7 +366,7 @@ or the latest version (equivalent to the beta) with These will build the binary in `$(go env GOPATH)/bin` (`~/go/bin/rclone` by default) after downloading the source to the go module cache. Note - do **not** use the `-u` flag here. This causes go -to try to update the depencencies that rclone uses and sometimes these +to try to update the dependencies that rclone uses and sometimes these don't work with the current version of rclone. ## Installation with Ansible ## @@ -404,13 +409,16 @@ See the following for detailed instructions for * [Cache](https://rclone.org/cache/) * [Chunker](https://rclone.org/chunker/) - transparently splits large files for other remotes * [Citrix ShareFile](https://rclone.org/sharefile/) + * [Compress](https://rclone.org/compress/) * [Crypt](https://rclone.org/crypt/) - to encrypt other remotes * [DigitalOcean Spaces](https://rclone.org/s3/#digitalocean-spaces) * [Dropbox](https://rclone.org/dropbox/) + * [Enterprise File Fabric](https://rclone.org/filefabric/) * [FTP](https://rclone.org/ftp/) * [Google Cloud Storage](https://rclone.org/googlecloudstorage/) * [Google Drive](https://rclone.org/drive/) * [Google Photos](https://rclone.org/googlephotos/) + * [HDFS](https://rclone.org/hdfs/) * [HTTP](https://rclone.org/http/) * [Hubic](https://rclone.org/hubic/) * [Jottacloud / GetSky.no](https://rclone.org/jottacloud/) @@ -433,6 +441,7 @@ See the following for detailed instructions for * [Union](https://rclone.org/union/) * [WebDAV](https://rclone.org/webdav/) * [Yandex Disk](https://rclone.org/yandex/) + * [Zoho WorkDrive](https://rclone.org/zoho/) * [The local filesystem](https://rclone.org/local/) Usage @@ -445,7 +454,7 @@ Its syntax is like this Syntax: [options] subcommand Source and destination paths are specified by the name you gave the -storage system in the config file then the sub path, eg +storage system in the config file then the sub path, e.g. "drive:myfolder" to look at "myfolder" in Google drive. You can define as many storage paths as you like in the config file. @@ -503,7 +512,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone copy -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis @@ -540,7 +549,7 @@ Not to destpath/sourcepath/two.txt If you are familiar with `rsync`, rclone always works as if you had -written a trailing / - meaning "copy the contents of this directory". +written a trailing `/` - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination. @@ -634,15 +643,15 @@ Move files from source to dest. Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and -the remote does not support a server side directory move operation. +the remote does not support a server-side directory move operation. -If no filters are in use and if possible this will server side move +If no filters are in use and if possible this will server-side move `source:path` into `dest:path`. After this `source:path` will no longer exist. Otherwise for each file in `source:path` selected by the filters (if -any) this will move it into `dest:path`. If possible a server side -move will be used, otherwise it will copy it (server side if possible) +any) this will move it into `dest:path`. If possible a server-side +move will be used, otherwise it will copy it (server-side if possible) into `dest:path` then delete the original (if no errors on copy) in `source:path`. @@ -679,7 +688,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone delete -Remove the contents of path. +Remove the files in path. ## Synopsis @@ -687,20 +696,21 @@ Remove the contents of path. Remove the files in path. Unlike `purge` it obeys include/exclude filters so can be used to selectively delete files. -`rclone delete` only deletes objects but leaves the directory structure +`rclone delete` only deletes files but leaves the directory structure alone. If you want to delete a directory and all of its contents use -`rclone purge` +the `purge` command. -If you supply the --rmdirs flag, it will remove all empty directories along with it. +If you supply the `--rmdirs` flag, it will remove all empty directories along with it. +You can also use the separate command `rmdir` or `rmdirs` to +delete empty directories only. -Eg delete all files bigger than 100MBytes - -Check what would be deleted first (use either) +For example, to delete all files bigger than 100MBytes, you may first want to check what +would be deleted (use either): rclone --min-size 100M lsl remote:path rclone --dry-run --min-size 100M delete remote:path -Then delete +Then proceed with the actual delete: rclone --min-size 100M delete remote:path @@ -736,8 +746,9 @@ Remove the path and all of its contents. Remove the path and all of its contents. Note that this does not obey -include/exclude filters - everything will be removed. Use `delete` if -you want to selectively delete files. +include/exclude filters - everything will be removed. Use the `delete` +command if you want to selectively delete files. To delete empty directories only, +use command `rmdir` or `rmdirs`. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. @@ -763,10 +774,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li Make the path if it doesn't already exist. -## Synopsis - -Make the path if it doesn't already exist. - ``` rclone mkdir remote:path [flags] ``` @@ -785,13 +792,18 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone rmdir -Remove the path if empty. +Remove the empty directory at path. ## Synopsis -Remove the path. Note that you can't remove a path with -objects in it, use purge for that. +This removes empty directory given by path. Will not remove the path if it +has any objects in it, not even empty subdirectories. Use +command `rmdirs` (or `delete` with option `--rmdirs`) +to do that. + +To delete a path and any objects in it, use `purge` command. + ``` rclone rmdir remote:path [flags] @@ -820,10 +832,10 @@ Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don't match. It doesn't alter the source or destination. -If you supply the --size-only flag, it will only compare the sizes not +If you supply the `--size-only` flag, it will only compare the sizes not the hashes as well. Use this for a quick check. -If you supply the --download flag, it will download the data from +If you supply the `--download` flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data. @@ -833,7 +845,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are @@ -859,6 +871,7 @@ rclone check source:path dest:path [flags] ``` --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file + --download Check by downloading rather than with hash. --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file @@ -906,12 +919,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). @@ -974,12 +987,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). @@ -1033,12 +1046,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). @@ -1068,6 +1081,11 @@ Produces an md5sum file for all the objects in the path. Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces. +By default, the hash is requested from the remote. If MD5 is +not supported by the remote, no hash will be returned. With the +download flag, the file will be downloaded from the remote and +hashed locally enabling MD5 for any remote. + ``` rclone md5sum remote:path [flags] @@ -1076,7 +1094,10 @@ rclone md5sum remote:path [flags] ## Options ``` - -h, --help help for md5sum + --base64 Output base64 encoded hashsum + --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + -h, --help help for md5sum + --output-file string Output hashsums to a file rather than the terminal ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -1095,6 +1116,11 @@ Produces an sha1sum file for all the objects in the path. Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces. +By default, the hash is requested from the remote. If SHA-1 is +not supported by the remote, no hash will be returned. With the +download flag, the file will be downloaded from the remote and +hashed locally enabling SHA-1 for any remote. + ``` rclone sha1sum remote:path [flags] @@ -1103,7 +1129,10 @@ rclone sha1sum remote:path [flags] ## Options ``` - -h, --help help for sha1sum + --base64 Output base64 encoded hashsum + --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + -h, --help help for sha1sum + --output-file string Output hashsums to a file rather than the terminal ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -1116,10 +1145,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li Prints the total size and number of objects in remote:path. -## Synopsis - -Prints the total size and number of objects in remote:path. - ``` rclone size remote:path [flags] ``` @@ -1191,7 +1216,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone cleanup -Clean up the remote if possible +Clean up the remote if possible. ## Synopsis @@ -1226,28 +1251,37 @@ Interactively find duplicate filenames and delete/rename them. By default `dedupe` interactively finds files with duplicate names and offers to delete all but one or rename them to be -different. +different. This is known as deduping by name. -This is only useful with backends like Google Drive which can have -duplicate file names. It can be run on wrapping backends (eg crypt) if -they wrap a backend which supports duplicate file names. +Deduping by name is only useful with backends like Google Drive which +can have duplicate file names. It can be run on wrapping backends +(e.g. crypt) if they wrap a backend which supports duplicate file +names. -In the first pass it will merge directories with the same name. It -will do this iteratively until all the identically named directories -have been merged. +However if --by-hash is passed in then dedupe will find files with +duplicate hashes instead which will work on any backend which supports +at least one hash. This can be used to find files with duplicate +content. This is known as deduping by hash. -In the second pass, for every group of duplicate file names, it will -delete all but one identical files it finds without confirmation. -This means that for most duplicated files the `dedupe` -command will not be interactive. +If deduping by name, first rclone will merge directories with the same +name. It will do this iteratively until all the identically named +directories have been merged. + +Next, if deduping by name, for every group of duplicate file names / +hashes, it will delete all but one identical files it finds without +confirmation. This means that for most duplicated files the `dedupe` command will not be interactive. `dedupe` considers files to be identical if they have the -same hash. If the backend does not support hashes (eg crypt wrapping +same file path and the same hash. If the backend does not support hashes (e.g. crypt wrapping Google Drive) then they will never be found to be identical. If you use the `--size-only` flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes. +Next rclone will resolve the remaining duplicates. Exactly which +action is taken depends on the dedupe mode. By default rclone will +interactively query the user for each one. + **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. @@ -1310,6 +1344,7 @@ Dedupe can be run non interactively using the `--dedupe-mode` flag or by using a * `--dedupe-mode largest` - removes identical files then keeps the largest one. * `--dedupe-mode smallest` - removes identical files then keeps the smallest one. * `--dedupe-mode rename` - removes identical files then renames the rest to be different. + * `--dedupe-mode list` - lists duplicate dirs and files only and changes nothing. For example to rename all the identically named photos in your Google Photos directory, do @@ -1327,6 +1362,7 @@ rclone dedupe [mode] remote:path [flags] ## Options ``` + --by-hash Find indentical hashes rather than names --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive") -h, --help help for dedupe ``` @@ -1344,10 +1380,10 @@ Get quota information from the remote. ## Synopsis -Get quota information from the remote, like bytes used/free/quota and bytes -used in the trash. Not supported by all remotes. +`rclone about`prints quota information about a remote to standard +output. The output is typically used, free, quota and trash contents. -This will print to stdout something like this: +E.g. Typical output from`rclone about remote:`is: Total: 17G Used: 7.444G @@ -1359,16 +1395,15 @@ Where the fields are: * Total: total size available. * Used: total size used - * Free: total amount this user could upload. - * Trashed: total amount in the trash - * Other: total amount in other storage (eg Gmail, Google Photos) + * Free: total space available to this user. + * Trashed: total space used by trash + * Other: total amount in other storage (e.g. Gmail, Google Photos) * Objects: total number of objects in the storage -Note that not all the backends provide all the fields - they will be -missing if they are not known for that backend. Where it is known -that the value is unlimited the value will also be omitted. +Not all backends print all fields. Information is not included if it is not +provided by a backend. Where the value is unlimited it is omitted. -Use the --full flag to see the numbers written out in full, eg +Applying a `--full` flag to the command prints the bytes in full, e.g. Total: 18253611008 Used: 7993453766 @@ -1376,7 +1411,7 @@ Use the --full flag to see the numbers written out in full, eg Trashed: 104857602 Other: 8849156022 -Use the --json flag for a computer readable output, eg +A `--json`flag generates conveniently computer readable output, e.g. { "total": 18253611008, @@ -1386,6 +1421,10 @@ Use the --json flag for a computer readable output, eg "free": 1411001220 } +Not all backends support the `rclone about` command. + +See [List of backends that do not support about](https://rclone.org/overview/#optional-features) + ``` rclone about remote: [flags] @@ -1458,7 +1497,7 @@ for more info). rclone backend features remote: -Pass options to the backend command with -o. This should be key=value or key, eg: +Pass options to the backend command with -o. This should be key=value or key, e.g.: rclone backend stats remote:path stats -o format=json -o long @@ -1509,10 +1548,10 @@ Or like this to output any .txt files in dir or its subdirectories. rclone --include "*.txt" cat remote:path/to/dir -Use the --head flag to print characters only at the start, --tail for -the end and --offset and --count to print a section in the middle. +Use the `--head` flag to print characters only at the start, `--tail` for +the end and `--offset` and `--count` to print a section in the middle. Note that if offset is negative it will count from the end, so ---offset -1 --count 1 is equivalent to --tail 1. +`--offset -1 --count 1` is equivalent to `--tail 1`. ``` @@ -1565,7 +1604,7 @@ whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use -"--no-obscure". You can also set osbscured passwords using the +"--no-obscure". You can also set obscured passwords using the "rclone config password" command. So for example if you wanted to configure a Google Drive remote but @@ -1596,10 +1635,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li Delete an existing remote `name`. -## Synopsis - -Delete an existing remote `name`. - ``` rclone config delete `name` [flags] ``` @@ -1650,10 +1685,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li Dump the config file as JSON. -## Synopsis - -Dump the config file as JSON. - ``` rclone config dump [flags] ``` @@ -1701,10 +1732,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li Show path of configuration file in use. -## Synopsis - -Show path of configuration file in use. - ``` rclone config file [flags] ``` @@ -1759,10 +1786,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li List in JSON format all the providers and options. -## Synopsis - -List in JSON format all the providers and options. - ``` rclone config providers [flags] ``` @@ -1813,10 +1836,6 @@ See the [global flags page](https://rclone.org/flags/) for global options not li Print (decrypted) config file, or the config for a single remote. -## Synopsis - -Print (decrypted) config file, or the config for a single remote. - ``` rclone config show [] [flags] ``` @@ -1858,7 +1877,7 @@ whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use -"--no-obscure". You can also set osbscured passwords using the +"--no-obscure". You can also set obscured passwords using the "rclone config password" command. If the remote uses OAuth the token will be updated, if you don't @@ -1915,7 +1934,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone copyto -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis @@ -2040,7 +2059,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are @@ -2098,6 +2117,9 @@ use it like this rclone cryptdecode --reverse encryptedremote: filename1 filename2 +Another way to accomplish this is by using the `rclone backend encode` (or `decode`)command. +See the documentation on the `crypt` overlay for more info. + ``` rclone cryptdecode encryptedremote: encryptedfilename [flags] @@ -2180,7 +2202,7 @@ Output bash completion script for rclone. Generates a bash shell autocompletion script for rclone. This writes to /etc/bash_completion.d/rclone by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete bash @@ -2192,6 +2214,8 @@ them directly If you supply a command line argument the script will be written there. +If output_file is "-", then the output will be written to stdout. + ``` rclone genautocomplete bash [output_file] [flags] @@ -2219,7 +2243,7 @@ Output fish completion script for rclone. Generates a fish autocompletion script for rclone. This writes to /etc/fish/completions/rclone.fish by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete fish @@ -2231,6 +2255,8 @@ them directly If you supply a command line argument the script will be written there. +If output_file is "-", then the output will be written to stdout. + ``` rclone genautocomplete fish [output_file] [flags] @@ -2258,7 +2284,7 @@ Output zsh completion script for rclone. Generates a zsh autocompletion script for rclone. This writes to /usr/share/zsh/vendor-completions/_rclone by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete zsh @@ -2270,6 +2296,8 @@ them directly If you supply a command line argument the script will be written there. +If output_file is "-", then the output will be written to stdout. + ``` rclone genautocomplete zsh [output_file] [flags] @@ -2325,7 +2353,12 @@ Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool. -Run without a hash to see the list of supported hashes, eg +By default, the hash is requested from the remote. If the hash is +not supported by the remote, no hash will be returned. With the +download flag, the file will be downloaded from the remote and +hashed locally enabling any hash for any remote. + +Run without a hash to see the list of all supported hashes, e.g. $ rclone hashsum Supported hashes are: @@ -2346,8 +2379,10 @@ rclone hashsum remote:path [flags] ## Options ``` - --base64 Output base64 encoded hashsum - -h, --help help for hashsum + --base64 Output base64 encoded hashsum + --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + -h, --help help for hashsum + --output-file string Output hashsums to a file rather than the terminal ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -2434,7 +2469,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone lsf -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. ## Synopsis @@ -2465,7 +2500,7 @@ output: o - Original ID of underlying object m - MimeType of object if known e - encrypted name - T - tier of storage if known, eg "Hot" or "Cool" + T - tier of storage if known, e.g. "Hot" or "Cool" So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last. @@ -2548,12 +2583,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). @@ -2618,11 +2653,11 @@ may be repeated). If --hash-type is set then it implies --hash. If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra -request (eg s3, swift). +request (e.g. s3, swift). If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra -request (eg s3, swift). +request (e.g. s3, swift). If --encrypted is not specified the Encrypted won't be emitted. @@ -2644,9 +2679,9 @@ If the directory is a bucket in a bucket based backend, then The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the -nearest millisecond (eg Google Drive) then 3 digits will always be +nearest millisecond (e.g. Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are -accurate to the nearest second (Dropbox, Box, WebDav etc) no digits +accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits will be shown ("2017-05-31T16:15:57+01:00"). The whole output can be processed as a JSON blob, or alternatively it @@ -2666,12 +2701,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). @@ -2713,37 +2748,51 @@ FUSE. First set up your remote using `rclone config`. Check it works with `rclone ls` etc. -You can either run mount in foreground mode or background (daemon) mode. Mount runs in -foreground mode by default, use the --daemon flag to specify background mode mode. -Background mode is only supported on Linux and OSX, you can only run mount in -foreground mode on Windows. +On Linux and OSX, you can either run mount in foreground mode or background (daemon) mode. +Mount runs in foreground mode by default, use the `--daemon` flag to specify background mode. +You can only run mount in foreground mode on Windows. -On Linux/macOS/FreeBSD Start the mount like this where `/path/to/local/mount` -is an **empty** **existing** directory. +On Linux/macOS/FreeBSD start the mount like this, where `/path/to/local/mount` +is an **empty** **existing** directory: rclone mount remote:path/to/files /path/to/local/mount -Or on Windows like this where `X:` is an unused drive letter -or use a path to **non-existent** directory. +On Windows you can start a mount in different ways. See [below](#mounting-modes-on-windows) +for details. The following examples will mount to an automatically assigned drive, +to specific drive letter `X:`, to path `C:\path\to\nonexistent\directory` +(which must be **non-existent** subdirectory of an **existing** parent directory or drive, +and is not supported when [mounting as a network drive](#mounting-modes-on-windows)), and +the last example will mount as network share `\\cloud\remote` and map it to an +automatically assigned drive: + rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\path\to\nonexistent\directory - -When running in background mode the user will have to stop the mount manually (specified below). + rclone mount remote:path/to/files \\cloud\remote When the program ends while in foreground mode, either via Ctrl+C or receiving -a SIGINT or SIGTERM signal, the mount is automatically stopped. +a SIGINT or SIGTERM signal, the mount should be automatically stopped. -The umount operation can fail, for example when the mountpoint is busy. -When that happens, it is the user's responsibility to stop the mount manually. - -Stopping the mount manually: +When running in background mode the user will have to stop the mount manually: # Linux fusermount -u /path/to/local/mount # OS X umount /path/to/local/mount +The umount operation can fail, for example when the mountpoint is busy. +When that happens, it is the user's responsibility to stop the mount manually. + +The size of the mounted file system will be set according to information retrieved +from the remote, the same as returned by the [rclone about](https://rclone.org/commands/rclone_about/) +command. Remotes with unlimited storage may report the used size only, +then an additional 1PB of free space is assumed. If the remote does not +[support](https://rclone.org/overview/#optional-features) the about feature +at all, then 1PB is set as both the total and the free size. + +**Note**: As of `rclone` 1.52.2, `rclone mount` now requires Go version 1.13 +or newer on some platforms depending on the underlying FUSE library in use. + ## Installing on Windows To run rclone mount on Windows, you will need to @@ -2752,10 +2801,110 @@ download and install [WinFsp](http://www.secfs.net/winfsp/). [WinFsp](https://github.com/billziss-gh/winfsp) is an open source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone -uses combination with -[cgofuse](https://github.com/billziss-gh/cgofuse). Both of these -packages are by Bill Zissimopoulos who was very helpful during the -implementation of rclone mount for Windows. +uses combination with [cgofuse](https://github.com/billziss-gh/cgofuse). +Both of these packages are by Bill Zissimopoulos who was very helpful +during the implementation of rclone mount for Windows. + +### Mounting modes on windows + +Unlike other operating systems, Microsoft Windows provides a different filesystem +type for network and fixed drives. It optimises access on the assumption fixed +disk drives are fast and reliable, while network drives have relatively high latency +and less reliability. Some settings can also be differentiated between the two types, +for example that Windows Explorer should just display icons and not create preview +thumbnails for image and video files on network drives. + +In most cases, rclone will mount the remote as a normal, fixed disk drive by default. +However, you can also choose to mount it as a remote network drive, often described +as a network share. If you mount an rclone remote using the default, fixed drive mode +and experience unexpected program errors, freezes or other issues, consider mounting +as a network drive instead. + +When mounting as a fixed disk drive you can either mount to an unused drive letter, +or to a path - which must be **non-existent** subdirectory of an **existing** parent +directory or drive. Using the special value `*` will tell rclone to +automatically assign the next available drive letter, starting with Z: and moving backward. +Examples: + + rclone mount remote:path/to/files * + rclone mount remote:path/to/files X: + rclone mount remote:path/to/files C:\path\to\nonexistent\directory + rclone mount remote:path/to/files X: + +Option `--volname` can be used to set a custom volume name for the mounted +file system. The default is to use the remote name and path. + +To mount as network drive, you can add option `--network-mode` +to your mount command. Mounting to a directory path is not supported in +this mode, it is a limitation Windows imposes on junctions, so the remote must always +be mounted to a drive letter. + + rclone mount remote:path/to/files X: --network-mode + +A volume name specified with `--volname` will be used to create the network share path. +A complete UNC path, such as `\\cloud\remote`, optionally with path +`\\cloud\remote\madeup\path`, will be used as is. Any other +string will be used as the share part, after a default prefix `\\server\`. +If no volume name is specified then `\\server\share` will be used. +You must make sure the volume name is unique when you are mounting more than one drive, +or else the mount command will fail. The share name will treated as the volume label for +the mapped drive, shown in Windows Explorer etc, while the complete +`\\server\share` will be reported as the remote UNC path by +`net use` etc, just like a normal network drive mapping. + +If you specify a full network share UNC path with `--volname`, this will implicitely +set the `--network-mode` option, so the following two examples have same result: + + rclone mount remote:path/to/files X: --network-mode + rclone mount remote:path/to/files X: --volname \\server\share + +You may also specify the network share UNC path as the mountpoint itself. Then rclone +will automatically assign a drive letter, same as with `*` and use that as +mountpoint, and instead use the UNC path specified as the volume name, as if it were +specified with the `--volname` option. This will also implicitely set +the `--network-mode` option. This means the following two examples have same result: + + rclone mount remote:path/to/files \\cloud\remote + rclone mount remote:path/to/files * --volname \\cloud\remote + +There is yet another way to enable network mode, and to set the share path, +and that is to pass the "native" libfuse/WinFsp option directly: +`--fuse-flag --VolumePrefix=\server\share`. Note that the path +must be with just a single backslash prefix in this case. + + +*Note:* In previous versions of rclone this was the only supported method. + +[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) + +See also [Limitations](#limitations) section below. + +### Windows filesystem permissions + +The FUSE emulation layer on Windows must convert between the POSIX-based +permission model used in FUSE, and the permission model used in Windows, +based on access-control lists (ACL). + +The mounted filesystem will normally get three entries in its access-control list (ACL), +representing permissions for the POSIX permission scopes: Owner, group and others. +By default, the owner and group will be taken from the current user, and the built-in +group "Everyone" will be used to represent others. The user/group can be customized +with FUSE options "UserName" and "GroupName", +e.g. `-o UserName=user123 -o GroupName="Authenticated Users"`. + +The permissions on each entry will be set according to +[options](#options) `--dir-perms` and `--file-perms`, +which takes a value in traditional [numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation), +where the default corresponds to `--file-perms 0666 --dir-perms 0777`. + +Note that the mapping of permissions is not always trivial, and the result +you see in Windows Explorer may not be exactly like you expected. +For example, when setting a value that includes write access, this will be +mapped to individual permissions "write attributes", "write data" and "append data", +but not "write extended attributes" (WinFsp does not support extended attributes, +see [this](https://github.com/billziss-gh/winfsp/wiki/NTFS-Compatibility)). +Windows will then show this as basic permission "Special" instead of "Write", +because "Write" includes the "write extended attributes" permission. ### Windows caveats @@ -2773,43 +2922,15 @@ infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Archit which creates drives accessible for everyone on the system or alternatively using [the nssm service manager](https://nssm.cc/usage). -### Mount as a network drive - -By default, rclone will mount the remote as a normal drive. However, -you can also mount it as a **Network Drive** (or **Network Share**, as -mentioned in some places) - -Unlike other systems, Windows provides a different filesystem type for -network drives. Windows and other programs treat the network drives -and fixed/removable drives differently: In network drives, many I/O -operations are optimized, as the high latency and low reliability -(compared to a normal drive) of a network is expected. - -Although many people prefer network shares to be mounted as normal -system drives, this might cause some issues, such as programs not -working as expected or freezes and errors while operating with the -mounted remote in Windows Explorer. If you experience any of those, -consider mounting rclone remotes as network shares, as Windows expects -normal drives to be fast and reliable, while cloud storage is far from -that. See also [Limitations](#limitations) section below for more -info - -Add "--fuse-flag --VolumePrefix=\server\share" to your "mount" -command, **replacing "share" with any other name of your choice if you -are mounting more than one remote**. Otherwise, the mountpoints will -conflict and your mounted filesystems will overlap. - -[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) - ## Limitations -Without the use of "--vfs-cache-mode" this can only write files +Without the use of `--vfs-cache-mode` this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without -"--vfs-cache-mode writes" or "--vfs-cache-mode full". See the [File -Caching](#file-caching) section for more info. +`--vfs-cache-mode writes` or `--vfs-cache-mode full`. +See the [File Caching](#file-caching) section for more info. -The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, +The bucket based remotes (e.g. Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache. @@ -2827,10 +2948,10 @@ for solutions to make mount more reliable. ## Attribute caching -You can use the flag --attr-timeout to set the time the kernel caches -the attributes (size, modification time etc) for directory entries. +You can use the flag `--attr-timeout` to set the time the kernel caches +the attributes (size, modification time, etc.) for directory entries. -The default is "1s" which caches files just long enough to avoid +The default is `1s` which caches files just long enough to avoid too many callbacks to rclone from the kernel. In theory 0s should be the correct value for filesystems which can @@ -2841,14 +2962,14 @@ few problems such as and [excessive time listing directories](https://github.com/rclone/rclone/issues/2095#issuecomment-371141147). The kernel can cache the info about a file for the time given by -"--attr-timeout". You may see corruption if the remote file changes +`--attr-timeout`. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file -or a file with garbage on the end. With "--attr-timeout 1s" this is -very unlikely but not impossible. The higher you set "--attr-timeout" +or a file with garbage on the end. With `--attr-timeout 1s` this is +very unlikely but not impossible. The higher you set `--attr-timeout` the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above. -If you set it higher ('10s' or '1m' say) then the kernel will call +If you set it higher (`10s` or `1m` say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above. @@ -2870,25 +2991,22 @@ after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode. -## chunked reading ### +## chunked reading ---vfs-read-chunk-size will enable reading the source objects in parts. +`--vfs-read-chunk-size` will enable reading the source objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests. -When --vfs-read-chunk-size-limit is also specified and greater than --vfs-read-chunk-size, -the chunk size for each open file will get doubled for each chunk read, until the -specified value is reached. A value of -1 will disable the limit and the chunk size will -grow indefinitely. +When `--vfs-read-chunk-size-limit` is also specified and greater than +`--vfs-read-chunk-size`, the chunk size for each open file will get doubled +for each chunk read, until the specified value is reached. A value of `-1` will disable +the limit and the chunk size will grow indefinitely. -With --vfs-read-chunk-size 100M and --vfs-read-chunk-size-limit 0 the following -parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. -When --vfs-read-chunk-size-limit 500M is specified, the result would be +With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` +the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. +When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. -Chunked reading will only work with --vfs-cache-mode < full, as the file will always -be copied to the vfs cache before opening with --vfs-cache-mode full. - ## VFS - Virtual File System This command uses the VFS layer. This adapts the cloud storage objects @@ -2985,9 +3103,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -3035,7 +3153,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -3052,6 +3170,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -3087,6 +3210,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -3100,7 +3229,7 @@ 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 +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. @@ -3130,30 +3259,33 @@ rclone mount remote:path /path/to/mountpoint [flags] ## Options ``` - --allow-non-empty Allow mounting over a non-empty directory (not Windows). - --allow-other Allow access to other users. - --allow-root Allow access to root user. - --async-read Use asynchronous reads. (default true) + --allow-non-empty Allow mounting over a non-empty directory. Not supported on Windows. + --allow-other Allow access to other users. Not supported on Windows. + --allow-root Allow access to root user. Not supported on Windows. + --async-read Use asynchronous reads. Not supported on Windows. (default true) --attr-timeout duration Time for which file/directory attributes are cached. (default 1s) - --daemon Run mount as a daemon (background mode). - --daemon-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes). + --daemon Run mount as a daemon (background mode). Not supported on Windows. + --daemon-timeout duration Time limit for rclone to respond to kernel. Not supported on Windows. --debug-fuse Debug the FUSE internals - needs -v. - --default-permissions Makes kernel enforce access control based on the file mode. + --default-permissions Makes kernel enforce access control based on the file mode. Not supported on Windows. --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for mount - --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) + --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. Not supported on Windows. (default 128k) + --network-mode Mount as remote network drive, instead of fixed disk drive. Supported on Windows only --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. + --noappledouble Ignore Apple Double (._) and .DS_Store files. Supported on OSX only. (default true) + --noapplexattr Ignore all "com.apple.*" extended attributes. Supported on OSX only. -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) @@ -3165,8 +3297,8 @@ rclone mount remote:path /path/to/mountpoint [flags] --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-back duration Time to writeback files after last use when using cache. (default 5s) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) - --volname string Set the volume name (not supported by all OSes). - --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. + --volname string Set the volume name. Supported on Windows and OSX only. + --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. Not supported on Windows. ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -3255,9 +3387,10 @@ Here are the keys - press '?' to toggle the help on and off ←,h to return c toggle counts g toggle graph - n,s,C sort by name,size,count + a toggle average size in directory + n,s,C,A sort by name,size,count,average size d delete file/directory - y copy current path to clipbard + y copy current path to clipboard Y display current path ^L refresh screen ? to toggle help on and off @@ -3289,7 +3422,7 @@ See the [global flags page](https://rclone.org/flags/) for global options not li # rclone obscure -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. ## Synopsis @@ -3305,7 +3438,8 @@ the config file. However it is very hard to shoulder surf a 64 character hex token. This command can also accept a password through STDIN instead of an -argument by passing a hyphen as an argument. Example: +argument by passing a hyphen as an argument. This will use the first +line of STDIN as the password not including the trailing newline. echo "secretpassword" | rclone obscure - @@ -3383,7 +3517,7 @@ Will place this in the "arg" value Use --loopback to connect to the rclone instance running "rclone rc". This is very useful for testing commands without having to run an -rclone rc server, eg: +rclone rc server, e.g.: rclone rc --loopback operations/about fs=/ @@ -3400,7 +3534,7 @@ rclone rc commands parameter [flags] -h, --help help for rc --json string Input JSON - use instead of key=value args. --loopback If set connect to this rclone instance not via HTTP. - --no-output If set don't output the JSON result. + --no-output If set, don't output the JSON result. -o, --opt stringArray Option in the form name=value or name placed in the "opt" array. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") @@ -3499,15 +3633,21 @@ Remove empty directories under the path. ## Synopsis -This removes any empty directories (or directories that only contain -empty directories) under the path that it finds, including the path if -it has nothing in. -If you supply the --leave-root flag, it will not remove the root directory. +This recursively removes any empty directories (including directories +that only contain empty directories), that it finds under the path. +The root path itself will also be removed if it is empty, unless +you supply the `--leave-root` flag. + +Use command `rmdir` to delete just the empty directory +given by path, not recurse. This is useful for tidying up remotes that rclone has left a lot of -empty directories in. +empty directories in. For example the `delete` command will +delete files but leave the directory structure (unless used with +option `--rmdirs`). +To delete a path and any objects in it, use `purge` command. ``` @@ -3534,7 +3674,7 @@ Serve a remote over a protocol. ## Synopsis rclone serve is used to serve a remote over a given protocol. This -command requires the use of a subcommand to specify the protocol, eg +command requires the use of a subcommand to specify the protocol, e.g. rclone serve http remote: @@ -3582,7 +3722,7 @@ players might show files that they are not able to play back correctly. ## Server options Use `--addr` to specify which IP address and port the server should -listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all +listen on, e.g. `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. Use `--name` to choose the friendly server name, which is by @@ -3687,9 +3827,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -3737,7 +3877,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -3754,6 +3894,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -3789,6 +3934,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -3802,7 +3953,7 @@ 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 +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. @@ -3836,7 +3987,7 @@ rclone serve dlna remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for dlna --log-trace enable trace logging of SOAP traffic --name string name of DLNA server @@ -3845,8 +3996,8 @@ rclone serve dlna remote:path [flags] --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) @@ -3880,7 +4031,7 @@ or you can make a remote of type ftp to read and write it. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -3989,9 +4140,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -4039,7 +4190,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -4056,6 +4207,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -4091,6 +4247,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -4104,7 +4266,7 @@ 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 +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. @@ -4131,7 +4293,7 @@ otherwise. If the flag is provided without a value, then it is "true". If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple -JSON based protocl with input on STDIN and output on STDOUT. +JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be @@ -4217,11 +4379,13 @@ rclone serve ftp remote:path [flags] ``` --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") --auth-proxy string A program to use to create the backend from the auth. + --cert string TLS PEM key (concatenation of certificate and CA certificate) --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for ftp + --key string TLS PEM Private key --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. @@ -4230,8 +4394,8 @@ rclone serve ftp remote:path [flags] --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -4262,7 +4426,7 @@ rclone serve http implements a basic web server to serve the remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it. -You can use the filter flags (eg --include, --exclude) to control what +You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. @@ -4273,7 +4437,7 @@ control the stats printing. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -4304,7 +4468,7 @@ to be used within the template to server pages: | .Name | The full path of a file/directory. | | .Title | Directory listing of .Name | | .Sort | The current sort used. This is changeable via ?sort= parameter | -| | Sort Options: namedirfist,name,size,time (default namedirfirst) | +| | Sort Options: namedirfirst,name,size,time (default namedirfirst) | | .Order | The current ordering used. This is changeable via ?order= parameter | | | Order Options: asc,desc (default asc) | | .Query | Currently unused. | @@ -4447,9 +4611,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -4497,7 +4661,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -4514,6 +4678,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -4549,6 +4718,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -4562,7 +4737,7 @@ 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 +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. @@ -4599,7 +4774,7 @@ rclone serve http remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -4614,8 +4789,8 @@ rclone serve http remote:path [flags] --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -4675,6 +4850,10 @@ with use of the "--addr" flag. You might wish to start this server on boot. +Adding --cache-objects=false will cause rclone to stop caching objects +returned from the List call. Caching is normally desirable as it speeds +up downloading objects, saves transactions and uses very little memory. + ## Setting up restic to use rclone ### Now you can [follow the restic @@ -4723,7 +4902,7 @@ with a path of `//`. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -4754,7 +4933,7 @@ to be used within the template to server pages: | .Name | The full path of a file/directory. | | .Title | Directory listing of .Name | | .Sort | The current sort used. This is changeable via ?sort= parameter | -| | Sort Options: namedirfist,name,size,time (default namedirfirst) | +| | Sort Options: namedirfirst,name,size,time (default namedirfirst) | | .Order | The current ordering used. This is changeable via ?order= parameter | | | Order Options: asc,desc (default asc) | | .Query | Currently unused. | @@ -4812,6 +4991,7 @@ rclone serve restic remote:path [flags] --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") --append-only disallow deletion of repository data --baseurl string Prefix for URLs - leave blank for root. + --cache-objects cache listed objects (default true) --cert string SSL PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with -h, --help help for restic @@ -4844,7 +5024,7 @@ rclone serve sftp implements an SFTP server to serve the remote over SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it. -You can use the filter flags (eg --include, --exclude) to control what +You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. @@ -4968,9 +5148,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -5018,7 +5198,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -5035,6 +5215,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -5070,6 +5255,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -5083,7 +5274,7 @@ 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 +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. @@ -5110,7 +5301,7 @@ otherwise. If the flag is provided without a value, then it is "true". If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple -JSON based protocl with input on STDIN and output on STDOUT. +JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be @@ -5200,7 +5391,7 @@ rclone serve sftp remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for sftp --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) --no-auth Allow connections with no authentication if set. @@ -5210,8 +5401,8 @@ rclone serve sftp remote:path [flags] --pass string Password for authentication. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -5261,7 +5452,7 @@ Use "rclone hashsum" to see the full list. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -5292,7 +5483,7 @@ to be used within the template to server pages: | .Name | The full path of a file/directory. | | .Title | Directory listing of .Name | | .Sort | The current sort used. This is changeable via ?sort= parameter | -| | Sort Options: namedirfist,name,size,time (default namedirfirst) | +| | Sort Options: namedirfirst,name,size,time (default namedirfirst) | | .Order | The current ordering used. This is changeable via ?order= parameter | | | Order Options: asc,desc (default asc) | | .Query | Currently unused. | @@ -5435,9 +5626,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -5485,7 +5676,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -5502,6 +5693,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -5537,6 +5733,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -5550,7 +5752,7 @@ 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 +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. @@ -5577,7 +5779,7 @@ otherwise. If the flag is provided without a value, then it is "true". If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple -JSON based protocl with input on STDIN and output on STDOUT. +JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be @@ -5671,7 +5873,7 @@ rclone serve webdav remote:path [flags] --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -5686,8 +5888,8 @@ rclone serve webdav remote:path [flags] --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -5770,9 +5972,9 @@ unless the --no-create flag is provided. If --timestamp is used then it will set the modification time to that time instead of the current time. Times may be specified as one of: -- 'YYMMDD' - eg. 17.10.30 -- 'YYYY-MM-DDTHH:MM:SS' - eg. 2006-01-02T15:04:05 -- 'YYYY-MM-DDTHH:MM:SS.SSS' - eg. 2006-01-02T15:04:05.123456789 +- 'YYMMDD' - e.g. 17.10.30 +- 'YYYY-MM-DDTHH:MM:SS' - e.g. 2006-01-02T15:04:05 +- 'YYYY-MM-DDTHH:MM:SS.SSS' - e.g. 2006-01-02T15:04:05.123456789 Note that --timestamp is in UTC if you want local time then add the --localtime flag. @@ -5820,7 +6022,7 @@ For example 1 directories, 5 files -You can use any of the filtering options with the tree command (eg +You can use any of the filtering options with the tree command (e.g. --include and --exclude). You can also use --fast-list. The tree command has many options for controlling the listing which @@ -5964,12 +6166,12 @@ Here are some gotchas which may help users unfamiliar with the shell rules ### Linux / OSX ### -If your names have spaces or shell metacharacters (eg `*`, `?`, `$`, -`'`, `"` etc) then you must quote them. Use single quotes `'` by default. +If your names have spaces or shell metacharacters (e.g. `*`, `?`, `$`, +`'`, `"`, etc.) then you must quote them. Use single quotes `'` by default. rclone copy 'Important files?' remote:backup -If you want to send a `'` you will need to use `"`, eg +If you want to send a `'` you will need to use `"`, e.g. rclone copy "O'Reilly Reviews" remote:backup @@ -5979,12 +6181,12 @@ shell. ### Windows ### -If your names have spaces in you need to put them in `"`, eg +If your names have spaces in you need to put them in `"`, e.g. rclone copy "E:\folder name\folder name\folder name" remote:backup If you are using the root directory on its own then don't quote it -(see [#464](https://github.com/rclone/rclone/issues/464) for why), eg +(see [#464](https://github.com/rclone/rclone/issues/464) for why), e.g. rclone copy E:\ remote:backup @@ -6009,7 +6211,7 @@ Server Side Copy ---------------- Most remotes (but not all - see [the -overview](https://rclone.org/overview/#optional-features)) support server side copy. +overview](https://rclone.org/overview/#optional-features)) support server-side copy. This means if you want to copy one folder to another then rclone won't download all the files and re-upload them; it will instruct the server @@ -6022,19 +6224,19 @@ Eg Will copy the contents of `oldbucket` to `newbucket` without downloading and re-uploading. -Remotes which don't support server side copy **will** download and +Remotes which don't support server-side copy **will** download and re-upload in this case. Server side copies are used with `sync` and `copy` and will be identified in the log when using the `-v` flag. The `move` command -may also use them if remote doesn't support server side move directly. -This is done by issuing a server side copy then a delete which is much +may also use them if remote doesn't support server-side move directly. +This is done by issuing a server-side copy then a delete which is much quicker than a download and re-upload. Server side copies will only be attempted if the remote names are the same. -This can be used when scripting to make aged backups efficiently, eg +This can be used when scripting to make aged backups efficiently, e.g. rclone sync -i remote:current-backup remote:previous-backup rclone sync -i /path/to/files remote:current-backup @@ -6060,7 +6262,7 @@ time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Options which use SIZE use kByte by default. However, a suffix of `b` for bytes, `k` for kBytes, `M` for MBytes, `G` for GBytes, `T` for -TBytes and `P` for PBytes may be used. These are the binary units, eg +TBytes and `P` for PBytes may be used. These are the binary units, e.g. 1, 2\*\*10, 2\*\*20, 2\*\*30 respectively. ### --backup-dir=DIR ### @@ -6073,7 +6275,7 @@ If `--suffix` is set, then the moved files will have the suffix added to them. If there is a file with the same path (after the suffix has been added) in DIR, then it will be overwritten. -The remote in use must support server side move or copy and you must +The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory. @@ -6100,59 +6302,81 @@ it will give an error. ### --bwlimit=BANDWIDTH_SPEC ### -This option controls the bandwidth limit. Limits can be specified -in two ways: As a single limit, or as a timetable. +This option controls the bandwidth limit. For example -Single limits last for the duration of the session. To use a single limit, -specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The -default is `0` which means to not limit bandwidth. + --bwlimit 10M + +would mean limit the upload and download bandwidth to 10 Mbyte/s. +**NB** this is **bytes** per second not **bits** per second. To use a +single limit, specify the desired bandwidth in kBytes/s, or use a +suffix b|k|M|G. The default is `0` which means to not limit bandwidth. -For example, to limit bandwidth usage to 10 MBytes/s use `--bwlimit 10M` +The upload and download bandwidth can be specified seperately, as +`--bwlimit UP:DOWN`, so -It is also possible to specify a "timetable" of limits, which will cause -certain limits to be applied at certain times. To specify a timetable, format your -entries as `WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH...` where: -`WEEKDAY` is optional element. -It could be written as whole world or only using 3 first characters. -`HH:MM` is an hour from 00:00 to 23:59. + --bwlimit 10M:100k + +would mean limit the upload bandwidth to 10 Mbyte/s and the download +bandwidth to 100 kByte/s. Either limit can be "off" meaning no limit, so +to just limit the upload bandwidth you would use + + --bwlimit 10M:off + +this would limit the upload bandwidth to 10MByte/s but the download +bandwidth would be unlimited. + +When specified as above the bandwidth limits last for the duration of +run of the rclone binary. + +It is also possible to specify a "timetable" of limits, which will +cause certain limits to be applied at certain times. To specify a +timetable, format your entries as `WEEKDAY-HH:MM,BANDWIDTH +WEEKDAY-HH:MM,BANDWIDTH...` where: `WEEKDAY` is optional element. + +- `BANDWIDTH` can be a single number, e.g.`100k` or a pair of numbers +for upload:download, e.g.`10M:1M`. +- `WEEKDAY` can be written as the whole word or only using the first 3 + characters. It is optional. +- `HH:MM` is an hour from 00:00 to 23:59. An example of a typical timetable to avoid link saturation during daytime working hours could be: -`--bwlimit "08:00,512 12:00,10M 13:00,512 18:00,30M 23:00,off"` +`--bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off"` -In this example, the transfer bandwidth will be every day set to 512kBytes/sec at 8am. -At noon, it will raise to 10Mbytes/s, and drop back to 512kBytes/sec at 1pm. -At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be -completely disabled (full speed). Anything between 11pm and 8am will remain -unlimited. +In this example, the transfer bandwidth will be set to 512kBytes/sec +at 8am every day. At noon, it will rise to 10Mbytes/s, and drop back +to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to +30MBytes/s, and at 11pm it will be completely disabled (full speed). +Anything between 11pm and 8am will remain unlimited. An example of timetable with `WEEKDAY` could be: `--bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off"` -It mean that, the transfer bandwidth will be set to 512kBytes/sec on Monday. -It will raise to 10Mbytes/s before the end of Friday. -At 10:00 on Sunday it will be set to 1Mbyte/s. -From 20:00 at Sunday will be unlimited. +It means that, the transfer bandwidth will be set to 512kBytes/sec on +Monday. It will rise to 10Mbytes/s before the end of Friday. At 10:00 +on Saturday it will be set to 1Mbyte/s. From 20:00 on Sunday it will +be unlimited. -Timeslots without weekday are extended to whole week. -So this one example: +Timeslots without `WEEKDAY` are extended to the whole week. So this +example: `--bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off"` -Is equal to this: +Is equivalent to this: `--bwlimit "Mon-00:00,512Mon-12:00,1M Tue-12:00,1M Wed-12:00,1M Thu-12:00,1M Fri-12:00,1M Sat-12:00,1M Sun-12:00,1M Sun-20:00,off"` -Bandwidth limits only apply to the data transfer. They don't apply to the -bandwidth of the directory listings etc. +Bandwidth limit apply to the data transfer for all backends. For most +backends the directory listing bandwidth is also included (exceptions +being the non HTTP backends, `ftp`, `sftp` and `tardigrade`). -Note that the units are Bytes/s, not Bits/s. Typically connections are -measured in Bits/s - to convert divide by 8. For example, let's say -you have a 10 Mbit/s connection and you wish rclone to use half of it -- 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would use a `--bwlimit -0.625M` parameter for rclone. +Note that the units are **Bytes/s**, not **Bits/s**. Typically +connections are measured in Bits/s - to convert divide by 8. For +example, let's say you have a 10 Mbit/s connection and you wish rclone +to use half of it - 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would +use a `--bwlimit 0.625M` parameter for rclone. On Unix systems (Linux, macOS, …) the bandwidth limiter can be toggled by sending a `SIGUSR2` signal to rclone. This allows to remove the limitations @@ -6205,6 +6429,9 @@ transfers as soon as possible. This flag can be useful on IO limited systems where transfers interfere with checking. +It can also be useful to ensure perfect ordering when using +`--order-by`. + Using this flag can use more memory as it effectively sets `--max-backlog` to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start. @@ -6212,7 +6439,7 @@ objects to transfer is held in memory before the transfers start. ### --checkers=N ### The number of checkers to run in parallel. Checkers do the equality -checking of files during a sync. For some storage systems (eg S3, +checking of files during a sync. For some storage systems (e.g. S3, Swift, Dropbox) this can take a significant amount of time so they are run in parallel. @@ -6228,7 +6455,7 @@ This is useful when the remote doesn't support setting modified time and a more accurate sync is desired than just checking the file size. This is very useful when transferring between remotes which store the -same hash type on the object, eg Drive and Swift. For details of which +same hash type on the object, e.g. Drive and Swift. For details of which remotes support which hash type see the table in the [overview section](https://rclone.org/overview/). @@ -6266,7 +6493,7 @@ for Rclone to use it, it will never be created automatically. If you run `rclone config file` you will see where the default location is for you. -Use this flag to override the config location, eg `rclone +Use this flag to override the config location, e.g. `rclone --config=".myconfig" .config`. ### --contimeout=TIME ### @@ -6282,10 +6509,10 @@ connection to go through to a remote object storage system. It is When using `sync`, `copy` or `move` DIR is checked in addition to the destination for files. If a file identical to the source is found that -file is server side copied from DIR to the destination. This is useful +file is server-side copied from DIR to the destination. This is useful for incremental backup. -The remote in use must support server side copy and you must +The remote in use must support server-side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. @@ -6298,7 +6525,7 @@ Mode to run dedupe command in. One of `interactive`, `skip`, `first`, `newest`, ### --disable FEATURE,FEATURE,... ### This disables a comma separated list of optional features. For example -to disable server side move and server side copy use: +to disable server-side move and server-side copy use: --disable move,copy @@ -6313,7 +6540,7 @@ See the overview [features](https://rclone.org/overview/#features) and which feature does what. This flag can be useful for debugging and in exceptional circumstances -(eg Google Drive limiting the total volume of Server Side Copies to +(e.g. Google Drive limiting the total volume of Server Side Copies to 100GB/day). ### -n, --dry-run ### @@ -6502,6 +6729,8 @@ This can be useful for tracking down problems with syncs in combination with the `-v` flag. See the [Logging section](#logging) for more info. +If FILE exists then rclone will append to it. + Note that if you are using the `logrotate` program to manage rclone's logs, then you should use the `copytruncate` option as rclone doesn't have a signal to rotate logs. @@ -6699,7 +6928,7 @@ This means that: - the destination is not listed minimising the API calls - files are always transferred -- this can cause duplicates on remotes which allow it (eg Google Drive) +- this can cause duplicates on remotes which allow it (e.g. Google Drive) - `--retries 1` is recommended otherwise you'll transfer everything again on a retry This flag is useful to minimise the transactions if you know that none @@ -6755,7 +6984,7 @@ When using this flag, rclone won't update modification times of remote files if they are incorrect as it would normally. This can be used if the remote is being synced with another tool also -(eg the Google Drive client). +(e.g. the Google Drive client). ### --order-by string ### @@ -6776,7 +7005,7 @@ This can have a modifier appended with a comma: - `mixed` - order so that the smallest is processed first for some threads and the largest for others If the modifier is `mixed` then it can have an optional percentage -(which defaults to `50`), eg `size,mixed,25` which means that 25% of +(which defaults to `50`), e.g. `size,mixed,25` which means that 25% of the threads should be taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The `mixed` @@ -6810,6 +7039,10 @@ Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of `--order-by` as being more of a best efforts flag rather than a perfect ordering. +If you want perfect ordering then you will need to specify +[--check-first](#check-first) which will find all the files which need +transferring first before transferring any. + ### --password-command SpaceSepList ### This flag supplies a program which should supply the config password @@ -6851,6 +7084,11 @@ Note: On Windows until [this bug](https://github.com/Azure/go-ansiterm/issues/26 is fixed all non-ASCII characters will be replaced with `.` when `--progress` is in use. +### --progress-terminal-title ### + +This flag, when used with `-P/--progress`, will print the string `ETA: %s` +to the terminal title. + ### -q, --quiet ### This flag will limit rclone's output to error messages only. @@ -6865,7 +7103,7 @@ This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them. This flag is **only** useful for destinations which don't support -hashes (eg `crypt`). +hashes (e.g. `crypt`). This can be used any of the sync commands `sync`, `copy` or `move`. @@ -6878,7 +7116,7 @@ to see if there is an existing file on the destination. If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re-uploading it, rclone will update the timestamp on the destination file. If the checksum does not -match rclone will upload the new file. If the checksum is absent (eg +match rclone will upload the new file. If the checksum is absent (e.g. on a `crypt` backend) then rclone will update the timestamp. Note that some remotes can't set the modification time without @@ -6988,7 +7226,7 @@ overwritten or deleted will have the suffix added to them. If there is a file with the same path (after the suffix has been added), then it will be overwritten. -The remote in use must support server side move or copy and you must +The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. This is for use with files to add the suffix in the current directory @@ -6996,11 +7234,17 @@ or with `--backup-dir`. See `--backup-dir` for more info. For example - rclone sync -i /path/to/local/file remote:current --suffix .bak + rclone copy -i /path/to/local/file remote:current --suffix .bak -will sync `/path/to/local` to `remote:current`, but for any files +will copy `/path/to/local` to `remote:current`, but for any files which would have been updated or deleted have .bak added. +If using `rclone sync` with `--suffix` and without `--backup-dir` then +it is recommended to put a filter rule in excluding the suffix +otherwise the `sync` will delete the backup files. + + rclone sync -i /path/to/local/file remote:current --suffix .bak --exclude "*.bak" + ### --suffix-keep-extension ### When using `--suffix`, setting this causes rclone put the SUFFIX @@ -7019,26 +7263,35 @@ This can be useful for running rclone in a script or `rclone mount`. ### --syslog-facility string ### -If using `--syslog` this sets the syslog facility (eg `KERN`, `USER`). +If using `--syslog` this sets the syslog facility (e.g. `KERN`, `USER`). See `man syslog` for a list of possible facilities. The default facility is `DAEMON`. ### --tpslimit float ### -Limit HTTP transactions per second to this. Default is 0 which is used -to mean unlimited transactions per second. +Limit transactions per second to this number. Default is 0 which is +used to mean unlimited transactions per second. -For example to limit rclone to 10 HTTP transactions per second use +A transaction is roughly defined as an API call; its exact meaning +will depend on the backend. For HTTP based backends it is an HTTP +PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip +transaction over TCP. + +For example to limit rclone to 10 transactions per second use `--tpslimit 10`, or to 1 transaction every 2 seconds use `--tpslimit 0.5`. Use this when the number of transactions per second from rclone is -causing a problem with the cloud storage provider (eg getting you +causing a problem with the cloud storage provider (e.g. getting you banned or rate limited). This can be very useful for `rclone mount` to control the behaviour of applications using it. +This limit applies to all HTTP based backends and to the FTP and SFTP +backends. It does not apply to the local backend or the Tardigrade +backend. + See also `--tpslimit-burst`. ### --tpslimit-burst int ### @@ -7063,8 +7316,8 @@ By default, rclone doesn't keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy. -If you use this flag, and the remote supports server side copy or -server side move, and the source and destination have a compatible +If you use this flag, and the remote supports server-side copy or +server-side move, and the source and destination have a compatible hash, then this will track renames during `sync` operations and perform renaming server-side. @@ -7132,7 +7385,7 @@ there were IO errors`. ### --fast-list ### -When doing anything which involves a directory listing (eg `sync`, +When doing anything which involves a directory listing (e.g. `sync`, `copy`, `ls` - in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. This can be parallelised and works very @@ -7140,7 +7393,7 @@ quickly using the least amount of memory. However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. These tend to -be the bucket based remotes (eg S3, B2, GCS, Swift, Hubic). +be the bucket based remotes (e.g. S3, B2, GCS, Swift, Hubic). If you use the `--fast-list` flag then rclone will use this method for listing directories. This will have the following consequences for @@ -7403,7 +7656,7 @@ Developer options These options are useful when developing or debugging rclone. There are also some more remote specific options which aren't documented -here which are used for testing. These start with remote name eg +here which are used for testing. These start with remote name e.g. `--drive-test-option` - see the docs for the remote in question. ### --cpuprofile=FILE ### @@ -7513,7 +7766,7 @@ Logging rclone has 4 levels of logging, `ERROR`, `NOTICE`, `INFO` and `DEBUG`. By default, rclone logs to standard error. This means you can redirect -standard error and still see the normal output of rclone commands (eg +standard error and still see the normal output of rclone commands (e.g. `rclone ls`). By default, rclone will produce `Error` and `Notice` level messages. @@ -7534,7 +7787,7 @@ If you use the `--log-file=FILE` option, rclone will redirect `Error`, If you use the `--syslog` flag then rclone will log to syslog and the `--syslog-facility` control which facility it uses. -Rclone prefixes all log messages with their level in capitals, eg INFO +Rclone prefixes all log messages with their level in capitals, e.g. INFO which makes it easy to grep the log file for different kinds of information. @@ -7629,11 +7882,11 @@ you must create the `..._TYPE` variable as above. The various different methods of backend configuration are read in this order and the first one with a value is used. -- Flag values as supplied on the command line, eg `--drive-use-trash`. -- Remote specific environment vars, eg `RCLONE_CONFIG_MYREMOTE_USE_TRASH` (see above). -- Backend specific environment vars, eg `RCLONE_DRIVE_USE_TRASH`. -- Config file, eg `use_trash = false`. -- Default values, eg `true` - these can't be changed. +- Flag values as supplied on the command line, e.g. `--drive-use-trash`. +- Remote specific environment vars, e.g. `RCLONE_CONFIG_MYREMOTE_USE_TRASH` (see above). +- Backend specific environment vars, e.g. `RCLONE_DRIVE_USE_TRASH`. +- Config file, e.g. `use_trash = false`. +- Default values, e.g. `true` - these can't be changed. So if both `--drive-use-trash` is supplied on the config line and an environment variable `RCLONE_DRIVE_USE_TRASH` is set, the command line @@ -7641,9 +7894,9 @@ flag will take preference. For non backend configuration the order is as follows: -- Flag values as supplied on the command line, eg `--stats 5s`. -- Environment vars, eg `RCLONE_STATS=5s`. -- Default values, eg `1m` - these can't be changed. +- Flag values as supplied on the command line, e.g. `--stats 5s`. +- Environment vars, e.g. `RCLONE_STATS=5s`. +- Default values, e.g. `1m` - these can't be changed. ### Other environment variables ### @@ -7659,7 +7912,7 @@ Some of the configurations (those involving oauth2) require an Internet connected web browser. If you are trying to set rclone up on a remote or headless box with no -browser available on it (eg a NAS or a server in a datacenter) then +browser available on it (e.g. a NAS or a server in a datacenter) then you will need to use an alternative means of configuration. There are two ways of doing it, described below. @@ -7739,92 +7992,89 @@ Configuration file is stored at: /home/user/.rclone.conf ``` -Now transfer it to the remote box (scp, cut paste, ftp, sftp etc) and +Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) and place it in the correct place (use `rclone config file` on the remote box to find out where). -# Filtering, includes and excludes # +# Filtering, includes and excludes -Rclone has a sophisticated set of include and exclude rules. Some of -these are based on patterns and some on other things like file size. +Filter flags determine which files rclone `sync`, `move`, `ls`, `lsl`, +`md5sum`, `sha1sum`, `size`, `delete`, `check` and similar commands +apply to. -The filters are applied for the `copy`, `sync`, `move`, `ls`, `lsl`, -`md5sum`, `sha1sum`, `size`, `delete` and `check` operations. -Note that `purge` does not obey the filters. +They are specified in terms of path/file name patterns; path/file +lists; file age and size, or presence of a file in a directory. Bucket +based remotes without the concept of directory apply filters to object +key, age and size in an analogous way. -Each path as it passes through rclone is matched against the include -and exclude rules like `--include`, `--exclude`, `--include-from`, -`--exclude-from`, `--filter`, or `--filter-from`. The simplest way to -try them out is using the `ls` command, or `--dry-run` together with -`-v`. `--filter-from`, `--exclude-from`, `--include-from`, `--files-from`, -`--files-from-raw` understand `-` as a file name to mean read from standard -input. +Rclone `purge` does not obey filters. -## Patterns ## +To test filters without risk of damage to data, apply them to `rclone +ls`, or with the `--dry-run` and `-vv` flags. -The patterns used to match files for inclusion or exclusion are based -on "file globs" as used by the unix shell. +Rclone filter patterns can only be used in filter command line options, not +in the specification of a remote. -If the pattern starts with a `/` then it only matches at the top level -of the directory tree, **relative to the root of the remote** (not -necessarily the root of the local drive). If it doesn't start with `/` -then it is matched starting at the **end of the path**, but it will -only match a complete path element: +E.g. `rclone copy "remote:dir*.jpg" /path/to/dir` does not have a filter effect. +`rclone copy remote:dir /path/to/dir --include "*.jpg"` does. - file.jpg - matches "file.jpg" - - matches "directory/file.jpg" - - doesn't match "afile.jpg" - - doesn't match "directory/afile.jpg" - /file.jpg - matches "file.jpg" in the root directory of the remote - - doesn't match "afile.jpg" - - doesn't match "directory/file.jpg" +**Important** Avoid mixing any two of `--include...`, `--exclude...` or +`--filter...` flags in an rclone command. The results may not be what +you expect. Instead use a `--filter...` flag. -**Important** Note that you must use `/` in patterns and not `\` even -if running on Windows. +## Patterns for matching path/file names -A `*` matches anything but not a `/`. +### Pattern syntax - *.jpg - matches "file.jpg" - - matches "directory/file.jpg" - - doesn't match "file.jpg/something" +Rclone matching rules follow a glob style: -Use `**` to match anything, including slashes (`/`). + `*` matches any sequence of non-separator (`/`) characters + `**` matches any sequence of characters including `/` separators + `?` matches any single non-separator (`/`) character + `[` [ `!` ] { character-range } `]` + character class (must be non-empty) + `{` pattern-list `}` + pattern alternatives + c matches character c (c != `*`, `**`, `?`, `\`, `[`, `{`, `}`) + `\` c matches character c - dir/** - matches "dir/file.jpg" - - matches "dir/dir1/dir2/file.jpg" - - doesn't match "directory/file.jpg" - - doesn't match "adir/file.jpg" +character-range: -A `?` matches any character except a slash `/`. + c matches character c (c != `\\`, `-`, `]`) + `\` c matches character c + lo `-` hi matches character c for lo <= c <= hi - l?ss - matches "less" - - matches "lass" - - doesn't match "floss" +pattern-list: -A `[` and `]` together make a character class, such as `[a-z]` or -`[aeiou]` or `[[:alpha:]]`. See the [go regexp -docs](https://golang.org/pkg/regexp/syntax/) for more info on these. + pattern { `,` pattern } + comma-separated (without spaces) patterns - h[ae]llo - matches "hello" - - matches "hallo" - - doesn't match "hullo" +character classes (see [Go regular expression reference](https://golang.org/pkg/regexp/syntax/)) include: -A `{` and `}` define a choice between elements. It should contain a -comma separated list of patterns, any of which might match. These -patterns can contain wildcards. + Named character classes (e.g. [\d], [^\d], [\D], [^\D]) + Perl character classes (e.g. \s, \S, \w, \W) + ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]]) - {one,two}_potato - matches "one_potato" - - matches "two_potato" - - doesn't match "three_potato" - - doesn't match "_potato" +If the filter pattern starts with a `/` then it only matches +at the top level of the directory tree, +**relative to the root of the remote** (not necessarily the root +of the drive). If it does not start with `/` then it is matched +starting at the **end of the path/file name** but it only matches +a complete path element - it must match from a `/` +separator or the beginning of the path/file. -Special characters can be escaped with a `\` before them. + file.jpg - matches "file.jpg" + - matches "directory/file.jpg" + - doesn't match "afile.jpg" + - doesn't match "directory/afile.jpg" + /file.jpg - matches "file.jpg" in the root directory of the remote + - doesn't match "afile.jpg" + - doesn't match "directory/file.jpg" - \*.jpg - matches "*.jpg" - \\.jpg - matches "\.jpg" - \[one\].jpg - matches "[one].jpg" +**Important** Use `/` in path/file name patterns and not `\` even if +running on Microsoft Windows. -Patterns are case sensitive unless the `--ignore-case` flag is used. +Simple patterns are case sensitive unless the `--ignore-case` flag is used. Without `--ignore-case` (default) @@ -7836,82 +8086,9 @@ With `--ignore-case` potato - matches "potato" - matches "POTATO" -Note also that rclone filter globs can only be used in one of the -filter command line flags, not in the specification of the remote, so -`rclone copy "remote:dir*.jpg" /path/to/dir` won't work - what is -required is `rclone --include "*.jpg" copy remote:dir /path/to/dir` +## How filter rules are applied to files -### Directories ### - -Rclone keeps track of directories that could match any file patterns. - -Eg if you add the include rule - - /a/*.jpg - -Rclone will synthesize the directory include rule - - /a/ - -If you put any rules which end in `/` then it will only match -directories. - -Directory matches are **only** used to optimise directory access -patterns - you must still match the files that you want to match. -Directory matches won't optimise anything on bucket based remotes (eg -s3, swift, google compute storage, b2) which don't have a concept of -directory. - -### Differences between rsync and rclone patterns ### - -Rclone implements bash style `{a,b,c}` glob matching which rsync doesn't. - -Rclone always does a wildcard match so `\` must always escape a `\`. - -## How the rules are used ## - -Rclone maintains a combined list of include rules and exclude rules. - -Each file is matched in order, starting from the top, against the rule -in the list until it finds a match. The file is then included or -excluded according to the rule type. - -If the matcher fails to find a match after testing against all the -entries in the list then the path is included. - -For example given the following rules, `+` being include, `-` being -exclude, - - - secret*.jpg - + *.jpg - + *.png - + file2.avi - - * - -This would include - - * `file1.jpg` - * `file3.png` - * `file2.avi` - -This would exclude - - * `secret17.jpg` - * non `*.jpg` and `*.png` - -A similar process is done on directory entries before recursing into -them. This only works on remotes which have a concept of directory -(Eg local, google drive, onedrive, amazon drive) and not on bucket -based remotes (eg s3, swift, google compute storage, b2). - -## Adding filtering rules ## - -Filtering rules are added with the following command line flags. - -### Repeating options ## - -You can repeat the following options to add more than one rule of that -type. +Rclone path / file name filters are made up of one or more of the following flags: * `--include` * `--include-from` @@ -7919,108 +8096,282 @@ type. * `--exclude-from` * `--filter` * `--filter-from` - * `--filter-from-raw` -**Important** You should not use `--include*` together with `--exclude*`. -It may produce different results than you expected. In that case try to use: `--filter*`. +There can be more than one instance of individual flags. -Note that all the options of the same type are processed together in -the order above, regardless of what order they were placed on the -command line. +Rclone internally uses a combined list of all the include and exclude +rules. The order in which rules are processed can influence the result +of the filter. -So all `--include` options are processed first in the order they -appeared on the command line, then all `--include-from` options etc. +All flags of the same type are processed together in the order +above, regardless of what order the different types of flags are +included on the command line. -To mix up the order includes and excludes, the `--filter` flag can be -used. +Multiple instances of the same flag are processed from left +to right according to their position in the command line. -### `--exclude` - Exclude files matching pattern ### +To mix up the order of processing includes and excludes use `--filter...` +flags. -Add a single exclude rule with `--exclude`. +Within `--include-from`, `--exclude-from` and `--filter-from` flags +rules are processed from top to bottom of the referenced file.. -This flag can be repeated. See above for the order the flags are +If there is an `--include` or `--include-from` flag specified, rclone +implies a `- **` rule which it adds to the bottom of the internal rule +list. Specifying a `+` rule with a `--filter...` flag does not imply +that rule. + +Each path/file name passed through rclone is matched against the +combined filter list. At first match to a rule the path/file name +is included or excluded and no further filter rules are processed for +that path/file. + +If rclone does not find a match, after testing against all rules +(including the implied rule if appropriate), the path/file name +is included. + +Any path/file included at that stage is processed by the rclone +command. + +`--files-from` and `--files-from-raw` flags over-ride and cannot be +combined with other filter options. + +To see the internal combined rule list, in regular expression form, +for a command add the `--dump filters` flag. Running an rclone command +with `--dump filters` and `-vv` flags lists the internal filter elements +and shows how they are applied to each source path/file. There is not +currently a means provided to pass regular expression filter options into +rclone directly though character class filter rules contain character +classes. [Go regular expression reference](https://golang.org/pkg/regexp/syntax/) + +### How filter rules are applied to directories + +Rclone commands filter, and are applied to, path/file names not +directories. The entire contents of a directory can be matched +to a filter by the pattern `directory/*` or recursively by +`directory/**`. + +Directory filter rules are defined with a closing `/` separator. + +E.g. `/directory/subdirectory/` is an rclone directory filter rule. + +Rclone commands can use directory filter rules to determine whether they +recurse into subdirectories. This potentially optimises access to a remote +by avoiding listing unnecessary directories. Whether optimisation is +desirable depends on the specific filter rules and source remote content. + +Optimisation occurs if either: + +* A source remote does not support the rclone `ListR` primitive. `local`, +`sftp`, `Microsoft OneDrive` and `WebDav` do not support `ListR`. Google +Drive and most bucket type storage do. [Full list](https://rclone.org/overview/#optional-features) + +* On other remotes, if the rclone command is not naturally recursive, +provided it is not run with the `--fast-list` flag. `ls`, `lsf -R` and +`size` are recursive but `sync`, `copy` and `move` are not. + +* Whenever the `--disable ListR` flag is applied to an rclone command. + +Rclone commands imply directory filter rules from path/file filter +rules. To view the directory filter rules rclone has implied for a +command specify the `--dump filters` flag. + +E.g. for an include rule + + /a/*.jpg + +Rclone implies the directory include rule + + /a/ + +Directory filter rules specified in an rclone command can limit +the scope of an rclone command but path/file filters still have +to be specified. + +E.g. `rclone ls remote: --include /directory/` will not match any +files. Because it is an `--include` option the `--exclude **` rule +is implied, and the `\directory\` pattern serves only to optimise +access to the remote by ignoring everything outside of that directory. + +E.g. `rclone ls remote: --filter-from filter-list.txt` with a file +`filter-list.txt`: + + - /dir1/ + - /dir2/ + + *.pdf + - ** + +All files in directories `dir1` or `dir2` or their subdirectories +are completely excluded from the listing. Only files of suffix +`'pdf` in the root of `remote:` or its subdirectories are listed. +The `- **` rule prevents listing of any path/files not previously +matched by the rules above. + +Option `exclude-if-present` creates a directory exclude rule based +on the presence of a file in a directory and takes precedence over +other rclone directory filter rules. + +### `--exclude` - Exclude files matching pattern + +Excludes path/file names from an rclone command based on a single exclude +rule. + +This flag can be repeated. See above for the order filter flags are processed in. -Eg `--exclude *.bak` to exclude all bak files from the sync. +`--exclude` should not be used with `--include`, `--include-from`, +`--filter` or `--filter-from` flags. -### `--exclude-from` - Read exclude patterns from file ### +`--exclude` has no effect when combined with `--files-from` or +`--files-from-raw` flags. -Add exclude rules from a file. +E.g. `rclone ls remote: --exclude *.bak` excludes all .bak files +from listing. -This flag can be repeated. See above for the order the flags are -processed in. +E.g. `rclone size remote: "--exclude /dir/**"` returns the total size of +all files on `remote:` excluding those in root directory `dir` and sub +directories. -Prepare a file like this `exclude-file.txt` +E.g. on Microsoft Windows `rclone ls remote: --exclude "*\[{JP,KR,HK}\]*"` +lists the files in `remote:` with `[JP]` or `[KR]` or `[HK]` in +their name. The single quotes prevent the shell from interpreting the `\` +characters. The `\` characters escape the `[` and `]` so ran clone filter +treats them literally rather than as a character-range. The `{` and `}` +define an rclone pattern list. For other operating systems single quotes are +required ie `rclone ls remote: --exclude '*\[{JP,KR,HK}\]*'` + +### `--exclude-from` - Read exclude patterns from file + +Excludes path/file names from an rclone command based on rules in a +named file. The file contains a list of remarks and pattern rules. + +For an example `exclude-file.txt`: # a sample exclude rule file *.bak file2.jpg -Then use as `--exclude-from exclude-file.txt`. This will sync all -files except those ending in `bak` and `file2.jpg`. +`rclone ls remote: --exclude-from exclude-file.txt` lists the files on +`remote:` except those named `file2.jpg` or with a suffix `.bak`. That is +equivalent to `rclone ls remote: --exclude file2.jpg --exclude "*.bak"`. -This is useful if you have a lot of rules. - -### `--include` - Include files matching pattern ### - -Add a single include rule with `--include`. - -This flag can be repeated. See above for the order the flags are +This flag can be repeated. See above for the order filter flags are processed in. -Eg `--include *.{png,jpg}` to include all `png` and `jpg` files in the -backup and no others. +The `--exclude-from` flag is useful where multiple exclude filter rules +are applied to an rclone command. -This adds an implicit `--exclude *` at the very end of the filter -list. This means you can mix `--include` and `--include-from` with the -other filters (eg `--exclude`) but you must include all the files you -want in the include statement. If this doesn't provide enough -flexibility then you must use `--filter-from`. +`--exclude-from` should not be used with `--include`, `--include-from`, +`--filter` or `--filter-from` flags. -### `--include-from` - Read include patterns from file ### +`--exclude-from` has no effect when combined with `--files-from` or +`--files-from-raw` flags. -Add include rules from a file. +`--exclude-from` followed by `-` reads filter rules from standard input. -This flag can be repeated. See above for the order the flags are +### `--include` - Include files matching pattern + +Adds a single include rule based on path/file names to an rclone +command. + +This flag can be repeated. See above for the order filter flags are processed in. -Prepare a file like this `include-file.txt` +`--include` has no effect when combined with `--files-from` or +`--files-from-raw` flags. + +`--include` implies `--exclude **` at the end of an rclone internal +filter list. Therefore if you mix `--include` and `--include-from` +flags with `--exclude`, `--exclude-from`, `--filter` or `--filter-from`, +you must use include rules for all the files you want in the include +statement. For more flexibility use the `--filter-from` flag. + +E.g. `rclone ls remote: --include "*.{png,jpg}"` lists the files on +`remote:` with suffix `.png` and `.jpg`. All other files are excluded. + +E.g. multiple rclone copy commands can be combined with `--include` and a +pattern-list. + + rclone copy /vol1/A remote:A + rclone copy /vol1/B remote:B + +is equivalent to: + + rclone copy /vol1 remote: --include "{A,B}/**" + +E.g. `rclone ls remote:/wheat --include "??[^[:punct:]]*"` lists the +files `remote:` directory `wheat` (and subdirectories) whose third +character is not punctuation. This example uses +an [ASCII character class](https://golang.org/pkg/regexp/syntax/). + +### `--include-from` - Read include patterns from file + +Adds path/file names to an rclone command based on rules in a +named file. The file contains a list of remarks and pattern rules. + +For an example `include-file.txt`: # a sample include rule file *.jpg - *.png file2.avi -Then use as `--include-from include-file.txt`. This will sync all -`jpg`, `png` files and `file2.avi`. +`rclone ls remote: --include-from include-file.txt` lists the files on +`remote:` with name `file2.avi` or suffix `.jpg`. That is equivalent to +`rclone ls remote: --include file2.avi --include "*.jpg"`. -This is useful if you have a lot of rules. - -This adds an implicit `--exclude *` at the very end of the filter -list. This means you can mix `--include` and `--include-from` with the -other filters (eg `--exclude`) but you must include all the files you -want in the include statement. If this doesn't provide enough -flexibility then you must use `--filter-from`. - -### `--filter` - Add a file-filtering rule ### - -This can be used to add a single include or exclude rule. Include -rules start with `+ ` and exclude rules start with `- `. A special -rule called `!` can be used to clear the existing rules. - -This flag can be repeated. See above for the order the flags are +This flag can be repeated. See above for the order filter flags are processed in. -Eg `--filter "- *.bak"` to exclude all bak files from the sync. +The `--include-from` flag is useful where multiple include filter rules +are applied to an rclone command. -### `--filter-from` - Read filtering patterns from a file ### +`--include-from` implies `--exclude **` at the end of an rclone internal +filter list. Therefore if you mix `--include` and `--include-from` +flags with `--exclude`, `--exclude-from`, `--filter` or `--filter-from`, +you must use include rules for all the files you want in the include +statement. For more flexibility use the `--filter-from` flag. -Add include/exclude rules from a file. +`--exclude-from` has no effect when combined with `--files-from` or +`--files-from-raw` flags. -This flag can be repeated. See above for the order the flags are +`--exclude-from` followed by `-` reads filter rules from standard input. + +### `--filter` - Add a file-filtering rule + +Specifies path/file names to an rclone command, based on a single +include or exclude rule, in `+` or `-` format. + +This flag can be repeated. See above for the order filter flags are processed in. -Prepare a file like this `filter-file.txt` +`--filter +` differs from `--include`. In the case of `--include` rclone +implies an `--exclude *` rule which it adds to the bottom of the internal rule +list. `--filter...+` does not imply +that rule. + +`--filter` has no effect when combined with `--files-from` or +`--files-from-raw` flags. + +`--filter` should not be used with `--include`, `--include-from`, +`--exclude` or `--exclude-from` flags. + +E.g. `rclone ls remote: --filter "- *.bak"` excludes all `.bak` files +from a list of `remote:`. + +### `--filter-from` - Read filtering patterns from a file + +Adds path/file names to an rclone command based on rules in a +named file. The file contains a list of remarks and pattern rules. Include +rules start with `+ ` and exclude rules with `- `. `!` clears existing +rules. Rules are processed in the order they are defined. + +This flag can be repeated. See above for the order filter flags are +processed in. + +Arrange the order of filter rules with the most restrictive first and +work down. + +E.g. For `filter-file.txt`: # a sample filter rule file - secret*.jpg @@ -8032,228 +8383,264 @@ Prepare a file like this `filter-file.txt` # exclude everything else - * -Then use as `--filter-from filter-file.txt`. The rules are processed -in the order that they are defined. +`rclone ls remote: --filter-from filter-file.txt` lists the path/files on +`remote:` including all `jpg` and `png` files, excluding any +matching `secret*.jpg` and including `file2.avi`. It also includes +everything in the directory `dir` at the root of `remote`, except +`remote:dir/Trash` which it excludes. Everything else is excluded. -This example will include all `jpg` and `png` files, exclude any files -matching `secret*.jpg` and include `file2.avi`. It will also include -everything in the directory `dir` at the root of the sync, except -`dir/Trash` which it will exclude. Everything else will be excluded -from the sync. -### `--files-from` - Read list of source-file names ### +E.g. for an alternative `filter-file.txt`: -This reads a list of file names from the file passed in and **only** -these files are transferred. The **filtering rules are ignored** -completely if you use this option. + - secret*.jpg + + *.jpg + + *.png + + file2.avi + - * -`--files-from` expects a list of files as its input. Leading / trailing -whitespace is stripped from the input lines and lines starting with `#` -and `;` are ignored. +Files `file1.jpg`, `file3.png` and `file2.avi` are listed whilst +`secret17.jpg` and files without the suffix .jpg` or `.png` are excluded. -Rclone will traverse the file system if you use `--files-from`, -effectively using the files in `--files-from` as a set of filters. -Rclone will not error if any of the files are missing. +E.g. for an alternative `filter-file.txt`: -If you use `--no-traverse` as well as `--files-from` then rclone will -not traverse the destination file system, it will find each file -individually using approximately 1 API call. This can be more -efficient for small lists of files. + + *.jpg + + *.gif + ! + + 42.doc + - * -This option can be repeated to read from more than one file. These -are read in the order that they are placed on the command line. +Only file 42.doc is listed. Prior rules are cleared by the `!`. -Paths within the `--files-from` file will be interpreted as starting -with the root specified in the command. Leading `/` characters are -ignored. See [--files-from-raw](#files-from-raw-read-list-of-source-file-names-without-any-processing) -if you need the input to be processed in a raw manner. +### `--files-from` - Read list of source-file names -For example, suppose you had `files-from.txt` with this content: +Adds path/files to an rclone command from a list in a named file. +Rclone processes the path/file names in the order of the list, and +no others. + +Other filter flags (`--include`, `--include-from`, `--exclude`, +`--exclude-from`, `--filter` and `--filter-from`) are ignored when +`--files-from` is used. + +`--files-from` expects a list of files as its input. Leading or +trailing whitespace is stripped from the input lines. Lines starting +with `#` or `;` are ignored. + +Rclone commands with a `--files-from` flag traverse the remote, +treating the names in `--files-from` as a set of filters. + +If the `--no-traverse` and `--files-from` flags are used together +an rclone command does not traverse the remote. Instead it addresses +each path/file named in the file individually. For each path/file name, that +requires typically 1 API call. This can be efficient for a short `--files-from` +list and a remote containing many files. + +Rclone commands do not error if any names in the `--files-from` file are +missing from the source remote. + +The `--files-from` flag can be repeated in a single rclone command to +read path/file names from more than one file. The files are read from left +to right along the command line. + +Paths within the `--files-from` file are interpreted as starting +with the root specified in the rclone command. Leading `/` separators are +ignored. See [--files-from-raw](#files-from-raw-read-list-of-source-file-names-without-any-processing) if +you need the input to be processed in a raw manner. + +E.g. for a file `files-from.txt`: # comment file1.jpg subdir/file2.jpg -You could then use it like this: - - rclone copy --files-from files-from.txt /home/me/pics remote:pics - -This will transfer these files only (if they exist) +`rclone copy --files-from files-from.txt /home/me/pics remote:pics` +copies the following, if they exist, and only those files. /home/me/pics/file1.jpg → remote:pics/file1.jpg /home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg -To take a more complicated example, let's say you had a few files you -want to back up regularly with these absolute paths: +E.g. to copy the following files referenced by their absolute paths: - /home/user1/important - /home/user1/dir/file - /home/user2/stuff + /home/user1/42 + /home/user1/dir/ford + /home/user2/prefect -To copy these you'd find a common subdirectory - in this case `/home` +First find a common subdirectory - in this case `/home` and put the remaining files in `files-from.txt` with or without -leading `/`, eg +leading `/`, e.g. - user1/important - user1/dir/file - user2/stuff + user1/42 + user1/dir/ford + user2/prefect -You could then copy these to a remote like this +Then copy these to a remote: rclone copy --files-from files-from.txt /home remote:backup -The 3 files will arrive in `remote:backup` with the paths as in the -`files-from.txt` like this: +The three files are transferred as follows: - /home/user1/important → remote:backup/user1/important - /home/user1/dir/file → remote:backup/user1/dir/file - /home/user2/stuff → remote:backup/user2/stuff + /home/user1/42 → remote:backup/user1/important + /home/user1/dir/ford → remote:backup/user1/dir/file + /home/user2/prefect → remote:backup/user2/stuff -You could of course choose `/` as the root too in which case your -`files-from.txt` might look like this. +Alternatively if `/` is chosen as root `files-from.txt` would be: - /home/user1/important - /home/user1/dir/file - /home/user2/stuff + /home/user1/42 + /home/user1/dir/ford + /home/user2/prefect -And you would transfer it like this +The copy command would be: rclone copy --files-from files-from.txt / remote:backup -In this case there will be an extra `home` directory on the remote: +Then there will be an extra `home` directory on the remote: - /home/user1/important → remote:backup/home/user1/important - /home/user1/dir/file → remote:backup/home/user1/dir/file - /home/user2/stuff → remote:backup/home/user2/stuff + /home/user1/42 → remote:backup/home/user1/42 + /home/user1/dir/ford → remote:backup/home/user1/dir/ford + /home/user2/prefect → remote:backup/home/user2/prefect -### `--files-from-raw` - Read list of source-file names without any processing ### -This option is same as `--files-from` with the only difference being that the input -is read in a raw manner. This means that lines with leading/trailing whitespace and -lines starting with `;` or `#` are read without any processing. [rclone lsf](https://rclone.org/commands/rclone_lsf/) -has a compatible format that can be used to export file lists from remotes, which -can then be used as an input to `--files-from-raw`. +### `--files-from-raw` - Read list of source-file names without any processing -### `--min-size` - Don't transfer any file smaller than this ### +This flag is the same as `--files-from` except that input is read in a +raw manner. Lines with leading / trailing whitespace, and lines starting +with `;` or `#` are read without any processing. [rclone lsf](https://rclone.org/commands/rclone_lsf/) has +a compatible format that can be used to export file lists from remotes for +input to `--files-from-raw`. -This option controls the minimum size file which will be transferred. -This defaults to `kBytes` but a suffix of `k`, `M`, or `G` can be -used. +### `--ignore-case` - make searches case insensitive -For example `--min-size 50k` means no files smaller than 50kByte will be -transferred. +By default rclone filter patterns are case sensitive. The `--ignore-case` +flag makes all of the filters patterns on the command line case +insensitive. -### `--max-size` - Don't transfer any file larger than this ### +E.g. `--include "zaphod.txt"` does not match a file `Zaphod.txt`. With +`--ignore-case` a match is made. -This option controls the maximum size file which will be transferred. -This defaults to `kBytes` but a suffix of `k`, `M`, or `G` can be -used. +## Quoting shell metacharacters -For example `--max-size 1G` means no files larger than 1GByte will be -transferred. +Rclone commands with filter patterns containing shell metacharacters may +not as work as expected in your shell and may require quoting. -### `--max-age` - Don't transfer any file older than this ### - -This option controls the maximum age of files to transfer. Give in -seconds or with a suffix of: - - * `ms` - Milliseconds - * `s` - Seconds - * `m` - Minutes - * `h` - Hours - * `d` - Days - * `w` - Weeks - * `M` - Months - * `y` - Years - -For example `--max-age 2d` means no files older than 2 days will be -transferred. - -This can also be an absolute time in one of these formats - -- RFC3339 - eg "2006-01-02T15:04:05Z07:00" -- ISO8601 Date and time, local timezone - "2006-01-02T15:04:05" -- ISO8601 Date and time, local timezone - "2006-01-02 15:04:05" -- ISO8601 Date - "2006-01-02" (YYYY-MM-DD) - -### `--min-age` - Don't transfer any file younger than this ### - -This option controls the minimum age of files to transfer. Give in -seconds or with a suffix (see `--max-age` for list of suffixes) - -For example `--min-age 2d` means no files younger than 2 days will be -transferred. - -### `--delete-excluded` - Delete files on dest excluded from sync ### - -**Important** this flag is dangerous - use with `--dry-run` and `-v` first. - -When doing `rclone sync` this will delete any files which are excluded -from the sync on the destination. - -If for example you did a sync from `A` to `B` without the `--min-size 50k` flag - - rclone sync -i A: B: - -Then you repeated it like this with the `--delete-excluded` - - rclone --min-size 50k --delete-excluded sync A: B: - -This would delete all files on `B` which are less than 50 kBytes as -these are now excluded from the sync. - -Always test first with `--dry-run` and `-v` before using this flag. - -### `--dump filters` - dump the filters to the output ### - -This dumps the defined filters to the output as regular expressions. - -Useful for debugging. - -### `--ignore-case` - make searches case insensitive ### - -Normally filter patterns are case sensitive. If this flag is supplied -then filter patterns become case insensitive. - -Normally a `--include "file.txt"` will not match a file called -`FILE.txt`. However if you use the `--ignore-case` flag then -`--include "file.txt"` this will match a file called `FILE.txt`. - -## Quoting shell metacharacters ## - -The examples above may not work verbatim in your shell as they have -shell metacharacters in them (eg `*`), and may require quoting. - -Eg linux, OSX +E.g. linux, OSX (`*` metacharacter) * `--include \*.jpg` * `--include '*.jpg'` * `--include='*.jpg'` -In Windows the expansion is done by the command not the shell so this -should work fine +Microsoft Windows expansion is done by the command, not shell, so +`--include *.jpg` does not require quoting. - * `--include *.jpg` +If the rclone error +`Command .... needs .... arguments maximum: you provided .... non flag arguments:` +is encountered, the cause is commonly spaces within the name of a +remote or flag value. The fix then is to quote values containing spaces. -## Exclude directory based on a file ## +## Other filters -It is possible to exclude a directory based on a file, which is -present in this directory. Filename should be specified using the -`--exclude-if-present` flag. This flag has a priority over the other -filtering flags. +### `--min-size` - Don't transfer any file smaller than this -Imagine, you have the following directory structure: +Controls the minimum size file within the scope of an rclone command. +Default units are `kBytes` but abbreviations `k`, `M`, or `G` are valid. + +E.g. `rclone ls remote: --min-size 50k` lists files on `remote:` of 50kByte +size or larger. + +### `--max-size` - Don't transfer any file larger than this + +Controls the maximum size file within the scope of an rclone command. +Default units are `kBytes` but abbreviations `k`, `M`, or `G` are valid. + +E.g. `rclone ls remote: --max-size 1G` lists files on `remote:` of 1GByte +size or smaller. + +### `--max-age` - Don't transfer any file older than this + +Controls the maximum age of files within the scope of an rclone command. +Default units are seconds or the following abbreviations are valid: + + * `ms` - Milliseconds + * `s` - Seconds + * `m` - Minutes + * `h` - Hours + * `d` - Days + * `w` - Weeks + * `M` - Months + * `y` - Years + +`--max-age` can also be specified as an absolute time in the following +formats: + +- RFC3339 - e.g. "2006-01-02T15:04:05Z07:00" +- ISO8601 Date and time, local timezone - "2006-01-02T15:04:05" +- ISO8601 Date and time, local timezone - "2006-01-02 15:04:05" +- ISO8601 Date - "2006-01-02" (YYYY-MM-DD) + +`--max-age` applies only to files and not to directories. + +E.g. `rclone ls remote: --max-age 2d` lists files on `remote:` of 2 days +old or less. + +### `--min-age` - Don't transfer any file younger than this + +Controls the minimum age of files within the scope of an rclone command. +(see `--max-age` for valid formats) + +`--min-age` applies only to files and not to directories. + +E.g. `rclone ls remote: --min-age 2d` lists files on `remote:` of 2 days +old or more. + +## Other flags + +### `--delete-excluded` - Delete files on dest excluded from sync + +**Important** this flag is dangerous to your data - use with `--dry-run` +and `-v` first. + +In conjunction with `rclone sync` the `--delete-excluded deletes any files +on the destination which are excluded from the command. + +E.g. the scope of `rclone sync -i A: B:` can be restricted: + + rclone --min-size 50k --delete-excluded sync A: B: + +All files on `B:` which are less than 50 kBytes are deleted +because they are excluded from the rclone sync command. + +### `--dump filters` - dump the filters to the output + +Dumps the defined filters to standard output in regular expression +format. + +Useful for debugging. + +## Exclude directory based on a file + +The `--exclude-if-present` flag controls whether a directory is +within the scope of an rclone command based on the presence of a +named file within it. + +This flag has a priority over other filter flags. + +E.g. for the following directory structure: dir1/file1 dir1/dir2/file2 dir1/dir2/dir3/file3 dir1/dir2/dir3/.ignore -You can exclude `dir3` from sync by running the following command: +The command `rclone ls --exclude-if-present .ignore dir1` does +not list `dir3`, `file3` or `.ignore`. - rclone sync -i --exclude-if-present .ignore dir1 remote:backup +`--exclude-if-present` can only be used once in an rclone command. -Currently only one filename is supported, i.e. `--exclude-if-present` -should not be used multiple times. +## Common pitfalls + +The most frequent filter support issues on +the [rclone forum](https://https://forum.rclone.org/) are: + +* Not using paths relative to the root of the remote +* Not using `/` to match from the root of a remote +* Not using `**` to match the contents of a directory # GUI (Experimental) @@ -8361,9 +8748,12 @@ If you have questions then please ask them on the [rclone forum](https://forum.r # Remote controlling rclone with its API -If rclone is run with the `--rc` flag then it starts an http server +If rclone is run with the `--rc` flag then it starts an HTTP server which can be used to remote control rclone using its API. +You can either use the [rclone rc](#api-rc) command to access the API +or [use HTTP directly](#api-http). + If you just want to run a remote control then see the [rcd command](https://rclone.org/commands/rclone_rcd/). ## Supported parameters @@ -8503,7 +8893,7 @@ use these methods. The alternative is to use `--rc-user` and Default Off. -## Accessing the remote control via the rclone rc command +## Accessing the remote control via the rclone rc command {#api-rc} Rclone itself implements the remote control protocol in its `rclone rc` command. @@ -8574,7 +8964,7 @@ background. The `job/status` call can be used to get information of the background job. The job can be queried for up to 1 minute after it has finished. -It is recommended that potentially long running jobs, eg `sync/sync`, +It is recommended that potentially long running jobs, e.g. `sync/sync`, `sync/copy`, `sync/move`, `operations/purge` are run with the `_async` flag to avoid any potential problems with the HTTP request and response timing out. @@ -8654,7 +9044,7 @@ $ rclone rc --json '{ "group": "job/1" }' core/stats This takes the following parameters - command - a string with the command name -- fs - a remote name string eg "drive:" +- fs - a remote name string e.g. "drive:" - arg - a list of arguments for the backend command - opt - a map of string to string of options @@ -8727,7 +9117,7 @@ Some valid examples are: "0:10" -> the first ten chunks Any parameter with a key that starts with "file" can be used to -specify files to fetch, eg +specify files to fetch, e.g. rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye @@ -8830,18 +9220,30 @@ See the [config update command](https://rclone.org/commands/rclone_config_update ### core/bwlimit: Set the bandwidth limit. {#core-bwlimit} -This sets the bandwidth limit to that passed in. +This sets the bandwidth limit to the string passed in. This should be +a single bandwidth limit entry or a pair of upload:download bandwidth. Eg rclone rc core/bwlimit rate=off { "bytesPerSecond": -1, + "bytesPerSecondTx": -1, + "bytesPerSecondRx": -1, "rate": "off" } rclone rc core/bwlimit rate=1M { "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 1048576, + "rate": "1M" + } + rclone rc core/bwlimit rate=1M:100k + { + "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 131072, "rate": "1M" } @@ -8851,6 +9253,8 @@ If the rate parameter is not supplied then the bandwidth is queried rclone rc core/bwlimit { "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 1048576, "rate": "1M" } @@ -8867,17 +9271,22 @@ This takes the following parameters - command - a string with the command name - arg - a list of arguments for the backend command - opt - a map of string to string of options +- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") + - defaults to "COMBINED_OUTPUT" if not set + - the STREAM returnTypes will write the output to the body of the HTTP message + - the COMBINED_OUTPUT will write the output to the "result" parameter Returns - result - result from the backend command + - only set when using returnType "COMBINED_OUTPUT" - error - set if rclone exits with an error code -- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT". "STREAM_ONLY_STDERR") +- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") For example rclone rc core/command command=ls -a mydrive:/ -o max-depth=1 - rclone rc core/command -a ls -a mydrive:/ -o max-depth=1 + rclone rc core/command -a ls -a mydrive:/ -o max-depth=1 Returns @@ -8893,6 +9302,8 @@ OR "result": "" } +``` + **Authentication is required for this call.** ### core/gc: Runs a garbage collection. {#core-gc} @@ -9049,7 +9460,7 @@ Returns the following values: This shows the current version of go and the go runtime -- version - rclone version, eg "v1.53.0" +- version - rclone version, e.g. "v1.53.0" - decomposed - version number as [major, minor, patch] - isGit - boolean - true if this was compiled from the git version - isBeta - boolean - true if this is a beta version @@ -9113,11 +9524,11 @@ 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") +- endTime - time the job finished (e.g. "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") +- startTime - time the job started (e.g. "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 @@ -9219,7 +9630,7 @@ Eg This takes the following parameters -- fs - a remote name string eg "drive:" +- fs - a remote name string e.g. "drive:" The result is as returned from rclone about --json @@ -9231,7 +9642,7 @@ See the [about command](https://rclone.org/commands/rclone_size/) command for mo This takes the following parameters -- fs - a remote name string eg "drive:" +- fs - a remote name string e.g. "drive:" See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. @@ -9241,10 +9652,10 @@ See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command f 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 +- srcFs - a remote name string e.g. "drive:" for the source +- srcRemote - a path within that remote e.g. "file.txt" for the source +- dstFs - a remote name string e.g. "drive2:" for the destination +- dstRemote - a path within that remote e.g. "file2.txt" for the destination **Authentication is required for this call.** @@ -9252,8 +9663,8 @@ 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 e.g. "drive:" +- remote - a path within that remote e.g. "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. @@ -9264,7 +9675,7 @@ See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command f This takes the following parameters -- fs - a remote name string eg "drive:" +- fs - a remote name string e.g. "drive:" See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above. @@ -9274,8 +9685,8 @@ See the [delete command](https://rclone.org/commands/rclone_delete/) command for 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. @@ -9285,7 +9696,7 @@ See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) com This takes the following parameters -- fs - a remote name string eg "drive:" +- fs - a remote name string e.g. "drive:" This returns info about the remote passed in; @@ -9342,8 +9753,8 @@ This command does not have a command line equivalent so use this instead: 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" - opt - a dictionary of options to control the listing (optional) - recurse - If set recurse directories - noModTime - If set return modification time @@ -9364,8 +9775,8 @@ See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more in 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. @@ -9375,10 +9786,10 @@ See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for m 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 +- srcFs - a remote name string e.g. "drive:" for the source +- srcRemote - a path within that remote e.g. "file.txt" for the source +- dstFs - a remote name string e.g. "drive2:" for the destination +- dstRemote - a path within that remote e.g. "file2.txt" for the destination **Authentication is required for this call.** @@ -9386,10 +9797,10 @@ 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" - unlink - boolean - if set removes the link rather than adding it (optional) -- expire - string - the expiry time of the link eg "1d" (optional) +- expire - string - the expiry time of the link e.g. "1d" (optional) Returns @@ -9403,8 +9814,8 @@ See the [link command](https://rclone.org/commands/rclone_link/) command for mor 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. @@ -9414,8 +9825,8 @@ See the [purge command](https://rclone.org/commands/rclone_purge/) command for m 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. @@ -9425,8 +9836,8 @@ See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for m 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 e.g. "drive:" +- remote - a path within that remote e.g. "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. @@ -9437,7 +9848,7 @@ See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for This takes the following parameters -- fs - a remote name string eg "drive:path/to/dir" +- fs - a remote name string e.g. "drive:path/to/dir" Returns @@ -9452,8 +9863,8 @@ See the [size command](https://rclone.org/commands/rclone_size/) command for mor 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 e.g. "drive:" +- remote - a path within that remote e.g. "dir" - each part in body represents a file to be uploaded See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above. @@ -9519,8 +9930,8 @@ This shows all possible plugins by a mime type This takes the following parameters -- type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3) -- pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) +- type: supported mime type by a loaded plugin e.g. (video/mp4, audio/mp3) +- pluginType: filter plugins based on their type e.g. (DASHBOARD, FILE_HANDLER, TERMINAL) and returns @@ -9568,7 +9979,7 @@ This allows you to remove a plugin using it's name This takes parameters -- name: name of the plugin in the format / +- name: name of the plugin in the format `author`/`plugin_name` Eg @@ -9582,7 +9993,7 @@ This allows you to remove a plugin using it's name This takes the following parameters -- name: name of the plugin in the format / +- name: name of the plugin in the format `author`/`plugin_name` Eg @@ -9618,8 +10029,8 @@ check that parameter passing is working properly. 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 +- srcFs - a remote name string e.g. "drive:src" for the source +- dstFs - a remote name string e.g. "drive:dst" for the destination See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above. @@ -9630,8 +10041,8 @@ See the [copy command](https://rclone.org/commands/rclone_copy/) command for mor 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 +- srcFs - a remote name string e.g. "drive:src" for the source +- dstFs - a remote name string e.g. "drive:dst" for the destination - deleteEmptySrcDirs - delete empty src directories if set @@ -9643,8 +10054,8 @@ See the [move command](https://rclone.org/commands/rclone_move/) command for mor 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 +- srcFs - a remote name string e.g. "drive:src" for the source +- dstFs - a remote name string e.g. "drive:dst" for the destination See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. @@ -9663,7 +10074,7 @@ directory cache. 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 +starting with dir will forget that dir, e.g. rclone rc vfs/forget file=hello file2=goodbye dir=home/junk @@ -9717,7 +10128,7 @@ 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 +starting with dir will refresh that directory, e.g. rclone rc vfs/refresh dir=home/junk dir2=data/misc @@ -9731,7 +10142,7 @@ must be supplied. -## Accessing the remote control via HTTP +## Accessing the remote control via HTTP {#api-http} Rclone implements a simple HTTP based protocol. @@ -9750,9 +10161,9 @@ formatted to be reasonably human readable. ### Error returns -If an error occurs then there will be an HTTP error status (eg 500) +If an error occurs then there will be an HTTP error status (e.g. 500) and the body of the response will contain a JSON encoded error object, -eg +e.g. ``` { @@ -9968,34 +10379,64 @@ Here is an overview of the major features of each cloud storage system. | Backblaze B2 | SHA1 | Yes | No | No | R/W | | Box | SHA1 | Yes | Yes | No | - | | Citrix ShareFile | MD5 | Yes | Yes | No | - | -| Dropbox | DBHASH † | Yes | Yes | No | - | +| Dropbox | DBHASH ¹ | Yes | Yes | No | - | +| Enterprise File Fabric | - | Yes | Yes | No | R/W | | 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 | +| HDFS | - | Yes | No | No | - | | HTTP | - | No | No | No | R | | Hubic | MD5 | Yes | No | No | R/W | -| Jottacloud | MD5 | Yes | Yes | No | R/W | +| Jottacloud | MD5 | Yes | Yes | No | R | | Koofr | MD5 | No | Yes | No | - | -| Mail.ru Cloud | Mailru ‡‡‡ | Yes | Yes | No | - | +| Mail.ru Cloud | Mailru ⁶ | Yes | Yes | No | - | | Mega | - | No | No | Yes | - | | Memory | MD5 | Yes | No | No | - | | Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | -| Microsoft OneDrive | SHA1 ‡‡ | Yes | Yes | No | R | -| OpenDrive | MD5 | Yes | Yes | Partial \* | - | +| Microsoft OneDrive | SHA1 ⁵ | Yes | Yes | No | R | +| OpenDrive | MD5 | Yes | Yes | Partial ⁸ | - | | OpenStack Swift | MD5 | Yes | No | No | R/W | -| pCloud | MD5, SHA1 | Yes | No | No | W | +| pCloud | MD5, SHA1 ⁷ | Yes | No | No | W | | premiumize.me | - | No | Yes | No | R | | put.io | CRC-32 | Yes | No | Yes | R | | QingStor | MD5 | No | No | No | R/W | | Seafile | - | No | No | No | - | -| SFTP | MD5, SHA1 ‡ | Yes | Depends | No | - | +| SFTP | MD5, SHA1 ² | Yes | Depends | No | - | | SugarSync | - | No | No | No | - | | Tardigrade | - | Yes | No | No | - | -| WebDAV | MD5, SHA1 ††| Yes ††† | Depends | No | - | -| Yandex Disk | MD5 | Yes | No | No | R/W | +| WebDAV | MD5, SHA1 ³ | Yes ⁴ | Depends | No | - | +| Yandex Disk | MD5 | Yes | No | No | R | +| Zoho WorkDrive | - | No | No | No | - | | The local filesystem | All | Yes | Depends | No | - | +### Notes + +¹ 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 + +⁷ pCloud only supports SHA1 (not MD5) in its EU region + +⁸ Opendrive does not support creation of duplicate files using +their web client interface or other stock clients, but the underlying +storage platform has been determined to allow duplicate files, and it +is possible to create them with `rclone`. It may be that this is a +mistake or an unsupported feature. + ### Hash ### The cloud storage system supports various hash types of the objects. @@ -10006,23 +10447,6 @@ 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 @@ -10036,7 +10460,7 @@ 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 +have two files which differ only in case, e.g. `file.txt` and `FILE.txt`. If a cloud storage system is case insensitive then that isn't possible. @@ -10049,7 +10473,7 @@ 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) + * Linux - usually case sensitive, but there are case insensitive file systems (e.g. 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 @@ -10063,12 +10487,6 @@ objects with the same name. This confuses rclone greatly when syncing - use the `rclone dedupe` command to rename or remove duplicates. -\* Opendrive does not support creation of duplicate files using -their web client interface or other stock clients, but the underlying -storage platform has been determined to allow duplicate files, and it -is possible to create them with `rclone`. It may be that this is a -mistake or an unsupported feature. - ### Restricted filenames ### Some cloud storage systems might have restrictions on the characters @@ -10187,7 +10605,7 @@ disable the encoding completely with `--backend-encoding None` or set Encoding takes a comma separated list of encodings. You can see the list of all available characters by passing an invalid value to this -flag, eg `--local-encoding "help"` and `rclone help flags encoding` +flag, e.g. `--local-encoding "help"` and `rclone help flags encoding` will show you the defaults for the backends. | Encoding | Characters | @@ -10203,7 +10621,7 @@ will show you the defaults for the backends. | Dot | `.` | | DoubleQuote | `"` | | Hash | `#` | -| InvalidUtf8 | An invalid UTF-8 character (eg latin1) | +| InvalidUtf8 | An invalid UTF-8 character (e.g. latin1) | | LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string | | LeftPeriod | `.` on the left of a string | | LeftSpace | SPACE on the left of a string | @@ -10248,7 +10666,7 @@ This can be specified using the `--local-encoding` flag or using an ### MIME Type ### MIME types (also known as media types) classify types of documents -using a simple text classification, eg `text/html` or +using a simple text classification, e.g. `text/html` or `application/pdf`. Some cloud storage systems support reading (`R`) the MIME type of @@ -10264,9 +10682,8 @@ 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. +All rclone remotes support a base command set. Other features depend +upon backend specific capabilities. | Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir | | ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| :------: | @@ -10277,10 +10694,12 @@ operations more efficient. | Box | Yes | Yes | Yes | Yes | Yes ‡‡ | No | Yes | Yes | No | Yes | | Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | Yes | No | No | Yes | | Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | Yes | Yes | +| Enterprise File Fabric | Yes | Yes | Yes | Yes | No | No | No | No | No | 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 | +| HDFS | Yes | No | No | No | No | No | Yes | No | Yes | Yes | | HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | | Hubic | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | | Jottacloud | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | @@ -10301,6 +10720,7 @@ operations more efficient. | Tardigrade | Yes † | No | No | No | No | Yes | Yes | No | No | No | | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | +| Zoho WorkDrive | Yes | Yes | Yes | Yes | No | No | No | No | Yes | Yes | | The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | ### Purge ### @@ -10317,7 +10737,7 @@ files other than deleting them individually. ### 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 +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. @@ -10327,7 +10747,7 @@ 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 +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 @@ -10348,7 +10768,7 @@ If the server can't do `CleanUp` then `rclone cleanup` will return an error. ‡‡ Note that while Box implements this it has to delete every file -idividually so it will be slower than emptying the trash via the WebUI +individually so it will be slower than emptying the trash via the WebUI ### ListR ### @@ -10370,13 +10790,17 @@ 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. +Rclone `about` prints quota information for a remote. Typical output +includes bytes used, free, quota and in trash. -This is also used to return the space used, available for `rclone mount`. +If a remote lacks about capability `rclone about remote:`returns +an error. -If the server can't do `About` then `rclone about` will return an -error. +Backends without about capability cannot determine free space for an +rclone mount, or use policy `mfs` (most free space) as a member of an +rclone union remote. + +See [rclone about command](https://rclone.org/commands/rclone_about/) ### EmptyDir ### @@ -10449,6 +10873,7 @@ These flags are available for every command. --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") + --log-systemd Activate systemd integration for the logger. --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) @@ -10466,13 +10891,15 @@ These flags are available for every command. --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) --no-check-certificate Do not verify the server SSL certificate. Insecure. --no-check-dest Don't check the destination, copy regardless. + --no-console Hide console window. Supported on Windows only. --no-gzip-encoding Don't set Accept-Encoding: gzip. --no-traverse Don't traverse destination file system on copy. --no-unicode-normalization Don't normalize unicode characters in filenames. --no-update-modtime Don't update destination mod-time if files identical. - --order-by string Instructions on how to order the transfers, eg 'size,descending' + --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --password-command SpaceSepList Command for supplying password for encrypted configuration. -P, --progress Show progress during transfer. + --progress-terminal-title Show progress on the terminal title. Requires -P/--progress. -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") @@ -10515,11 +10942,11 @@ These flags are available for every command. --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") + --syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON") --timeout duration IO idle timeout (default 5m0s) --tpslimit float Limit HTTP transactions per second to this. --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) - --track-renames When synchronizing, track file renames and do a server side move if possible + --track-renames When synchronizing, track file renames and do a server-side move if possible --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") --transfers int Number of file transfers to run in parallel. (default 4) -u, --update Skip files that are newer on the destination. @@ -10527,7 +10954,7 @@ These flags are available for every command. --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata - --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.54.0") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -10548,6 +10975,7 @@ and may be set in the config file. --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-archive-tier-delete Delete archive tier blobs before overwriting. --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) --azureblob-disable-checksum Don't store MD5 checksum with object metadata. --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) @@ -10556,9 +10984,14 @@ and may be set in the config file. --azureblob-list-chunk int Size of blob list. (default 5000) --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified. + --azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified. + --azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified. --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-service-principal-file string Path to file containing credentials for use with a service principal. + --azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256MB). (Deprecated) --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) + --azureblob-use-msi Use a managed service identity to authenticate (only works in Azure) --b2-account string Account ID or Application Key ID --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) @@ -10594,7 +11027,7 @@ and may be set in the config file. --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-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.). (default 6h0m0s) --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server --cache-plex-password string The password of the Plex user (obscured) --cache-plex-url string The URL of the Plex server @@ -10609,24 +11042,25 @@ and may be set in the config file. --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) + --compress-level int GZIP compression level (-2 to 9). (default -1) + --compress-mode string Compression mode. (default "gzip") + --compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size. (default 20M) + --compress-remote string Remote to compress. -L, --copy-links Follow symlinks and copy the pointed to item. --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) --crypt-filename-encryption string How to encrypt the filenames. (default "standard") --crypt-password string Password or pass phrase for encryption. (obscured) --crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) --crypt-remote string Remote to encrypt/decrypt. - --crypt-server-side-across-configs Allow server side operations (eg copy) to work across different crypt configs. + --crypt-server-side-across-configs Allow server-side operations (e.g. copy) to work across different crypt configs. --crypt-show-mapping For all files listed show how the names encrypt. --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. --drive-auth-owner-only Only consider files owned by the authenticated user. --drive-auth-url string Auth server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) - --drive-client-id string OAuth Client Id + --drive-client-id string Google Application Client Id --drive-client-secret string OAuth Client Secret --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) @@ -10640,7 +11074,7 @@ and may be set in the config file. --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-server-side-across-configs Allow server-side operations (e.g. 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. @@ -10649,6 +11083,7 @@ and may be set in the config file. --drive-skip-gdocs Skip google documents in all listings. --drive-skip-shortcuts If set skip shortcut files --drive-starred-only Only show files that are starred. + --drive-stop-on-download-limit Make download limit errors be fatal --drive-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Team Drive --drive-token string OAuth Access Token as a JSON blob. @@ -10665,20 +11100,30 @@ and may be set in the config file. --dropbox-client-secret string OAuth Client Secret --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-impersonate string Impersonate this user when using a business account. + --dropbox-shared-files Instructs rclone to work on individual shared files. + --dropbox-shared-folders Instructs rclone to work on shared folders. --dropbox-token string OAuth Access Token as a JSON blob. --dropbox-token-url string Token server url. --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) --fichier-shared-folder string If you want to download a shared folder, add this parameter + --filefabric-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --filefabric-permanent-token string Permanent Authentication Token + --filefabric-root-folder-id string ID of the root folder + --filefabric-token string Session Token + --filefabric-token-expiry string Token expiry time + --filefabric-url string URL of the Enterprise File Fabric to connect to + --filefabric-version string Version read from the file fabric --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited --ftp-disable-epsv Disable using EPSV even if server advertises support + --ftp-disable-mlsd Disable using MLSD even if server advertises support --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) - --ftp-explicit-tls Use FTP over TLS (Explicit) + --ftp-explicit-tls Use Explicit FTPS (FTP over TLS) --ftp-host string FTP host to connect to --ftp-no-check-certificate Do not verify the TLS certificate of the server --ftp-pass string FTP password (obscured) --ftp-port string FTP port, leave blank to use default (21) - --ftp-tls Use FTPS over TLS (Implicit) + --ftp-tls Use Implicit FTPS (FTP over TLS) --ftp-user string FTP username, leave blank for current username, $USER --gcs-anonymous Access public buckets and objects without credentials --gcs-auth-url string Auth server URL. @@ -10697,11 +11142,17 @@ and may be set in the config file. --gphotos-auth-url string Auth server URL. --gphotos-client-id string OAuth Client Id --gphotos-client-secret string OAuth Client Secret + --gphotos-include-archived Also view and download archived media. --gphotos-read-only Set to make the Google Photos backend read only. --gphotos-read-size Set to read the size of media items. --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) --gphotos-token string OAuth Access Token as a JSON blob. --gphotos-token-url string Token server url. + --hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy + --hdfs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot) + --hdfs-namenode string hadoop name node and port + --hdfs-service-principal-name string Kerberos service principal name for the namenode + --hdfs-username string hadoop user name --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 / @@ -10734,6 +11185,7 @@ and may be set in the config file. --local-no-sparse Disable sparse files for multi-thread downloads --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) --local-nounc string Disable UNC (long path names) conversion on Windows + --local-zero-size-links Assume the Stat size of links is zero (and read them instead) --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) --mailru-pass string Password (obscured) @@ -10754,10 +11206,14 @@ and may be set in the config file. --onedrive-client-secret string OAuth Client Secret --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) - --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. + --onedrive-link-password string Set the password for links created by the link command. + --onedrive-link-scope string Set the scope of the links created by the link command. (default "anonymous") + --onedrive-link-type string Set the type of the links created by the link command. (default "view") --onedrive-no-versions Remove all versions on modifying operations - --onedrive-server-side-across-configs Allow server side operations (eg copy) to work across different onedrive configs. + --onedrive-region string Choose national cloud region for OneDrive. (default "global") + --onedrive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different onedrive configs. --onedrive-token string OAuth Access Token as a JSON blob. --onedrive-token-url string Token server url. --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) @@ -10790,6 +11246,7 @@ and may be set in the config file. --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) --s3-disable-checksum Don't store MD5 checksum with object metadata + --s3-disable-http2 Disable usage of http2 for S3 backends --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) --s3-endpoint string Endpoint for S3 API. --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). @@ -10800,17 +11257,19 @@ and may be set in the config file. --s3-max-upload-parts int Maximum number of parts in a multipart upload. (default 10000) --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --s3-no-check-bucket If set don't attempt to check the bucket exists or create it + --s3-no-check-bucket If set, don't attempt to check the bucket exists or create it + --s3-no-head If set, don't HEAD uploaded objects to check integrity --s3-profile string Profile to use in the shared credentials file --s3-provider string Choose your S3 provider. --s3-region string Region to connect to. + --s3-requester-pays Enables requester pays option when interacting with S3 bucket. --s3-secret-access-key string AWS Secret Access Key (password) --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. --s3-session-token string An AWS session token --s3-shared-credentials-file string Path to the shared credentials file --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. - --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. + --s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional). --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) @@ -10832,17 +11291,20 @@ and may be set in the config file. --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. --sftp-key-use-agent When set forces the usage of the ssh-agent. + --sftp-known-hosts-file string Optional path to known_hosts file. --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) --sftp-path-override string Override path used by SSH connection. --sftp-port string SSH port, leave blank to use default (22) + --sftp-pubkey-file string Optional path to public key file. --sftp-server-command string Specifies the path or command to run a sftp server on the remote host. --sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. --sftp-skip-links Set to skip any symlinks and any other non regular files. --sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp") + --sftp-use-fstat If set use fstat instead of stat --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 + --sftp-user string SSH username, leave blank for current username, $USER --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) --sharefile-endpoint string Endpoint for API calls. @@ -10872,6 +11334,7 @@ and may be set in the config file. --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-leave-parts-on-error If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions. --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 @@ -10891,7 +11354,7 @@ and may be set in the config file. --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") --union-upstreams string List of space separated upstreams. - --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) + --webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon) --webdav-bearer-token-command string Command to run to get a bearer token --webdav-pass string Password. (obscured) --webdav-url string URL of http host to connect to @@ -10903,6 +11366,8 @@ and may be set in the config file. --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-token string OAuth Access Token as a JSON blob. --yandex-token-url string Token server url. + --zoho-encoding MultiEncoder This sets the encoding for the backend. (default Del,Ctl,InvalidUtf8) + --zoho-region string Zoho region to connect to. You'll have to use the region you organization is registered in. ``` 1Fichier @@ -10914,7 +11379,7 @@ the API. Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for 1Fichier involves getting the API key from the website which you need to do in your browser. @@ -11053,6 +11518,15 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +### Limitations + +`rclone about` is not supported by the 1Fichier backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Alias ----------------------------------------- @@ -11060,7 +11534,7 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin 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`. +e.g. `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. @@ -11460,6 +11934,14 @@ failure. To avoid this problem, use `--max-size 50000M` option to limit the maximum size of uploaded files. Note that `--max-size` does not split files into segments, it only ignores files over this size. +`rclone about` is not supported by the Amazon Drive backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) + Amazon S3 Storage Providers -------------------------------------------------------- @@ -11475,11 +11957,12 @@ The S3 backend can be used with a number of different providers: - Minio - Scaleway - StackPath +- Tencent Cloud Object Storage (COS) - Wasabi Paths are specified as `remote:bucket` (or `remote:` for the `lsd` -command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. +command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. Once you have made a remote (see the provider specific section above) you can use it like this: @@ -11519,7 +12002,7 @@ 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) +XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -11556,7 +12039,7 @@ 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. + 1 | US Region, Northern Virginia, or Pacific Northwest. | Leave location constraint empty. \ "us-east-1" / US East (Ohio) Region @@ -11595,7 +12078,7 @@ Choose a number from below, or type in your own value / Asia Pacific (Mumbai) 13 | Needs location constraint ap-south-1. \ "ap-south-1" - / Asia Patific (Hong Kong) Region + / Asia Pacific (Hong Kong) Region 14 | Needs location constraint ap-east-1. \ "ap-east-1" / South America (Sao Paulo) Region @@ -11607,7 +12090,7 @@ 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. + 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. \ "" 2 / US East (Ohio) Region. \ "us-east-2" @@ -11704,25 +12187,6 @@ d) Delete this remote y/e/d> ``` -### --fast-list ### - -This remote supports `--fast-list` which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast-list) for more details. - -### --update and --use-server-modtime ### - -As noted below, the modified time is stored on metadata on the object. It is -used by default for all operations that require checking the time a file was -last updated. It allows rclone to treat the remote more like a true filesystem, -but it is inefficient because it requires an extra API call to retrieve the -metadata. - -For many operations, the time the object was last uploaded to the remote is -sufficient to determine if it is "dirty". By using `--update` along with -`--use-server-modtime`, you can avoid the extra API call and simply upload -files whose local modtime is newer than the time it was last uploaded. - ### Modified time ### The modified time is stored as metadata on the object as @@ -11733,6 +12197,109 @@ 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. +Note that reading this from the object takes an additional `HEAD` +request as the metadata isn't returned in object listings. + +### Reducing costs + +#### Avoiding HEAD requests to read the modification time + +By default rclone will use the modification time of objects stored in +S3 for syncing. This is stored in object metadata which unfortunately +takes an extra HEAD request to read which can be expensive (in time +and money). + +The modification time 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 on +S3 because it requires an extra API call to retrieve the metadata. + +The extra API calls can be avoided when syncing (using `rclone sync` +or `rclone copy`) in a few different ways, each with its own +tradeoffs. + +- `--size-only` + - Only checks the size of files. + - Uses no extra transactions. + - If the file doesn't change size then rclone won't detect it has + changed. + - `rclone sync --size-only /path/to/source s3:bucket` +- `--checksum` + - Checks the size and MD5 checksum of files. + - Uses no extra transactions. + - The most accurate detection of changes possible. + - Will cause the source to read an MD5 checksum which, if it is a + local disk, will cause lots of disk activity. + - If the source and destination are both S3 this is the + **recommended** flag to use for maximum efficiency. + - `rclone sync --checksum /path/to/source s3:bucket` +- `--update --use-server-modtime` + - Uses no extra transactions. + - Modification time becomes the time the object was uploaded. + - For many operations this is sufficient to determine if it needs + uploading. + - Using `--update` along with `--use-server-modtime`, avoids the + extra API call and uploads files whose local modification time + is newer than the time it was last uploaded. + - Files created with timestamps in the past will be missed by the sync. + - `rclone sync --update --use-server-modtime /path/to/source s3:bucket` + +These flags can and should be used in combination with `--fast-list` - +see below. + +If using `rclone mount` or any command using the VFS (eg `rclone +serve`) commands then you might want to consider using the VFS flag +`--no-modtime` which will stop rclone reading the modification time +for every object. You could also use `--use-server-modtime` if you are +happy with the modification times of the objects being the time of +upload. + +#### Avoiding GET requests to read directory listings + +Rclone's default directory traversal is to process each directory +individually. This takes one API call per directory. Using the +`--fast-list` flag will read all info about the the objects into +memory first using a smaller number of API calls (one per 1000 +objects). See the [rclone docs](https://rclone.org/docs/#fast-list) for more details. + + rclone sync --fast-list --checksum /path/to/source s3:bucket + +`--fast-list` trades off API transactions for memory use. As a rough +guide rclone uses 1k of memory per object stored, so using +`--fast-list` on a sync of a million objects will use roughly 1 GB of +RAM. + +If you are only copying a small number of files into a big repository +then using `--no-traverse` is a good idea. This finds objects directly +instead of through directory listings. You can do a "top-up" sync very +cheaply by using `--max-age` and `--no-traverse` to copy only recent +files, eg + + rclone copy --min-age 24h --no-traverse /path/to/source s3:bucket + +You'd then do a full `rclone sync` less often. + +Note that `--fast-list` isn't required in the top-up sync. + +### Hashes ### + +For small objects which weren't uploaded as multipart uploads (objects +sized below `--s3-upload-cutoff` if uploaded with rclone) rclone uses +the `ETag:` header as an MD5 checksum. + +However for objects which were uploaded as multipart uploads or with +server side encryption (SSE-AWS or SSE-C) the `ETag` header is no +longer the MD5 sum of the data, so rclone adds an additional piece of +metadata `X-Amz-Meta-Md5chksum` which is a base64 encoded MD5 hash (in +the same format as is required for `Content-MD5`). + +For large objects, calculating this hash can take some time so the +addition of this hash can be disabled with `--s3-disable-checksum`. +This will mean that these objects do not have an MD5 checksum. + +Note that reading this from the object takes an additional `HEAD` +request as the metadata isn't returned in object listings. + ### Cleanup ### If you run `rclone cleanup s3:bucket` then it will remove all pending @@ -11822,7 +12389,7 @@ The different authentication methods are tried in this order: - 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: + - By default it will use the profile in your home directory (e.g. `~/.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). @@ -11889,11 +12456,10 @@ 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). +If you are using server-side encryption with KMS then you must make +sure rclone is configured with `server_side_encryption = aws:kms` +otherwise you will find you can't transfer small objects - these will +create checksum errors. ### Glacier and Glacier Deep Archive ### @@ -11912,7 +12478,7 @@ Vault API, so rclone cannot directly access Glacier Vaults. ### Standard Options -Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). +Here are the standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS). #### --s3-provider @@ -11943,6 +12509,8 @@ Choose your S3 provider. - Scaleway Object Storage - "StackPath" - StackPath Object Storage + - "TencentCOS" + - Tencent Cloud Object Storage (COS) - "Wasabi" - Wasabi Object Storage - "Other" @@ -11994,17 +12562,17 @@ Region to connect to. - Examples: - "us-east-1" - The default endpoint - a good choice if you are unsure. - - US Region, Northern Virginia or Pacific Northwest. + - 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. + - "us-west-2" + - US West (Oregon) Region + - Needs location constraint us-west-2. - "ca-central-1" - Canada (Central) Region - Needs location constraint ca-central-1. @@ -12014,9 +12582,15 @@ Region to connect to. - "eu-west-2" - EU (London) Region - Needs location constraint eu-west-2. + - "eu-west-3" + - EU (Paris) Region + - Needs location constraint eu-west-3. - "eu-north-1" - EU (Stockholm) Region - Needs location constraint eu-north-1. + - "eu-south-1" + - EU (Milan) Region + - Needs location constraint eu-south-1. - "eu-central-1" - EU (Frankfurt) Region - Needs location constraint eu-central-1. @@ -12032,15 +12606,36 @@ Region to connect to. - "ap-northeast-2" - Asia Pacific (Seoul) - Needs location constraint ap-northeast-2. + - "ap-northeast-3" + - Asia Pacific (Osaka-Local) + - Needs location constraint ap-northeast-3. - "ap-south-1" - Asia Pacific (Mumbai) - Needs location constraint ap-south-1. - "ap-east-1" - - Asia Patific (Hong Kong) Region + - Asia Pacific (Hong Kong) Region - Needs location constraint ap-east-1. - "sa-east-1" - South America (Sao Paulo) Region - Needs location constraint sa-east-1. + - "me-south-1" + - Middle East (Bahrain) Region + - Needs location constraint me-south-1. + - "af-south-1" + - Africa (Cape Town) Region + - Needs location constraint af-south-1. + - "cn-north-1" + - China (Beijing) Region + - Needs location constraint cn-north-1. + - "cn-northwest-1" + - China (Ningxia) Region + - Needs location constraint cn-northwest-1. + - "us-gov-east-1" + - AWS GovCloud (US-East) Region + - Needs location constraint us-gov-east-1. + - "us-gov-west-1" + - AWS GovCloud (US) Region + - Needs location constraint us-gov-west-1. #### --s3-region @@ -12069,7 +12664,7 @@ Leave blank if you are using an S3 clone and you don't have a region. - "" - 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. + - Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH. #### --s3-endpoint @@ -12296,6 +12891,54 @@ Endpoint for StackPath Object Storage. #### --s3-endpoint +Endpoint for Tencent COS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "cos.ap-beijing.myqcloud.com" + - Beijing Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-shanghai.myqcloud.com" + - Shanghai Region. + - "cos.ap-guangzhou.myqcloud.com" + - Guangzhou Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-chengdu.myqcloud.com" + - Chengdu Region. + - "cos.ap-chongqing.myqcloud.com" + - Chongqing Region. + - "cos.ap-hongkong.myqcloud.com" + - Hong Kong (China) Region. + - "cos.ap-singapore.myqcloud.com" + - Singapore Region. + - "cos.ap-mumbai.myqcloud.com" + - Mumbai Region. + - "cos.ap-seoul.myqcloud.com" + - Seoul Region. + - "cos.ap-bangkok.myqcloud.com" + - Bangkok Region. + - "cos.ap-tokyo.myqcloud.com" + - Tokyo Region. + - "cos.na-siliconvalley.myqcloud.com" + - Silicon Valley Region. + - "cos.na-ashburn.myqcloud.com" + - Virginia Region. + - "cos.na-toronto.myqcloud.com" + - Toronto Region. + - "cos.eu-frankfurt.myqcloud.com" + - Frankfurt Region. + - "cos.eu-moscow.myqcloud.com" + - Moscow Region. + - "cos.accelerate.myqcloud.com" + - Use Tencent COS Accelerate Endpoint. + +#### --s3-endpoint + Endpoint for S3 API. Required when using an S3 clone. @@ -12330,21 +12973,25 @@ Used when creating buckets only. - Default: "" - Examples: - "" - - Empty for US Region, Northern Virginia or Pacific Northwest. + - 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. + - "us-west-2" + - US West (Oregon) Region. - "ca-central-1" - Canada (Central) Region. - "eu-west-1" - EU (Ireland) Region. - "eu-west-2" - EU (London) Region. + - "eu-west-3" + - EU (Paris) Region. - "eu-north-1" - EU (Stockholm) Region. + - "eu-south-1" + - EU (Milan) Region. - "EU" - EU Region. - "ap-southeast-1" @@ -12354,13 +13001,27 @@ Used when creating buckets only. - "ap-northeast-1" - Asia Pacific (Tokyo) Region. - "ap-northeast-2" - - Asia Pacific (Seoul) + - Asia Pacific (Seoul) Region. + - "ap-northeast-3" + - Asia Pacific (Osaka-Local) Region. - "ap-south-1" - - Asia Pacific (Mumbai) + - Asia Pacific (Mumbai) Region. - "ap-east-1" - - Asia Pacific (Hong Kong) + - Asia Pacific (Hong Kong) Region. - "sa-east-1" - South America (Sao Paulo) Region. + - "me-south-1" + - Middle East (Bahrain) Region. + - "af-south-1" + - Africa (Cape Town) Region. + - "cn-north-1" + - China (Beijing) Region + - "cn-northwest-1" + - China (Ningxia) Region. + - "us-gov-east-1" + - AWS GovCloud (US-East) Region. + - "us-gov-west-1" + - AWS GovCloud (US) Region. #### --s3-location-constraint @@ -12455,7 +13116,7 @@ This ACL is used for creating objects and if bucket_acl isn't set, for creating 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 +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 @@ -12463,6 +13124,8 @@ doesn't copy the ACL from the source but rather writes a fresh one. - Type: string - Default: "" - Examples: + - "default" + - Owner gets Full_CONTROL. No one else has access rights (default). - "private" - Owner gets FULL_CONTROL. No one else has access rights (default). - "public-read" @@ -12563,6 +13226,24 @@ The storage class to use when storing new objects in OSS. #### --s3-storage-class +The storage class to use when storing new objects in Tencent COS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "ARCHIVE" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +#### --s3-storage-class + The storage class to use when storing new objects in S3. - Config: storage_class @@ -12579,7 +13260,7 @@ The storage class to use when storing new objects in S3. ### Advanced Options -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). +Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS). #### --s3-bucket-acl @@ -12605,6 +13286,15 @@ isn't set then "acl" is used instead. - "authenticated-read" - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. +#### --s3-requester-pays + +Enables requester pays option when interacting with S3 bucket. + +- Config: requester_pays +- Env Var: RCLONE_S3_REQUESTER_PAYS +- Type: bool +- Default: false + #### --s3-sse-customer-algorithm If using SSE-C, the server-side encryption algorithm used when storing this object in S3. @@ -12633,7 +13323,10 @@ If using SSE-C you must provide the secret encryption key used to encrypt/decryp #### --s3-sse-customer-key-md5 -If using SSE-C you must provide the secret encryption key MD5 checksum. +If using SSE-C you may provide the secret encryption key MD5 checksum (optional). + +If you leave it blank, this is calculated automatically from the sse_customer_key provided. + - Config: sse_customer_key_md5 - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 @@ -12660,14 +13353,14 @@ The minimum is 0 and the maximum is 5GB. Chunk size to use for uploading. When uploading files larger than upload_cutoff or files with unknown -size (eg from "rclone rcat" or uploaded with "rclone mount" or google +size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google photos or google docs) they will be uploaded as multipart uploads using this chunk size. Note that "--s3-upload-concurrency" chunks of this size are buffered in memory per transfer. -If you are transferring large files over high speed links and you have +If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers. Rclone will automatically increase the chunk size when uploading a @@ -12676,7 +13369,7 @@ large file of known size to stay below the 10,000 chunks limit. Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5MB and there can be at most 10,000 chunks, this means that by default the maximum size of -file you can stream upload is 48GB. If you wish to stream upload +a file you can stream upload is 48GB. If you wish to stream upload larger files then you will need to increase chunk_size. - Config: chunk_size @@ -12707,7 +13400,7 @@ large file of a known size to stay below this number of chunks limit. Cutoff for switching to multipart copy -Any files larger than this that need to be server side copied will be +Any files larger than this that need to be server-side copied will be copied in chunks of this size. The minimum is 0 and the maximum is 5GB. @@ -12782,7 +13475,7 @@ 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 +If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers. @@ -12800,7 +13493,7 @@ if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. -Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to +Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting. @@ -12816,7 +13509,7 @@ 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. +Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH. - Config: v2_auth - Env Var: RCLONE_S3_V2_AUTH @@ -12865,17 +13558,58 @@ In Ceph, this can be increased with the "rgw list buckets max chunk" option. #### --s3-no-check-bucket -If set don't attempt to check the bucket exists or create it +If set, don't attempt to check the bucket exists or create it This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. +It can also be needed if the user you are using does not have bucket +creation permissions. Before v1.52.0 this would have passed silently +due to a bug. + - Config: no_check_bucket - Env Var: RCLONE_S3_NO_CHECK_BUCKET - Type: bool - Default: false +#### --s3-no-head + +If set, don't HEAD uploaded objects to check integrity + +This can be useful when trying to minimise the number of transactions +rclone does. + +Setting it means that if rclone receives a 200 OK message after +uploading an object with PUT then it will assume that it got uploaded +properly. + +In particular it will assume: + +- the metadata, including modtime, storage class and content type was as uploaded +- the size was as uploaded + +It reads the following items from the response for a single part PUT: + +- the MD5SUM +- The uploaded date + +For multipart uploads these items aren't read. + +If an source object of unknown length is uploaded then rclone **will** do a +HEAD request. + +Setting this flag increases the chance for undetected upload failures, +in particular an incorrect size, so it isn't recommended for normal +operation. In practice the chance of an undetected upload failure is +very small even with this flag. + + +- Config: no_head +- Env Var: RCLONE_S3_NO_HEAD +- Type: bool +- Default: false + #### --s3-encoding This sets the encoding for the backend. @@ -12907,6 +13641,23 @@ Whether to use mmap buffers in internal memory pool. - Type: bool - Default: false +#### --s3-disable-http2 + +Disable usage of http2 for S3 backends + +There is currently an unsolved issue with the s3 (specifically minio) backend +and HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be +disabled here. When the issue is solved this flag will be removed. + +See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631 + + + +- Config: disable_http2 +- Env Var: RCLONE_S3_DISABLE_HTTP2 +- Type: bool +- Default: false + ### Backend commands Here are the commands specific to the s3 backend. @@ -12947,7 +13698,7 @@ All the objects shown will be marked for restore, then rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard It returns a list of status dictionaries with Remote and Status -keys. The Status will be OK if it was successfull or an error message +keys. The Status will be OK if it was successful or an error message if not. [ @@ -13053,7 +13804,7 @@ server_side_encryption = storage_class = ``` -Then use it as normal with the name of the public bucket, eg +Then use it as normal with the name of the public bucket, e.g. rclone lsd anons3:1000genomes @@ -13085,7 +13836,7 @@ server_side_encryption = storage_class = ``` -If you are using an older version of CEPH, eg 10.2.x Jewel, then you +If you are using an older version of CEPH, e.g. 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. @@ -13248,7 +13999,7 @@ Choose a number from below, or type in your own value 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. +6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an endpoint address. ``` Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. @@ -13309,7 +14060,7 @@ Choose a number from below, or type in your own value 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. +9. Specify a canned ACL. IBM Cloud (Storage) 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 @@ -13483,7 +14234,7 @@ 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. + 1 | US Region, Northern Virginia, or Pacific Northwest. | Leave location constraint empty. \ "us-east-1" [snip] @@ -13494,7 +14245,7 @@ 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. + 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. \ "" [snip] location_constraint> @@ -13579,7 +14330,7 @@ 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) + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS \ "s3" [snip] Storage> s3 @@ -13624,7 +14375,7 @@ Choose a number from below, or type in your own value 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 +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 @@ -13669,19 +14420,161 @@ d) Delete this remote y/e/d> y ``` -### Netease NOS ### +### Tencent COS {#tencent-cos} + +[Tencent Cloud Object Storage (COS)](https://intl.cloud.tencent.com/product/cos) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost. + +To configure access to Tencent COS, follow the steps below: + +1. Run `rclone config` and select `n` for a new remote. + +``` +rclone config +No remotes found - make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +``` + +2. Give the name of the configuration. For example, name it 'cos'. + +``` +name> cos +``` + +3. Select `s3` storage. + +``` +Choose a number from below, or type in your own value +1 / 1Fichier + \ "fichier" + 2 / Alias for an existing remote + \ "alias" + 3 / Amazon Drive + \ "amazon cloud drive" + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + \ "s3" +[snip] +Storage> s3 +``` + +4. Select `TencentCOS` provider. +``` +Choose a number from below, or type in your own value +1 / Amazon Web Services (AWS) S3 + \ "AWS" +[snip] +11 / Tencent Cloud Object Storage (COS) + \ "TencentCOS" +[snip] +provider> TencentCOS +``` + +5. Enter your SecretId and SecretKey of Tencent Cloud. + +``` +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Enter a boolean value (true or false). Press Enter for the default ("false"). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" +env_auth> 1 +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (""). +access_key_id> AKIDxxxxxxxxxx +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (""). +secret_access_key> xxxxxxxxxxx +``` + +6. Select endpoint for Tencent COS. This is the standard endpoint for different region. + +``` + 1 / Beijing Region. + \ "cos.ap-beijing.myqcloud.com" + 2 / Nanjing Region. + \ "cos.ap-nanjing.myqcloud.com" + 3 / Shanghai Region. + \ "cos.ap-shanghai.myqcloud.com" + 4 / Guangzhou Region. + \ "cos.ap-guangzhou.myqcloud.com" +[snip] +endpoint> 4 +``` + +7. Choose acl and storage class. + +``` +Note that this ACL is applied when server-side copying objects as S3 +doesn't copy the ACL from the source but rather writes a fresh one. +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Owner gets Full_CONTROL. No one else has access rights (default). + \ "default" +[snip] +acl> 1 +The storage class to use when storing new objects in Tencent COS. +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Default + \ "" +[snip] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +-------------------- +[cos] +type = s3 +provider = TencentCOS +env_auth = false +access_key_id = xxx +secret_access_key = xxx +endpoint = cos.ap-guangzhou.myqcloud.com +acl = default +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: + +Name Type +==== ==== +cos s3 +``` + +### Netease NOS For Netease NOS configure as per the configurator `rclone config` setting the provider `Netease`. This will automatically set `force_path_style = false` which is necessary for it to run properly. +### Limitations + +`rclone about` is not supported by the S3 backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) + 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`. +command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. Here is an example of making a b2 configuration. First run @@ -13853,7 +14746,7 @@ 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`. +e.g. `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. @@ -14089,7 +14982,7 @@ This value should be set no larger than 4.657GiB (== 5GB). Cutoff for switching to multipart copy -Any files larger than this that need to be server side copied will be +Any files larger than this that need to be server-side copied will be copied in chunks of this size. The minimum is 0 and the maximum is 4.6GB. @@ -14133,7 +15026,9 @@ 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. +Rclone works with private buckets by sending an "Authorization" header. +If the custom endpoint rewrites the requests for authentication, +e.g., in Cloudflare Workers, this header needs to be handled properly. Leave blank if you want to use the endpoint provided by Backblaze. - Config: download_url @@ -14185,13 +15080,22 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot +### Limitations + +`rclone about` is not supported by the B2 backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Box ----------------------------------------- Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `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 @@ -14587,10 +15491,19 @@ 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 `＼`. +and from an identical looking unicode equivalent `＼` (U+FF3C Fullwidth +Reverse Solidus). Box only supports filenames up to 255 characters in length. +`rclone about` is not supported by the Box backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) + Cache (BETA) ----------------------------------------- @@ -14639,7 +15552,7 @@ XX / Cache a remote [snip] Storage> cache Remote to cache. -Normally should contain a ':' and a path, eg "myremote:path/to/dir", +Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). remote> local:/test Optional: The URL of the Plex server @@ -14665,7 +15578,7 @@ Choose a number from below, or type in your own value 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. +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 @@ -14901,7 +15814,7 @@ 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", +Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - Config: remote @@ -14960,7 +15873,7 @@ will need to be cleared or unexpected EOF errors will occur. #### --cache-info-age -How long to cache file structure information (directory listings, file size, times etc). +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. @@ -15244,7 +16157,7 @@ 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) +won't. This means that if you are using a bucket based remote (e.g. 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` @@ -15265,7 +16178,7 @@ XX / Transparently chunk/split large files [snip] Storage> chunker Remote to chunk/unchunk. -Normally should contain a ':' and a path, eg "myremote:path/to/dir", +Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). Enter a string value. Press Enter for the default (""). remote> remote:path @@ -15332,7 +16245,7 @@ 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 +(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 @@ -15345,7 +16258,7 @@ 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 +missing or invalid chunks, e.g. 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 @@ -15367,7 +16280,7 @@ 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. +user to start from 0, e.g. 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 @@ -15438,7 +16351,7 @@ guarantee given hash for all files. If wrapped remote doesn't support it, chunker will then add metadata to all files, even small. However, this can double the amount of small files in storage and incur additional service charges. You can even use chunker to force md5/sha1 support in any other remote -at expense of sidecar meta objects by setting eg. `chunk_type=sha1all` +at expense of sidecar meta objects by setting e.g. `chunk_type=sha1all` to force hashsums and `chunk_size=1P` to effectively disable chunking. Normally, when a file is copied to chunker controlled remote, chunker @@ -15498,7 +16411,7 @@ remove everything including garbage. ### Caveats and Limitations -Chunker requires wrapped remote to support server side `move` (or `copy` + +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. @@ -15509,7 +16422,7 @@ suffix during operations. Many file systems limit base file name without path by 255 characters. Using rclone's crypt remote as a base file system limits file name by 143 characters. Thus, maximum name length is 231 for most files and 119 for chunker-over-crypt. A user in need can change name format to -eg. `*.rcc##` and save 10 characters (provided at most 99 chunks per file). +e.g. `*.rcc##` and save 10 characters (provided at most 99 chunks per file). Note that a move implemented using the copy-and-delete method may incur double charging with some cloud storage providers. @@ -15526,6 +16439,9 @@ 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). +Chunker included in rclone releases up to `v1.54` can sometimes fail to +detect metadata produced by recent versions of rclone. We recommend users +to keep rclone up-to-date to avoid data corruption. ### Standard Options @@ -15535,7 +16451,7 @@ Here are the standard options specific to chunker (Transparently chunk/split lar #### --chunker-remote Remote to chunk/unchunk. -Normally should contain a ':' and a path, eg "myremote:path/to/dir", +Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - Config: remote @@ -15732,7 +16648,7 @@ 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`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. ### Modified time and hashes ### @@ -15865,62 +16781,141 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot +### Limitations + +`rclone about` is not supported by the Citrix ShareFile backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Crypt ---------------------------------------- -The `crypt` remote encrypts and decrypts another remote. +Rclone `crypt` remotes encrypt and decrypt other remotes. -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. +A remote of type `crypt` does not access a [storage system](https://rclone.org/overview/) +directly, but instead wraps another remote, which in turn accesses +the storage system. This is similar to how [alias](https://rclone.org/alias/), +[union](https://rclone.org/union/), [chunker](https://rclone.org/chunker/) +and a few others work. It makes the usage very flexible, as you can +add a layer, in this case an encryption layer, on top of any other +backend, even in multiple layers. Rclone's functionality +can be used as with any other remote, for example you can +[mount](https://rclone.org/commands/rclone_mount/) a crypt remote. -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. +Accessing a storage system through a crypt remote realizes client-side +encryption, which makes it safe to keep your data in a location you do +not trust will not get compromised. +When working against the `crypt` remote, rclone will automatically +encrypt (before uploading) and decrypt (after downloading) on your local +system as needed on the fly, leaving the data encrypted at rest in the +wrapped remote. If you access the storage system using an application +other than rclone, or access the wrapped remote directly using rclone, +there will not be any encryption/decryption: Downloading existing content +will just give you the encrypted (scrambled) format, and anything you +upload will *not* become encrypted. -Now configure `crypt` using `rclone config`. We will call this one -`secret` to differentiate it from the `remote`. +The encryption is a secret-key encryption (also called symmetric key encryption) +algorithm, where a password (or pass phrase) is used to generate real encryption key. +The password can be supplied by user, or you may chose to let rclone +generate one. It will be stored in the configuration file, in a lightly obscured form. +If you are in an environment where you are not able to keep your configuration +secured, you should add +[configuration encryption](https://rclone.org/docs/#configuration-encryption) +as protection. As long as you have this configuration file, you will be able to +decrypt your data. Without the configuration file, as long as you remember +the password (or keep it in a safe place), you can re-create the configuration +and gain access to the existing data. You may also configure a corresponding +remote in a different installation to access the same data. +See below for guidance to [changing password](#changing-password). + +Encryption uses [cryptographic salt](https://en.wikipedia.org/wiki/Salt_(cryptography)), +to permute the encryption key so that the same string may be encrypted in +different ways. When configuring the crypt remote it is optional to enter a salt, +or to let rclone generate a unique salt. If omitted, rclone uses a built-in unique string. +Normally in cryptography, the salt is stored together with the encrypted content, +and do not have to be memorized by the user. This is not the case in rclone, +because rclone does not store any additional information on the remotes. Use of +custom salt is effectively a second password that must be memorized. + +[File content](#file-encryption) encryption is performed using +[NaCl SecretBox](https://godoc.org/golang.org/x/crypto/nacl/secretbox), +based on XSalsa20 cipher and Poly1305 for integrity. +[Names](#name-encryption) (file- and directory names) are also encrypted +by default, but this has some implications and is therefore +possible to turned off. + +### Configuration + +Here is an example of how to make a remote called `secret`. + +To use `crypt`, first set up the underlying remote. Follow the +`rclone config` instructions for the specific backend. + +Before configuring the crypt remote, check the underlying remote is +working. In this example the underlying remote is called `remote`. +We will configure a path `path` within this remote to contain the +encrypted content. Anything inside `remote:path` will be encrypted +and anything outside will not. + +Configure `crypt` using `rclone config`. In this example the `crypt` +remote is called `secret`, to differentiate it from the underlying +`remote`. + +When you are done you can use the crypt remote named `secret` just +as you would with any other remote, e.g. `rclone copy D:\docs secret:\docs`, +and rclone will encrypt and decrypt as needed on the fly. +If you access the wrapped remote `remote:path` directly you will bypass +the encryption, and anything you read will be in encrypted form, and +anything you write will be undencrypted. To avoid issues it is best to +configure a dedicated path for encrypted content, and access it +exclusively through a crypt remote. ``` No remotes found - make a new one n) New remote s) Set configuration password q) Quit config -n/s/q> n +n/s/q> n name> secret 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 / Encrypt/Decrypt a remote \ "crypt" [snip] Storage> crypt +** See help for crypt backend at: https://rclone.org/crypt/ ** + Remote to encrypt/decrypt. 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 How to encrypt the filenames. +Enter a string value. Press Enter for the default ("standard"). 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. + 1 / Encrypt the filenames see the docs for the details. \ "standard" - 3 / Very simple filename obfuscation. + 2 / Very simple filename obfuscation. \ "obfuscate" -filename_encryption> 2 + 3 / Don't encrypt the file names. Adds a ".bin" extension only. + \ "off" +filename_encryption> Option to either encrypt directory names or leave them intact. + +NB If filename_encryption is "off" then this option will do nothing. +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 / Encrypt directory names. \ "true" 2 / Don't encrypt directory names, leave them intact. \ "false" -filename_encryption> 1 +directory_name_encryption> Password or pass phrase for encryption. y) Yes type in my own password g) Generate random password @@ -15933,7 +16928,7 @@ 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 +n) No leave this optional password blank (default) y/g/n> g Password strength in bits. 64 is just about memorable @@ -15941,67 +16936,126 @@ Password strength in bits. 1024 is the maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ -Use this password? -y) Yes +Use this password? Please note that an obscured version of this +password (and not the password itself) will be stored under your +configuration file, so keep this generated password in a safe place. +y) Yes (default) n) No -y/n> y +y/n> +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> Remote config -------------------- [secret] +type = crypt remote = remote:path -filename_encryption = standard password = *** ENCRYPTED *** password2 = *** ENCRYPTED *** -------------------- -y) Yes this is OK +y) Yes this is OK (default) e) Edit this remote d) Delete this remote -y/e/d> y +y/e/d> ``` -**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. +**Important** The crypt password stored in `rclone.conf` is lightly +obscured. That only protects it from cursory inspection. It is not +secure unless [configuration encryption](https://rclone.org/docs/#configuration-encryption) of `rclone.conf` is specified. -A long passphrase is recommended, or you can use a random one. +A long passphrase is recommended, or `rclone config` can generate a +random one. -The obscured password is created by using AES-CTR with a static key, with -the salt stored verbatim at the beginning of the obscured password. This -static key is shared by between all versions of rclone. +The obscured password is created using AES-CTR with a static key. The +salt is stored verbatim at the beginning of the obscured password. This +static key is shared between all versions of rclone. If you reconfigure rclone with the same passwords/passphrases elsewhere it will be compatible, but the obscured version will be different due to the different salt. -Note that rclone does not encrypt +Rclone does not encrypt * file length - this can be calculated within 16 bytes * modification time - used for syncing -## Specifying the remote ## +### 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. +When configuring the remote to encrypt/decrypt, you may specify any +string that rclone accepts as a source/destination of other commands. -If you specify the remote as `remote:path/to/dir` then rclone will -store encrypted files in `path/to/dir` on the remote. If you are using -file name encryption, then when you save files to -`secret:subdir/subfile` this will store them in the unencrypted path -`path/to/dir` but the `subdir/subpath` bit will be encrypted. +The primary use case is to specify the path into an already configured +remote (e.g. `remote:path/to/dir` or `remote:bucket`), such that +data in a remote untrusted location can be stored 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. +You may also specify a local filesystem path, such as +`/path/to/dir` on Linux, `C:\path\to\dir` on Windows. By creating +a crypt remote pointing to such a local filesystem path, you can +use rclone as a utility for pure local file encryption, for example +to keep encrypted files on a removable USB drive. -## Example ## +**Note**: A string which do not contain a `:` will by rclone be treated +as a relative path in the local filesystem. For example, if you enter +the name `remote` without the trailing `:`, it will be treated as +a subdirectory of the current directory with name "remote". -To test I made a little directory of files using "standard" file name +If a path `remote:path/to/dir` is specified, rclone stores encrypted +files in `path/to/dir` on the remote. With file name encryption, files +saved to `secret:subdir/subfile` are stored in the unencrypted path +`path/to/dir` but the `subdir/subpath` element is encrypted. + +The path you specify does not have to exist, rclone will create +it when needed. + +If you intend to use the wrapped remote both directly for keeping +unencrypted content, as well as through a crypt remote for encrypted +content, it is recommended to point the crypt remote to a separate +directory within the wrapped remote. If you use a bucket based storage +system (e.g. Swift, S3, Google Compute Storage, B2, Hubic) it is generally +advisable to wrap the crypt remote around a specific bucket (`s3:bucket`). +If wrapping around the entire root of the storage (`s3:`), and use the +optional file name encryption, rclone will encrypt the bucket name. + +### Changing password + +Should the password, or the configuration file containing a lightly obscured +form of the password, be compromised, you need to re-encrypt your data with +a new password. Since rclone uses secret-key encryption, where the encryption +key is generated directly from the password kept on the client, it is not +possible to change the password/key of already encrypted content. Just changing +the password configured for an existing crypt remote means you will no longer +able to decrypt any of the previously encrypted content. The only possibility +is to re-upload everything via a crypt remote configured with your new password. + +Depending on the size of your data, your bandwith, storage quota etc, there are +different approaches you can take: +- If you have everything in a different location, for example on your local system, +you could remove all of the prior encrypted files, change the password for your +configured crypt remote (or delete and re-create the crypt configuration), +and then re-upload everything from the alternative location. +- If you have enough space on the storage system you can create a new crypt +remote pointing to a separate directory on the same backend, and then use +rclone to copy everything from the original crypt remote to the new, +effectively decrypting everything on the fly using the old password and +re-encrypting using the new password. When done, delete the original crypt +remote directory and finally the rclone crypt configuration with the old password. +All data will be streamed from the storage system and back, so you will +get half the bandwith and be charged twice if you have upload and download quota +on the storage system. + +**Note**: A security problem related to the random password generator +was fixed in rclone version 1.53.3 (released 2020-11-19). Passwords generated +by rclone config in version 1.49.0 (released 2019-08-26) to 1.53.2 +(released 2020-10-26) are not considered secure and should be changed. +If you made up your own password, or used rclone version older than 1.49.0 or +newer than 1.53.2 to generate it, you are *not* affected by this issue. +See [issue #4783](https://github.com/rclone/rclone/issues/4783) for more +details, and a tool you can use to check if you are affected. + +### Example + +Create the following file structure using "standard" file name encryption. ``` @@ -16015,7 +17069,7 @@ plaintext/ └── file4.txt ``` -Copy these to the remote and list them back +Copy these to the remote, and list them ``` $ rclone -q copy plaintext secret: @@ -16027,7 +17081,7 @@ $ rclone -q ls secret: 9 subdir/file3.txt ``` -Now see what that looked like when encrypted +The crypt remote looks like ``` $ rclone -q ls remote:path @@ -16038,7 +17092,7 @@ $ rclone -q ls remote:path 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps ``` -Note that this retains the directory structure which means you can do this +The directory structure is preserved ``` $ rclone -q ls secret:subdir @@ -16047,9 +17101,9 @@ $ rclone -q ls secret:subdir 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. +Without file name encryption `.bin` extensions are added to underlying +names. This prevents the cloud provider attempting to interpret file +content. ``` $ rclone -q ls remote:path @@ -16060,9 +17114,7 @@ $ rclone -q ls remote:path 55 file1.txt.bin ``` -### File name encryption modes ### - -Here are some of the features of the file name encryption modes +### File name encryption modes Off @@ -16082,17 +17134,19 @@ Standard 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". +distance based on the filename. Rclone stores the distance at the +beginning of the filename. 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. +Obfuscation is not a strong encryption of filenames, but hinders +automated scanning tools picking up on filename patterns. It is an +intermediate between "off" and "standard" which 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. +equivalents. + +Obfuscation cannot be relied upon for strong protection. * file names very lightly obfuscated * file names can be longer than standard encryption @@ -16100,15 +17154,17 @@ equivalents. You can not rely on this for strong protection. * 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. +Cloud storage systems have limits on file name length and +total path length which rclone is more likely to breach using +"Standard" file name encryption. Where file names are less thn 156 +characters in length issues should not be encountered, irrespective of +cloud storage provider. -There may be an even more secure file name encryption mode in the -future which will address the long file name problem. +An alternative, future rclone file name encryption mode may tolerate +backend provider path length limits. + +### Directory name encryption -### Directory name encryption ### Crypt offers the option of encrypting dir names or leaving them intact. There are two options: @@ -16127,15 +17183,15 @@ Example: `1/12/qgm4avr35m5loi1th53ato71v0` -### Modified time and hashes ### +### 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 +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 +Use the `rclone cryptcheck` command to check the integrity of a crypted remote instead of `rclone check` which can't check the checksums properly. @@ -16147,7 +17203,7 @@ 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", +Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - Config: remote @@ -16216,7 +17272,7 @@ Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). #### --crypt-server-side-across-configs -Allow server side operations (eg copy) to work across different crypt configs. +Allow server-side operations (e.g. copy) to work across different crypt configs. Normally this option is not what you want, but if you have two crypts pointing to the same backend you can use it. @@ -16298,7 +17354,7 @@ Usage Example: -## Backing up a crypted remote ## +## Backing up a crypted remote If you wish to backup a crypted remote, it is recommended that you use `rclone sync` on the encrypted files, and make sure the passwords are @@ -16324,14 +17380,14 @@ And to check the integrity you would do rclone check remote:crypt remote2:crypt -## File formats ## +## File formats -### File encryption ### +### File encryption Files are encrypted 1:1 source file to destination object. The file has a header and is divided into chunks. -#### Header #### +#### Header * 8 bytes magic string `RCLONE\x00\x00` * 24 bytes Nonce (IV) @@ -16343,11 +17399,11 @@ 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 #### +#### 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 +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: @@ -16362,7 +17418,7 @@ 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 #### +#### Examples 1 byte file will encrypt to @@ -16379,7 +17435,7 @@ This uses a 32 byte (256 bit key) key derived from the user password. 1049120 bytes total (a 0.05% overhead). This is the overhead for big files. -### Name encryption ### +### Name encryption File names are encrypted segment by segment - the path is broken up into `/` separated strings and these are encrypted individually. @@ -16411,9 +17467,9 @@ encoding is modified in two ways: * 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). +used on case insensitive remotes (e.g. Windows, Amazon Drive). -### Key derivation ### +### 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 @@ -16424,12 +17480,159 @@ then rclone uses an internal one. encrypted data. For full protection against this you should always use a salt. +## SEE ALSO + +* [rclone cryptdecode](https://rclone.org/commands/rclone_cryptdecode/) - Show forward/reverse mapping of encrypted filenames + +Compress (Experimental) +----------------------------------------- + +### Warning +This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is +at your own risk. Please understand the risks associated with using experimental code and don't use this remote in +critical applications. + +The `Compress` remote adds compression to another remote. It is best used with remotes containing +many large compressible files. + +To use this remote, all you need to do is specify another remote and a compression mode to use: + +``` +Current remotes: + +Name Type +==== ==== +remote_to_press sometype + +e) Edit existing remote +$ rclone config +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> n +name> compress +... + 8 / Compress a remote + \ "compress" +... +Storage> compress +** See help for compress backend at: https://rclone.org/compress/ ** + +Remote to compress. +Enter a string value. Press Enter for the default (""). +remote> remote_to_press:subdir +Compression mode. +Enter a string value. Press Enter for the default ("gzip"). +Choose a number from below, or type in your own value + 1 / Gzip compression balanced for speed and compression strength. + \ "gzip" +compression_mode> gzip +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +-------------------- +[compress] +type = compress +remote = remote_to_press:subdir +compression_mode = gzip +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +``` + +### Compression Modes +Currently only gzip compression is supported, it provides a decent balance between speed and strength and is well +supported by other application. Compression strength can further be configured via an advanced setting where 0 is no +compression and 9 is strongest compression. + +#### Filetype +If you open a remote wrapped by press, you will see that there are many files with an extension corresponding to +the compression algorithm you chose. These files are standard files that can be opened by various archive programs, +but they have some hidden metadata that allows them to be used by rclone. +While you may download and decompress these files at will, do **not** manually delete or rename files. Files without +correct metadata files will not be recognized by rclone. + +### File names + +The compressed files will be named `*.###########.gz` where `*` is the base file and the `#` part is base64 encoded +size of the uncompressed file. The file names should not be changed by anything other than the rclone compression backend. + + +### Standard Options + +Here are the standard options specific to compress (Compress a remote). + +#### --compress-remote + +Remote to compress. + +- Config: remote +- Env Var: RCLONE_COMPRESS_REMOTE +- Type: string +- Default: "" + +#### --compress-mode + +Compression mode. + +- Config: mode +- Env Var: RCLONE_COMPRESS_MODE +- Type: string +- Default: "gzip" +- Examples: + - "gzip" + - Standard gzip compression with fastest parameters. + +### Advanced Options + +Here are the advanced options specific to compress (Compress a remote). + +#### --compress-level + +GZIP compression level (-2 to 9). + + Generally -1 (default, equivalent to 5) is recommended. + Levels 1 to 9 increase compressiong at the cost of speed.. Going past 6 + generally offers very little return. + + Level -2 uses Huffmann encoding only. Only use if you now what you + are doing + Level 0 turns off compression. + +- Config: level +- Env Var: RCLONE_COMPRESS_LEVEL +- Type: int +- Default: -1 + +#### --compress-ram-cache-limit + +Some remotes don't allow the upload of files with unknown size. + In this case the compressed file will need to be cached to determine + it's size. + + Files smaller than this limit will be cached in RAM, file larger than + this limit will be cached on disk + +- Config: ram_cache_limit +- Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT +- Type: SizeSuffix +- Default: 20M + + + Dropbox --------------------------------- Paths are specified as `remote:path` -Dropbox paths may be as deep as required, eg +Dropbox paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for dropbox involves getting a token from Dropbox @@ -16623,6 +17826,39 @@ Impersonate this user when using a business account. - Type: string - Default: "" +#### --dropbox-shared-files + +Instructs rclone to work on individual shared files. + +In this mode rclone's features are extremely limited - only list (ls, lsl, etc.) +operations and read operations (e.g. downloading) are supported in this mode. +All other operations will be disabled. + +- Config: shared_files +- Env Var: RCLONE_DROPBOX_SHARED_FILES +- Type: bool +- Default: false + +#### --dropbox-shared-folders + +Instructs rclone to work on shared folders. + +When this flag is used with no path only the List operation is supported and +all available shared folders will be listed. If you specify a path the first part +will be interpreted as the name of shared folder. Rclone will then try to mount this +shared to the root namespace. On success shared folder rclone proceeds normally. +The shared folder is now pretty much a normal folder and all normal operations +are supported. + +Note that we don't unmount the shared folder afterwards so the +--dropbox-shared-folders can be omitted after the first use of a particular +shared folder. + +- Config: shared_folders +- Env Var: RCLONE_DROPBOX_SHARED_FOLDERS +- Type: bool +- Default: false + #### --dropbox-encoding This sets the encoding for the backend. @@ -16679,25 +17915,283 @@ to be the same account as the Dropbox you want to access) 6. Find the `App key` and `App secret` Use these values in rclone config to add a new remote or edit an existing remote. + Enterprise File Fabric +----------------------------------------- + +This backend supports [Storage Made Easy's Enterprise File +Fabric™](https://storagemadeeasy.com/about/) which provides a software +solution to integrate and unify File and Object Storage accessible +through a global file system. + +The initial setup for the Enterprise File Fabric backend involves +getting a token from the the Enterprise File Fabric 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 / Enterprise File Fabric + \ "filefabric" +[snip] +Storage> filefabric +** See help for filefabric backend at: https://rclone.org/filefabric/ ** + +URL of the Enterprise File Fabric to connect to +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Storage Made Easy US + \ "https://storagemadeeasy.com" + 2 / Storage Made Easy EU + \ "https://eu.storagemadeeasy.com" + 3 / Connect to your Enterprise File Fabric + \ "https://yourfabric.smestorage.com" +url> https://yourfabric.smestorage.com/ +ID of the root folder +Leave blank normally. + +Fill in to make rclone start with directory of a given ID. + +Enter a string value. Press Enter for the default (""). +root_folder_id> +Permanent Authentication Token + +A Permanent Authentication Token can be created in the Enterprise File +Fabric, on the users Dashboard under Security, there is an entry +you'll see called "My Authentication Tokens". Click the Manage button +to create one. + +These tokens are normally valid for several years. + +For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens + +Enter a string value. Press Enter for the default (""). +permanent_token> xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +-------------------- +[remote] +type = filefabric +url = https://yourfabric.smestorage.com/ +permanent_token = xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx +-------------------- +y) Yes this is OK (default) +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 Enterprise File Fabric + + rclone lsd remote: + +List all the files in your Enterprise File Fabric + + rclone ls remote: + +To copy a local directory to an Enterprise File Fabric directory called backup + + rclone copy /home/source remote:backup + +### Modified time and hashes + +The Enterprise File Fabric allows modification times to be set on +files accurate to 1 second. These will be used to detect whether +objects need syncing or not. + +The Enterprise File Fabric does not support any data hashes at this time. + +### Restricted filename characters + +The [default restricted characters set](https://rclone.org/overview/#restricted-characters) +will be replaced. + +Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), +as they can't be used in JSON strings. + +### Empty files + +Empty files aren't supported by the Enterprise File Fabric. Rclone will therefore +upload an empty file as a single space with a mime type of +`application/vnd.rclone.empty.file` and files with that mime type are +treated as empty. + +### 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 Enterprise File Fabric. + +Normally you will leave this blank and rclone will determine the +correct root to use itself. + +However you can set this to restrict rclone to a specific folder +hierarchy. + +In order to do this you will have to find the `Folder ID` of the +directory you wish rclone to display. These aren't displayed in the +web interface, but you can use `rclone lsf` to find them, for example + +``` +$ rclone lsf --dirs-only -Fip --csv filefabric: +120673758,Burnt PDFs/ +120673759,My Quick Uploads/ +120673755,My Syncs/ +120673756,My backups/ +120673757,My contacts/ +120673761,S3 Storage/ +``` + +The ID for "S3 Storage" would be `120673761`. + + +### Standard Options + +Here are the standard options specific to filefabric (Enterprise File Fabric). + +#### --filefabric-url + +URL of the Enterprise File Fabric to connect to + +- Config: url +- Env Var: RCLONE_FILEFABRIC_URL +- Type: string +- Default: "" +- Examples: + - "https://storagemadeeasy.com" + - Storage Made Easy US + - "https://eu.storagemadeeasy.com" + - Storage Made Easy EU + - "https://yourfabric.smestorage.com" + - Connect to your Enterprise File Fabric + +#### --filefabric-root-folder-id + +ID of the root folder +Leave blank normally. + +Fill in to make rclone start with directory of a given ID. + + +- Config: root_folder_id +- Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID +- Type: string +- Default: "" + +#### --filefabric-permanent-token + +Permanent Authentication Token + +A Permanent Authentication Token can be created in the Enterprise File +Fabric, on the users Dashboard under Security, there is an entry +you'll see called "My Authentication Tokens". Click the Manage button +to create one. + +These tokens are normally valid for several years. + +For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens + + +- Config: permanent_token +- Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN +- Type: string +- Default: "" + +### Advanced Options + +Here are the advanced options specific to filefabric (Enterprise File Fabric). + +#### --filefabric-token + +Session Token + +This is a session token which rclone caches in the config file. It is +usually valid for 1 hour. + +Don't set this value - rclone will set it automatically. + + +- Config: token +- Env Var: RCLONE_FILEFABRIC_TOKEN +- Type: string +- Default: "" + +#### --filefabric-token-expiry + +Token expiry time + +Don't set this value - rclone will set it automatically. + + +- Config: token_expiry +- Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY +- Type: string +- Default: "" + +#### --filefabric-version + +Version read from the file fabric + +Don't set this value - rclone will set it automatically. + + +- Config: version +- Env Var: RCLONE_FILEFABRIC_VERSION +- Type: string +- Default: "" + +#### --filefabric-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_FILEFABRIC_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,InvalidUtf8,Dot + + + FTP ------------------------------ -FTP is the File Transfer Protocol. FTP support is provided using the +FTP is the File Transfer Protocol. Rclone FTP support is provided using the [github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) package. +[Limitations of Rclone's FTP backend](#Limitations) + Paths are specified as `remote:path`. If the path does not begin with a `/` it is relative to the home directory of the user. An empty path `remote:` refers to the user's home directory. -Here is an example of making an FTP configuration. First run +To create an FTP configuration named `remote`, 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. +Rclone config guides you through an interactive setup process. A minimal +rclone FTP remote definition only requires host, username and password. +For an anonymous FTP server, use `anonymous` as username and your email +address as password. ``` No remotes found - make a new one @@ -16724,7 +18218,7 @@ 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 +FTP username, leave blank for current username, $USER Enter a string value. Press Enter for the default (""). user> FTP port, leave blank to use default (21) @@ -16757,9 +18251,7 @@ 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 +To see all directories in the home directory of `remote` rclone lsd remote: @@ -16776,45 +18268,17 @@ excess files in the directory. rclone sync -i /home/local/directory remote:directory -### Modified time ### - -FTP does not support modified times. Any times you see on the server -will be time of upload. - -### Checksums ### - -FTP does not support any checksums. - -### Usage without a config file ### - -An example how to use the ftp remote without a config file: +### Example without a config file ### rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy` -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) -the following characters are also replaced: - -File names can also not end with the following characters. -These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| --------- |:-----:|:-----------:| -| SP | 0x20 | ␠ | - -Note that not all FTP servers can have all characters in file names, for example: - -| FTP Server| Forbidden characters | -| --------- |:--------------------:| -| proftpd | `*` | -| pureftpd | `\ [ ]` | ### Implicit TLS ### -FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled -in the config for the remote. The default FTPS port is `990` so the -port will likely have to be explicitly set in the config for the remote. +Rlone FTP supports implicit FTP over TLS servers (FTPS). This has to +be enabled in the FTP backend config for the remote, or with +`[--ftp-tls]{#ftp-tls}`. The default FTPS port is `990`, not `21` and +can be set with `[--ftp-port]{#ftp-port}`. ### Standard Options @@ -16864,9 +18328,9 @@ FTP password #### --ftp-tls -Use FTPS over TLS (Implicit) -When using implicit FTP over TLS the client will connect using TLS -right from the start, which in turn breaks the compatibility with +Use Implicit FTPS (FTP over TLS) +When using implicit FTP over TLS the client connects using TLS +right from the start which breaks compatibility with non-TLS-aware servers. This is usually served over port 990 rather than port 21. Cannot be used in combination with explicit FTP. @@ -16877,8 +18341,8 @@ than port 21. Cannot be used in combination with explicit FTP. #### --ftp-explicit-tls -Use FTP over TLS (Explicit) -When using explicit FTP over TLS the client explicitly request +Use Explicit FTPS (FTP over TLS) +When using explicit FTP over TLS the client explicitly requests security from the server in order to upgrade a plain text connection to an encrypted one. Cannot be used in combination with implicit FTP. @@ -16918,6 +18382,15 @@ Disable using EPSV even if server advertises support - Type: bool - Default: false +#### --ftp-disable-mlsd + +Disable using MLSD even if server advertises support + +- Config: disable_mlsd +- Env Var: RCLONE_FTP_DISABLE_MLSD +- Type: bool +- Default: false + #### --ftp-encoding This sets the encoding for the backend. @@ -16933,24 +18406,61 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin ### Limitations ### -Note that FTP does have its own implementation of : `--dump headers`, -`--dump bodies`, `--dump auth` for debugging which isn't the same as -the HTTP based backends - it has less fine grained control. +Modified times are not supported. Times you see on the FTP server +through rclone are those of upload. -Note that `--timeout` isn't supported (but `--contimeout` is). +Rclone's FTP backend does not support any checksums but can compare +file sizes. -Note that `--bind` isn't supported. +`rclone about` is not supported by the FTP backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. -FTP could support server side move but doesn't yet. +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) -Note that the ftp backend does not support the `ftp_proxy` environment -variable yet. +The implementation of : `--dump headers`, +`--dump bodies`, `--dump auth` for debugging isn't the same as +for rclone HTTP based backends - it has less fine grained control. + +`--timeout` isn't supported (but `--contimeout` is). + +`--bind` isn't supported. + +Rclone's FTP backend could support server-side move but does not +at present. + +The `ftp_proxy` environment variable is not currently supported. + +FTP servers acting as rclone remotes must support 'passive' +mode. Rclone's FTP implementation is not compatible with 'active' +mode. + +#### Restricted filename characters + +In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) +the following characters are also replaced: + +File names cannot end with the following characters. Repacement is +limited to the last character in a file name: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| SP | 0x20 | ␠ | + +Not all FTP servers can have all characters in file names, for example: + +| FTP Server| Forbidden characters | +| --------- |:--------------------:| +| proftpd | `*` | +| pureftpd | `\ [ ]` | 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`. +command.) You may put subdirectories in too, e.g. `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 @@ -17175,6 +18685,7 @@ flag. Google Cloud Storage supports the headers as described in the - Content-Encoding - Content-Language - Content-Type +- X-Goog-Storage-Class - X-Goog-Meta- Eg `--header-upload "Content-Type text/potato"` @@ -17452,13 +18963,22 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,CrLf,InvalidUtf8,Dot +### Limitations + +`rclone about` is not supported by the Google Cloud Storage backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Google Drive ----------------------------------------- Paths are specified as `drive:path` -Drive paths may be as deep as required, eg `drive:directory/subdirectory`. +Drive paths may be as deep as required, e.g. `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 @@ -17847,7 +19367,7 @@ be in multiple folders at once](https://cloud.google.com/blog/products/g-suite/s Shortcuts are files that link to other files on Google Drive somewhat like a symlink in unix, except they point to the underlying file data -(eg the inode in unix terms) so they don't break if the source is +(e.g. the inode in unix terms) so they don't break if the source is renamed or moved about. Be default rclone treats these as follows. @@ -17857,8 +19377,8 @@ For shortcuts pointing to files: - When listing a file shortcut appears as the destination file. - When downloading the contents of the destination file is downloaded. - When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. -- When server side moving (renaming) the shortcut is renamed, not the destination file. -- When server side copying the shortcut is copied, not the contents of the shortcut. +- When server-side moving (renaming) the shortcut is renamed, not the destination file. +- When server-side copying the shortcut is copied, not the contents of the shortcut. - When deleting the shortcut is deleted not the linked file. - When setting the modification time, the modification time of the linked file will be set. @@ -17867,8 +19387,8 @@ For shortcuts pointing to folders: - When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) - When downloading the contents of the linked folder and sub contents are downloaded - When uploading to a shortcut folder the file will be placed in the linked folder -- When server side moving (renaming) the shortcut is renamed, not the destination folder -- When server side copying the contents of the linked folder is copied, not the shortcut. +- When server-side moving (renaming) the shortcut is renamed, not the destination folder +- When server-side copying the contents of the linked folder is copied, not the shortcut. - When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder. - **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted. @@ -17940,7 +19460,7 @@ Here are some examples for allowed and prohibited conversions. 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`, +in the same document type at once, e.g. 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 @@ -17997,8 +19517,10 @@ Here are the standard options specific to drive (Google Drive). #### --drive-client-id -OAuth Client Id -Leave blank normally. +Google Application Client Id +Setting your own is recommended. +See https://rclone.org/drive/#making-your-own-client-id for how to create your own. +If you leave this blank, it will use an internal key which is low performance. - Config: client_id - Env Var: RCLONE_DRIVE_CLIENT_ID @@ -18187,8 +19709,8 @@ 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. +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 @@ -18406,9 +19928,9 @@ Number of API calls to allow without sleeping. #### --drive-server-side-across-configs -Allow server side operations (eg copy) to work across different drive configs. +Allow server-side operations (e.g. copy) to work across different drive configs. -This can be useful if you wish to do a server side copy between two +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. @@ -18457,6 +19979,25 @@ See: https://github.com/rclone/rclone/issues/3857 - Type: bool - Default: false +#### --drive-stop-on-download-limit + +Make download limit errors be fatal + +At the time of writing it is only possible to download 10TB of data from +Google Drive a day (this is an undocumented limit). When this limit is +reached Google Drive produces a slightly different error message. When +this flag is set it causes these errors to be fatal. These will stop +the in-progress sync. + +Note that this detection is relying on error message strings which +Google don't document so it may break in the future. + + +- Config: stop_on_download_limit +- Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT +- Type: bool +- Default: false + #### --drive-skip-shortcuts If set skip shortcut files @@ -18621,6 +20162,33 @@ Result: } +#### copyid + +Copy files by ID + + rclone backend copyid remote: [options] [+] + +This command copies files by ID + +Usage: + + rclone backend copyid drive: ID path + rclone backend copyid drive: ID1 path1 ID2 path2 + +It copies the drive file with ID given to the path (an rclone path which +will be passed internally to rclone copyto). The ID and path pairs can be +repeated. + +The path should end with a / to indicate copy the file as named to +this directory. If it doesn't end with a / then the last path +component will be used as the file name. + +If the destination is a drive backend then server-side copying will be +attempted if possible. + +Use the -i flag to see what would be copied before copying. + + ### Limitations ### @@ -18632,13 +20200,13 @@ 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 +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`. +anything which uses the VFS layer, e.g. `rclone mount`, `rclone serve`. This is because rclone can't find out the size of the Google docs without downloading them. @@ -18976,6 +20544,14 @@ 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.. +`rclone about` is not supported by the Google Photos backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) + ### Downloading Images When Images are downloaded this strips EXIF location (according to the @@ -19144,6 +20720,254 @@ Year limits the photos to be downloaded to those which are uploaded after the gi - Type: int - Default: 2000 +#### --gphotos-include-archived + +Also view and download archived media. + +By default rclone does not request archived media. Thus, when syncing, +archived media is not visible in directory listings or transferred. + +Note that media in albums is always visible and synced, no matter +their archive status. + +With this flag, archived media are always visible in directory +listings and transferred. + +Without this flag, archived media will not be visible in directory +listings and won't be transferred. + +- Config: include_archived +- Env Var: RCLONE_GPHOTOS_INCLUDE_ARCHIVED +- Type: bool +- Default: false + + + + HDFS +------------------------------------------------- + +[HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html) is a +distributed file-system, part of the [Apache Hadoop](https://hadoop.apache.org/) framework. + +Paths are specified as `remote:` or `remote:path/to/dir`. + +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 +[skip] +XX / Hadoop distributed file system + \ "hdfs" +[skip] +Storage> hdfs +** See help for hdfs backend at: https://rclone.org/hdfs/ ** + +hadoop name node and port +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Connect to host namenode at port 8020 + \ "namenode:8020" +namenode> namenode.hadoop:8020 +hadoop user name +Enter a string value. Press Enter for the default (""). +Choose a number from below, or type in your own value + 1 / Connect to hdfs as root + \ "root" +username> root +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +-------------------- +[remote] +type = hdfs +namenode = namenode.hadoop:8020 +username = root +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: + +Name Type +==== ==== +hadoop hdfs + +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 +``` + +This remote is called `remote` and can now be used like this + +See all the top level directories + + rclone lsd remote: + +List the contents of a directory + + rclone ls remote:directory + +Sync the remote `directory` to `/home/local/directory`, deleting any excess files. + + rclone sync -i remote:directory /home/local/directory + +### Setting up your own HDFS instance for testing + +You may start with a [manual setup](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/SingleCluster.html) +or use the docker image from the tests: + +If you want to build the docker image + +``` +git clone https://github.com/rclone/rclone.git +cd rclone/fstest/testserver/images/test-hdfs +docker build --rm -t rclone/test-hdfs . +``` + +Or you can just use the latest one pushed + +``` +docker run --rm --name "rclone-hdfs" -p 127.0.0.1:9866:9866 -p 127.0.0.1:8020:8020 --hostname "rclone-hdfs" rclone/test-hdfs +``` + +**NB** it need few seconds to startup. + +For this docker image the remote needs to be configured like this: + +``` +[remote] +type = hdfs +namenode = 127.0.0.1:8020 +username = root +``` + +You can stop this image with `docker kill rclone-hdfs` (**NB** it does not use volumes, so all data +uploaded will be lost.) + +### Modified time + +Time accurate to 1 second is stored. + +### Checksum + +No checksums are implemented. + +### Usage information + +You can use the `rclone about remote:` command which will display filesystem size and current usage. + +### Restricted filename characters + +In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) +the following characters are also replaced: + +| Character | Value | Replacement | +| --------- |:-----:|:-----------:| +| : | 0x3A | ： | + +Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8). + +### Limitations + +- No server-side `Move` or `DirMove`. +- Checksums not implemented. + + +### Standard Options + +Here are the standard options specific to hdfs (Hadoop distributed file system). + +#### --hdfs-namenode + +hadoop name node and port + +- Config: namenode +- Env Var: RCLONE_HDFS_NAMENODE +- Type: string +- Default: "" +- Examples: + - "namenode:8020" + - Connect to host namenode at port 8020 + +#### --hdfs-username + +hadoop user name + +- Config: username +- Env Var: RCLONE_HDFS_USERNAME +- Type: string +- Default: "" +- Examples: + - "root" + - Connect to hdfs as root + +### Advanced Options + +Here are the advanced options specific to hdfs (Hadoop distributed file system). + +#### --hdfs-service-principal-name + +Kerberos service principal name for the namenode + +Enables KERBEROS authentication. Specifies the Service Principal Name +(/) for the namenode. + +- Config: service_principal_name +- Env Var: RCLONE_HDFS_SERVICE_PRINCIPAL_NAME +- Type: string +- Default: "" +- Examples: + - "hdfs/namenode.hadoop.docker" + - Namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'. + +#### --hdfs-data-transfer-protection + +Kerberos data transfer protection: authentication|integrity|privacy + +Specifies whether or not authentication, data signature integrity +checks, and wire encryption is required when communicating the the +datanodes. Possible values are 'authentication', 'integrity' and +'privacy'. Used only with KERBEROS enabled. + +- Config: data_transfer_protection +- Env Var: RCLONE_HDFS_DATA_TRANSFER_PROTECTION +- Type: string +- Default: "" +- Examples: + - "privacy" + - Ensure authentication, integrity and encryption enabled. + +#### --hdfs-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_HDFS_ENCODING +- Type: MultiEncoder +- Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot + HTTP @@ -19276,7 +21100,7 @@ The input format is comma separated list of key,value pairs. Standard For example to set a Cookie use 'Cookie,name=value', or '"Cookie","name=value"'. -You can set multiple headers, eg '"Cookie","name=value","Authorization","xxx"'. +You can set multiple headers, e.g. '"Cookie","name=value","Authorization","xxx"'. - Config: headers @@ -19329,6 +21153,15 @@ If you set this option, rclone will not do the HEAD request. This will mean - Default: false +### Limitations + +`rclone about` is not supported by the HTTP backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Hubic ----------------------------------------- @@ -19336,7 +21169,7 @@ If you set this option, rclone will not do the HEAD request. This will mean Paths are specified as `remote:path` Paths are specified as `remote:container` (or `remote:` for the `lsd` -command.) You may put subdirectories in too, eg `remote:container/path/to/dir`. +command.) You may put subdirectories in too, e.g. `remote:container/path/to/dir`. The initial setup for Hubic involves getting a token from Hubic which you need to do in your browser. `rclone config` walks you through it. @@ -19506,7 +21339,7 @@ default for this is 5GB which is its maximum value. Don't chunk files during streaming upload. -When doing streaming uploads (eg using rcat or mount) setting this +When doing streaming uploads (e.g. using rcat or mount) setting this flag will cause the swift backend to not upload chunked files. This will limit the maximum upload size to 5GB. However non chunked @@ -19553,7 +21386,7 @@ also several whitelabel versions which should work with this backend. Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. ## Setup @@ -19567,10 +21400,19 @@ Note that the web interface may refer to this token as a JottaCli token. ### Legacy Setup If you are using one of the whitelabel versions (Elgiganten, Com Hem Cloud) you may not have the option -to generate a CLI token. In this case you'll have to use the legacy authentification. To to this select -yes when the setup asks for legacy authentification and enter your username and password. +to generate a CLI token. In this case you'll have to use the legacy authentication. To to this select +yes when the setup asks for legacy authentication and enter your username and password. The rest of the setup is identical to the default setup. +### Telia Cloud Setup + +Similar to other whitelabel versions Telia Cloud doesn't offer the option of creating a CLI token, and +additionally uses a separate authentication flow where the username is generated internally. To setup +rclone to use Telia Cloud, choose Telia Cloud authentication in the setup. The rest of the setup is +identical to the default setup. + +### Example + Here is an example of how to make a remote called `remote` with the default setup. First run: rclone config @@ -19599,7 +21441,7 @@ y) Yes n) No y/n> n Remote config -Use legacy authentification?. +Use legacy authentication?. This is only required for certain whitelabel versions of Jottacloud and not recommended for normal users. y) Yes n) No (default) @@ -19688,8 +21530,13 @@ flag. Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (wherever the `TMPDIR` environment variable points -to) before it is uploaded. Small files will be cached in memory - see +to) before it is uploaded. Small files will be cached in memory - see the [--jottacloud-md5-memory-limit](#jottacloud-md5-memory-limit) flag. +When uploading from local disk the source checksum is always available, +so this does not apply. Starting with rclone version 1.52 the same is +true for crypted remotes (in older versions the crypt backend would not +calculate hashes for uploads from local disk, so the Jottacloud +backend had to do it as described above). #### Restricted filename characters @@ -19802,7 +21649,7 @@ operations to previously deleted paths to fail. Emptying the trash should help i Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for Koofr involves creating an application password for rclone. You can do that by opening the Koofr @@ -19974,7 +21821,7 @@ Currently it is recommended to disable 2FA on Mail.ru accounts intended for rclo ### Features highlights ### -- Paths may be as deep as required, eg `remote:directory/subdirectory` +- Paths may be as deep as required, e.g. `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 @@ -20156,6 +22003,7 @@ 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. +It is meaningless and ineffective if source file is unique or encrypted. 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 @@ -20258,7 +22106,7 @@ 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 +Supported quirks: atomicmkdir binlist unknowndirs - Config: quirks - Env Var: RCLONE_MAILRU_QUIRKS @@ -20292,7 +22140,7 @@ features of Mega using the same client side encryption. Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. Here is an example of how to make a remote called `remote`. First run: @@ -20507,7 +22355,7 @@ Mega allows duplicate files which may confuse rclone. The memory backend is an in RAM backend. It does not persist its data - use the local backend for that. -The memory backend behaves like a bucket based remote (eg like +The memory backend behaves like a bucket based remote (e.g. like s3). Because it has no parameters you can just use it with the `:memory:` remote name. @@ -20544,7 +22392,7 @@ y/e/d> y ``` Because the memory backend isn't persistent it is most useful for -testing or with an rclone server or rclone mount, eg +testing or with an rclone server or rclone mount, e.g. rclone mount :memory: /mnt/tmp rclone serve webdav :memory: @@ -20566,7 +22414,7 @@ set](https://rclone.org/overview/#restricted-characters). ----------------------------------------- Paths are specified as `remote:container` (or `remote:` for the `lsd` -command.) You may put subdirectories in too, eg +command.) You may put subdirectories in too, e.g. `remote:container/path/to/dir`. Here is an example of making a Microsoft Azure Blob Storage @@ -20663,7 +22511,7 @@ as they can't be used in JSON strings. 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. +hashes, e.g. the local disk. ### Authenticating with Azure Blob Storage @@ -20686,7 +22534,7 @@ container level SAS URL right click on a container in the Azure Blob explorer in the Azure portal. If you use a container level SAS URL, rclone operations are permitted -only on a particular container, eg +only on a particular container, e.g. rclone ls azureblob:container @@ -20705,27 +22553,6 @@ Container level SAS URLs are useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment such as a CI build server. -### Multipart uploads ### - -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 @@ -20740,6 +22567,26 @@ Storage Account Name (leave blank to use SAS URL or Emulator) - Type: string - Default: "" +#### --azureblob-service-principal-file + +Path to file containing credentials for use with a service principal. + +Leave blank normally. Needed only if you want to use a service principal instead of interactive login. + + $ az sp create-for-rbac --name "" \ + --role "Storage Blob Data Owner" \ + --scopes "/subscriptions//resourceGroups//providers/Microsoft.Storage/storageAccounts//blobServices/default/containers/" \ + > azure-principal.json + +See [Use Azure CLI to assign an Azure role for access to blob and queue data](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) +for more details. + + +- Config: service_principal_file +- Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE +- Type: string +- Default: "" + #### --azureblob-key Storage Account Key (leave blank to use SAS URL or Emulator) @@ -20759,6 +22606,24 @@ SAS URL for container level access only - Type: string - Default: "" +#### --azureblob-use-msi + +Use a managed service identity to authenticate (only works in Azure) + +When true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) +to authenticate to Azure Storage instead of a SAS token or account key. + +If the VM(SS) on which this program is running has a system-assigned identity, it will +be used by default. If the resource has no system-assigned but exactly one user-assigned identity, +the user-assigned identity will be used by default. If the resource has multiple user-assigned +identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, +msi_client_id, or msi_mi_res_id parameters. + +- Config: use_msi +- Env Var: RCLONE_AZUREBLOB_USE_MSI +- Type: bool +- Default: false + #### --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) @@ -20772,6 +22637,33 @@ Uses local storage emulator if provided as 'true' (leave blank if using real azu Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage). +#### --azureblob-msi-object-id + +Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified. + +- Config: msi_object_id +- Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID +- Type: string +- Default: "" + +#### --azureblob-msi-client-id + +Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified. + +- Config: msi_client_id +- Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID +- Type: string +- Default: "" + +#### --azureblob-msi-mi-res-id + +Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified. + +- Config: msi_mi_res_id +- Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID +- Type: string +- Default: "" + #### --azureblob-endpoint Endpoint for the service @@ -20784,12 +22676,12 @@ Leave blank normally. #### --azureblob-upload-cutoff -Cutoff for switching to chunked upload (<= 256MB). +Cutoff for switching to chunked upload (<= 256MB). (Deprecated) - Config: upload_cutoff - Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF -- Type: SizeSuffix -- Default: 256M +- Type: string +- Default: "" #### --azureblob-chunk-size @@ -20840,6 +22732,28 @@ tiering blob to "Hot" or "Cool". - Type: string - Default: "" +#### --azureblob-archive-tier-delete + +Delete archive tier blobs before overwriting. + +Archive tier blobs cannot be updated. So without this flag, if you +attempt to update an archive tier blob, then rclone will produce the +error: + + can't update archive tier blob without --azureblob-archive-tier-delete + +With this flag set then before rclone attempts to overwrite an archive +tier blob, it will delete the existing blob before uploading its +replacement. This has the potential for data loss if the upload fails +(unlike updating a normal blob) and also may cost more since deleting +archive tier blobs early may be chargable. + + +- Config: archive_tier_delete +- Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE +- Type: bool +- Default: false + #### --azureblob-disable-checksum Don't store MD5 checksum with object metadata. @@ -20886,12 +22800,19 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 - ### 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. +`rclone about` is not supported by the Microsoft Azure Blob storage backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) + ### Azure Storage Emulator Support ### You can test rclone with storage emulator locally, to do this make sure azure storage emulator installed locally and set up a new remote with `rclone config` follow instructions described in @@ -20903,7 +22824,7 @@ or key if using emulator. Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for OneDrive involves getting a token from Microsoft which you need to do in your browser. `rclone config` walks @@ -21023,7 +22944,7 @@ If you are having problems with them (E.g., seeing a lot of throttling), you can Client ID and Key by following the steps below: 1. Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade and then click `New registration`. -2. Enter a name for your app, choose account type `Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)`, 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. +2. Enter a name for your app, choose account type `Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)`, select `Web` in `Redirect URI`, then type (do not copy and paste) `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 following permissions: `Files.Read`, `Files.ReadWrite`, `Files.Read.All`, `Files.ReadWrite.All`, `offline_access`, `User.Read`. Once selected click `Add permissions` at the bottom. @@ -21058,8 +22979,6 @@ the following characters are also replaced: | ? | 0x3F | ？ | | \ | 0x5C | ＼ | | \| | 0x7C | ｜ | -| # | 0x23 | ＃ | -| % | 0x25 | ％ | File names can also not end with the following characters. These only get replaced if they are the last character in the name: @@ -21112,6 +23031,24 @@ Leave blank normally. - Type: string - Default: "" +#### --onedrive-region + +Choose national cloud region for OneDrive. + +- Config: region +- Env Var: RCLONE_ONEDRIVE_REGION +- Type: string +- Default: "global" +- Examples: + - "global" + - Microsoft Cloud Global + - "us" + - Microsoft Cloud for US Government + - "de" + - Microsoft Cloud Germany + - "cn" + - Azure and Office 365 operated by 21Vianet in China + ### Advanced Options Here are the advanced options specific to onedrive (Microsoft OneDrive). @@ -21193,12 +23130,11 @@ listing, set this option. #### --onedrive-server-side-across-configs -Allow server side operations (eg copy) to work across different onedrive configs. +Allow server-side operations (e.g. copy) to work across different onedrive configs. -This can be useful if you wish to do a server side copy between two -different Onedrives. Note that this isn't enabled by default -because it isn't easy to tell if it will work between any two -configurations. +This will only work if you are copying between two OneDrive *Personal* drives AND +the files to copy are already shared between them. In other cases, rclone will +fall back to normal copy (which will be slightly slower). - Config: server_side_across_configs - Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS @@ -21226,6 +23162,48 @@ this flag there. - Type: bool - Default: false +#### --onedrive-link-scope + +Set the scope of the links created by the link command. + +- Config: link_scope +- Env Var: RCLONE_ONEDRIVE_LINK_SCOPE +- Type: string +- Default: "anonymous" +- Examples: + - "anonymous" + - Anyone with the link has access, without needing to sign in. This may include people outside of your organization. Anonymous link support may be disabled by an administrator. + - "organization" + - Anyone signed into your organization (tenant) can use the link to get access. Only available in OneDrive for Business and SharePoint. + +#### --onedrive-link-type + +Set the type of the links created by the link command. + +- Config: link_type +- Env Var: RCLONE_ONEDRIVE_LINK_TYPE +- Type: string +- Default: "view" +- Examples: + - "view" + - Creates a read-only link to the item. + - "edit" + - Creates a read-write link to the item. + - "embed" + - Creates an embeddable link to the item. + +#### --onedrive-link-password + +Set the password for links created by the link command. + +At the time of writing this only works with OneDrive personal paid accounts. + + +- Config: link_password +- Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD +- Type: string +- Default: "" + #### --onedrive-encoding This sets the encoding for the backend. @@ -21235,7 +23213,7 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Config: encoding - Env Var: RCLONE_ONEDRIVE_ENCODING - Type: MultiEncoder -- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot @@ -21259,7 +23237,7 @@ in it will be mapped to `？` instead. #### File sizes #### -The largest allowed file size is 100GB for both OneDrive Personal and OneDrive for Business [(Updated 17 June 2020)](https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize). +The largest allowed file size is 250GB for both OneDrive Personal and OneDrive for Business [(Updated 13 Jan 2021)](https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize). #### Path length #### @@ -21412,7 +23390,7 @@ If you see the error above after enabling multi-factor authentication for your a Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. Here is an example of how to make a remote called `remote`. First run: @@ -21567,11 +23545,19 @@ 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. +`rclone about` is not supported by the OpenDrive backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) + QingStor --------------------------------------- Paths are specified as `remote:bucket` (or `remote:` for the `lsd` -command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. +command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. Here is an example of making an QingStor configuration. First run @@ -21808,7 +23794,7 @@ as multipart uploads using this chunk size. Note that "--qingstor-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 +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 @@ -21823,10 +23809,10 @@ Concurrency for multipart uploads. This is the number of chunks of the same file that are uploaded concurrently. -NB if you set this to > 1 then the checksums of multpart uploads +NB if you set this to > 1 then the checksums of multipart uploads become corrupted (the uploads themselves are not corrupted though). -If you are uploading small numbers of large file over high speed link +If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers. @@ -21847,6 +23833,15 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,Ctl,InvalidUtf8 +### Limitations + +`rclone about` is not supported by the qingstor backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Swift ---------------------------------------- @@ -21861,7 +23856,7 @@ Commercial implementations of that being: * [IBM Bluemix Cloud ObjectStorage Swift](https://console.bluemix.net/docs/infrastructure/objectstorage-swift/index.html) Paths are specified as `remote:container` (or `remote:` for the `lsd` -command.) You may put subdirectories in too, eg `remote:container/path/to/dir`. +command.) You may put subdirectories in too, e.g. `remote:container/path/to/dir`. Here is an example of making a swift configuration. First run @@ -22275,6 +24270,15 @@ provider. Here are the advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)). +#### --swift-leave-parts-on-error + +If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions. + +- Config: leave_parts_on_error +- Env Var: RCLONE_SWIFT_LEAVE_PARTS_ON_ERROR +- Type: bool +- Default: false + #### --swift-chunk-size Above this size files will be chunked into a _segments container. @@ -22291,7 +24295,7 @@ default for this is 5GB which is its maximum value. Don't chunk files during streaming upload. -When doing streaming uploads (eg using rcat or mount) setting this +When doing streaming uploads (e.g. using rcat or mount) setting this flag will cause the swift backend to not upload chunked files. This will limit the maximum upload size to 5GB. However non chunked @@ -22355,7 +24359,7 @@ So this most likely means your username / password is wrong. You can investigate further with the `--dump-bodies` flag. This may also be caused by specifying the region when you shouldn't -have (eg OVH). +have (e.g. OVH). #### Rclone gives Failed to create file system: Response didn't have storage url and auth token #### @@ -22367,7 +24371,7 @@ setting up a swift remote. Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for pCloud involves getting a token from pCloud which you need to do in your browser. `rclone config` walks you through it. @@ -22449,8 +24453,11 @@ 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. +pCloud supports MD5 and SHA1 type hashes in the US region but and SHA1 +only in the EU region, so you can use the `--checksum` flag. + +(Note that pCloud also support SHA256 in the EU region, but rclone +does not have support for that yet.) #### Restricted filename characters @@ -22596,7 +24603,7 @@ with rclone authorize. Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for [premiumize.me](https://premiumize.me/) involves getting a token from premiumize.me which you need to do in your browser. `rclone config` walks you through it. @@ -22738,7 +24745,7 @@ premiumize.me only supports filenames up to 255 characters in length. Paths are specified as `remote:path` -put.io paths may be as deep as required, eg +put.io paths may be as deep as required, e.g. `remote:directory/subdirectory`. The initial setup for put.io involves getting a token from put.io @@ -22868,7 +24875,7 @@ This is a backend for the [Seafile](https://www.seafile.com/) storage service: There are two distinct modes you can setup your remote: - you point your remote to the **root of the server**, meaning you don't specify a library during the configuration: -Paths are specified as `remote:library`. You may put subdirectories in too, eg `remote:library/path/to/dir`. +Paths are specified as `remote:library`. You may put subdirectories in too, e.g. `remote:library/path/to/dir`. - you point your remote to a specific library during the configuration: Paths are specified as `remote:path/to/dir`. **This is the recommended mode when using encrypted libraries**. (_This mode is possibly slightly faster than the root mode_) @@ -23266,7 +25273,7 @@ Choose a number from below, or type in your own value 1 / Connect to example.com \ "example.com" host> example.com -SSH username, leave blank for current username, ncw +SSH username, leave blank for current username, $USER user> sftpuser SSH port, leave blank to use default (22) port> @@ -23316,7 +25323,7 @@ excess files in the directory. The SFTP remote supports three authentication methods: * Password - * Key file + * Key file, including certificate signed keys * ssh-agent Key files should be PEM-encoded private key files. For instance `/home/$USER/.ssh/id_rsa`. @@ -23342,11 +25349,82 @@ Using an ssh-agent is the only way to load encrypted OpenSSH keys at the moment. If you set the `--sftp-ask-password` option, rclone will prompt for a password when needed and no password has been configured. +If you have a certificate then you can provide the path to the public key that contains the certificate. For example: + +``` +[remote] +type = sftp +host = example.com +user = sftpuser +key_file = ~/id_rsa +pubkey_file = ~/id_rsa-cert.pub +```` + +If you concatenate a cert with a private key then you can specify the +merged file in both places. + +Note: the cert must come first in the file. e.g. + +``` +cat id_rsa-cert.pub id_rsa > merged_key +``` + +### Host key validation ### + +By default rclone will not check the server's host key for validation. This +can allow an attacker to replace a server with their own and if you use +password authentication then this can lead to that password being exposed. + +Host key matching, using standard `known_hosts` files can be turned on by +enabling the `known_hosts_file` option. This can point to the file maintained +by `OpenSSH` or can point to a unique file. + +e.g. + +``` +[remote] +type = sftp +host = example.com +user = sftpuser +pass = +known_hosts_file = ~/.ssh/known_hosts +```` + +There are some limitations: + +* `rclone` will not _manage_ this file for you. If the key is missing or +wrong then the connection will be refused. +* If the server is set up for a certificate host key then the entry in +the `known_hosts` file _must_ be the `@cert-authority` entry for the CA +* Unlike `OpenSSH`, the libraries used by `rclone` do not permit (at time +of writing) multiple host keys to be listed for a server. Only the first +entry is used. + +If the host key provided by the server does not match the one in the +file (or is missing) then the connection will be aborted and an error +returned such as + + NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key mismatch + +or + + NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key is unknown + +If you see an error such as + + NewFs: couldn't connect SSH: ssh: handshake failed: ssh: no authorities for hostname: example.com:22 + +then it is likely the server has presented a CA signed host certificate +and you will need to add the appropriate `@cert-authority` entry. + +The `known_hosts_file` setting can be set during `rclone config` as an +advanced option. + ### ssh-agent on macOS ### Note that there seem to be various problems with using an ssh-agent on macOS due to recent changes in the OS. The most effective work-around -seems to be to start an ssh-agent in each session, eg +seems to be to start an ssh-agent in each session, e.g. eval `ssh-agent -s` && ssh-add -A @@ -23386,7 +25464,7 @@ SSH host to connect to #### --sftp-user -SSH username, leave blank for current username, ncw +SSH username, leave blank for current username, $USER - Config: user - Env Var: RCLONE_SFTP_USER @@ -23448,6 +25526,20 @@ in the new OpenSSH format can't be used. - Type: string - Default: "" +#### --sftp-pubkey-file + +Optional path to public key file. + +Set this if you have a signed certificate you want to use for authentication. + +Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. + + +- Config: pubkey_file +- Env Var: RCLONE_SFTP_PUBKEY_FILE +- Type: string +- Default: "" + #### --sftp-key-use-agent When set forces the usage of the ssh-agent. @@ -23500,6 +25592,23 @@ Leave blank or set to false to enable hashing (recommended), set to true to disa Here are the advanced options specific to sftp (SSH/SFTP Connection). +#### --sftp-known-hosts-file + +Optional path to known_hosts file. + +Set this value to enable server host key validation. + +Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. + + +- Config: known_hosts_file +- Env Var: RCLONE_SFTP_KNOWN_HOSTS_FILE +- Type: string +- Default: "" +- Examples: + - "~/.ssh/known_hosts" + - Use OpenSSH's known_hosts file + #### --sftp-ask-password Allow asking for SFTP password when needed. @@ -23590,6 +25699,24 @@ The subsystem option is ignored when server_command is defined. - Type: string - Default: "" +#### --sftp-use-fstat + +If set use fstat instead of stat + +Some servers limit the amount of open files and calling Stat after opening +the file will throw an error from the server. Setting this flag will call +Fstat instead of Stat which is called on an already open file handle. + +It has been found that this helps with IBM Sterling SFTP servers which have +"extractability" level set to 1 which means only 1 file can be opened at +any given time. + + +- Config: use_fstat +- Env Var: RCLONE_SFTP_USE_FSTAT +- Type: bool +- Default: false + ### Limitations ### @@ -23610,7 +25737,7 @@ 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 +Note that some SFTP servers (e.g. 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. @@ -23731,7 +25858,7 @@ To copy a local directory to an SugarSync folder called backup Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. **NB** you can't create files in the top level folder you have to create a folder, which rclone will create as a "Sync Folder" with @@ -23890,6 +26017,15 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin - Default: Slash,Ctl,InvalidUtf8,Dot +### Limitations + +`rclone about` is not supported by the SugarSync backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Tardigrade ----------------------------------------- @@ -23953,7 +26089,7 @@ d) Delete this remote y/e/d> y ``` -### Setup with API key and passhprase +### Setup with API key and passphrase ``` No remotes found - make a new one @@ -24014,7 +26150,7 @@ y/e/d> y ## Usage Paths are specified as `remote:bucket` (or `remote:` for the `lsf` -command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. +command.) You may put subdirectories in too, e.g. `remote:bucket/path/to/dir`. Once configured you can then use `rclone` like this. @@ -24188,6 +26324,15 @@ Encryption Passphrase. To access existing objects enter passphrase used for uplo - Default: "" +### Limitations + +`rclone about` is not supported by the rclone Tardigrade backend. Backends without +this capability cannot determine free space for an rclone mount or +use policy `mfs` (most free space) as a member of an rclone union +remote. + +See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) +See [rclone about](https://rclone.org/commands/rclone_about/) Union ----------------------------------------- @@ -24195,21 +26340,21 @@ Encryption Passphrase. To access existing objects enter passphrase used for uplo The `union` remote provides a unification similar to UnionFS using other remotes. Paths may be as deep as required or a local path, -eg `remote:directory/subdirectory` or `/directory/subdirectory`. +e.g. `remote:directory/subdirectory` or `/directory/subdirectory`. During the initial setup with `rclone config` you will specify the upstream remotes as a space separated list. The upstream remotes can either be a local paths or other remotes. Attribute `:ro` and `:nc` can be attach to the end of path to tag the remote as **read only** or **no create**, -eg `remote:directory/subdirectory:ro` or `remote:directory/subdirectory:nc`. +e.g. `remote:directory/subdirectory:ro` or `remote:directory/subdirectory:nc`. Subfolders can be used in upstream remotes. Assume a union remote named `backup` with the remotes `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop` -is exactly the same as invoking `rclone mkdir mydrive2:/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 mydrive2:/backup/../desktop`. +`rclone mkdir mydrive:private/backup/../desktop`. ### Behavior / Policies @@ -24305,7 +26450,7 @@ Storage> union List of space separated upstreams. Can be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc. Enter a string value. Press Enter for the default (""). -upstreams> +upstreams> remote1:dir1 remote2:dir2 remote3:dir3 Policy to choose upstream on ACTION class. Enter a string value. Press Enter for the default ("epall"). action_policy> @@ -24322,7 +26467,7 @@ Remote config -------------------- [remote] type = union -upstreams = C:\dir1 C:\dir2 C:\dir3 +upstreams = remote1:dir1 remote2:dir2 remote3:dir3 -------------------- y) Yes this is OK e) Edit this remote @@ -24346,15 +26491,15 @@ e/n/d/r/c/s/q> q Once configured you can then use `rclone` like this, -List directories in top level in `C:\dir1`, `C:\dir2` and `C:\dir3` +List directories in top level in `remote1:dir1`, `remote2:dir2` and `remote3:dir3` rclone lsd remote: -List all the files in `C:\dir1`, `C:\dir2` and `C:\dir3` +List all the files in `remote1:dir1`, `remote2:dir2` and `remote3:dir3` rclone ls remote: -Copy another local directory to the union directory called source, which will be placed into `C:\dir3` +Copy another local directory to the union directory called source, which will be placed into `remote3:dir3` rclone copy C:\source remote:source @@ -24417,7 +26562,7 @@ Cache time of usage and free space (in seconds). This option is only useful when Paths are specified as `remote:path` -Paths may be as deep as required, eg `remote:directory/subdirectory`. +Paths may be as deep as required, e.g. `remote:directory/subdirectory`. To configure the WebDAV remote you will need to have a URL for it, and a username and password. If you know what kind of system you are @@ -24470,7 +26615,7 @@ Enter the password: password: Confirm the password: password: -Bearer token instead of user/pass (eg a Macaroon) +Bearer token instead of user/pass (e.g. a Macaroon) bearer_token> Remote config -------------------- @@ -24570,7 +26715,7 @@ Password. #### --webdav-bearer-token -Bearer token instead of user/pass (eg a Macaroon) +Bearer token instead of user/pass (e.g. a Macaroon) - Config: bearer_token - Env Var: RCLONE_WEBDAV_BEARER_TOKEN @@ -24607,10 +26752,8 @@ Owncloud supports modified times using the `X-OC-Mtime` header. ### Nextcloud ### This is configured in an identical way to Owncloud. Note that -Nextcloud does not support streaming of files (`rcat`) whereas -Owncloud does. This [may be -fixed](https://github.com/nextcloud/nextcloud-snap/issues/365) in the -future. +Nextcloud initially did not support streaming of files (`rcat`) whereas +Owncloud did, but [this](https://github.com/nextcloud/nextcloud-snap/issues/365) seems to be fixed as of 2020-11-27 (tested with rclone v1.53.1 and Nextcloud Server v19). ### Sharepoint ### @@ -24818,7 +26961,7 @@ excess files in the path. rclone sync -i /home/local/directory remote:directory -Yandex paths may be as deep as required, eg `remote:directory/subdirectory`. +Yandex paths may be as deep as required, e.g. `remote:directory/subdirectory`. ### Modified time ### @@ -24932,10 +27075,169 @@ See: the [encoding section in the overview](https://rclone.org/overview/#encodin +Zoho Workdrive +---------------------------------------- + +[Zoho WorkDrive](https://www.zoho.com/workdrive/) is a cloud storage solution created by [Zoho](https://zoho.com). + +Here is an example of making a zoho 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 +n/s> 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 / Zoho + \ "zoho" +[snip] +Storage> zoho +** See help for zoho backend at: https://rclone.org/zoho/ ** + +OAuth Client Id +Leave blank normally. +Enter a string value. Press Enter for the default (""). +client_id> +OAuth Client Secret +Leave blank normally. +Enter a string value. Press Enter for the default (""). +client_secret> +Edit advanced config? (y/n) +y) Yes +n) No (default) +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 (default) +n) No +y/n> +If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ +Log in and authorize rclone for access +Waiting for code... +Got code +Choose a number from below, or type in your own value + 1 / MyTeam + \ "4u28602177065ff22426787a6745dba8954eb" +Enter a Team ID> 1 +Choose a number from below, or type in your own value + 1 / General + \ "4u2869d2aa6fca04f4f2f896b6539243b85b1" +Enter a Workspace ID> 1 +-------------------- +[remote] +type = zoho +token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"Zoho-oauthtoken","refresh_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","expiry":"2020-10-12T00:54:52.370275223+02:00"} +root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> +``` + +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 Zoho Workdrive. 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, + +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 -i /home/local/directory remote:directory + +Zoho paths may be as deep as required, eg `remote:directory/subdirectory`. + +### Modified time ### + +Modified times are currently not supported for Zoho Workdrive + +### Checksums ### + +No checksums are supported. + +### Usage information ### + +To view your current quota you can use the `rclone about remote:` +command which will display your current usage. + +#### Restricted filename characters + +Only control characters and invalid UTF-8 are replaced. In addition most +Unicode full-width characters are not supported at all and will be removed +from filenames during upload. + + +### Standard Options + +Here are the standard options specific to zoho (Zoho). + +#### --zoho-region + +Zoho region to connect to. You'll have to use the region you organization is registered in. + +- Config: region +- Env Var: RCLONE_ZOHO_REGION +- Type: string +- Default: "" +- Examples: + - "com" + - United states / Global + - "eu" + - Europe + - "in" + - India + - "com.au" + - Australia + +### Advanced Options + +Here are the advanced options specific to zoho (Zoho). + +#### --zoho-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_ZOHO_ENCODING +- Type: MultiEncoder +- Default: Del,Ctl,InvalidUtf8 + + + Local Filesystem ------------------------------------------- -Local paths are specified as normal filesystem paths, eg `/path/to/wherever`, so +Local paths are specified as normal filesystem paths, e.g. `/path/to/wherever`, so rclone sync -i /home/source /tmp/destination @@ -24957,14 +27259,14 @@ 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 +old Linux filesystem with non UTF-8 file names (e.g. latin1) then you can use the `convmv` tool to convert the filesystem to UTF-8. This tool is available in most distributions' package managers. If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes. The name `gro\xdf` will be transferred as `gro‛DF`. `rclone` will emit a debug -message in this case (use `-v` to see), eg +message in this case (use `-v` to see), e.g. ``` Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf" @@ -25224,7 +27526,7 @@ 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. +where it isn't supported (e.g. Windows) it will be ignored. ### Standard Options @@ -25276,6 +27578,24 @@ points, as you explicitly acknowledge that they should be skipped. - Type: bool - Default: false +#### --local-zero-size-links + +Assume the Stat size of links is zero (and read them instead) + +On some virtual filesystems (such ash LucidLink), reading a link size via a Stat call always returns 0. +However, on unix it reads as the length of the text in the link. This may cause errors like this when +syncing: + + Failed to copy: corrupted on transfer: sizes differ 0 vs 13 + +Setting this flag causes rclone to read the link and use that as the size of the link +instead of 0 which in most cases fixes the problem. + +- Config: zero_size_links +- Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS +- Type: bool +- Default: false + #### --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) @@ -25297,13 +27617,13 @@ Normally rclone checks the size and modification time of files as they are being uploaded and aborts with a message which starts "can't copy - source file is being updated" if the file changes during upload. -However on some file systems this modification time check may fail (eg +However on some file systems this modification time check may fail (e.g. [Glusterfs #2206](https://github.com/rclone/rclone/issues/2206)) so this check can be disabled with this flag. If this flag is set, rclone will use its best efforts to transfer a file which is being updated. If the file is only having things -appended to it (eg a log) then rclone will transfer the log file with +appended to it (e.g. a log) then rclone will transfer the log file with the size it had the first time rclone saw it. If the file is being modified throughout (not just appended to) then @@ -25432,6 +27752,364 @@ Options: # Changelog +## v1.54.0 - 2021-02-02 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.0...v1.54.0) + +* New backends + * Compression remote (experimental)(buengese) + * Enterprise File Fabric (Nick Craig-Wood) + * This work was sponsored by [Storage Made Easy](https://storagemadeeasy.com/) + * HDFS (Hadoop Distributed File System) (Yury Stankevich) + * Zoho workdrive (buengese) +* New Features + * Deglobalise the config (Nick Craig-Wood) + * Global config now read from the context + * Global config can be passed into the rc + * This work was sponsored by [Digitalis](digitalis.io) + * Add `--bwlimit` for upload and download (Nick Craig-Wood) + * Obey bwlimit in http Transport for better limiting + * Enhance systemd integration (Hekmon) + * log level identification + * manual activation with flag + * automatic systemd launch detection + * Don't compile systemd log integration for non unix systems (Benjamin Gustin) + * Add a download flag to hashsum and related commands to force rclone to download and hash files locally (lostheli) + * build + * Raise minimum go version to go1.12 (Nick Craig-Wood) + * check + * Make the error count match up in the log message (Nick Craig-Wood) + * cmd + * Add --progress-terminal-title to print ETA to terminal title (LaSombra) + * Make backend env vars show in help as the defaults for backend flags (Nick Craig-Wood) + * dedupe + * Add --by-hash to dedupe on hash not file name (Nick Craig-Wood) + * Add --dedupe-mode list to just list dupes, changing nothing (Nick Craig-Wood) + * Add warning if used on a remote which can't have duplicate names (Nick Craig-Wood) + * flags: Improve error message when reading environment vars (Nick Craig-Wood) + * fs + * Add Shutdown optional method for backends (Nick Craig-Wood) + * When using --files-from check files concurrently (zhucan) + * Accumulate stats when using --dry-run (Ingo Weiss) + * Always show stats when using --dry-run or --interactive (Nick Craig-Wood) + * Add support for flag --no-console on windows to hide the console window (albertony) + * genautocomplete: Add support to output to stdout (Ingo) + * ncdu + * Highlight read errors instead of aborting (Claudio Bantaloukas) + * Add sort by average size in directory (Adam Plánský) + * Add toggle option for average size in directory - key 'a' (Adam Plánský) + * Add empty folder flag into ncdu browser (Adam Plánský) + * Add ! (errror) and . (unreadable) file flags to go with e (empty) (Nick Craig-Wood) + * obscure: Make `rclone osbcure -` ignore newline at end of line (Nick Craig-Wood) + * operations + * Add logs when need to upload files to set mod times (Nick Craig-Wood) + * Move and copy log name of the destination object in verbose (Adam Plánský) + * Add size if known to skipped items and JSON log (Nick Craig-Wood) + * rc + * Prefer actual listener address if using ":port" or "addr:0" only (Nick Craig-Wood) + * Add listener for finished jobs (Aleksandar Jankovic) + * serve ftp: Add options to enable TLS (Deepak Sah) + * serve http/webdav: Redirect requests to the base url without the / (Nick Craig-Wood) + * serve restic: Implement object cache (Nick Craig-Wood) + * stats: Add counter for deleted directories (Nick Craig-Wood) + * sync: Only print "There was nothing to transfer" if no errors (Nick Craig-Wood) + * webui + * Prompt user for updating webui if an update is available (Chaitanya Bankanhal) + * Fix plugins initialization (negative0) +* Bug Fixes + * build + * Explicitly set ARM version to fix build (Nick Craig-Wood) + * Don't explicitly set ARM version to fix ARMv5 build (Nick Craig-Wood) + * Fix nfpm install (Nick Craig-Wood) + * Fix docker build by upgrading ilteoood/docker_buildx (Nick Craig-Wood) + * Temporary fix for Windows build errors (Ivan Andreev) + * fs + * Fix nil pointer on copy & move operations directly to remote (Anagh Kumar Baranwal) + * Fix parsing of .. when joining remotes (Nick Craig-Wood) + * log: Fix enabling systemd logging when using --log-file (Nick Craig-Wood) + * move: Fix data loss when moving the same object (Nick Craig-Wood) + * operations + * Fix --cutof-mode hard not cutting off immediately (Nick Craig-Wood) + * Fix --immutable error message (Nick Craig-Wood) + * sync + * Fix --cutoff-mode soft & cautious so it doesn't end the transfer early (Nick Craig-Wood) + * Fix --immutable errors retrying many times (Nick Craig-Wood) +* Docs + * Many fixes and a rewrite of the filtering docs (edwardxml) + * Many spelling and grammar problems (Josh Soref) + * Doc fixes for commands delete, purge, rmdir, rmdirs and mount (albertony) + * And thanks to these people for many doc fixes too numerous to list + * Ameer Dawood, Antoine GIRARD, Bob Bagwill, Christopher Stewart + * CokeMine, David, Dov Murik, Durval Menezes, Evan Harris, gtorelly + * Ilyess Bachiri, Janne Johansson, Kerry Su, Marcin Zelent, + * Martin Michlmayr, Milly, Sơn Trần-Nguyễn +* Mount + * Update systemd status with cache stats (Hekmon) + * Disable bazil/fuse based mount on macOS (Nick Craig-Wood) + * Make mount be cmount under macOS (Nick Craig-Wood) + * Implement mknod to make NFS file creation work (Nick Craig-Wood) + * Make sure we don't call umount more than once (Nick Craig-Wood) + * Don't call host.Umount if a signal has been received (Nick Craig-Wood) + * More user friendly mounting as network drive on windows (albertony) + * Cleanup OS specific option handling and documentation (albertony) + * Detect if uid or gid are set in same option string: -o uid=123,gid=456 (albertony) + * Don't attempt to unmount if fs has been destroyed already (Nick Craig-Wood) +* VFS + * Fix virtual entries causing deleted files to still appear (Nick Craig-Wood) + * Fix "file already exists" error for stale cache files (Nick Craig-Wood) + * Fix file leaks with --vfs-cache-mode full and --buffer-size 0 (Nick Craig-Wood) + * Fix invalid cache path on windows when using :backend: as remote (albertony) +* Local + * Continue listing files/folders when a circular symlink is detected (Manish Gupta) + * New flag --local-zero-size-links to fix sync on some virtual filesystems (Riccardo Iaconelli) +* Azure Blob + * Add support for service principals (James Lim) + * Utilize streaming capabilities (Denis Neuling) + * Update SDK to v0.13.0 and fix API breakage (Nick Craig-Wood, Mitsuo Heijo) + * Fix setting of mime types (Nick Craig-Wood) + * Fix crash when listing outside a SAS URL's root (Nick Craig-Wood) + * Delete archive tier blobs before update if --azureblob-archive-tier-delete (Nick Craig-Wood) + * Add support for managed identities (Brad Ackerman) + * Fix crash on startup (Nick Craig-Wood) + * Add examples for access tier (Bob Pusateri) + * Fix memory usage by upgrading the SDK and implementing a TransferManager (Nick Craig-Wood) + * Require go1.14+ to compile due to SDK changes (Nick Craig-Wood) +* B2 + * Make NewObject use less expensive API calls (Nick Craig-Wood) + * Fixed possible crash when accessing Backblaze b2 remote (lluuaapp) +* Box + * Fix NewObject for files that differ in case (Nick Craig-Wood) + * Fix finding directories in a case insentive way (Nick Craig-Wood) +* Chunker + * Skip long local hashing, hash in-transit (fixes) (Ivan Andreev) + * Set Features.ReadMimeType=false as Object.MimeType not supported (Nick Craig-Wood) + * Fix case-insensitive NewObject, test metadata detection (Ivan Andreev) +* Drive + * Implement "rclone backend copyid" command for copying files by ID (Nick Craig-Wood) + * Added flag `--drive-stop-on-download-limit` to stop transfers when the download limit is exceeded (Anagh Kumar Baranwal) + * Implement CleanUp workaround for team drives (buengese) + * Allow shortcut resolution and creation to be retried (Nick Craig-Wood) + * Log that emptying the trash can take some time (Nick Craig-Wood) + * Add xdg office icons to xdg desktop files (Pau Rodriguez-Estivill) +* Dropbox + * Add support for viewing shared files and folders (buengese) + * Implement IDer (buengese) + * Set Features.ReadMimeType=false as Object.MimeType not supported (Nick Craig-Wood) + * Tidy repeated error message (Nick Craig-Wood) + * Make malformed_path errors from too long files not retriable (Nick Craig-Wood) + * Test file name length before upload to fix upload loop (Nick Craig-Wood) + * Enable short lived access tokens (Nick Craig-Wood) +* Fichier + * Set Features.ReadMimeType=true as Object.MimeType is supported (Nick Craig-Wood) +* FTP + * Add --ftp-disable-msld option to ignore MLSD for really old servers (Nick Craig-Wood) + * Make --tpslimit apply (Nick Craig-Wood) +* Google Cloud Storage + * Storage class object header support (Laurens Janssen) + * Fix anonymous client to use rclone's HTTP client (Nick Craig-Wood) + * Fix Entry doesn't belong in directory "" (same as directory) - ignoring (Nick Craig-Wood) +* Googlephotos + * New flag --gphotos-include-archived (Nicolas Rueff) +* Jottacloud + * Don't erroniously report support for writing mime types (buengese) + * Add support for Telia Cloud (#4930) (Patrik Nordlén) +* Mailru + * Fix uploads after recent changes on server (Ivan Andreev) + * Fix range requests after June 2020 changes on server (Ivan Andreev) + * Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) + * Remove deprecated protocol quirks (Ivan Andreev) + * Accept special folders eg camera-upload (Ivan Andreev) + * Avoid prehashing of large local files (Ivan Andreev) +* Memory + * Fix setting of mime types (Nick Craig-Wood) +* Onedrive + * Add support for china region operated by 21vianet and other regional suppliers (#4963) (NyaMisty) + * Warn on gateway timeout errors (Nick Craig-Wood) + * Fall back to normal copy if server-side copy unavailable (#4903) (Alex Chen) + * Fix server-side copy completely disabled on OneDrive for Business (Cnly) + * (business only) workaround to replace existing file on server-side copy (#4904) (Alex Chen) + * Enhance link creation with expiry, scope, type and password (Nick Craig-Wood) + * Remove % and # from the set of encoded characters (#4909) (Alex Chen) + * Support addressing site by server-relative URL (#4761) (kice) +* Opendrive + * Fix finding directories in a case insensitive way (Nick Craig-Wood) +* Pcloud + * Fix setting of mime types (Nick Craig-Wood) +* Premiumizeme + * Fix finding directories in a case insensitive way (Nick Craig-Wood) +* Qingstor + * Fix error propagation in CleanUp (Nick Craig-Wood) + * Fix rclone cleanup (Nick Craig-Wood) +* S3 + * Added `--s3-disable-http2` to disable http/2 (Anagh Kumar Baranwal) + * Complete SSE-C implementation (Nick Craig-Wood) + * Fix hashes on small files with AWS:KMS and SSE-C (Nick Craig-Wood) + * Add MD5 metadata to objects uploaded with SSE-AWS/SSE-C (Nick Craig-Wood) + * Update docs with a Reducing Costs section (Nick Craig-Wood) + * Added error handling for error code 429 indicating too many requests (Anagh Kumar Baranwal) + * Add requester pays option (kelv) + * Fix copy multipart with v2 auth failing with 'SignatureDoesNotMatch' (Louis Koo) + * Add --s3-no-head parameter to minimise transactions on upload (Nick Craig-Wood) +* SFTP + * Allow cert based auth via optional pubkey (Stephen Harris) + * Allow user to optionally check server hosts key to add security (Stephen Harris) + * Defer asking for user passwords until the SSH connection succeeds (Stephen Harris) + * Remember entered password in AskPass mode (Stephen Harris) + * Implement Shutdown method (Nick Craig-Wood) + * Implement keyboard interactive authentication (Nick Craig-Wood) + * Make --tpslimit apply (Nick Craig-Wood) + * Implement --sftp-use-fstat (Nick Craig-Wood) +* Sugarsync + * Fix NewObject for files that differ in case (Nick Craig-Wood) + * Fix finding directories in a case insentive way (Nick Craig-Wood) +* Swift + * Fix deletion of parts of Static Large Object (SLO) (Nguyễn Hữu Luân) + * Ensure partially uploaded large files are uploaded unless --swift-leave-parts-on-error (Nguyễn Hữu Luân) +* Tardigrade + * Upgrade to uplink v1.4.1 (Caleb Case) +* WebDAV + * Updated docs to show streaming to nextcloud is working (Durval Menezes) +* Yandex + * Set Features.WriteMimeType=false as Yandex ignores mime types (Nick Craig-Wood) + +## v1.53.4 - 2021-01-20 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.3...v1.53.4) + +* Bug Fixes + * accounting: Fix data race in Transferred() (Maciej Zimnoch) + * build + * Stop tagged releases making a current beta (Nick Craig-Wood) + * Upgrade docker buildx action (Matteo Pietro Dazzi) + * Add -buildmode to cross-compile.go (Nick Craig-Wood) + * Fix docker build by upgrading ilteoood/docker_buildx (Nick Craig-Wood) + * Revert GitHub actions brew fix since this is now fixed (Nick Craig-Wood) + * Fix brew install --cask syntax for macOS build (Nick Craig-Wood) + * Update nfpm syntax to fix build of .deb/.rpm packages (Nick Craig-Wood) + * Fix for Windows build errors (Ivan Andreev) + * fs: Parseduration: fixed tests to use UTC time (Ankur Gupta) + * fshttp: Prevent overlap of HTTP headers in logs (Nathan Collins) + * rc + * Fix core/command giving 500 internal error (Nick Craig-Wood) + * Add Copy method to rc.Params (Nick Craig-Wood) + * Fix 500 error when marshalling errors from core/command (Nick Craig-Wood) + * plugins: Create plugins files only if webui is enabled. (negative0) + * serve http: Fix serving files of unknown length (Nick Craig-Wood) + * serve sftp: Fix authentication on one connection blocking others (Nick Craig-Wood) +* Mount + * Add optional `brew` tag to throw an error when using mount in the binaries installed via Homebrew (Anagh Kumar Baranwal) + * Add "." and ".." to directories to match cmount and expectations (Nick Craig-Wood) +* VFS + * Make cache dir absolute before using it to fix path too long errors (Nick Craig-Wood) +* Chunker + * Improve detection of incompatible metadata (Ivan Andreev) +* Google Cloud Storage + * Fix server side copy of large objects (Nick Craig-Wood) +* Jottacloud + * Fix token renewer to fix long uploads (Nick Craig-Wood) + * Fix token refresh failed: is not a regular file error (Nick Craig-Wood) +* Pcloud + * Only use SHA1 hashes in EU region (Nick Craig-Wood) +* Sharefile + * Undo Fix backend due to API swapping integers for strings (Nick Craig-Wood) +* WebDAV + * Fix Open Range requests to fix 4shared mount (Nick Craig-Wood) + * Add "Depth: 0" to GET requests to fix bitrix (Nick Craig-Wood) + +## v1.53.3 - 2020-11-19 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.2...v1.53.3) + +* Bug Fixes + * random: Fix incorrect use of math/rand instead of crypto/rand CVE-2020-28924 (Nick Craig-Wood) + * Passwords you have generated with `rclone config` may be insecure + * See [issue #4783](https://github.com/rclone/rclone/issues/4783) for more details and a checking tool + * random: Seed math/rand in one place with crypto strong seed (Nick Craig-Wood) +* VFS + * Fix vfs/refresh calls with fs= parameter (Nick Craig-Wood) +* Sharefile + * Fix backend due to API swapping integers for strings (Nick Craig-Wood) + +## v1.53.2 - 2020-10-26 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.1...v1.53.2) + +* Bug Fixes + * acounting + * Fix incorrect speed and transferTime in core/stats (Nick Craig-Wood) + * Stabilize display order of transfers on Windows (Nick Craig-Wood) + * operations + * Fix use of --suffix without --backup-dir (Nick Craig-Wood) + * Fix spurious "--checksum is in use but the source and destination have no hashes in common" (Nick Craig-Wood) + * build + * Work around GitHub actions brew problem (Nick Craig-Wood) + * Stop using set-env and set-path in the GitHub actions (Nick Craig-Wood) +* Mount + * mount2: Fix the swapped UID / GID values (Russell Cattelan) +* VFS + * Detect and recover from a file being removed externally from the cache (Nick Craig-Wood) + * Fix a deadlock vulnerability in downloaders.Close (Leo Luan) + * Fix a race condition in retryFailedResets (Leo Luan) + * Fix missed concurrency control between some item operations and reset (Leo Luan) + * Add exponential backoff during ENOSPC retries (Leo Luan) + * Add a missed update of used cache space (Leo Luan) + * Fix --no-modtime to not attempt to set modtimes (as documented) (Nick Craig-Wood) +* Local + * Fix sizes and syncing with --links option on Windows (Nick Craig-Wood) +* Chunker + * Disable ListR to fix missing files on GDrive (workaround) (Ivan Andreev) + * Fix upload over crypt (Ivan Andreev) +* Fichier + * Increase maximum file size from 100GB to 300GB (gyutw) +* Jottacloud + * Remove clientSecret from config when upgrading to token based authentication (buengese) + * Avoid double url escaping of device/mountpoint (albertony) + * Remove DirMove workaround as it's not required anymore - also (buengese) +* Mailru + * Fix uploads after recent changes on server (Ivan Andreev) + * Fix range requests after june changes on server (Ivan Andreev) + * Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) +* Onedrive + * Fix disk usage for sharepoint (Nick Craig-Wood) +* S3 + * Add missing regions for AWS (Anagh Kumar Baranwal) +* Seafile + * Fix accessing libraries > 2GB on 32 bit systems (Muffin King) +* SFTP + * Always convert the checksum to lower case (buengese) +* Union + * Create root directories if none exist (Nick Craig-Wood) + +## v1.53.1 - 2020-09-13 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1) + +* Bug Fixes + * accounting: Remove new line from end of --stats-one-line display (Nick Craig-Wood) + * check + * Add back missing --download flag (Nick Craig-Wood) + * Fix docs (Nick Craig-Wood) + * docs + * Note --log-file does append (Nick Craig-Wood) + * Add full stops for consistency in rclone --help (edwardxml) + * Add Tencent COS to s3 provider list (wjielai) + * Updated mount command to reflect that it requires Go 1.13 or newer (Evan Harris) + * jottacloud: Mention that uploads from local disk will not need to cache files to disk for md5 calculation (albertony) + * Fix formatting of rc docs page (Nick Craig-Wood) + * build + * Include vendor tar ball in release and fix startdev (Nick Craig-Wood) + * Fix "Illegal instruction" error for ARMv6 builds (Nick Craig-Wood) + * Fix architecture name in ARMv7 build (Nick Craig-Wood) +* VFS + * Fix spurious error "vfs cache: failed to _ensure cache EOF" (Nick Craig-Wood) + * Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood) +* Local + * Log an ERROR if we fail to set the file to be sparse (Nick Craig-Wood) +* Drive + * Re-adds special oauth help text (Tim Gallant) +* Opendrive + * Do not retry 400 errors (Evan Harris) + ## v1.53.0 - 2020-09-02 [See commits](https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0) @@ -25460,7 +28138,7 @@ Options: * Add reverse proxy pluginsHandler for serving plugins (Chaitanya Bankanhal) * Add `mount/listmounts` option for listing current mounts (Chaitanya Bankanhal) * Add `operations/uploadfile` to upload a file through rc using encoding multipart/form-data (Chaitanya Bankanhal) - * Add `core/copmmand` to execute rclone terminal commands. (Chaitanya Bankanhal) + * Add `core/command` to execute rclone terminal commands. (Chaitanya Bankanhal) * `rclone check` * Add reporting of filenames for same/missing/changed (Nick Craig-Wood) * Make check command obey `--dry-run`/`-i`/`--interactive` (Nick Craig-Wood) @@ -25539,7 +28217,7 @@ Options: * Azure Blob * Don't compile on < go1.13 after dependency update (Nick Craig-Wood) * B2 - * Implement server side copy for files > 5GB (Nick Craig-Wood) + * Implement server-side copy for files > 5GB (Nick Craig-Wood) * Cancel in progress multipart uploads and copies on rclone exit (Nick Craig-Wood) * Note that b2's encoding now allows \ but rclone's hasn't changed (Nick Craig-Wood) * Fix transfers when using download_url (Nick Craig-Wood) @@ -25555,7 +28233,7 @@ Options: * Work around drive bug which didn't set modtime of copied docs (Nick Craig-Wood) * Added `--drive-starred-only` to only show starred files (Jay McEntire) * Deprecate `--drive-alternate-export` as it is no longer needed (themylogin) - * Fix duplication of Google docs on server side copy (Nick Craig-Wood) + * Fix duplication of Google docs on server-side copy (Nick Craig-Wood) * Fix "panic: send on closed channel" when recycling dir entries (Nick Craig-Wood) * Dropbox * Add copyright detector info in limitations section in the docs (Alex Guerrero) @@ -25569,7 +28247,7 @@ Options: * Google Cloud Storage * Add support for anonymous access (Kai Lüke) * Jottacloud - * Bring back legacy authentification for use with whitelabel versions (buengese) + * Bring back legacy authentication for use with whitelabel versions (buengese) * Switch to new api root - also implement a very ugly workaround for the DirMove failures (buengese) * Onedrive * Rework cancel of multipart uploads on rclone exit (Nick Craig-Wood) @@ -25615,7 +28293,7 @@ Options: * Bug Fixes * docs - * Disable smart typography (eg en-dash) in MANUAL.* and man page (Nick Craig-Wood) + * Disable smart typography (e.g. en-dash) in MANUAL.* and man page (Nick Craig-Wood) * Update install.md to reflect minimum Go version (Evan Harris) * Update install from source instructions (Nick Craig-Wood) * make_manual: Support SOURCE_DATE_EPOCH (Morten Linderud) @@ -25719,8 +28397,8 @@ all the docs and Edward Barker for helping re-write the front page. * Add `--header` flag to add HTTP headers to every HTTP transaction (Nick Craig-Wood) * Add `--check-first` to do all checking before starting transfers (Nick Craig-Wood) * Add `--track-renames-strategy` for configurable matching criteria for `--track-renames` (Bernd Schoolmann) - * Add `--cutoff-mode` hard,soft,catious (Shing Kit Chan & Franklyn Tackitt) - * Filter flags (eg `--files-from -`) can read from stdin (fishbullet) + * Add `--cutoff-mode` hard,soft,cautious (Shing Kit Chan & Franklyn Tackitt) + * Filter flags (e.g. `--files-from -`) can read from stdin (fishbullet) * Add `--error-on-no-transfer` option (Jon Fautley) * Implement `--order-by xxx,mixed` for copying some small and some big files (Nick Craig-Wood) * Allow `--max-backlog` to be negative meaning as large as possible (Nick Craig-Wood) @@ -26002,7 +28680,7 @@ all the docs and Edward Barker for helping re-write the front page. * dbhashsum: Stop it returning UNSUPPORTED on dropbox (Nick Craig-Wood) * dedupe: Add missing modes to help string (Nick Craig-Wood) * operations - * Fix dedupe continuing on errors like insufficientFilePermisson (SezalAgrawal) + * Fix dedupe continuing on errors like insufficientFilePersimmon (SezalAgrawal) * Clear accounting before low level retry (Maciej Zimnoch) * Write debug message when hashes could not be checked (Ole Schütt) * Move interface assertion to tests to remove pflag dependency (Nick Craig-Wood) @@ -26066,7 +28744,7 @@ all the docs and Edward Barker for helping re-write the front page. * S3 * Re-implement multipart upload to fix memory issues (Nick Craig-Wood) * Add `--s3-copy-cutoff` for size to switch to multipart copy (Nick Craig-Wood) - * Add new region Asia Patific (Hong Kong) (Outvi V) + * Add new region Asia Pacific (Hong Kong) (Outvi V) * Reduce memory usage streaming files by reducing max stream upload size (Nick Craig-Wood) * Add `--s3-list-chunk` option for bucket listing (Thomas Kriechbaumer) * Force path style bucket access to off for AWS deprecation (Nick Craig-Wood) @@ -26145,7 +28823,7 @@ all the docs and Edward Barker for helping re-write the front page. * 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) + * 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 @@ -26164,7 +28842,7 @@ all the docs and Edward Barker for helping re-write the front page. * 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) + * serve sftp: Fix crash on unsupported operations (e.g. Readlink) (Nick Craig-Wood) * Mount * Allow files of unknown size to be read properly (Nick Craig-Wood) * Skip tests on <= 2 CPUs to avoid lockup (Nick Craig-Wood) @@ -26180,7 +28858,7 @@ all the docs and Edward Barker for helping re-write the front page. * 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) + * Remove `unverified:` prefix on sha1 to improve interop (e.g. with CyberDuck) (Nick Craig-Wood) * Box * Add options to get access token via JWT auth (David) * Drive @@ -26327,7 +29005,7 @@ all the docs and Edward Barker for helping re-write the front page. * rcat: Fix slowdown on systems with multiple hashes (Nick Craig-Wood) * rcd: Fix permissions problems on cache directory with web gui download (Nick Craig-Wood) * Mount - * Default `--deamon-timout` to 15 minutes on macOS and FreeBSD (Nick Craig-Wood) + * Default `--daemon-timout` to 15 minutes on macOS and FreeBSD (Nick Craig-Wood) * Update docs to show mounting from root OK for bucket based (Nick Craig-Wood) * Remove nonseekable flag from write files (Nick Craig-Wood) * VFS @@ -26344,10 +29022,10 @@ all the docs and Edward Barker for helping re-write the front page. * Make all operations work from the root (Nick Craig-Wood) * B2 * Implement link sharing (yparitcher) - * Enable server side copy to copy between buckets (Nick Craig-Wood) + * Enable server-side copy to copy between buckets (Nick Craig-Wood) * Make all operations work from the root (Nick Craig-Wood) * Drive - * Fix server side copy of big files (Nick Craig-Wood) + * Fix server-side copy of big files (Nick Craig-Wood) * Update API for teamdrive use (Nick Craig-Wood) * Add error for purge with `--drive-trashed-only` (ginvine) * Fichier @@ -26395,7 +29073,7 @@ all the docs and Edward Barker for helping re-write the front page. * controlled with `--multi-thread-cutoff` and `--multi-thread-streams` * Use rclone.conf from rclone executable directory to enable portable use (albertony) * Allow sync of a file and a directory with the same name (forgems) - * this is common on bucket based remotes, eg s3, gcs + * this is common on bucket based remotes, e.g. s3, gcs * Add `--ignore-case-sync` for forced case insensitivity (garry415) * Implement `--stats-one-line-date` and `--stats-one-line-date-format` (Peter Berbec) * Log an ERROR for all commands which exit with non-zero status (Nick Craig-Wood) @@ -26441,12 +29119,12 @@ all the docs and Edward Barker for helping re-write the front page. * Support PublicLink (rclone link) of underlying backend (Nick Craig-Wood) * Implement Optional methods SetTier, GetTier (Nick Craig-Wood) * B2 - * Implement server side copy (Nick Craig-Wood) + * Implement server-side copy (Nick Craig-Wood) * Implement SetModTime (Nick Craig-Wood) * Drive * Fix move and copy from TeamDrive to GDrive (Fionera) * Add notes that cleanup works in the background on drive (Nick Craig-Wood) - * Add `--drive-server-side-across-configs` to default back to old server side copy semantics by default (Nick Craig-Wood) + * Add `--drive-server-side-across-configs` to default back to old server-side copy semantics by default (Nick Craig-Wood) * Add `--drive-size-as-quota` to show storage quota usage for file size (Garry McNulty) * FTP * Add FTP List timeout (Jeff Quinn) @@ -26485,12 +29163,12 @@ all the docs and Edward Barker for helping re-write the front page. * use `--disable ListR` to get old behaviour if required * Make `--files-from` traverse the destination unless `--no-traverse` is set (Nick Craig-Wood) * this fixes `--files-from` with Google drive and excessive API use in general. - * Make server side copy account bytes and obey `--max-transfer` (Nick Craig-Wood) + * Make server-side copy account bytes and obey `--max-transfer` (Nick Craig-Wood) * Add `--create-empty-src-dirs` flag and default to not creating empty dirs (ishuah) * Add client side TLS/SSL flags `--ca-cert`/`--client-cert`/`--client-key` (Nick Craig-Wood) * Implement `--suffix-keep-extension` for use with `--suffix` (Nick Craig-Wood) * build: - * Switch to semvar compliant version tags to be go modules compliant (Nick Craig-Wood) + * Switch to semver compliant version tags to be go modules compliant (Nick Craig-Wood) * Update to use go1.12.x for the build (Nick Craig-Wood) * serve dlna: Add connection manager service description to improve compatibility (Dan Walters) * lsf: Add 'e' format to show encrypted names and 'o' for original IDs (Nick Craig-Wood) @@ -26520,11 +29198,11 @@ all the docs and Edward Barker for helping re-write the front page. * Ignore malformed `src_last_modified_millis` (Nick Craig-Wood) * Drive * Add `--skip-checksum-gphotos` to ignore incorrect checksums on Google Photos (Nick Craig-Wood) - * Allow server side move/copy between different remotes. (Fionera) + * Allow server-side move/copy between different remotes. (Fionera) * Add docs on team drives and `--fast-list` eventual consistency (Nestar47) * Fix imports of text files (Nick Craig-Wood) * Fix range requests on 0 length files (Nick Craig-Wood) - * Fix creation of duplicates with server side copy (Nick Craig-Wood) + * Fix creation of duplicates with server-side copy (Nick Craig-Wood) * Dropbox * Retry blank errors to fix long listings (Nick Craig-Wood) * FTP @@ -26608,7 +29286,7 @@ all the docs and Edward Barker for helping re-write the front page. * Check for maximum length before decrypting filename to fix panic (Garry McNulty) * Azure Blob * Allow building azureblob backend on *BSD (themylogin) - * Use the rclone HTTP client to support `--dump headers`, `--tpslimit` etc (Nick Craig-Wood) + * Use the rclone HTTP client to support `--dump headers`, `--tpslimit`, etc. (Nick Craig-Wood) * Use the s3 pacer for 0 delay in non error conditions (Nick Craig-Wood) * Ignore directory markers (Nick Craig-Wood) * Stop Mkdir attempting to create existing containers (Nick Craig-Wood) @@ -26666,7 +29344,7 @@ all the docs and Edward Barker for helping re-write the front page. * Add support for PEM encrypted private keys (Fabian Möller) * Add option to force the usage of an ssh-agent (Fabian Möller) * Perform environment variable expansion on key-file (Fabian Möller) - * Fix rmdir on Windows based servers (eg CrushFTP) (Nick Craig-Wood) + * Fix rmdir on Windows based servers (e.g. CrushFTP) (Nick Craig-Wood) * Fix rmdir deleting directory contents on some SFTP servers (Nick Craig-Wood) * Fix error on dangling symlinks (Nick Craig-Wood) * Swift @@ -26697,7 +29375,7 @@ all the docs and Edward Barker for helping re-write the front page. * sensitive operations require authorization or the `--rc-no-auth` flag * config/* operations to configure rclone * options/* for reading/setting command line flags - * operations/* for all low level operations, eg copy file, list directory + * operations/* for all low level operations, e.g. copy file, list directory * sync/* for sync, copy and move * `--rc-files` flag to serve files on the rc http server * this is for building web native GUIs for rclone @@ -26737,7 +29415,7 @@ all the docs and Edward Barker for helping re-write the front page. * Fix transfer of files with `+` and `&` in (Nick Craig-Wood) * Fix retries of upload chunks (Nick Craig-Wood) * S3 - * Set ACL for server side copies to that provided by the user (Nick Craig-Wood) + * Set ACL for server-side copies to that provided by the user (Nick Craig-Wood) * Fix role_arn, credential_source, ... (Erik Swanson) * Add config info for Wasabi's US-West endpoint (Henry Ptasinski) * SFTP @@ -26780,7 +29458,7 @@ all the docs and Edward Barker for helping re-write the front page. * VFS * Fix race condition detected by serve ftp tests (Nick Craig-Wood) * Add vfs/poll-interval rc command (Fabian Möller) - * Enable rename for nearly all remotes using server side Move or Copy (Nick Craig-Wood) + * Enable rename for nearly all remotes using server-side Move or Copy (Nick Craig-Wood) * Reduce directory cache cleared by poll-interval (Fabian Möller) * Remove EXPERIMENTAL tags (Nick Craig-Wood) * Local @@ -26843,7 +29521,7 @@ all the docs and Edward Barker for helping re-write the front page. * Fix v2 auth on files with spaces (Nick Craig-Wood) * Union * Implement union backend which reads from multiple backends (Felix Brucker) - * Implement optional interfaces (Move, DirMove, Copy etc) (Nick Craig-Wood) + * Implement optional interfaces (Move, DirMove, Copy, etc.) (Nick Craig-Wood) * Fix ChangeNotify to support multiple remotes (Fabian Möller) * Fix `--backup-dir` on union backend (Nick Craig-Wood) * WebDAV @@ -26965,7 +29643,7 @@ Point release to fix hubic and azureblob backends. * Swift * Add `storage_policy` (Ruben Vandamme) * Make it so just `storage_url` or `auth_token` can be overridden (Nick Craig-Wood) - * Fix server side copy bug for unusual file names (Nick Craig-Wood) + * Fix server-side copy bug for unusual file names (Nick Craig-Wood) * Remove leading / from paths (Nick Craig-Wood) * WebDAV * Ensure we call MKCOL with a URL with a trailing / for QNAP interop (Nick Craig-Wood) @@ -27092,7 +29770,7 @@ Point release to fix hubic and azureblob backends. * rc: fix setting bwlimit to unlimited * rc: take note of the --rc-addr flag too as per the docs * Mount - * Use About to return the correct disk total/used/free (eg in `df`) + * Use About to return the correct disk total/used/free (e.g. in `df`) * Set `--attr-timeout default` to `1s` - fixes: * rclone using too much memory * rclone not serving files to samba @@ -27283,7 +29961,7 @@ Point release to fix hubic and azureblob backends. * Update docs to discourage use of v2 auth with CEPH and others * Don't check for bucket/container presence if listing was OK * this makes rclone do one less request per invocation - * Fix server side copy and set modtime on files with + in + * Fix server-side copy and set modtime on files with + in * SFTP * Add option to disable remote hash check command execution (Jon Fautley) * Add `--sftp-ask-password` flag to prompt for password when needed (Leo R. Lundgren) @@ -27331,7 +30009,7 @@ Point release to fix hubic and azureblob backends. * Retry lots more different types of errors to make multipart transfers more reliable * Save the config before asking for a token, fixes disappearing oauth config * Warn the user if --include and --exclude are used together (Ernest Borowski) - * Fix duplicate files (eg on Google drive) causing spurious copies + * Fix duplicate files (e.g. on Google drive) causing spurious copies * Allow trailing and leading whitespace for passwords (Jason Rose) * ncdu: fix crashes on empty directories * rcat: fix goroutine leak @@ -27420,7 +30098,7 @@ Point release to fix hubic and azureblob backends. * Fix "entry doesn't belong in directory" error * Stop using deprecated API methods * Swift - * Fix server side copy to empty container with `--fast-list` + * Fix server-side copy to empty container with `--fast-list` * Google Drive * Change the default for `--drive-use-trash` to `true` * S3 @@ -27520,7 +30198,7 @@ Point release to fix hubic and azureblob backends. * Retry on token expired error, reset upload body on retry - Yoni Jah * Google Cloud Storage * Add ability to specify location and storage class via config and command line - thanks gdm85 - * Create container if necessary on server side copy + * Create container if necessary on server-side copy * Increase directory listing chunk to 1000 to increase performance * Obtain a refresh token for GCS - Steven Lu * Yandex @@ -27536,14 +30214,14 @@ Point release to fix hubic and azureblob backends. * Now supports low level retries * S3 * Work around eventual consistency in bucket creation - * Create container if necessary on server side copy + * Create container if necessary on server-side copy * Add us-east-2 (Ohio) and eu-west-2 (London) S3 regions - Zahiar Ahmed * Swift, Hubic * Fix zero length directory markers showing in the subdirectory listing * this caused lots of duplicate transfers * Fix paged directory listings * this caused duplicate directory errors - * Create container if necessary on server side copy + * Create container if necessary on server-side copy * Increase directory listing chunk to 1000 to increase performance * Make sensible error if the user forgets the container * SFTP @@ -27645,7 +30323,7 @@ Point release to fix hubic and azureblob backends. * Allow repeated --include/--exclude/--filter options * Only show transfer stats on commands which transfer stuff * show stats on any command using the `--stats` flag - * Allow overlapping directories in move when server side dir move is supported + * Allow overlapping directories in move when server-side dir move is supported * Add --stats-unit option - thanks Scott McGillivray * Bug Fixes * Fix the config file being overwritten when two rclone instances are running @@ -27667,7 +30345,7 @@ Point release to fix hubic and azureblob backends. * Fix failed to authenticate decrypted block errors * these will now return the underlying unexpected EOF instead * Amazon Drive - * Add support for server side move and directory move - thanks Stefan Breunig + * Add support for server-side move and directory move - thanks Stefan Breunig * Fix nil pointer deref on size attribute * B2 * Use new prefix and delimiter parameters in directory listings @@ -27759,7 +30437,7 @@ Point release to fix hubic and azureblob backends. * New B2 API endpoint (thanks Per Cederberg) * Set maximum backoff to 5 Minutes * onedrive - * Fix URL escaping in file names - eg uploading files with `+` in them. + * Fix URL escaping in file names - e.g. uploading files with `+` in them. * amazon cloud drive * Fix token expiry during large uploads * Work around 408 REQUEST_TIMEOUT and 504 GATEWAY_TIMEOUT errors @@ -27800,7 +30478,7 @@ Point release to fix hubic and azureblob backends. * Skip setting the modified time for objects > 5GB as it isn't possible. * Backblaze B2 * Add --b2-versions flag so old versions can be listed and retrieved. - * Treat 403 errors (eg cap exceeded) as fatal. + * Treat 403 errors (e.g. cap exceeded) as fatal. * Implement cleanup command for deleting old file versions. * Make error handling compliant with B2 integrations notes. * Fix handling of token expiry. @@ -27823,7 +30501,7 @@ Point release to fix hubic and azureblob backends. * Log -v output to stdout by default * Display the transfer stats in more human readable form * Make 0 size files specifiable with `--max-size 0b` - * Add `b` suffix so we can specify bytes in --bwlimit, --min-size etc + * Add `b` suffix so we can specify bytes in --bwlimit, --min-size, etc. * Use "password:" instead of "password>" prompt - thanks Klaus Post and Leigh Klotz * Bug Fixes * Fix retry doing one too many retries @@ -27958,7 +30636,7 @@ Point release to fix hubic and azureblob backends. * Swift * Fix sync for chunked files * OneDrive - * Re-enable server side copy + * Re-enable server-side copy * Don't mask HTTP error codes with JSON decode error * S3 * Fix corrupting Content-Type on mod time update (thanks Joseph Spurrier) @@ -27972,11 +30650,11 @@ Point release to fix hubic and azureblob backends. * This could have deleted files unexpectedly on sync * Always check first with `--dry-run`! * Swift - * Stop SetModTime losing metadata (eg X-Object-Manifest) + * Stop SetModTime losing metadata (e.g. X-Object-Manifest) * This could have caused data loss for files > 5GB in size * Use ContentType from Object to avoid lookups in listings * OneDrive - * disable server side copy as it seems to be broken at Microsoft + * disable server-side copy as it seems to be broken at Microsoft ## v1.24 - 2015-11-07 @@ -28037,7 +30715,7 @@ Point release to fix hubic and azureblob backends. * drive, googlecloudstorage: optionally use auto config for the oauth token * Implement --dump-headers and --dump-bodies debug flags * Show multiple matched commands if abbreviation too short - * Implement server side move where possible + * Implement server-side move where possible * local * Always use UNC paths internally on Windows - fixes a lot of bugs * dropbox @@ -28048,7 +30726,7 @@ Point release to fix hubic and azureblob backends. * New features * Server side copies for s3/swift/drive/dropbox/gcs - * Move command - uses server side copies if it can + * Move command - uses server-side copies if it can * Implement --retries flag - tries 3 times by default * Build for plan9/amd64 and solaris/amd64 too * Fixes @@ -28135,7 +30813,7 @@ Point release to fix hubic and azureblob backends. ## v1.09 - 2015-02-07 -* windows: Stop drive letters (eg C:) getting mixed up with remotes (eg drive:) +* windows: Stop drive letters (e.g. C:) getting mixed up with remotes (e.g. drive:) * local: Fix directory separators on Windows * drive: fix rate limit exceeded errors @@ -28290,7 +30968,7 @@ Frequently Asked Questions ### Do all cloud storage systems support all rclone commands ### -Yes they do. All the rclone commands (eg `sync`, `copy` etc) will +Yes they do. All the rclone commands (e.g. `sync`, `copy`, etc.) will work on all the remote storage systems. ### Can I copy the config from one machine to another ### @@ -28322,7 +31000,7 @@ Eg ### Using rclone from multiple locations at the same time ### You can use rclone from multiple places at the same time if you choose -different subdirectory for the output, eg +different subdirectory for the output, e.g. ``` Server A> rclone sync -i /tmp/whatever remote:ServerA @@ -28330,7 +31008,7 @@ Server B> rclone sync -i /tmp/whatever remote:ServerB ``` If you sync to the same directory then you should use rclone copy -otherwise the two instances of rclone may delete each other's files, eg +otherwise the two instances of rclone may delete each other's files, e.g. ``` Server A> rclone copy /tmp/whatever remote:Backup @@ -28338,14 +31016,14 @@ Server B> rclone copy /tmp/whatever remote:Backup ``` The file names you upload from Server A and Server B should be -different in this case, otherwise some file systems (eg Drive) may +different in this case, otherwise some file systems (e.g. Drive) may make duplicates. ### Why doesn't rclone support partial transfers / binary diffs like rsync? ### Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you -upload as expected using alternative access methods (eg using the +upload as expected using alternative access methods (e.g. using the Google Drive web interface). There is a 1:1 mapping between files on your hard disk and objects created in the cloud storage system. @@ -28702,7 +31380,7 @@ put them back in again.` >}} * Andres Alvarez <1671935+kir4h@users.noreply.github.com> * reddi1 * Matt Tucker - * Sebastian Bünger + * Sebastian Bünger * Martin Polden * Alex Chen * Denis @@ -28927,6 +31605,53 @@ put them back in again.` >}} * Lucas Kanashiro * WarpedPixel * Sam Edwards + * wjielai + * Muffin King + * Christopher Stewart <6573710+1f47a@users.noreply.github.com> + * Russell Cattelan + * gyutw <30371241+gyutw@users.noreply.github.com> + * Hekmon + * LaSombra + * Dov Murik + * Ameer Dawood + * Dan Hipschman + * Josh Soref + * David + * Ingo + * Adam Plánský + * Manish Gupta + * Deepak Sah + * Marcin Zelent + * zhucan + * James Lim + * Laurens Janssen + * Bob Bagwill + * Nathan Collins + * lostheli + * kelv + * Milly + * gtorelly + * Brad Ackerman + * Mitsuo Heijo + * Claudio Bantaloukas + * Benjamin Gustin + * Ingo Weiss + * Kerry Su + * Ilyess Bachiri + * Yury Stankevich + * kice + * Denis Neuling + * Janne Johansson + * Patrik Nordlén + * CokeMine + * Sơn Trần-Nguyễn + * lluuaapp <266615+lluuaapp@users.noreply.github.com> + * Zach Kipp + * Riccardo Iaconelli + * Sakuragawa Misty + * Nicolas Rueff + * Pau Rodriguez-Estivill + * Bob Pusateri # Contact the rclone project # diff --git a/MANUAL.txt b/MANUAL.txt index f974a3cd4..1d3dbbbb3 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ rclone(1) User Manual Nick Craig-Wood -Sep 02, 2020 +Feb 02, 2021 @@ -36,12 +36,12 @@ Rclone really looks after your data. It preserves timestamps and verifies checksums at all times. Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can check the integrity of your files. -Where possible, rclone employs server side transfers to minimise local +Where possible, rclone employs server-side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk. Virtual backends wrap local and cloud file systems to apply encryption, -caching, chunking and joining. +caching, compression chunking and joining. Rclone mounts any local, cloud or virtual filesystem as a disk on Windows, macOS, linux and FreeBSD, and also serves these over SFTP, @@ -81,7 +81,7 @@ Features - MD5, SHA1 hashes are checked at all times for file integrity - Timestamps are preserved on files - Operations can be restarted at any time - - Can be to and from network, eg two different cloud providers + - Can be to and from network, e.g. two different cloud providers - Can use multi-threaded downloads to local disk - Copy new or changed files to cloud storage - Sync (one way) to make a directory identical @@ -109,10 +109,12 @@ S3, that work out of the box.) - DigitalOcean Spaces - Dreamhost - Dropbox +- Enterprise File Fabric - FTP - Google Cloud Storage - Google Drive - Google Photos +- HDFS - HTTP - Hubic - Jottacloud @@ -143,9 +145,11 @@ S3, that work out of the box.) - StackPath - SugarSync - Tardigrade +- Tencent Cloud Object Storage (COS) - Wasabi - WebDAV - Yandex Disk +- Zoho WorkDrive - The local filesystem Links @@ -271,7 +275,7 @@ 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. +version tags, e.g. :1.49.1, :1.49 or :1. $ docker pull rclone/rclone:latest latest: Pulling from rclone/rclone @@ -344,7 +348,7 @@ Here are some commands tested on an Ubuntu 18.04.3 host: Install from source -Make sure you have at least Go 1.11 installed. Download go if necessary. +Make sure you have at least Go 1.12 installed. Download go if necessary. The latest release is recommended. Then git clone https://github.com/rclone/rclone.git @@ -367,7 +371,7 @@ or the latest version (equivalent to the beta) with These will build the binary in $(go env GOPATH)/bin (~/go/bin/rclone by default) after downloading the source to the go module cache. Note - do NOT use the -u flag here. This causes go to try to update the -depencencies that rclone uses and sometimes these don't work with the +dependencies that rclone uses and sometimes these don't work with the current version of rclone. @@ -409,13 +413,16 @@ See the following for detailed instructions for - Cache - Chunker - transparently splits large files for other remotes - Citrix ShareFile +- Compress - Crypt - to encrypt other remotes - DigitalOcean Spaces - Dropbox +- Enterprise File Fabric - FTP - Google Cloud Storage - Google Drive - Google Photos +- HDFS - HTTP - Hubic - Jottacloud / GetSky.no @@ -438,6 +445,7 @@ See the following for detailed instructions for - Union - WebDAV - Yandex Disk +- Zoho WorkDrive - The local filesystem @@ -450,8 +458,8 @@ Its syntax is like this Syntax: [options] subcommand Source and destination paths are specified by the name you gave the -storage system in the config file then the sub path, eg "drive:myfolder" -to look at "myfolder" in Google drive. +storage system in the config file then the sub path, e.g. +"drive:myfolder" to look at "myfolder" in Google drive. You can define as many storage paths as you like in the config file. @@ -515,7 +523,7 @@ SEE ALSO RCLONE COPY -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. Synopsis @@ -645,14 +653,14 @@ Synopsis Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote -does not support a server side directory move operation. +does not support a server-side directory move operation. -If no filters are in use and if possible this will server side move +If no filters are in use and if possible this will server-side move source:path into dest:path. After this source:path will no longer exist. Otherwise for each file in source:path selected by the filters (if any) -this will move it into dest:path. If possible a server side move will be -used, otherwise it will copy it (server side if possible) into dest:path +this will move it into dest:path. If possible a server-side move will be +used, otherwise it will copy it (server-side if possible) into dest:path then delete the original (if no errors on copy) in source:path. If you want to delete empty source directories after move, use the @@ -688,7 +696,7 @@ SEE ALSO RCLONE DELETE -Remove the contents of path. +Remove the files in path. Synopsis @@ -696,21 +704,21 @@ Synopsis Remove the files in path. Unlike purge it obeys include/exclude filters so can be used to selectively delete files. -rclone delete only deletes objects but leaves the directory structure -alone. If you want to delete a directory and all of its contents use -rclone purge +rclone delete only deletes files but leaves the directory structure +alone. If you want to delete a directory and all of its contents use the +purge command. If you supply the --rmdirs flag, it will remove all empty directories -along with it. +along with it. You can also use the separate command rmdir or rmdirs to +delete empty directories only. -Eg delete all files bigger than 100MBytes - -Check what would be deleted first (use either) +For example, to delete all files bigger than 100MBytes, you may first +want to check what would be deleted (use either): rclone --min-size 100M lsl remote:path rclone --dry-run --min-size 100M delete remote:path -Then delete +Then proceed with the actual delete: rclone --min-size 100M delete remote:path @@ -746,8 +754,9 @@ Remove the path and all of its contents. Synopsis Remove the path and all of its contents. Note that this does not obey -include/exclude filters - everything will be removed. Use delete if you -want to selectively delete files. +include/exclude filters - everything will be removed. Use the delete +command if you want to selectively delete files. To delete empty +directories only, use command rmdir or rmdirs. IMPORTANT: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag. @@ -771,11 +780,6 @@ SEE ALSO RCLONE MKDIR -Make the path if it doesn't already exist. - - -Synopsis - Make the path if it doesn't already exist. rclone mkdir remote:path [flags] @@ -797,13 +801,16 @@ SEE ALSO RCLONE RMDIR -Remove the path if empty. +Remove the empty directory at path. Synopsis -Remove the path. Note that you can't remove a path with objects in it, -use purge for that. +This removes empty directory given by path. Will not remove the path if +it has any objects in it, not even empty subdirectories. Use command +rmdirs (or delete with option --rmdirs) to do that. + +To delete a path and any objects in it, use purge command. rclone rmdir remote:path [flags] @@ -846,7 +853,7 @@ source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The --differ, --missing-on-dst, --missing-on-src, --src-only and --error +The --differ, --missing-on-dst, --missing-on-src, --match and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and @@ -874,6 +881,7 @@ Options --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file + --download Check by downloading rather than with hash. --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file @@ -922,14 +930,14 @@ There are several related list commands ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable. -Note that ls and lsl recurse by default - use "--max-depth 1" to stop -the recursion. +Note that ls and lsl recurse by default - use --max-depth 1 to stop the +recursion. The other list commands lsd,lsf,lsjson do not recurse by default - use -"-R" to make them recurse. +-R to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - the +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). rclone ls remote:path [flags] @@ -990,14 +998,14 @@ There are several related list commands ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable. -Note that ls and lsl recurse by default - use "--max-depth 1" to stop -the recursion. +Note that ls and lsl recurse by default - use --max-depth 1 to stop the +recursion. The other list commands lsd,lsf,lsjson do not recurse by default - use -"-R" to make them recurse. +-R to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - the +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). rclone lsd remote:path [flags] @@ -1050,14 +1058,14 @@ There are several related list commands ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable. -Note that ls and lsl recurse by default - use "--max-depth 1" to stop -the recursion. +Note that ls and lsl recurse by default - use --max-depth 1 to stop the +recursion. The other list commands lsd,lsf,lsjson do not recurse by default - use -"-R" to make them recurse. +-R to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - the +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). rclone lsl remote:path [flags] @@ -1087,12 +1095,20 @@ Synopsis Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces. +By default, the hash is requested from the remote. If MD5 is not +supported by the remote, no hash will be returned. With the download +flag, the file will be downloaded from the remote and hashed locally +enabling MD5 for any remote. + rclone md5sum remote:path [flags] Options - -h, --help help for md5sum + --base64 Output base64 encoded hashsum + --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + -h, --help help for md5sum + --output-file string Output hashsums to a file rather than the terminal See the global flags page for global options not listed here. @@ -1114,12 +1130,20 @@ Synopsis Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces. +By default, the hash is requested from the remote. If SHA-1 is not +supported by the remote, no hash will be returned. With the download +flag, the file will be downloaded from the remote and hashed locally +enabling SHA-1 for any remote. + rclone sha1sum remote:path [flags] Options - -h, --help help for sha1sum + --base64 Output base64 encoded hashsum + --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + -h, --help help for sha1sum + --output-file string Output hashsums to a file rather than the terminal See the global flags page for global options not listed here. @@ -1133,11 +1157,6 @@ SEE ALSO RCLONE SIZE -Prints the total size and number of objects in remote:path. - - -Synopsis - Prints the total size and number of objects in remote:path. rclone size remote:path [flags] @@ -1211,7 +1230,7 @@ SEE ALSO RCLONE CLEANUP -Clean up the remote if possible +Clean up the remote if possible. Synopsis @@ -1244,27 +1263,37 @@ Interactively find duplicate filenames and delete/rename them. Synopsis By default dedupe interactively finds files with duplicate names and -offers to delete all but one or rename them to be different. +offers to delete all but one or rename them to be different. This is +known as deduping by name. -This is only useful with backends like Google Drive which can have -duplicate file names. It can be run on wrapping backends (eg crypt) if -they wrap a backend which supports duplicate file names. +Deduping by name is only useful with backends like Google Drive which +can have duplicate file names. It can be run on wrapping backends (e.g. +crypt) if they wrap a backend which supports duplicate file names. -In the first pass it will merge directories with the same name. It will -do this iteratively until all the identically named directories have -been merged. +However if --by-hash is passed in then dedupe will find files with +duplicate hashes instead which will work on any backend which supports +at least one hash. This can be used to find files with duplicate +content. This is known as deduping by hash. -In the second pass, for every group of duplicate file names, it will -delete all but one identical files it finds without confirmation. This -means that for most duplicated files the dedupe command will not be -interactive. +If deduping by name, first rclone will merge directories with the same +name. It will do this iteratively until all the identically named +directories have been merged. -dedupe considers files to be identical if they have the same hash. If -the backend does not support hashes (eg crypt wrapping Google Drive) -then they will never be found to be identical. If you use the ---size-only flag then files will be considered identical if they have -the same size (any hash will be ignored). This can be useful on crypt -backends which do not support hashes. +Next, if deduping by name, for every group of duplicate file names / +hashes, it will delete all but one identical files it finds without +confirmation. This means that for most duplicated files the dedupe +command will not be interactive. + +dedupe considers files to be identical if they have the same file path +and the same hash. If the backend does not support hashes (e.g. crypt +wrapping Google Drive) then they will never be found to be identical. If +you use the --size-only flag then files will be considered identical if +they have the same size (any hash will be ignored). This can be useful +on crypt backends which do not support hashes. + +Next rclone will resolve the remaining duplicates. Exactly which action +is taken depends on the dedupe mode. By default rclone will +interactively query the user for each one. IMPORTANT: Since this can cause data loss, test first with the --dry-run or the --interactive/-i flag. @@ -1336,6 +1365,8 @@ using an extra parameter with the same value smallest one. - --dedupe-mode rename - removes identical files then renames the rest to be different. +- --dedupe-mode list - lists duplicate dirs and files only and changes + nothing. For example to rename all the identically named photos in your Google Photos directory, do @@ -1351,6 +1382,7 @@ Or Options + --by-hash Find indentical hashes rather than names --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive") -h, --help help for dedupe @@ -1371,10 +1403,10 @@ Get quota information from the remote. Synopsis -Get quota information from the remote, like bytes used/free/quota and -bytes used in the trash. Not supported by all remotes. +rclone aboutprints quota information about a remote to standard output. +The output is typically used, free, quota and trash contents. -This will print to stdout something like this: +E.g. Typical output fromrclone about remote:is: Total: 17G Used: 7.444G @@ -1386,16 +1418,15 @@ Where the fields are: - Total: total size available. - Used: total size used -- Free: total amount this user could upload. -- Trashed: total amount in the trash -- Other: total amount in other storage (eg Gmail, Google Photos) +- Free: total space available to this user. +- Trashed: total space used by trash +- Other: total amount in other storage (e.g. Gmail, Google Photos) - Objects: total number of objects in the storage -Note that not all the backends provide all the fields - they will be -missing if they are not known for that backend. Where it is known that -the value is unlimited the value will also be omitted. +Not all backends print all fields. Information is not included if it is +not provided by a backend. Where the value is unlimited it is omitted. -Use the --full flag to see the numbers written out in full, eg +Applying a --full flag to the command prints the bytes in full, e.g. Total: 18253611008 Used: 7993453766 @@ -1403,7 +1434,7 @@ Use the --full flag to see the numbers written out in full, eg Trashed: 104857602 Other: 8849156022 -Use the --json flag for a computer readable output, eg +A --jsonflag generates conveniently computer readable output, e.g. { "total": 18253611008, @@ -1413,6 +1444,10 @@ Use the --json flag for a computer readable output, eg "free": 1411001220 } +Not all backends support the rclone about command. + +See List of backends that do not support about + rclone about remote: [flags] @@ -1485,7 +1520,7 @@ operations/fsinfo in the remote control docs for more info). rclone backend features remote: Pass options to the backend command with -o. This should be key=value or -key, eg: +key, e.g.: rclone backend stats remote:path stats -o format=json -o long @@ -1538,8 +1573,8 @@ Or like this to output any .txt files in dir or its subdirectories. Use the --head flag to print characters only at the start, --tail for the end and --offset and --count to print a section in the middle. Note -that if offset is negative it will count from the end, so --offset -1 ---count 1 is equivalent to --tail 1. +that if offset is negative it will count from the end, so +--offset -1 --count 1 is equivalent to --tail 1. rclone cat remote:path [flags] @@ -1592,7 +1627,7 @@ password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use "--no-obscure". You can -also set osbscured passwords using the "rclone config password" command. +also set obscured passwords using the "rclone config password" command. So for example if you wanted to configure a Google Drive remote but using remote authorization you would do this: @@ -1620,11 +1655,6 @@ SEE ALSO RCLONE CONFIG DELETE -Delete an existing remote name. - - -Synopsis - Delete an existing remote name. rclone config delete `name` [flags] @@ -1676,11 +1706,6 @@ SEE ALSO RCLONE CONFIG DUMP -Dump the config file as JSON. - - -Synopsis - Dump the config file as JSON. rclone config dump [flags] @@ -1730,11 +1755,6 @@ SEE ALSO RCLONE CONFIG FILE -Show path of configuration file in use. - - -Synopsis - Show path of configuration file in use. rclone config file [flags] @@ -1790,11 +1810,6 @@ SEE ALSO RCLONE CONFIG PROVIDERS -List in JSON format all the providers and options. - - -Synopsis - List in JSON format all the providers and options. rclone config providers [flags] @@ -1846,11 +1861,6 @@ SEE ALSO RCLONE CONFIG SHOW -Print (decrypted) config file, or the config for a single remote. - - -Synopsis - Print (decrypted) config file, or the config for a single remote. rclone config show [] [flags] @@ -1895,7 +1905,7 @@ password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use "--no-obscure". You can -also set osbscured passwords using the "rclone config password" command. +also set obscured passwords using the "rclone config password" command. If the remote uses OAuth the token will be updated, if you don't require this add an extra parameter thus: @@ -1951,7 +1961,7 @@ SEE ALSO RCLONE COPYTO -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. Synopsis @@ -2074,7 +2084,7 @@ source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The --differ, --missing-on-dst, --missing-on-src, --src-only and --error +The --differ, --missing-on-dst, --missing-on-src, --match and --error flags write paths, one per line, to the file name (or stdout if it is -) supplied. What they write is described in the help below. For example --differ will write all paths which are present on both the source and @@ -2137,6 +2147,10 @@ use it like this rclone cryptdecode --reverse encryptedremote: filename1 filename2 +Another way to accomplish this is by using the rclone backend encode (or +decode)command. See the documentation on the crypt overlay for more +info. + rclone cryptdecode encryptedremote: encryptedfilename [flags] @@ -2224,7 +2238,7 @@ Synopsis Generates a bash shell autocompletion script for rclone. This writes to /etc/bash_completion.d/rclone by default so will probably -need to be run with sudo or as root, eg +need to be run with sudo or as root, e.g. sudo rclone genautocomplete bash @@ -2235,6 +2249,8 @@ directly If you supply a command line argument the script will be written there. +If output_file is "-", then the output will be written to stdout. + rclone genautocomplete bash [output_file] [flags] @@ -2262,7 +2278,7 @@ Synopsis Generates a fish autocompletion script for rclone. This writes to /etc/fish/completions/rclone.fish by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete fish @@ -2273,6 +2289,8 @@ directly If you supply a command line argument the script will be written there. +If output_file is "-", then the output will be written to stdout. + rclone genautocomplete fish [output_file] [flags] @@ -2300,7 +2318,7 @@ Synopsis Generates a zsh autocompletion script for rclone. This writes to /usr/share/zsh/vendor-completions/_rclone by default so -will probably need to be run with sudo or as root, eg +will probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete zsh @@ -2311,6 +2329,8 @@ directly If you supply a command line argument the script will be written there. +If output_file is "-", then the output will be written to stdout. + rclone genautocomplete zsh [output_file] [flags] @@ -2367,7 +2387,12 @@ Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool. -Run without a hash to see the list of supported hashes, eg +By default, the hash is requested from the remote. If the hash is not +supported by the remote, no hash will be returned. With the download +flag, the file will be downloaded from the remote and hashed locally +enabling any hash for any remote. + +Run without a hash to see the list of all supported hashes, e.g. $ rclone hashsum Supported hashes are: @@ -2385,8 +2410,10 @@ Then Options - --base64 Output base64 encoded hashsum - -h, --help help for hashsum + --base64 Output base64 encoded hashsum + --download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + -h, --help help for hashsum + --output-file string Output hashsums to a file rather than the terminal See the global flags page for global options not listed here. @@ -2477,7 +2504,7 @@ SEE ALSO RCLONE LSF -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. Synopsis @@ -2507,7 +2534,7 @@ just the path, but you can use these parameters to control the output: o - Original ID of underlying object m - MimeType of object if known e - encrypted name - T - tier of storage if known, eg "Hot" or "Cool" + T - tier of storage if known, e.g. "Hot" or "Cool" So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last. @@ -2587,14 +2614,14 @@ There are several related list commands ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable. -Note that ls and lsl recurse by default - use "--max-depth 1" to stop -the recursion. +Note that ls and lsl recurse by default - use --max-depth 1 to stop the +recursion. The other list commands lsd,lsf,lsjson do not recurse by default - use -"-R" to make them recurse. +-R to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - the +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). rclone lsf remote:path [flags] @@ -2650,11 +2677,11 @@ be repeated). If --hash-type is set then it implies --hash. If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra request -(eg s3, swift). +(e.g. s3, swift). If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra -request (eg s3, swift). +request (e.g. s3, swift). If --encrypted is not specified the Encrypted won't be emitted. @@ -2676,10 +2703,10 @@ will be set to true. This key won't be present unless it is "true". The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the -nearest millisecond (eg Google Drive) then 3 digits will always be shown -("2017-05-31T16:15:57.034+01:00") whereas if the times are accurate to -the nearest second (Dropbox, Box, WebDav etc) no digits will be shown -("2017-05-31T16:15:57+01:00"). +nearest millisecond (e.g. Google Drive) then 3 digits will always be +shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are +accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits +will be shown ("2017-05-31T16:15:57+01:00"). The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line. @@ -2697,14 +2724,14 @@ There are several related list commands ls,lsl,lsd are designed to be human readable. lsf is designed to be human and machine readable. lsjson is designed to be machine readable. -Note that ls and lsl recurse by default - use "--max-depth 1" to stop -the recursion. +Note that ls and lsl recurse by default - use --max-depth 1 to stop the +recursion. The other list commands lsd,lsf,lsjson do not recurse by default - use -"-R" to make them recurse. +-R to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - the +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). rclone lsjson remote:path [flags] @@ -2746,40 +2773,56 @@ Rclone's cloud storage systems as a file system with FUSE. First set up your remote using rclone config. Check it works with rclone ls etc. -You can either run mount in foreground mode or background (daemon) mode. -Mount runs in foreground mode by default, use the --daemon flag to -specify background mode mode. Background mode is only supported on Linux -and OSX, you can only run mount in foreground mode on Windows. +On Linux and OSX, you can either run mount in foreground mode or +background (daemon) mode. Mount runs in foreground mode by default, use +the --daemon flag to specify background mode. You can only run mount in +foreground mode on Windows. -On Linux/macOS/FreeBSD Start the mount like this where -/path/to/local/mount is an EMPTY EXISTING directory. +On Linux/macOS/FreeBSD start the mount like this, where +/path/to/local/mount is an EMPTY EXISTING directory: rclone mount remote:path/to/files /path/to/local/mount -Or on Windows like this where X: is an unused drive letter or use a path -to NON-EXISTENT directory. +On Windows you can start a mount in different ways. See below for +details. The following examples will mount to an automatically assigned +drive, to specific drive letter X:, to path +C:\path\to\nonexistent\directory (which must be NON-EXISTENT +subdirectory of an EXISTING parent directory or drive, and is not +supported when mounting as a network drive), and the last example will +mount as network share \\cloud\remote and map it to an automatically +assigned drive: + rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\path\to\nonexistent\directory - -When running in background mode the user will have to stop the mount -manually (specified below). + rclone mount remote:path/to/files \\cloud\remote When the program ends while in foreground mode, either via Ctrl+C or -receiving a SIGINT or SIGTERM signal, the mount is automatically +receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped. -The umount operation can fail, for example when the mountpoint is busy. -When that happens, it is the user's responsibility to stop the mount -manually. - -Stopping the mount manually: +When running in background mode the user will have to stop the mount +manually: # Linux fusermount -u /path/to/local/mount # OS X umount /path/to/local/mount +The umount operation can fail, for example when the mountpoint is busy. +When that happens, it is the user's responsibility to stop the mount +manually. + +The size of the mounted file system will be set according to information +retrieved from the remote, the same as returned by the rclone about +command. Remotes with unlimited storage may report the used size only, +then an additional 1PB of free space is assumed. If the remote does not +support the about feature at all, then 1PB is set as both the total and +the free size. + +NOTE: As of rclone 1.52.2, rclone mount now requires Go version 1.13 or +newer on some platforms depending on the underlying FUSE library in use. + Installing on Windows @@ -2792,6 +2835,113 @@ emulation layer which rclone uses combination with cgofuse. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows. +Mounting modes on windows + +Unlike other operating systems, Microsoft Windows provides a different +filesystem type for network and fixed drives. It optimises access on the +assumption fixed disk drives are fast and reliable, while network drives +have relatively high latency and less reliability. Some settings can +also be differentiated between the two types, for example that Windows +Explorer should just display icons and not create preview thumbnails for +image and video files on network drives. + +In most cases, rclone will mount the remote as a normal, fixed disk +drive by default. However, you can also choose to mount it as a remote +network drive, often described as a network share. If you mount an +rclone remote using the default, fixed drive mode and experience +unexpected program errors, freezes or other issues, consider mounting as +a network drive instead. + +When mounting as a fixed disk drive you can either mount to an unused +drive letter, or to a path - which must be NON-EXISTENT subdirectory of +an EXISTING parent directory or drive. Using the special value * will +tell rclone to automatically assign the next available drive letter, +starting with Z: and moving backward. Examples: + + rclone mount remote:path/to/files * + rclone mount remote:path/to/files X: + rclone mount remote:path/to/files C:\path\to\nonexistent\directory + rclone mount remote:path/to/files X: + +Option --volname can be used to set a custom volume name for the mounted +file system. The default is to use the remote name and path. + +To mount as network drive, you can add option --network-mode to your +mount command. Mounting to a directory path is not supported in this +mode, it is a limitation Windows imposes on junctions, so the remote +must always be mounted to a drive letter. + + rclone mount remote:path/to/files X: --network-mode + +A volume name specified with --volname will be used to create the +network share path. A complete UNC path, such as \\cloud\remote, +optionally with path \\cloud\remote\madeup\path, will be used as is. Any +other string will be used as the share part, after a default prefix +\\server\. If no volume name is specified then \\server\share will be +used. You must make sure the volume name is unique when you are mounting +more than one drive, or else the mount command will fail. The share name +will treated as the volume label for the mapped drive, shown in Windows +Explorer etc, while the complete \\server\share will be reported as the +remote UNC path by net use etc, just like a normal network drive +mapping. + +If you specify a full network share UNC path with --volname, this will +implicitely set the --network-mode option, so the following two examples +have same result: + + rclone mount remote:path/to/files X: --network-mode + rclone mount remote:path/to/files X: --volname \\server\share + +You may also specify the network share UNC path as the mountpoint +itself. Then rclone will automatically assign a drive letter, same as +with * and use that as mountpoint, and instead use the UNC path +specified as the volume name, as if it were specified with the --volname +option. This will also implicitely set the --network-mode option. This +means the following two examples have same result: + + rclone mount remote:path/to/files \\cloud\remote + rclone mount remote:path/to/files * --volname \\cloud\remote + +There is yet another way to enable network mode, and to set the share +path, and that is to pass the "native" libfuse/WinFsp option directly: +--fuse-flag --VolumePrefix=\server\share. Note that the path must be +with just a single backslash prefix in this case. + +_Note:_ In previous versions of rclone this was the only supported +method. + +Read more about drive mapping + +See also Limitations section below. + +Windows filesystem permissions + +The FUSE emulation layer on Windows must convert between the POSIX-based +permission model used in FUSE, and the permission model used in Windows, +based on access-control lists (ACL). + +The mounted filesystem will normally get three entries in its +access-control list (ACL), representing permissions for the POSIX +permission scopes: Owner, group and others. By default, the owner and +group will be taken from the current user, and the built-in group +"Everyone" will be used to represent others. The user/group can be +customized with FUSE options "UserName" and "GroupName", e.g. +-o UserName=user123 -o GroupName="Authenticated Users". + +The permissions on each entry will be set according to options +--dir-perms and --file-perms, which takes a value in traditional numeric +notation, where the default corresponds to +--file-perms 0666 --dir-perms 0777. + +Note that the mapping of permissions is not always trivial, and the +result you see in Windows Explorer may not be exactly like you expected. +For example, when setting a value that includes write access, this will +be mapped to individual permissions "write attributes", "write data" and +"append data", but not "write extended attributes" (WinFsp does not +support extended attributes, see this). Windows will then show this as +basic permission "Special" instead of "Write", because "Write" includes +the "write extended attributes" permission. + Windows caveats Note that drives created as Administrator are not visible by other @@ -2806,43 +2956,16 @@ prompt. It is also possible to start a drive from the SYSTEM account accessible for everyone on the system or alternatively using the nssm service manager. -Mount as a network drive - -By default, rclone will mount the remote as a normal drive. However, you -can also mount it as a NETWORK DRIVE (or NETWORK SHARE, as mentioned in -some places) - -Unlike other systems, Windows provides a different filesystem type for -network drives. Windows and other programs treat the network drives and -fixed/removable drives differently: In network drives, many I/O -operations are optimized, as the high latency and low reliability -(compared to a normal drive) of a network is expected. - -Although many people prefer network shares to be mounted as normal -system drives, this might cause some issues, such as programs not -working as expected or freezes and errors while operating with the -mounted remote in Windows Explorer. If you experience any of those, -consider mounting rclone remotes as network shares, as Windows expects -normal drives to be fast and reliable, while cloud storage is far from -that. See also Limitations section below for more info - -Add "--fuse-flag --VolumePrefix=" to your "mount" command, REPLACING -"SHARE" WITH ANY OTHER NAME OF YOUR CHOICE IF YOU ARE MOUNTING MORE THAN -ONE REMOTE. Otherwise, the mountpoints will conflict and your mounted -filesystems will overlap. - -Read more about drive mapping - Limitations -Without the use of "--vfs-cache-mode" this can only write files +Without the use of --vfs-cache-mode this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without -"--vfs-cache-mode writes" or "--vfs-cache-mode full". See the File -Caching section for more info. +--vfs-cache-mode writes or --vfs-cache-mode full. See the File Caching +section for more info. -The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, +The bucket based remotes (e.g. Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache. @@ -2862,10 +2985,10 @@ at the file caching for solutions to make mount more reliable. Attribute caching You can use the flag --attr-timeout to set the time the kernel caches -the attributes (size, modification time etc) for directory entries. +the attributes (size, modification time, etc.) for directory entries. -The default is "1s" which caches files just long enough to avoid too -many callbacks to rclone from the kernel. +The default is 1s which caches files just long enough to avoid too many +callbacks to rclone from the kernel. In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a @@ -2873,16 +2996,16 @@ few problems such as rclone using too much memory, rclone not serving files to samba and excessive time listing directories. The kernel can cache the info about a file for the time given by -"--attr-timeout". You may see corruption if the remote file changes -length during this window. It will show up as either a truncated file or -a file with garbage on the end. With "--attr-timeout 1s" this is very -unlikely but not impossible. The higher you set "--attr-timeout" the -more likely it is. The default setting of "1s" is the lowest setting -which mitigates the problems above. +--attr-timeout. You may see corruption if the remote file changes length +during this window. It will show up as either a truncated file or a file +with garbage on the end. With --attr-timeout 1s this is very unlikely +but not impossible. The higher you set --attr-timeout the more likely it +is. The default setting of "1s" is the lowest setting which mitigates +the problems above. -If you set it higher ('10s' or '1m' say) then the kernel will call back -to rclone less often making it more efficient, however there is more -chance of the corruption issue above. +If you set it higher (10s or 1m say) then the kernel will call back to +rclone less often making it more efficient, however there is more chance +of the corruption issue above. If files don't change on the remote outside of the control of rclone then there is no chance of corruption. @@ -2924,10 +3047,6 @@ following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. -Chunked reading will only work with --vfs-cache-mode < full, as the file -will always be copied to the vfs cache before opening with ---vfs-cache-mode full. - VFS - Virtual File System @@ -3075,7 +3194,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -3092,6 +3211,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -3127,6 +3251,13 @@ cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or +full), the global flag --transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +--checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + VFS Case Sensitivity @@ -3142,11 +3273,10 @@ 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 --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 @@ -3173,30 +3303,33 @@ it is "true". Options - --allow-non-empty Allow mounting over a non-empty directory (not Windows). - --allow-other Allow access to other users. - --allow-root Allow access to root user. - --async-read Use asynchronous reads. (default true) + --allow-non-empty Allow mounting over a non-empty directory. Not supported on Windows. + --allow-other Allow access to other users. Not supported on Windows. + --allow-root Allow access to root user. Not supported on Windows. + --async-read Use asynchronous reads. Not supported on Windows. (default true) --attr-timeout duration Time for which file/directory attributes are cached. (default 1s) - --daemon Run mount as a daemon (background mode). - --daemon-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes). + --daemon Run mount as a daemon (background mode). Not supported on Windows. + --daemon-timeout duration Time limit for rclone to respond to kernel. Not supported on Windows. --debug-fuse Debug the FUSE internals - needs -v. - --default-permissions Makes kernel enforce access control based on the file mode. + --default-permissions Makes kernel enforce access control based on the file mode. Not supported on Windows. --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for mount - --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) + --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. Not supported on Windows. (default 128k) + --network-mode Mount as remote network drive, instead of fixed disk drive. Supported on Windows only --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. + --noappledouble Ignore Apple Double (._) and .DS_Store files. Supported on OSX only. (default true) + --noapplexattr Ignore all "com.apple.*" extended attributes. Supported on OSX only. -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) @@ -3208,8 +3341,8 @@ Options --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-back duration Time to writeback files after last use when using cache. (default 5s) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) - --volname string Set the volume name (not supported by all OSes). - --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. + --volname string Set the volume name. Supported on Windows and OSX only. + --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. Not supported on Windows. See the global flags page for global options not listed here. @@ -3298,9 +3431,10 @@ Here are the keys - press '?' to toggle the help on and off ←,h to return c toggle counts g toggle graph - n,s,C sort by name,size,count + a toggle average size in directory + n,s,C,A sort by name,size,count,average size d delete file/directory - y copy current path to clipbard + y copy current path to clipboard Y display current path ^L refresh screen ? to toggle help on and off @@ -3331,7 +3465,7 @@ SEE ALSO RCLONE OBSCURE -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. Synopsis @@ -3347,7 +3481,8 @@ the config file. However it is very hard to shoulder surf a 64 character hex token. This command can also accept a password through STDIN instead of an -argument by passing a hyphen as an argument. Example: +argument by passing a hyphen as an argument. This will use the first +line of STDIN as the password not including the trailing newline. echo "secretpassword" | rclone obscure - @@ -3423,7 +3558,7 @@ Will place this in the "arg" value Use --loopback to connect to the rclone instance running "rclone rc". This is very useful for testing commands without having to run an rclone -rc server, eg: +rc server, e.g.: rclone rc --loopback operations/about fs=/ @@ -3438,7 +3573,7 @@ Options -h, --help help for rc --json string Input JSON - use instead of key=value args. --loopback If set connect to this rclone instance not via HTTP. - --no-output If set don't output the JSON result. + --no-output If set, don't output the JSON result. -o, --opt stringArray Option in the form name=value or name placed in the "opt" array. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") @@ -3541,15 +3676,19 @@ Remove empty directories under the path. Synopsis -This removes any empty directories (or directories that only contain -empty directories) under the path that it finds, including the path if -it has nothing in. +This recursively removes any empty directories (including directories +that only contain empty directories), that it finds under the path. The +root path itself will also be removed if it is empty, unless you supply +the --leave-root flag. -If you supply the --leave-root flag, it will not remove the root -directory. +Use command rmdir to delete just the empty directory given by path, not +recurse. This is useful for tidying up remotes that rclone has left a lot of -empty directories in. +empty directories in. For example the delete command will delete files +but leave the directory structure (unless used with option --rmdirs). + +To delete a path and any objects in it, use purge command. rclone rmdirs remote:path [flags] @@ -3577,7 +3716,7 @@ Serve a remote over a protocol. Synopsis rclone serve is used to serve a remote over a given protocol. This -command requires the use of a subcommand to specify the protocol, eg +command requires the use of a subcommand to specify the protocol, e.g. rclone serve http remote: @@ -3628,7 +3767,7 @@ that they are not able to play back correctly. Server options Use --addr to specify which IP address and port the server should listen -on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. +on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. Use --name to choose the friendly server name, which is by default "rclone (hostname)". @@ -3783,7 +3922,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -3800,6 +3939,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -3835,6 +3979,13 @@ cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or +full), the global flag --transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +--checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + VFS Case Sensitivity @@ -3850,11 +4001,10 @@ 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 --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 @@ -3885,7 +4035,7 @@ Options --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for dlna --log-trace enable trace logging of SOAP traffic --name string name of DLNA server @@ -3894,8 +4044,8 @@ Options --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) @@ -3933,7 +4083,7 @@ remote of type ftp to read and write it. Server options Use --addr to specify which IP address and port the server should listen -on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By +on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -4094,7 +4244,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -4111,6 +4261,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -4146,6 +4301,13 @@ cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or +full), the global flag --transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +--checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + VFS Case Sensitivity @@ -4161,11 +4323,10 @@ 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 --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 @@ -4193,7 +4354,7 @@ Auth Proxy If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based -protocl with input on STDIN and output on STDOUT. +protocol with input on STDIN and output on STDOUT. PLEASE NOTE: --auth-proxy and --authorized-keys cannot be used together, if --auth-proxy is set the authorized keys option will be ignored. @@ -4266,11 +4427,13 @@ Options --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") --auth-proxy string A program to use to create the backend from the auth. + --cert string TLS PEM key (concatenation of certificate and CA certificate) --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for ftp + --key string TLS PEM Private key --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. @@ -4279,8 +4442,8 @@ Options --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -4315,7 +4478,7 @@ rclone serve http implements a basic web server to serve the remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it. -You can use the filter flags (eg --include, --exclude) to control what +You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. @@ -4327,7 +4490,7 @@ the stats printing. Server options Use --addr to specify which IP address and port the server should listen -on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By +on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -4363,8 +4526,8 @@ be used within the template to server pages: changeable via ?sort= parameter Sort Options: - namedirfist,name,size,time (default - namedirfirst) + namedirfirst,name,size,time + (default namedirfirst) .Order The current ordering used. This is changeable via ?order= parameter @@ -4578,7 +4741,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -4595,6 +4758,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -4630,6 +4798,13 @@ cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or +full), the global flag --transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +--checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + VFS Case Sensitivity @@ -4645,11 +4820,10 @@ 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 --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 @@ -4683,7 +4857,7 @@ Options --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -4698,8 +4872,8 @@ Options --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -4763,6 +4937,10 @@ use of the "--addr" flag. You might wish to start this server on boot. +Adding --cache-objects=false will cause rclone to stop caching objects +returned from the List call. Caching is normally desirable as it speeds +up downloading objects, saves transactions and uses very little memory. + Setting up restic to use rclone @@ -4811,7 +4989,7 @@ starting with a path of //. Server options Use --addr to specify which IP address and port the server should listen -on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By +on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -4847,8 +5025,8 @@ be used within the template to server pages: changeable via ?sort= parameter Sort Options: - namedirfist,name,size,time (default - namedirfirst) + namedirfirst,name,size,time + (default namedirfirst) .Order The current ordering used. This is changeable via ?order= parameter @@ -4923,6 +5101,7 @@ Options --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") --append-only disallow deletion of repository data --baseurl string Prefix for URLs - leave blank for root. + --cache-objects cache listed objects (default true) --cert string SSL PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with -h, --help help for restic @@ -4959,7 +5138,7 @@ rclone serve sftp implements an SFTP server to serve the remote over SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it. -You can use the filter flags (eg --include, --exclude) to control what +You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. @@ -5133,7 +5312,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -5150,6 +5329,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -5185,6 +5369,13 @@ cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or +full), the global flag --transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +--checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + VFS Case Sensitivity @@ -5200,11 +5391,10 @@ 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 --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 @@ -5232,7 +5422,7 @@ Auth Proxy If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based -protocl with input on STDIN and output on STDOUT. +protocol with input on STDIN and output on STDOUT. PLEASE NOTE: --auth-proxy and --authorized-keys cannot be used together, if --auth-proxy is set the authorized keys option will be ignored. @@ -5309,7 +5499,7 @@ Options --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for sftp --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) --no-auth Allow connections with no authentication if set. @@ -5319,8 +5509,8 @@ Options --pass string Password for authentication. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -5374,7 +5564,7 @@ Use "rclone hashsum" to see the full list. Server options Use --addr to specify which IP address and port the server should listen -on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By +on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -5410,8 +5600,8 @@ be used within the template to server pages: changeable via ?sort= parameter Sort Options: - namedirfist,name,size,time (default - namedirfirst) + namedirfirst,name,size,time + (default namedirfirst) .Order The current ordering used. This is changeable via ?order= parameter @@ -5625,7 +5815,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -5642,6 +5832,11 @@ bytes ahead. The --buffer-size is buffered in memory whereas the When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +IMPORTANT not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache directory +is on a filesystem which doesn't support sparse files and it will log an +ERROR message if one is detected. + VFS Performance @@ -5677,6 +5872,13 @@ cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or +full), the global flag --transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +--checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + VFS Case Sensitivity @@ -5692,11 +5894,10 @@ 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 --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 @@ -5724,7 +5925,7 @@ Auth Proxy If you supply the parameter --auth-proxy /path/to/program then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple JSON based -protocl with input on STDIN and output on STDOUT. +protocol with input on STDIN and output on STDOUT. PLEASE NOTE: --auth-proxy and --authorized-keys cannot be used together, if --auth-proxy is set the authorized keys option will be ignored. @@ -5805,7 +6006,7 @@ Options --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -5820,8 +6021,8 @@ Options --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) @@ -5908,9 +6109,9 @@ unless the --no-create flag is provided. If --timestamp is used then it will set the modification time to that time instead of the current time. Times may be specified as one of: -- 'YYMMDD' - eg. 17.10.30 -- 'YYYY-MM-DDTHH:MM:SS' - eg. 2006-01-02T15:04:05 -- 'YYYY-MM-DDTHH:MM:SS.SSS' - eg. 2006-01-02T15:04:05.123456789 +- 'YYMMDD' - e.g. 17.10.30 +- 'YYYY-MM-DDTHH:MM:SS' - e.g. 2006-01-02T15:04:05 +- 'YYYY-MM-DDTHH:MM:SS.SSS' - e.g. 2006-01-02T15:04:05.123456789 Note that --timestamp is in UTC if you want local time then add the --localtime flag. @@ -5958,7 +6159,7 @@ For example 1 directories, 5 files -You can use any of the filtering options with the tree command (eg +You can use any of the filtering options with the tree command (e.g. --include and --exclude). You can also use --fast-list. The tree command has many options for controlling the listing which are @@ -6100,12 +6301,12 @@ rules Linux / OSX -If your names have spaces or shell metacharacters (eg *, ?, $, ', " etc) -then you must quote them. Use single quotes ' by default. +If your names have spaces or shell metacharacters (e.g. *, ?, $, ', ", +etc.) then you must quote them. Use single quotes ' by default. rclone copy 'Important files?' remote:backup -If you want to send a ' you will need to use ", eg +If you want to send a ' you will need to use ", e.g. rclone copy "O'Reilly Reviews" remote:backup @@ -6114,12 +6315,12 @@ full details you'll have to consult the manual page for your shell. Windows -If your names have spaces in you need to put them in ", eg +If your names have spaces in you need to put them in ", e.g. rclone copy "E:\folder name\folder name\folder name" remote:backup If you are using the root directory on its own then don't quote it (see -#464 for why), eg +#464 for why), e.g. rclone copy E:\ remote:backup @@ -6143,7 +6344,7 @@ or Server Side Copy -Most remotes (but not all - see the overview) support server side copy. +Most remotes (but not all - see the overview) support server-side copy. This means if you want to copy one folder to another then rclone won't download all the files and re-upload them; it will instruct the server @@ -6156,19 +6357,19 @@ Eg Will copy the contents of oldbucket to newbucket without downloading and re-uploading. -Remotes which don't support server side copy WILL download and re-upload +Remotes which don't support server-side copy WILL download and re-upload in this case. Server side copies are used with sync and copy and will be identified in the log when using the -v flag. The move command may also use them if -remote doesn't support server side move directly. This is done by -issuing a server side copy then a delete which is much quicker than a +remote doesn't support server-side move directly. This is done by +issuing a server-side copy then a delete which is much quicker than a download and re-upload. Server side copies will only be attempted if the remote names are the same. -This can be used when scripting to make aged backups efficiently, eg +This can be used when scripting to make aged backups efficiently, e.g. rclone sync -i remote:current-backup remote:previous-backup rclone sync -i /path/to/files remote:current-backup @@ -6193,7 +6394,7 @@ are "ns", "us" (or "µs"), "ms", "s", "m", "h". Options which use SIZE use kByte by default. However, a suffix of b for bytes, k for kBytes, M for MBytes, G for GBytes, T for TBytes and P for -PBytes may be used. These are the binary units, eg 1, 2**10, 2**20, +PBytes may be used. These are the binary units, e.g. 1, 2**10, 2**20, 2**30 respectively. --backup-dir=DIR @@ -6206,7 +6407,7 @@ If --suffix is set, then the moved files will have the suffix added to them. If there is a file with the same path (after the suffix has been added) in DIR, then it will be overwritten. -The remote in use must support server side move or copy and you must use +The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. The backup directory must not overlap the destination directory. @@ -6232,30 +6433,52 @@ will give an error. --bwlimit=BANDWIDTH_SPEC -This option controls the bandwidth limit. Limits can be specified in two -ways: As a single limit, or as a timetable. +This option controls the bandwidth limit. For example -Single limits last for the duration of the session. To use a single -limit, specify the desired bandwidth in kBytes/s, or use a suffix -b|k|M|G. The default is 0 which means to not limit bandwidth. + --bwlimit 10M -For example, to limit bandwidth usage to 10 MBytes/s use --bwlimit 10M +would mean limit the upload and download bandwidth to 10 Mbyte/s. NB +this is BYTES per second not BITS per second. To use a single limit, +specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The +default is 0 which means to not limit bandwidth. + +The upload and download bandwidth can be specified seperately, as +--bwlimit UP:DOWN, so + + --bwlimit 10M:100k + +would mean limit the upload bandwidth to 10 Mbyte/s and the download +bandwidth to 100 kByte/s. Either limit can be "off" meaning no limit, so +to just limit the upload bandwidth you would use + + --bwlimit 10M:off + +this would limit the upload bandwidth to 10MByte/s but the download +bandwidth would be unlimited. + +When specified as above the bandwidth limits last for the duration of +run of the rclone binary. It is also possible to specify a "timetable" of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as WEEKDAY-HH:MM,BANDWIDTH WEEKDAY-HH:MM,BANDWIDTH... where: WEEKDAY is -optional element. It could be written as whole world or only using 3 -first characters. HH:MM is an hour from 00:00 to 23:59. +optional element. + +- BANDWIDTH can be a single number, e.g.100k or a pair of numbers for + upload:download, e.g.10M:1M. +- WEEKDAY can be written as the whole word or only using the first 3 + characters. It is optional. +- HH:MM is an hour from 00:00 to 23:59. An example of a typical timetable to avoid link saturation during daytime working hours could be: ---bwlimit "08:00,512 12:00,10M 13:00,512 18:00,30M 23:00,off" +--bwlimit "08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off" -In this example, the transfer bandwidth will be every day set to -512kBytes/sec at 8am. At noon, it will raise to 10Mbytes/s, and drop -back to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to +In this example, the transfer bandwidth will be set to 512kBytes/sec at +8am every day. At noon, it will rise to 10Mbytes/s, and drop back to +512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be completely disabled (full speed). Anything between 11pm and 8am will remain unlimited. @@ -6263,24 +6486,25 @@ An example of timetable with WEEKDAY could be: --bwlimit "Mon-00:00,512 Fri-23:59,10M Sat-10:00,1M Sun-20:00,off" -It mean that, the transfer bandwidth will be set to 512kBytes/sec on -Monday. It will raise to 10Mbytes/s before the end of Friday. At 10:00 -on Sunday it will be set to 1Mbyte/s. From 20:00 at Sunday will be +It means that, the transfer bandwidth will be set to 512kBytes/sec on +Monday. It will rise to 10Mbytes/s before the end of Friday. At 10:00 on +Saturday it will be set to 1Mbyte/s. From 20:00 on Sunday it will be unlimited. -Timeslots without weekday are extended to whole week. So this one +Timeslots without WEEKDAY are extended to the whole week. So this example: --bwlimit "Mon-00:00,512 12:00,1M Sun-20:00,off" -Is equal to this: +Is equivalent to this: --bwlimit "Mon-00:00,512Mon-12:00,1M Tue-12:00,1M Wed-12:00,1M Thu-12:00,1M Fri-12:00,1M Sat-12:00,1M Sun-12:00,1M Sun-20:00,off" -Bandwidth limits only apply to the data transfer. They don't apply to -the bandwidth of the directory listings etc. +Bandwidth limit apply to the data transfer for all backends. For most +backends the directory listing bandwidth is also included (exceptions +being the non HTTP backends, ftp, sftp and tardigrade). -Note that the units are Bytes/s, not Bits/s. Typically connections are +Note that the units are BYTES/S, not BITS/S. Typically connections are measured in Bits/s - to convert divide by 8. For example, let's say you have a 10 Mbit/s connection and you wish rclone to use half of it - 5 Mbit/s. This is 5/8 = 0.625MByte/s so you would use a --bwlimit 0.625M @@ -6337,6 +6561,8 @@ possible. This flag can be useful on IO limited systems where transfers interfere with checking. +It can also be useful to ensure perfect ordering when using --order-by. + Using this flag can use more memory as it effectively sets --max-backlog to infinite. This means that all the info on the objects to transfer is held in memory before the transfers start. @@ -6344,9 +6570,9 @@ held in memory before the transfers start. --checkers=N The number of checkers to run in parallel. Checkers do the equality -checking of files during a sync. For some storage systems (eg S3, Swift, -Dropbox) this can take a significant amount of time so they are run in -parallel. +checking of files during a sync. For some storage systems (e.g. S3, +Swift, Dropbox) this can take a significant amount of time so they are +run in parallel. The default is to run 8 checkers in parallel. @@ -6360,7 +6586,7 @@ This is useful when the remote doesn't support setting modified time and a more accurate sync is desired than just checking the file size. This is very useful when transferring between remotes which store the -same hash type on the object, eg Drive and Swift. For details of which +same hash type on the object, e.g. Drive and Swift. For details of which remotes support which hash type see the table in the overview section. Eg rclone --checksum sync s3:/bucket swift:/bucket would run much @@ -6397,7 +6623,7 @@ Rclone to use it, it will never be created automatically. If you run rclone config file you will see where the default location is for you. -Use this flag to override the config location, eg +Use this flag to override the config location, e.g. rclone --config=".myconfig" .config. --contimeout=TIME @@ -6413,10 +6639,10 @@ default. When using sync, copy or move DIR is checked in addition to the destination for files. If a file identical to the source is found that -file is server side copied from DIR to the destination. This is useful +file is server-side copied from DIR to the destination. This is useful for incremental backup. -The remote in use must support server side copy and you must use the +The remote in use must support server-side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. @@ -6431,7 +6657,7 @@ more information as to what these options mean. --disable FEATURE,FEATURE,... This disables a comma separated list of optional features. For example -to disable server side move and server side copy use: +to disable server-side move and server-side copy use: --disable move,copy @@ -6445,7 +6671,7 @@ See the overview features and optional features to get an idea of which feature does what. This flag can be useful for debugging and in exceptional circumstances -(eg Google Drive limiting the total volume of Server Side Copies to +(e.g. Google Drive limiting the total volume of Server Side Copies to 100GB/day). -n, --dry-run @@ -6623,6 +6849,8 @@ Log all of rclone's output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination with the -v flag. See the Logging section for more info. +If FILE exists then rclone will append to it. + Note that if you are using the logrotate program to manage rclone's logs, then you should use the copytruncate option as rclone doesn't have a signal to rotate logs. @@ -6816,7 +7044,7 @@ This means that: - the destination is not listed minimising the API calls - files are always transferred -- this can cause duplicates on remotes which allow it (eg Google +- this can cause duplicates on remotes which allow it (e.g. Google Drive) - --retries 1 is recommended otherwise you'll transfer everything again on a retry @@ -6873,7 +7101,7 @@ When using this flag, rclone won't update modification times of remote files if they are incorrect as it would normally. This can be used if the remote is being synced with another tool also -(eg the Google Drive client). +(e.g. the Google Drive client). --order-by string @@ -6897,7 +7125,7 @@ This can have a modifier appended with a comma: threads and the largest for others If the modifier is mixed then it can have an optional percentage (which -defaults to 50), eg size,mixed,25 which means that 25% of the threads +defaults to 50), e.g. size,mixed,25 which means that 25% of the threads should be taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The mixed mode can be useful to @@ -6931,6 +7159,10 @@ Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of --order-by as being more of a best efforts flag rather than a perfect ordering. +If you want perfect ordering then you will need to specify --check-first +which will find all the files which need transferring first before +transferring any. + --password-command SpaceSepList This flag supplies a program which should supply the config password @@ -6969,6 +7201,11 @@ This can be used with the --stats-one-line flag for a simpler display. Note: On Windows until this bug is fixed all non-ASCII characters will be replaced with . when --progress is in use. +--progress-terminal-title + +This flag, when used with -P/--progress, will print the string ETA: %s +to the terminal title. + -q, --quiet This flag will limit rclone's output to error messages only. @@ -6982,8 +7219,8 @@ hashes. This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them. -This flag is ONLY useful for destinations which don't support hashes (eg -crypt). +This flag is ONLY useful for destinations which don't support hashes +(e.g. crypt). This can be used any of the sync commands sync, copy or move. @@ -6996,7 +7233,7 @@ see if there is an existing file on the destination. If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re-uploading it, rclone will update the timestamp on the destination file. If the checksum does not match -rclone will upload the new file. If the checksum is absent (eg on a +rclone will upload the new file. If the checksum is absent (e.g. on a crypt backend) then rclone will update the timestamp. Note that some remotes can't set the modification time without @@ -7105,7 +7342,7 @@ overwritten or deleted will have the suffix added to them. If there is a file with the same path (after the suffix has been added), then it will be overwritten. -The remote in use must support server side move or copy and you must use +The remote in use must support server-side move or copy and you must use the same remote as the destination of the sync. This is for use with files to add the suffix in the current directory or @@ -7113,11 +7350,17 @@ with --backup-dir. See --backup-dir for more info. For example - rclone sync -i /path/to/local/file remote:current --suffix .bak + rclone copy -i /path/to/local/file remote:current --suffix .bak -will sync /path/to/local to remote:current, but for any files which +will copy /path/to/local to remote:current, but for any files which would have been updated or deleted have .bak added. +If using rclone sync with --suffix and without --backup-dir then it is +recommended to put a filter rule in excluding the suffix otherwise the +sync will delete the backup files. + + rclone sync -i /path/to/local/file remote:current --suffix .bak --exclude "*.bak" + --suffix-keep-extension When using --suffix, setting this causes rclone put the SUFFIX before @@ -7136,25 +7379,34 @@ This can be useful for running rclone in a script or rclone mount. --syslog-facility string -If using --syslog this sets the syslog facility (eg KERN, USER). See +If using --syslog this sets the syslog facility (e.g. KERN, USER). See man syslog for a list of possible facilities. The default facility is DAEMON. --tpslimit float -Limit HTTP transactions per second to this. Default is 0 which is used +Limit transactions per second to this number. Default is 0 which is used to mean unlimited transactions per second. -For example to limit rclone to 10 HTTP transactions per second use +A transaction is roughly defined as an API call; its exact meaning will +depend on the backend. For HTTP based backends it is an HTTP +PUT/GET/POST/etc and its response. For FTP/SFTP it is a round trip +transaction over TCP. + +For example to limit rclone to 10 transactions per second use --tpslimit 10, or to 1 transaction every 2 seconds use --tpslimit 0.5. Use this when the number of transactions per second from rclone is -causing a problem with the cloud storage provider (eg getting you banned -or rate limited). +causing a problem with the cloud storage provider (e.g. getting you +banned or rate limited). This can be very useful for rclone mount to control the behaviour of applications using it. +This limit applies to all HTTP based backends and to the FTP and SFTP +backends. It does not apply to the local backend or the Tardigrade +backend. + See also --tpslimit-burst. --tpslimit-burst int @@ -7179,9 +7431,9 @@ By default, rclone doesn't keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy. -If you use this flag, and the remote supports server side copy or server -side move, and the source and destination have a compatible hash, then -this will track renames during sync operations and perform renaming +If you use this flag, and the remote supports server-side copy or +server-side move, and the source and destination have a compatible hash, +then this will track renames during sync operations and perform renaming server-side. Files will be matched by size and hash - if both match then a rename @@ -7249,7 +7501,7 @@ not deleting files as there were IO errors. --fast-list -When doing anything which involves a directory listing (eg sync, copy, +When doing anything which involves a directory listing (e.g. sync, copy, ls - in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. This can be parallelised and works very quickly using @@ -7257,7 +7509,7 @@ the least amount of memory. However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. These tend to be -the bucket based remotes (eg S3, B2, GCS, Swift, Hubic). +the bucket based remotes (e.g. S3, B2, GCS, Swift, Hubic). If you use the --fast-list flag then rclone will use this method for listing directories. This will have the following consequences for the @@ -7512,7 +7764,7 @@ Developer options These options are useful when developing or debugging rclone. There are also some more remote specific options which aren't documented here -which are used for testing. These start with remote name eg +which are used for testing. These start with remote name e.g. --drive-test-option - see the docs for the remote in question. --cpuprofile=FILE @@ -7620,7 +7872,7 @@ Logging rclone has 4 levels of logging, ERROR, NOTICE, INFO and DEBUG. By default, rclone logs to standard error. This means you can redirect -standard error and still see the normal output of rclone commands (eg +standard error and still see the normal output of rclone commands (e.g. rclone ls). By default, rclone will produce Error and Notice level messages. @@ -7641,7 +7893,7 @@ and Debug messages along with standard error to FILE. If you use the --syslog flag then rclone will log to syslog and the --syslog-facility control which facility it uses. -Rclone prefixes all log messages with their level in capitals, eg INFO +Rclone prefixes all log messages with their level in capitals, e.g. INFO which makes it easy to grep the log file for different kinds of information. @@ -7736,12 +7988,12 @@ Precedence The various different methods of backend configuration are read in this order and the first one with a value is used. -- Flag values as supplied on the command line, eg --drive-use-trash. -- Remote specific environment vars, eg +- Flag values as supplied on the command line, e.g. --drive-use-trash. +- Remote specific environment vars, e.g. RCLONE_CONFIG_MYREMOTE_USE_TRASH (see above). -- Backend specific environment vars, eg RCLONE_DRIVE_USE_TRASH. -- Config file, eg use_trash = false. -- Default values, eg true - these can't be changed. +- Backend specific environment vars, e.g. RCLONE_DRIVE_USE_TRASH. +- Config file, e.g. use_trash = false. +- Default values, e.g. true - these can't be changed. So if both --drive-use-trash is supplied on the config line and an environment variable RCLONE_DRIVE_USE_TRASH is set, the command line @@ -7749,9 +8001,9 @@ flag will take preference. For non backend configuration the order is as follows: -- Flag values as supplied on the command line, eg --stats 5s. -- Environment vars, eg RCLONE_STATS=5s. -- Default values, eg 1m - these can't be changed. +- Flag values as supplied on the command line, e.g. --stats 5s. +- Environment vars, e.g. RCLONE_STATS=5s. +- Default values, e.g. 1m - these can't be changed. Other environment variables @@ -7775,9 +8027,9 @@ Some of the configurations (those involving oauth2) require an Internet connected web browser. If you are trying to set rclone up on a remote or headless box with no -browser available on it (eg a NAS or a server in a datacenter) then you -will need to use an alternative means of configuration. There are two -ways of doing it, described below. +browser available on it (e.g. a NAS or a server in a datacenter) then +you will need to use an alternative means of configuration. There are +two ways of doing it, described below. Configuring using rclone authorize @@ -7849,7 +8101,7 @@ Find the config file by running rclone config file, for example Configuration file is stored at: /home/user/.rclone.conf -Now transfer it to the remote box (scp, cut paste, ftp, sftp etc) and +Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) and place it in the correct place (use rclone config file on the remote box to find out where). @@ -7858,85 +8110,83 @@ to find out where). FILTERING, INCLUDES AND EXCLUDES -Rclone has a sophisticated set of include and exclude rules. Some of -these are based on patterns and some on other things like file size. +Filter flags determine which files rclone sync, move, ls, lsl, md5sum, +sha1sum, size, delete, check and similar commands apply to. -The filters are applied for the copy, sync, move, ls, lsl, md5sum, -sha1sum, size, delete and check operations. Note that purge does not -obey the filters. +They are specified in terms of path/file name patterns; path/file lists; +file age and size, or presence of a file in a directory. Bucket based +remotes without the concept of directory apply filters to object key, +age and size in an analogous way. -Each path as it passes through rclone is matched against the include and -exclude rules like --include, --exclude, --include-from, --exclude-from, ---filter, or --filter-from. The simplest way to try them out is using -the ls command, or --dry-run together with -v. --filter-from, ---exclude-from, --include-from, --files-from, --files-from-raw -understand - as a file name to mean read from standard input. +Rclone purge does not obey filters. + +To test filters without risk of damage to data, apply them to rclone ls, +or with the --dry-run and -vv flags. + +Rclone filter patterns can only be used in filter command line options, +not in the specification of a remote. + +E.g. rclone copy "remote:dir*.jpg" /path/to/dir does not have a filter +effect. rclone copy remote:dir /path/to/dir --include "*.jpg" does. + +IMPORTANT Avoid mixing any two of --include..., --exclude... or +--filter... flags in an rclone command. The results may not be what you +expect. Instead use a --filter... flag. -Patterns +Patterns for matching path/file names -The patterns used to match files for inclusion or exclusion are based on -"file globs" as used by the unix shell. +Pattern syntax -If the pattern starts with a / then it only matches at the top level of -the directory tree, RELATIVE TO THE ROOT OF THE REMOTE (not necessarily -the root of the local drive). If it doesn't start with / then it is -matched starting at the END OF THE PATH, but it will only match a -complete path element: +Rclone matching rules follow a glob style: - file.jpg - matches "file.jpg" - - matches "directory/file.jpg" - - doesn't match "afile.jpg" - - doesn't match "directory/afile.jpg" - /file.jpg - matches "file.jpg" in the root directory of the remote - - doesn't match "afile.jpg" - - doesn't match "directory/file.jpg" + `*` matches any sequence of non-separator (`/`) characters + `**` matches any sequence of characters including `/` separators + `?` matches any single non-separator (`/`) character + `[` [ `!` ] { character-range } `]` + character class (must be non-empty) + `{` pattern-list `}` + pattern alternatives + c matches character c (c != `*`, `**`, `?`, `\`, `[`, `{`, `}`) + `\` c matches character c -IMPORTANT Note that you must use / in patterns and not \ even if running -on Windows. +character-range: -A * matches anything but not a /. + c matches character c (c != `\\`, `-`, `]`) + `\` c matches character c + lo `-` hi matches character c for lo <= c <= hi - *.jpg - matches "file.jpg" - - matches "directory/file.jpg" - - doesn't match "file.jpg/something" +pattern-list: -Use ** to match anything, including slashes (/). + pattern { `,` pattern } + comma-separated (without spaces) patterns - dir/** - matches "dir/file.jpg" - - matches "dir/dir1/dir2/file.jpg" - - doesn't match "directory/file.jpg" - - doesn't match "adir/file.jpg" +character classes (see Go regular expression reference) include: -A ? matches any character except a slash /. + Named character classes (e.g. [\d], [^\d], [\D], [^\D]) + Perl character classes (e.g. \s, \S, \w, \W) + ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]]) - l?ss - matches "less" - - matches "lass" - - doesn't match "floss" +If the filter pattern starts with a / then it only matches at the top +level of the directory tree, RELATIVE TO THE ROOT OF THE REMOTE (not +necessarily the root of the drive). If it does not start with / then it +is matched starting at the END OF THE PATH/FILE NAME but it only matches +a complete path element - it must match from a / separator or the +beginning of the path/file. -A [ and ] together make a character class, such as [a-z] or [aeiou] or -[[:alpha:]]. See the go regexp docs for more info on these. + file.jpg - matches "file.jpg" + - matches "directory/file.jpg" + - doesn't match "afile.jpg" + - doesn't match "directory/afile.jpg" + /file.jpg - matches "file.jpg" in the root directory of the remote + - doesn't match "afile.jpg" + - doesn't match "directory/file.jpg" - h[ae]llo - matches "hello" - - matches "hallo" - - doesn't match "hullo" +IMPORTANT Use / in path/file name patterns and not \ even if running on +Microsoft Windows. -A { and } define a choice between elements. It should contain a comma -separated list of patterns, any of which might match. These patterns can -contain wildcards. - - {one,two}_potato - matches "one_potato" - - matches "two_potato" - - doesn't match "three_potato" - - doesn't match "_potato" - -Special characters can be escaped with a \ before them. - - \*.jpg - matches "*.jpg" - \\.jpg - matches "\.jpg" - \[one\].jpg - matches "[one].jpg" - -Patterns are case sensitive unless the --ignore-case flag is used. +Simple patterns are case sensitive unless the --ignore-case flag is +used. Without --ignore-case (default) @@ -7948,81 +8198,11 @@ With --ignore-case potato - matches "potato" - matches "POTATO" -Note also that rclone filter globs can only be used in one of the filter -command line flags, not in the specification of the remote, so -rclone copy "remote:dir*.jpg" /path/to/dir won't work - what is required -is rclone --include "*.jpg" copy remote:dir /path/to/dir -Directories +How filter rules are applied to files -Rclone keeps track of directories that could match any file patterns. - -Eg if you add the include rule - - /a/*.jpg - -Rclone will synthesize the directory include rule - - /a/ - -If you put any rules which end in / then it will only match directories. - -Directory matches are ONLY used to optimise directory access patterns - -you must still match the files that you want to match. Directory matches -won't optimise anything on bucket based remotes (eg s3, swift, google -compute storage, b2) which don't have a concept of directory. - -Differences between rsync and rclone patterns - -Rclone implements bash style {a,b,c} glob matching which rsync doesn't. - -Rclone always does a wildcard match so \ must always escape a \. - - -How the rules are used - -Rclone maintains a combined list of include rules and exclude rules. - -Each file is matched in order, starting from the top, against the rule -in the list until it finds a match. The file is then included or -excluded according to the rule type. - -If the matcher fails to find a match after testing against all the -entries in the list then the path is included. - -For example given the following rules, + being include, - being exclude, - - - secret*.jpg - + *.jpg - + *.png - + file2.avi - - * - -This would include - -- file1.jpg -- file3.png -- file2.avi - -This would exclude - -- secret17.jpg -- non *.jpg and *.png - -A similar process is done on directory entries before recursing into -them. This only works on remotes which have a concept of directory (Eg -local, google drive, onedrive, amazon drive) and not on bucket based -remotes (eg s3, swift, google compute storage, b2). - - -Adding filtering rules - -Filtering rules are added with the following command line flags. - -Repeating options - -You can repeat the following options to add more than one rule of that -type. +Rclone path / file name filters are made up of one or more of the +following flags: - --include - --include-from @@ -8030,109 +8210,278 @@ type. - --exclude-from - --filter - --filter-from -- --filter-from-raw -IMPORTANT You should not use --include* together with --exclude*. It may -produce different results than you expected. In that case try to use: ---filter*. +There can be more than one instance of individual flags. -Note that all the options of the same type are processed together in the -order above, regardless of what order they were placed on the command -line. +Rclone internally uses a combined list of all the include and exclude +rules. The order in which rules are processed can influence the result +of the filter. -So all --include options are processed first in the order they appeared -on the command line, then all --include-from options etc. +All flags of the same type are processed together in the order above, +regardless of what order the different types of flags are included on +the command line. -To mix up the order includes and excludes, the --filter flag can be -used. +Multiple instances of the same flag are processed from left to right +according to their position in the command line. + +To mix up the order of processing includes and excludes use --filter... +flags. + +Within --include-from, --exclude-from and --filter-from flags rules are +processed from top to bottom of the referenced file.. + +If there is an --include or --include-from flag specified, rclone +implies a - ** rule which it adds to the bottom of the internal rule +list. Specifying a + rule with a --filter... flag does not imply that +rule. + +Each path/file name passed through rclone is matched against the +combined filter list. At first match to a rule the path/file name is +included or excluded and no further filter rules are processed for that +path/file. + +If rclone does not find a match, after testing against all rules +(including the implied rule if appropriate), the path/file name is +included. + +Any path/file included at that stage is processed by the rclone command. + +--files-from and --files-from-raw flags over-ride and cannot be combined +with other filter options. + +To see the internal combined rule list, in regular expression form, for +a command add the --dump filters flag. Running an rclone command with +--dump filters and -vv flags lists the internal filter elements and +shows how they are applied to each source path/file. There is not +currently a means provided to pass regular expression filter options +into rclone directly though character class filter rules contain +character classes. Go regular expression reference + +How filter rules are applied to directories + +Rclone commands filter, and are applied to, path/file names not +directories. The entire contents of a directory can be matched to a +filter by the pattern directory/* or recursively by directory/**. + +Directory filter rules are defined with a closing / separator. + +E.g. /directory/subdirectory/ is an rclone directory filter rule. + +Rclone commands can use directory filter rules to determine whether they +recurse into subdirectories. This potentially optimises access to a +remote by avoiding listing unnecessary directories. Whether optimisation +is desirable depends on the specific filter rules and source remote +content. + +Optimisation occurs if either: + +- A source remote does not support the rclone ListR primitive. local, + sftp, Microsoft OneDrive and WebDav do not support ListR. Google + Drive and most bucket type storage do. Full list + +- On other remotes, if the rclone command is not naturally recursive, + provided it is not run with the --fast-list flag. ls, lsf -R and + size are recursive but sync, copy and move are not. + +- Whenever the --disable ListR flag is applied to an rclone command. + +Rclone commands imply directory filter rules from path/file filter +rules. To view the directory filter rules rclone has implied for a +command specify the --dump filters flag. + +E.g. for an include rule + + /a/*.jpg + +Rclone implies the directory include rule + + /a/ + +Directory filter rules specified in an rclone command can limit the +scope of an rclone command but path/file filters still have to be +specified. + +E.g. rclone ls remote: --include /directory/ will not match any files. +Because it is an --include option the --exclude ** rule is implied, and +the \directory\ pattern serves only to optimise access to the remote by +ignoring everything outside of that directory. + +E.g. rclone ls remote: --filter-from filter-list.txt with a file +filter-list.txt: + + - /dir1/ + - /dir2/ + + *.pdf + - ** + +All files in directories dir1 or dir2 or their subdirectories are +completely excluded from the listing. Only files of suffix 'pdf in the +root of remote: or its subdirectories are listed. The - ** rule prevents +listing of any path/files not previously matched by the rules above. + +Option exclude-if-present creates a directory exclude rule based on the +presence of a file in a directory and takes precedence over other rclone +directory filter rules. --exclude - Exclude files matching pattern -Add a single exclude rule with --exclude. +Excludes path/file names from an rclone command based on a single +exclude rule. -This flag can be repeated. See above for the order the flags are +This flag can be repeated. See above for the order filter flags are processed in. -Eg --exclude *.bak to exclude all bak files from the sync. +--exclude should not be used with --include, --include-from, --filter or +--filter-from flags. + +--exclude has no effect when combined with --files-from or +--files-from-raw flags. + +E.g. rclone ls remote: --exclude *.bak excludes all .bak files from +listing. + +E.g. rclone size remote: "--exclude /dir/**" returns the total size of +all files on remote: excluding those in root directory dir and sub +directories. + +E.g. on Microsoft Windows rclone ls remote: --exclude "*\[{JP,KR,HK}\]*" +lists the files in remote: with [JP] or [KR] or [HK] in their name. The +single quotes prevent the shell from interpreting the \ characters. The +\ characters escape the [ and ] so ran clone filter treats them +literally rather than as a character-range. The { and } define an rclone +pattern list. For other operating systems single quotes are required ie +rclone ls remote: --exclude '*\[{JP,KR,HK}\]*' --exclude-from - Read exclude patterns from file -Add exclude rules from a file. +Excludes path/file names from an rclone command based on rules in a +named file. The file contains a list of remarks and pattern rules. -This flag can be repeated. See above for the order the flags are -processed in. - -Prepare a file like this exclude-file.txt +For an example exclude-file.txt: # a sample exclude rule file *.bak file2.jpg -Then use as --exclude-from exclude-file.txt. This will sync all files -except those ending in bak and file2.jpg. +rclone ls remote: --exclude-from exclude-file.txt lists the files on +remote: except those named file2.jpg or with a suffix .bak. That is +equivalent to rclone ls remote: --exclude file2.jpg --exclude "*.bak". -This is useful if you have a lot of rules. +This flag can be repeated. See above for the order filter flags are +processed in. + +The --exclude-from flag is useful where multiple exclude filter rules +are applied to an rclone command. + +--exclude-from should not be used with --include, --include-from, +--filter or --filter-from flags. + +--exclude-from has no effect when combined with --files-from or +--files-from-raw flags. + +--exclude-from followed by - reads filter rules from standard input. --include - Include files matching pattern -Add a single include rule with --include. +Adds a single include rule based on path/file names to an rclone +command. -This flag can be repeated. See above for the order the flags are +This flag can be repeated. See above for the order filter flags are processed in. -Eg --include *.{png,jpg} to include all png and jpg files in the backup -and no others. +--include has no effect when combined with --files-from or +--files-from-raw flags. -This adds an implicit --exclude * at the very end of the filter list. -This means you can mix --include and --include-from with the other -filters (eg --exclude) but you must include all the files you want in -the include statement. If this doesn't provide enough flexibility then -you must use --filter-from. +--include implies --exclude ** at the end of an rclone internal filter +list. Therefore if you mix --include and --include-from flags with +--exclude, --exclude-from, --filter or --filter-from, you must use +include rules for all the files you want in the include statement. For +more flexibility use the --filter-from flag. + +E.g. rclone ls remote: --include "*.{png,jpg}" lists the files on +remote: with suffix .png and .jpg. All other files are excluded. + +E.g. multiple rclone copy commands can be combined with --include and a +pattern-list. + + rclone copy /vol1/A remote:A + rclone copy /vol1/B remote:B + +is equivalent to: + + rclone copy /vol1 remote: --include "{A,B}/**" + +E.g. rclone ls remote:/wheat --include "??[^[:punct:]]*" lists the files +remote: directory wheat (and subdirectories) whose third character is +not punctuation. This example uses an ASCII character class. --include-from - Read include patterns from file -Add include rules from a file. +Adds path/file names to an rclone command based on rules in a named +file. The file contains a list of remarks and pattern rules. -This flag can be repeated. See above for the order the flags are -processed in. - -Prepare a file like this include-file.txt +For an example include-file.txt: # a sample include rule file *.jpg - *.png file2.avi -Then use as --include-from include-file.txt. This will sync all jpg, png -files and file2.avi. +rclone ls remote: --include-from include-file.txt lists the files on +remote: with name file2.avi or suffix .jpg. That is equivalent to +rclone ls remote: --include file2.avi --include "*.jpg". -This is useful if you have a lot of rules. +This flag can be repeated. See above for the order filter flags are +processed in. -This adds an implicit --exclude * at the very end of the filter list. -This means you can mix --include and --include-from with the other -filters (eg --exclude) but you must include all the files you want in -the include statement. If this doesn't provide enough flexibility then -you must use --filter-from. +The --include-from flag is useful where multiple include filter rules +are applied to an rclone command. + +--include-from implies --exclude ** at the end of an rclone internal +filter list. Therefore if you mix --include and --include-from flags +with --exclude, --exclude-from, --filter or --filter-from, you must use +include rules for all the files you want in the include statement. For +more flexibility use the --filter-from flag. + +--exclude-from has no effect when combined with --files-from or +--files-from-raw flags. + +--exclude-from followed by - reads filter rules from standard input. --filter - Add a file-filtering rule -This can be used to add a single include or exclude rule. Include rules -start with + and exclude rules start with -. A special rule called ! can -be used to clear the existing rules. +Specifies path/file names to an rclone command, based on a single +include or exclude rule, in + or - format. -This flag can be repeated. See above for the order the flags are +This flag can be repeated. See above for the order filter flags are processed in. -Eg --filter "- *.bak" to exclude all bak files from the sync. +--filter + differs from --include. In the case of --include rclone +implies an --exclude * rule which it adds to the bottom of the internal +rule list. --filter...+ does not imply that rule. + +--filter has no effect when combined with --files-from or +--files-from-raw flags. + +--filter should not be used with --include, --include-from, --exclude or +--exclude-from flags. + +E.g. rclone ls remote: --filter "- *.bak" excludes all .bak files from a +list of remote:. --filter-from - Read filtering patterns from a file -Add include/exclude rules from a file. +Adds path/file names to an rclone command based on rules in a named +file. The file contains a list of remarks and pattern rules. Include +rules start with + and exclude rules with -. ! clears existing rules. +Rules are processed in the order they are defined. -This flag can be repeated. See above for the order the flags are +This flag can be repeated. See above for the order filter flags are processed in. -Prepare a file like this filter-file.txt +Arrange the order of filter rules with the most restrictive first and +work down. + +E.g. For filter-file.txt: # a sample filter rule file - secret*.jpg @@ -8144,127 +8493,178 @@ Prepare a file like this filter-file.txt # exclude everything else - * -Then use as --filter-from filter-file.txt. The rules are processed in -the order that they are defined. +rclone ls remote: --filter-from filter-file.txt lists the path/files on +remote: including all jpg and png files, excluding any matching +secret*.jpg and including file2.avi. It also includes everything in the +directory dir at the root of remote, except remote:dir/Trash which it +excludes. Everything else is excluded. -This example will include all jpg and png files, exclude any files -matching secret*.jpg and include file2.avi. It will also include -everything in the directory dir at the root of the sync, except -dir/Trash which it will exclude. Everything else will be excluded from -the sync. +E.g. for an alternative filter-file.txt: + + - secret*.jpg + + *.jpg + + *.png + + file2.avi + - * + +Files file1.jpg, file3.png and file2.avi are listed whilst secret17.jpg +and files without the suffix .jpgor.png` are excluded. + +E.g. for an alternative filter-file.txt: + + + *.jpg + + *.gif + ! + + 42.doc + - * + +Only file 42.doc is listed. Prior rules are cleared by the !. --files-from - Read list of source-file names -This reads a list of file names from the file passed in and ONLY these -files are transferred. The FILTERING RULES ARE IGNORED completely if you -use this option. +Adds path/files to an rclone command from a list in a named file. Rclone +processes the path/file names in the order of the list, and no others. ---files-from expects a list of files as its input. Leading / trailing -whitespace is stripped from the input lines and lines starting with # -and ; are ignored. +Other filter flags (--include, --include-from, --exclude, +--exclude-from, --filter and --filter-from) are ignored when +--files-from is used. -Rclone will traverse the file system if you use --files-from, -effectively using the files in --files-from as a set of filters. Rclone -will not error if any of the files are missing. +--files-from expects a list of files as its input. Leading or trailing +whitespace is stripped from the input lines. Lines starting with # or ; +are ignored. -If you use --no-traverse as well as --files-from then rclone will not -traverse the destination file system, it will find each file -individually using approximately 1 API call. This can be more efficient -for small lists of files. +Rclone commands with a --files-from flag traverse the remote, treating +the names in --files-from as a set of filters. -This option can be repeated to read from more than one file. These are -read in the order that they are placed on the command line. +If the --no-traverse and --files-from flags are used together an rclone +command does not traverse the remote. Instead it addresses each +path/file named in the file individually. For each path/file name, that +requires typically 1 API call. This can be efficient for a short +--files-from list and a remote containing many files. -Paths within the --files-from file will be interpreted as starting with -the root specified in the command. Leading / characters are ignored. See ---files-from-raw if you need the input to be processed in a raw manner. +Rclone commands do not error if any names in the --files-from file are +missing from the source remote. -For example, suppose you had files-from.txt with this content: +The --files-from flag can be repeated in a single rclone command to read +path/file names from more than one file. The files are read from left to +right along the command line. + +Paths within the --files-from file are interpreted as starting with the +root specified in the rclone command. Leading / separators are ignored. +See --files-from-raw if you need the input to be processed in a raw +manner. + +E.g. for a file files-from.txt: # comment file1.jpg subdir/file2.jpg -You could then use it like this: - - rclone copy --files-from files-from.txt /home/me/pics remote:pics - -This will transfer these files only (if they exist) +rclone copy --files-from files-from.txt /home/me/pics remote:pics copies +the following, if they exist, and only those files. /home/me/pics/file1.jpg → remote:pics/file1.jpg /home/me/pics/subdir/file2.jpg → remote:pics/subdir/file2.jpg -To take a more complicated example, let's say you had a few files you -want to back up regularly with these absolute paths: +E.g. to copy the following files referenced by their absolute paths: - /home/user1/important - /home/user1/dir/file - /home/user2/stuff + /home/user1/42 + /home/user1/dir/ford + /home/user2/prefect -To copy these you'd find a common subdirectory - in this case /home and -put the remaining files in files-from.txt with or without leading /, eg +First find a common subdirectory - in this case /home and put the +remaining files in files-from.txt with or without leading /, e.g. - user1/important - user1/dir/file - user2/stuff + user1/42 + user1/dir/ford + user2/prefect -You could then copy these to a remote like this +Then copy these to a remote: rclone copy --files-from files-from.txt /home remote:backup -The 3 files will arrive in remote:backup with the paths as in the -files-from.txt like this: +The three files are transferred as follows: - /home/user1/important → remote:backup/user1/important - /home/user1/dir/file → remote:backup/user1/dir/file - /home/user2/stuff → remote:backup/user2/stuff + /home/user1/42 → remote:backup/user1/important + /home/user1/dir/ford → remote:backup/user1/dir/file + /home/user2/prefect → remote:backup/user2/stuff -You could of course choose / as the root too in which case your -files-from.txt might look like this. +Alternatively if / is chosen as root files-from.txt would be: - /home/user1/important - /home/user1/dir/file - /home/user2/stuff + /home/user1/42 + /home/user1/dir/ford + /home/user2/prefect -And you would transfer it like this +The copy command would be: rclone copy --files-from files-from.txt / remote:backup -In this case there will be an extra home directory on the remote: +Then there will be an extra home directory on the remote: - /home/user1/important → remote:backup/home/user1/important - /home/user1/dir/file → remote:backup/home/user1/dir/file - /home/user2/stuff → remote:backup/home/user2/stuff + /home/user1/42 → remote:backup/home/user1/42 + /home/user1/dir/ford → remote:backup/home/user1/dir/ford + /home/user2/prefect → remote:backup/home/user2/prefect --files-from-raw - Read list of source-file names without any processing -This option is same as --files-from with the only difference being that -the input is read in a raw manner. This means that lines with -leading/trailing whitespace and lines starting with ; or # are read -without any processing. rclone lsf has a compatible format that can be -used to export file lists from remotes, which can then be used as an -input to --files-from-raw. +This flag is the same as --files-from except that input is read in a raw +manner. Lines with leading / trailing whitespace, and lines starting +with ; or # are read without any processing. rclone lsf has a compatible +format that can be used to export file lists from remotes for input to +--files-from-raw. + +--ignore-case - make searches case insensitive + +By default rclone filter patterns are case sensitive. The --ignore-case +flag makes all of the filters patterns on the command line case +insensitive. + +E.g. --include "zaphod.txt" does not match a file Zaphod.txt. With +--ignore-case a match is made. + + +Quoting shell metacharacters + +Rclone commands with filter patterns containing shell metacharacters may +not as work as expected in your shell and may require quoting. + +E.g. linux, OSX (* metacharacter) + +- --include \*.jpg +- --include '*.jpg' +- --include='*.jpg' + +Microsoft Windows expansion is done by the command, not shell, so +--include *.jpg does not require quoting. + +If the rclone error +Command .... needs .... arguments maximum: you provided .... non flag arguments: +is encountered, the cause is commonly spaces within the name of a remote +or flag value. The fix then is to quote values containing spaces. + + +Other filters --min-size - Don't transfer any file smaller than this -This option controls the minimum size file which will be transferred. -This defaults to kBytes but a suffix of k, M, or G can be used. +Controls the minimum size file within the scope of an rclone command. +Default units are kBytes but abbreviations k, M, or G are valid. -For example --min-size 50k means no files smaller than 50kByte will be -transferred. +E.g. rclone ls remote: --min-size 50k lists files on remote: of 50kByte +size or larger. --max-size - Don't transfer any file larger than this -This option controls the maximum size file which will be transferred. -This defaults to kBytes but a suffix of k, M, or G can be used. +Controls the maximum size file within the scope of an rclone command. +Default units are kBytes but abbreviations k, M, or G are valid. -For example --max-size 1G means no files larger than 1GByte will be -transferred. +E.g. rclone ls remote: --max-size 1G lists files on remote: of 1GByte +size or smaller. --max-age - Don't transfer any file older than this -This option controls the maximum age of files to transfer. Give in -seconds or with a suffix of: +Controls the maximum age of files within the scope of an rclone command. +Default units are seconds or the following abbreviations are valid: - ms - Milliseconds - s - Seconds @@ -8275,98 +8675,83 @@ seconds or with a suffix of: - M - Months - y - Years -For example --max-age 2d means no files older than 2 days will be -transferred. +--max-age can also be specified as an absolute time in the following +formats: -This can also be an absolute time in one of these formats - -- RFC3339 - eg "2006-01-02T15:04:05Z07:00" +- RFC3339 - e.g. "2006-01-02T15:04:05Z07:00" - ISO8601 Date and time, local timezone - "2006-01-02T15:04:05" - ISO8601 Date and time, local timezone - "2006-01-02 15:04:05" - ISO8601 Date - "2006-01-02" (YYYY-MM-DD) +--max-age applies only to files and not to directories. + +E.g. rclone ls remote: --max-age 2d lists files on remote: of 2 days old +or less. + --min-age - Don't transfer any file younger than this -This option controls the minimum age of files to transfer. Give in -seconds or with a suffix (see --max-age for list of suffixes) +Controls the minimum age of files within the scope of an rclone command. +(see --max-age for valid formats) -For example --min-age 2d means no files younger than 2 days will be -transferred. +--min-age applies only to files and not to directories. + +E.g. rclone ls remote: --min-age 2d lists files on remote: of 2 days old +or more. + + +Other flags --delete-excluded - Delete files on dest excluded from sync -IMPORTANT this flag is dangerous - use with --dry-run and -v first. +IMPORTANT this flag is dangerous to your data - use with --dry-run and +-v first. -When doing rclone sync this will delete any files which are excluded -from the sync on the destination. +In conjunction with rclone sync the `--delete-excluded deletes any files +on the destination which are excluded from the command. -If for example you did a sync from A to B without the --min-size 50k -flag - - rclone sync -i A: B: - -Then you repeated it like this with the --delete-excluded +E.g. the scope of rclone sync -i A: B: can be restricted: rclone --min-size 50k --delete-excluded sync A: B: -This would delete all files on B which are less than 50 kBytes as these -are now excluded from the sync. - -Always test first with --dry-run and -v before using this flag. +All files on B: which are less than 50 kBytes are deleted because they +are excluded from the rclone sync command. --dump filters - dump the filters to the output -This dumps the defined filters to the output as regular expressions. +Dumps the defined filters to standard output in regular expression +format. Useful for debugging. ---ignore-case - make searches case insensitive - -Normally filter patterns are case sensitive. If this flag is supplied -then filter patterns become case insensitive. - -Normally a --include "file.txt" will not match a file called FILE.txt. -However if you use the --ignore-case flag then --include "file.txt" this -will match a file called FILE.txt. - - -Quoting shell metacharacters - -The examples above may not work verbatim in your shell as they have -shell metacharacters in them (eg *), and may require quoting. - -Eg linux, OSX - -- --include \*.jpg -- --include '*.jpg' -- --include='*.jpg' - -In Windows the expansion is done by the command not the shell so this -should work fine - -- --include *.jpg - Exclude directory based on a file -It is possible to exclude a directory based on a file, which is present -in this directory. Filename should be specified using the ---exclude-if-present flag. This flag has a priority over the other -filtering flags. +The --exclude-if-present flag controls whether a directory is within the +scope of an rclone command based on the presence of a named file within +it. -Imagine, you have the following directory structure: +This flag has a priority over other filter flags. + +E.g. for the following directory structure: dir1/file1 dir1/dir2/file2 dir1/dir2/dir3/file3 dir1/dir2/dir3/.ignore -You can exclude dir3 from sync by running the following command: +The command rclone ls --exclude-if-present .ignore dir1 does not list +dir3, file3 or .ignore. - rclone sync -i --exclude-if-present .ignore dir1 remote:backup +--exclude-if-present can only be used once in an rclone command. -Currently only one filename is supported, i.e. --exclude-if-present -should not be used multiple times. + +Common pitfalls + +The most frequent filter support issues on the rclone forum are: + +- Not using paths relative to the root of the remote +- Not using / to match from the root of a remote +- Not using ** to match the contents of a directory @@ -8489,9 +8874,12 @@ If you have questions then please ask them on the rclone forum. REMOTE CONTROLLING RCLONE WITH ITS API -If rclone is run with the --rc flag then it starts an http server which +If rclone is run with the --rc flag then it starts an HTTP server which can be used to remote control rclone using its API. +You can either use the rclone rc command to access the API or use HTTP +directly. + If you just want to run a remote control then see the rcd command. @@ -8703,7 +9091,7 @@ background. The job/status call can be used to get information of the background job. The job can be queried for up to 1 minute after it has finished. -It is recommended that potentially long running jobs, eg sync/sync, +It is recommended that potentially long running jobs, e.g. sync/sync, sync/copy, sync/move, operations/purge are run with the _async flag to avoid any potential problems with the HTTP request and response timing out. @@ -8776,7 +9164,7 @@ backend/command: Runs a backend command. This takes the following parameters - command - a string with the command name -- fs - a remote name string eg "drive:" +- fs - a remote name string e.g. "drive:" - arg - a list of arguments for the backend command - opt - a map of string to string of options @@ -8844,7 +9232,7 @@ Some valid examples are: ":5,-5:" -> the first and last five chunks chunks Any parameter with a key that starts with "file" can be used to specify -files to fetch, eg +files to fetch, e.g. rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye @@ -8943,18 +9331,30 @@ AUTHENTICATION IS REQUIRED FOR THIS CALL. core/bwlimit: Set the bandwidth limit. -This sets the bandwidth limit to that passed in. +This sets the bandwidth limit to the string passed in. This should be a +single bandwidth limit entry or a pair of upload:download bandwidth. Eg rclone rc core/bwlimit rate=off { "bytesPerSecond": -1, + "bytesPerSecondTx": -1, + "bytesPerSecondRx": -1, "rate": "off" } rclone rc core/bwlimit rate=1M { "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 1048576, + "rate": "1M" + } + rclone rc core/bwlimit rate=1M:100k + { + "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 131072, "rate": "1M" } @@ -8963,6 +9363,8 @@ If the rate parameter is not supplied then the bandwidth is queried rclone rc core/bwlimit { "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 1048576, "rate": "1M" } @@ -8979,13 +9381,21 @@ This takes the following parameters - command - a string with the command name - arg - a list of arguments for the backend command - opt - a map of string to string of options +- returnType - one of ("COMBINED_OUTPUT", "STREAM", + "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") + - defaults to "COMBINED_OUTPUT" if not set + - the STREAM returnTypes will write the output to the body of the + HTTP message + - the COMBINED_OUTPUT will write the output to the "result" + parameter Returns - result - result from the backend command + - only set when using returnType "COMBINED_OUTPUT" - error - set if rclone exits with an error code - returnType - one of ("COMBINED_OUTPUT", "STREAM", - "STREAM_ONLY_STDOUT". "STREAM_ONLY_STDERR") + "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") For example @@ -9005,9197 +9415,11536 @@ Returns "result": "" } - **Authentication is required for this call.** +AUTHENTICATION IS REQUIRED FOR THIS CALL. - ### core/gc: Runs a garbage collection. {#core-gc} +core/gc: Runs a garbage collection. - This tells the go runtime to do a garbage collection run. It isn't - necessary to call this normally, but it can be useful for debugging - memory problems. +This tells the go runtime to do a garbage collection run. It isn't +necessary to call this normally, but it can be useful for debugging +memory problems. - ### core/group-list: Returns list of stats. {#core-group-list} +core/group-list: Returns list of stats. - This returns list of stats groups currently in memory. +This returns list of stats groups currently in memory. - Returns the following values: +Returns the following values: -{ "groups": an array of group names: [ "group1", "group2", ... ] } + { + "groups": an array of group names: + [ + "group1", + "group2", + ... + ] + } +core/memstats: Returns the memory statistics - ### core/memstats: Returns the memory statistics {#core-memstats} +This returns the memory statistics of the running program. What the +values mean are explained in the go docs: +https://golang.org/pkg/runtime/#MemStats - This returns the memory statistics of the running program. What the values mean - are explained in the go docs: https://golang.org/pkg/runtime/#MemStats +The most interesting values for most people are: - The most interesting values for most people are: +- HeapAlloc: This is the amount of memory rclone is actually using +- HeapSys: This is the amount of memory rclone has obtained from the + OS +- Sys: this is the total amount of memory requested from the OS + - It is virtual memory so may include unused memory - * HeapAlloc: This is the amount of memory rclone is actually using - * HeapSys: This is the amount of memory rclone has obtained from the OS - * Sys: this is the total amount of memory requested from the OS - * It is virtual memory so may include unused memory +core/obscure: Obscures a string passed in. - ### core/obscure: Obscures a string passed in. {#core-obscure} +Pass a clear string and rclone will obscure it for the config file: - +clear - string - Pass a clear string and rclone will obscure it for the config file: - - clear - string +Returns - obscured - string - Returns - - obscured - string +core/pid: Return PID of current process - ### core/pid: Return PID of current process {#core-pid} +This returns PID of current process. Useful for stopping rclone process. - This returns PID of current process. - Useful for stopping rclone process. +core/quit: Terminates the app. - ### core/quit: Terminates the app. {#core-quit} +(optional) Pass an exit code to be used for terminating the app: - +exitCode - int - (optional) Pass an exit code to be used for terminating the app: - - exitCode - int +core/stats: Returns stats about current transfers. - ### core/stats: Returns stats about current transfers. {#core-stats} +This returns all available stats: - This returns all available stats: + rclone rc core/stats - rclone rc core/stats +If group is not provided then summed up stats for all groups will be +returned. - If group is not provided then summed up stats for all groups will be - returned. +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +Returns the following values: - Returns the following values: + { + "speed": average speed in bytes/sec since start of the process, + "bytes": total transferred bytes since the start of the process, + "errors": number of errors, + "fatalError": whether there has been at least one FatalError, + "retryError": whether there has been at least one non-NoRetryError, + "checks": number of checked files, + "transfers": number of transferred files, + "deletes" : number of deleted files, + "renames" : number of renamed files, + "transferTime" : total time spent on running jobs, + "elapsedTime": time in seconds since the start of the process, + "lastError": last occurred error, + "transferring": an array of currently active file transfers: + [ + { + "bytes": total transferred bytes for this file, + "eta": estimated time in seconds until file transfer completion + "name": name of the file, + "percentage": progress of the file transfer in percent, + "speed": average speed over the whole transfer in bytes/sec, + "speedAvg": current speed in bytes/sec as an exponentially weighted moving average, + "size": size of the file in bytes + } + ], + "checking": an array of names of currently active file checks + [] + } -{ "speed": average speed in bytes/sec since start of the process, -"bytes": total transferred bytes since the start of the process, -"errors": number of errors, "fatalError": whether there has been at -least one FatalError, "retryError": whether there has been at least one -non-NoRetryError, "checks": number of checked files, "transfers": number -of transferred files, "deletes" : number of deleted files, "renames" : -number of renamed files, "transferTime" : total time spent on running -jobs, "elapsedTime": time in seconds since the start of the process, -"lastError": last occurred error, "transferring": an array of currently -active file transfers: [ { "bytes": total transferred bytes for this -file, "eta": estimated time in seconds until file transfer completion -"name": name of the file, "percentage": progress of the file transfer in -percent, "speed": average speed over the whole transfer in bytes/sec, -"speedAvg": current speed in bytes/sec as an exponentially weighted -moving average, "size": size of the file in bytes } ], "checking": an -array of names of currently active file checks [] } +Values for "transferring", "checking" and "lastError" are only assigned +if data is available. The value for "eta" is null if an eta cannot be +determined. - Values for "transferring", "checking" and "lastError" are only assigned if data is available. - The value for "eta" is null if an eta cannot be determined. +core/stats-delete: Delete stats group. - ### core/stats-delete: Delete stats group. {#core-stats-delete} +This deletes entire stats group - This deletes entire stats group +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +core/stats-reset: Reset stats. - ### core/stats-reset: Reset stats. {#core-stats-reset} +This clears counters, errors and finished transfers for all stats or +specific stats group if group is provided. - This clears counters, errors and finished transfers for all stats or specific - stats group if group is provided. +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +core/transferred: Returns stats about completed transfers. - ### core/transferred: Returns stats about completed transfers. {#core-transferred} +This returns stats about completed transfers: - This returns stats about completed transfers: + rclone rc core/transferred - rclone rc core/transferred +If group is not provided then completed transfers for all groups will be +returned. - If group is not provided then completed transfers for all groups will be - returned. +Note only the last 100 completed transfers are returned. - Note only the last 100 completed transfers are returned. +Parameters - Parameters +- group - name of the stats group (string) - - group - name of the stats group (string) +Returns the following values: - Returns the following values: + { + "transferred": an array of completed transfers (including failed ones): + [ + { + "name": name of the file, + "size": size of the file in bytes, + "bytes": total transferred bytes for this file, + "checked": if the transfer is only checked (skipped, deleted), + "timestamp": integer representing millisecond unix epoch, + "error": string description of the error (empty if successful), + "jobid": id of the job that this transfer belongs to + } + ] + } -{ "transferred": an array of completed transfers (including failed -ones): [ { "name": name of the file, "size": size of the file in bytes, -"bytes": total transferred bytes for this file, "checked": if the -transfer is only checked (skipped, deleted), "timestamp": integer -representing millisecond unix epoch, "error": string description of the -error (empty if successful), "jobid": id of the job that this transfer -belongs to } ] } +core/version: Shows the current version of rclone and the go runtime. +This shows the current version of go and the go runtime - ### core/version: Shows the current version of rclone and the go runtime. {#core-version} +- version - rclone version, e.g. "v1.53.0" +- decomposed - version number as [major, minor, patch] +- isGit - boolean - true if this was compiled from the git version +- isBeta - boolean - true if this is a beta version +- os - OS in use as according to Go +- arch - cpu architecture in use according to Go +- goVersion - version of Go runtime in use - This shows the current version of go and the go runtime +debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. - - version - rclone version, eg "v1.53.0" - - decomposed - version number as [major, minor, patch] - - isGit - boolean - true if this was compiled from the git version - - isBeta - boolean - true if this is a beta version - - os - OS in use as according to Go - - arch - cpu architecture in use according to Go - - goVersion - version of Go runtime in use +SetBlockProfileRate controls the fraction of goroutine blocking events +that are reported in the blocking profile. The profiler aims to sample +an average of one blocking event per rate nanoseconds spent blocked. - ### debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug-set-block-profile-rate} +To include every blocking event in the profile, pass rate = 1. To turn +off profiling entirely, pass rate <= 0. - SetBlockProfileRate controls the fraction of goroutine blocking events - that are reported in the blocking profile. The profiler aims to sample - an average of one blocking event per rate nanoseconds spent blocked. +After calling this you can use this to see the blocking profile: - To include every blocking event in the profile, pass rate = 1. To turn - off profiling entirely, pass rate <= 0. + go tool pprof http://localhost:5572/debug/pprof/block - After calling this you can use this to see the blocking profile: +Parameters - go tool pprof http://localhost:5572/debug/pprof/block +- rate - int - Parameters +debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. - - rate - int +SetMutexProfileFraction controls the fraction of mutex contention events +that are reported in the mutex profile. On average 1/rate events are +reported. The previous rate is returned. - ### debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug-set-mutex-profile-fraction} +To turn off profiling entirely, pass rate 0. To just read the current +rate, pass rate < 0. (For n>1 the details of sampling may change.) - SetMutexProfileFraction controls the fraction of mutex contention - events that are reported in the mutex profile. On average 1/rate - events are reported. The previous rate is returned. +Once this is set you can look use this to profile the mutex contention: - To turn off profiling entirely, pass rate 0. To just read the current - rate, pass rate < 0. (For n>1 the details of sampling may change.) + go tool pprof http://localhost:5572/debug/pprof/mutex - Once this is set you can look use this to profile the mutex contention: +Parameters - go tool pprof http://localhost:5572/debug/pprof/mutex +- rate - int - Parameters +Results - - rate - int +- previousRate - int - Results +job/list: Lists the IDs of the running jobs - - previousRate - int +Parameters - None - ### job/list: Lists the IDs of the running jobs {#job-list} +Results - Parameters - None +- jobids - array of integer job ids - Results +job/status: Reads the status of the job ID - - jobids - array of integer job ids +Parameters - ### job/status: Reads the status of the job ID {#job-status} +- jobid - id of the job (integer) - Parameters +Results - - jobid - id of the job (integer) +- finished - boolean +- duration - time in seconds that the job ran for +- endTime - time the job finished (e.g. + "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 (e.g. + "2018-10-26T18:50:20.528336039+01:00") +- success - boolean - true for success false otherwise +- output - output of the job as would have been returned if called + synchronously +- progress - output of the progress related to the underlying job - Results +job/stop: Stop the running job - - finished - boolean - - duration - time in seconds that the job ran for - - endTime - time the job finished (eg "2018-10-26T18:50:20.528746884+01:00") - - error - error from the job or empty string for no error - - finished - boolean whether the job has finished or not - - id - as passed in above - - startTime - time the job started (eg "2018-10-26T18:50:20.528336039+01:00") - - success - boolean - true for success false otherwise - - output - output of the job as would have been returned if called synchronously - - progress - output of the progress related to the underlying job +Parameters - ### job/stop: Stop the running job {#job-stop} +- jobid - id of the job (integer) - Parameters +mount/listmounts: Show current mount points - - jobid - id of the job (integer) +This shows currently mounted points, which can be used for performing an +unmount - ### mount/listmounts: Show current mount points {#mount-listmounts} +This takes no parameters and returns - This shows currently mounted points, which can be used for performing an unmount +- mountPoints: list of current mount points - This takes no parameters and returns +Eg - - mountPoints: list of current mount points + rclone rc mount/listmounts - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/listmounts +mount/mount: Create a new mount point - **Authentication is required for this call.** +rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's +cloud storage systems as a file system with FUSE. - ### mount/mount: Create a new mount point {#mount-mount} +If no mountType is provided, the priority is given as follows: 1. mount +2.cmount 3.mount2 - rclone allows Linux, FreeBSD, macOS and Windows to mount any of - Rclone's cloud storage systems as a file system with FUSE. +This takes the following parameters - If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2 +- fs - a remote path to be mounted (required) +- mountPoint: valid path on the local machine (required) +- mountType: One of the values (mount, cmount, mount2) specifies the + mount implementation to use +- mountOpt: a JSON object with Mount options in. +- vfsOpt: a JSON object with VFS options in. - This takes the following parameters +Eg - - fs - a remote path to be mounted (required) - - mountPoint: valid path on the local machine (required) - - mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use - - mountOpt: a JSON object with Mount options in. - - vfsOpt: a JSON object with VFS options in. + rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint + rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount + rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}' - Eg +The vfsOpt are as described in options/get and can be seen in the the +"vfs" section when running and the mountOpt can be seen in the "mount" +section. - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount - rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt='{"CacheMode": 2}' mountOpt='{"AllowOther": true}' + rclone rc options/get - The vfsOpt are as described in options/get and can be seen in the the - "vfs" section when running and the mountOpt can be seen in the "mount" section. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc options/get +mount/types: Show all possible mount types - **Authentication is required for this call.** +This shows all possible mount types and returns them as a list. - ### mount/types: Show all possible mount types {#mount-types} +This takes no parameters and returns - This shows all possible mount types and returns them as a list. +- mountTypes: list of mount types - This takes no parameters and returns +The mount types are strings like "mount", "mount2", "cmount" and can be +passed to mount/mount as the mountType parameter. - - mountTypes: list of mount types +Eg - The mount types are strings like "mount", "mount2", "cmount" and can - be passed to mount/mount as the mountType parameter. + rclone rc mount/types - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/types +mount/unmount: Unmount selected active mount - **Authentication is required for this call.** +rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's +cloud storage systems as a file system with FUSE. - ### mount/unmount: Unmount selected active mount {#mount-unmount} +This takes the following parameters - rclone allows Linux, FreeBSD, macOS and Windows to - mount any of Rclone's cloud storage systems as a file system with - FUSE. +- mountPoint: valid path on the local machine where the mount was + created (required) - This takes the following parameters +Eg - - mountPoint: valid path on the local machine where the mount was created (required) + rclone rc mount/unmount mountPoint=/home//mountPoint - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/unmount mountPoint=/home//mountPoint +mount/unmountall: Show current mount points - **Authentication is required for this call.** +This shows currently mounted points, which can be used for performing an +unmount - ### mount/unmountall: Show current mount points {#mount-unmountall} +This takes no parameters and returns error if unmount does not succeed. - This shows currently mounted points, which can be used for performing an unmount +Eg - This takes no parameters and returns error if unmount does not succeed. + rclone rc mount/unmountall - Eg +AUTHENTICATION IS REQUIRED FOR THIS CALL. - rclone rc mount/unmountall +operations/about: Return the space used on the remote - **Authentication is required for this call.** +This takes the following parameters - ### operations/about: Return the space used on the remote {#operations-about} +- fs - a remote name string e.g. "drive:" - This takes the following parameters +The result is as returned from rclone about --json - - fs - a remote name string eg "drive:" +See the about command command for more information on the above. - The result is as returned from rclone about --json +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above. +operations/cleanup: Remove trashed files in the remote or path - **Authentication is required for this call.** +This takes the following parameters - ### operations/cleanup: Remove trashed files in the remote or path {#operations-cleanup} +- fs - a remote name string e.g. "drive:" - This takes the following parameters +See the cleanup command command for more information on the above. - - fs - a remote name string eg "drive:" +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. +operations/copyfile: Copy a file from source remote to destination remote - **Authentication is required for this call.** +This takes the following parameters - ### operations/copyfile: Copy a file from source remote to destination remote {#operations-copyfile} +- srcFs - a remote name string e.g. "drive:" for the source +- srcRemote - a path within that remote e.g. "file.txt" for the source +- dstFs - a remote name string e.g. "drive2:" for the destination +- dstRemote - a path within that remote e.g. "file2.txt" for the + destination - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - srcFs - a remote name string eg "drive:" for the source - - srcRemote - a path within that remote eg "file.txt" for the source - - dstFs - a remote name string eg "drive2:" for the destination - - dstRemote - a path within that remote eg "file2.txt" for the destination +operations/copyurl: Copy the URL to the object - **Authentication is required for this call.** +This takes the following parameters - ### operations/copyurl: Copy the URL to the object {#operations-copyurl} +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" +- url - string, URL to read from +- autoFilename - boolean, set to true to retrieve destination file + name from url See the copyurl command command for more information + on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - url - string, URL to read from - - autoFilename - boolean, set to true to retrieve destination file name from url - See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command for more information on the above. +operations/delete: Remove files in the path - **Authentication is required for this call.** +This takes the following parameters - ### operations/delete: Remove files in the path {#operations-delete} +- fs - a remote name string e.g. "drive:" - This takes the following parameters +See the delete command command for more information on the above. - - fs - a remote name string eg "drive:" +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above. +operations/deletefile: Remove the single file pointed to - **Authentication is required for this call.** +This takes the following parameters - ### operations/deletefile: Remove the single file pointed to {#operations-deletefile} +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" - This takes the following parameters +See the deletefile command command for more information on the above. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +AUTHENTICATION IS REQUIRED FOR THIS CALL. - See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. +operations/fsinfo: Return information about the remote - **Authentication is required for this call.** +This takes the following parameters - ### operations/fsinfo: Return information about the remote {#operations-fsinfo} +- fs - a remote name string e.g. "drive:" - This takes the following parameters +This returns info about the remote passed in; - - fs - a remote name string eg "drive:" + { + // optional features and whether they are available or not + "Features": { + "About": true, + "BucketBased": false, + "CanHaveEmptyDirectories": true, + "CaseInsensitive": false, + "ChangeNotify": false, + "CleanUp": false, + "Copy": false, + "DirCacheFlush": false, + "DirMove": true, + "DuplicateFiles": false, + "GetTier": false, + "ListR": false, + "MergeDirs": false, + "Move": true, + "OpenWriterAt": true, + "PublicLink": false, + "Purge": true, + "PutStream": true, + "PutUnchecked": false, + "ReadMimeType": false, + "ServerSideAcrossConfigs": false, + "SetTier": false, + "SetWrapper": false, + "UnWrap": false, + "WrapFs": false, + "WriteMimeType": false + }, + // Names of hashes available + "Hashes": [ + "MD5", + "SHA-1", + "DropboxHash", + "QuickXorHash" + ], + "Name": "local", // Name as created + "Precision": 1, // Precision of timestamps in ns + "Root": "/", // Path as created + "String": "Local file system at /" // how the remote will appear in logs + } - This returns info about the remote passed in; +This command does not have a command line equivalent so use this +instead: -{ // optional features and whether they are available or not "Features": -{ "About": true, "BucketBased": false, "CanHaveEmptyDirectories": true, -"CaseInsensitive": false, "ChangeNotify": false, "CleanUp": false, -"Copy": false, "DirCacheFlush": false, "DirMove": true, -"DuplicateFiles": false, "GetTier": false, "ListR": false, "MergeDirs": -false, "Move": true, "OpenWriterAt": true, "PublicLink": false, "Purge": -true, "PutStream": true, "PutUnchecked": false, "ReadMimeType": false, -"ServerSideAcrossConfigs": false, "SetTier": false, "SetWrapper": false, -"UnWrap": false, "WrapFs": false, "WriteMimeType": false }, // Names of -hashes available "Hashes": [ "MD5", "SHA-1", "DropboxHash", -"QuickXorHash" ], "Name": "local", // Name as created "Precision": 1, // -Precision of timestamps in ns "Root": "/", // Path as created "String": -"Local file system at /" // how the remote will appear in logs } + rclone rc --loopback operations/fsinfo fs=remote: +operations/list: List the given remote and path in JSON format - This command does not have a command line equivalent so use this instead: +This takes the following parameters - rclone rc --loopback operations/fsinfo fs=remote: +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" +- opt - a dictionary of options to control the listing (optional) + - recurse - If set recurse directories + - noModTime - If set return modification time + - showEncrypted - If set show decrypted names + - showOrigIDs - If set show the IDs for each item if known + - showHash - If set return a dictionary of hashes - ### operations/list: List the given remote and path in JSON format {#operations-list} +The result is - This takes the following parameters +- list + - This is an array of objects as described in the lsjson command - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - opt - a dictionary of options to control the listing (optional) - - recurse - If set recurse directories - - noModTime - If set return modification time - - showEncrypted - If set show decrypted names - - showOrigIDs - If set show the IDs for each item if known - - showHash - If set return a dictionary of hashes +See the lsjson command for more information on the above and examples. - The result is +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - list - - This is an array of objects as described in the lsjson command +operations/mkdir: Make a destination directory or container - See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" - ### operations/mkdir: Make a destination directory or container {#operations-mkdir} +See the mkdir command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +operations/movefile: Move a file from source remote to destination remote - See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- srcFs - a remote name string e.g. "drive:" for the source +- srcRemote - a path within that remote e.g. "file.txt" for the source +- dstFs - a remote name string e.g. "drive2:" for the destination +- dstRemote - a path within that remote e.g. "file2.txt" for the + destination - ### operations/movefile: Move a file from source remote to destination remote {#operations-movefile} +AUTHENTICATION IS REQUIRED FOR THIS CALL. - This takes the following parameters +operations/publiclink: Create or retrieve a public link to the given file or folder. - - srcFs - a remote name string eg "drive:" for the source - - srcRemote - a path within that remote eg "file.txt" for the source - - dstFs - a remote name string eg "drive2:" for the destination - - dstRemote - a path within that remote eg "file2.txt" for the destination +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" +- unlink - boolean - if set removes the link rather than adding it + (optional) +- expire - string - the expiry time of the link e.g. "1d" (optional) - ### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations-publiclink} +Returns - This takes the following parameters +- url - URL of the resource - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - unlink - boolean - if set removes the link rather than adding it (optional) - - expire - string - the expiry time of the link eg "1d" (optional) +See the link command command for more information on the above. - Returns +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - url - URL of the resource +operations/purge: Remove a directory or container and all of its contents - See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" - ### operations/purge: Remove a directory or container and all of its contents {#operations-purge} +See the purge command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +operations/rmdir: Remove an empty directory or container - See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" - ### operations/rmdir: Remove an empty directory or container {#operations-rmdir} +See the rmdir command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +operations/rmdirs: Remove all the empty directories in the path - See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" +- leaveRoot - boolean, set to true not to delete the root - ### operations/rmdirs: Remove all the empty directories in the path {#operations-rmdirs} +See the rmdirs command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - leaveRoot - boolean, set to true not to delete the root +operations/size: Count the number of bytes and files in remote - See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:path/to/dir" - ### operations/size: Count the number of bytes and files in remote {#operations-size} +Returns - This takes the following parameters +- count - number of files +- bytes - number of bytes in those files - - fs - a remote name string eg "drive:path/to/dir" +See the size command command for more information on the above. - Returns +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - count - number of files - - bytes - number of bytes in those files +operations/uploadfile: Upload file using multiform/form-data - See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above. +This takes the following parameters - **Authentication is required for this call.** +- fs - a remote name string e.g. "drive:" +- remote - a path within that remote e.g. "dir" +- each part in body represents a file to be uploaded See the + uploadfile command command for more information on the above. - ### operations/uploadfile: Upload file using multiform/form-data {#operations-uploadfile} +AUTHENTICATION IS REQUIRED FOR THIS CALL. - This takes the following parameters +options/blocks: List all the option blocks - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - each part in body represents a file to be uploaded - See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above. +Returns - options - a list of the options block names - **Authentication is required for this call.** +options/get: Get all the options - ### options/blocks: List all the option blocks {#options-blocks} +Returns an object where keys are option block names and values are an +object with the current option values in. - Returns - - options - a list of the options block names +This shows the internal names of the option within rclone which should +map to the external options very easily with a few exceptions. - ### options/get: Get all the options {#options-get} +options/set: Set an option - Returns an object where keys are option block names and values are an - object with the current option values in. +Parameters - This shows the internal names of the option within rclone which should - map to the external options very easily with a few exceptions. +- option block name containing an object with + - key: value - ### options/set: Set an option {#options-set} +Repeated as often as required. - Parameters +Only supply the options you wish to change. If an option is unknown it +will be silently ignored. Not all options will have an effect when +changed like this. - - option block name containing an object with - - key: value +For example: - Repeated as often as required. +This sets DEBUG level logs (-vv) - Only supply the options you wish to change. If an option is unknown - it will be silently ignored. Not all options will have an effect when - changed like this. + rclone rc options/set --json '{"main": {"LogLevel": 8}}' - For example: +And this sets INFO level logs (-v) - This sets DEBUG level logs (-vv) + rclone rc options/set --json '{"main": {"LogLevel": 7}}' - rclone rc options/set --json '{"main": {"LogLevel": 8}}' +And this sets NOTICE level logs (normal without -v) - And this sets INFO level logs (-v) + rclone rc options/set --json '{"main": {"LogLevel": 6}}' - rclone rc options/set --json '{"main": {"LogLevel": 7}}' +pluginsctl/addPlugin: Add a plugin using url - And this sets NOTICE level logs (normal without -v) +used for adding a plugin to the webgui - rclone rc options/set --json '{"main": {"LogLevel": 6}}' +This takes the following parameters - ### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl-addPlugin} +- url: http url of the github repo where the plugin is hosted + (http://github.com/rclone/rclone-webui-react) - used for adding a plugin to the webgui +Eg - This takes the following parameters +rclone rc pluginsctl/addPlugin - - url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone-webui-react) +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/getPluginsForType: Get plugins with type criteria - rclone rc pluginsctl/addPlugin +This shows all possible plugins by a mime type - **Authentication is required for this call.** +This takes the following parameters - ### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl-getPluginsForType} +- type: supported mime type by a loaded plugin e.g. (video/mp4, + audio/mp3) +- pluginType: filter plugins based on their type e.g. (DASHBOARD, + FILE_HANDLER, TERMINAL) - This shows all possible plugins by a mime type +and returns - This takes the following parameters +- loadedPlugins: list of current production plugins +- testPlugins: list of temporarily loaded development plugins, usually + running on a different server. - - type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3) - - pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) +Eg - and returns +rclone rc pluginsctl/getPluginsForType type=video/mp4 - - loadedPlugins: list of current production plugins - - testPlugins: list of temporarily loaded development plugins, usually running on a different server. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/listPlugins: Get the list of currently loaded plugins - rclone rc pluginsctl/getPluginsForType type=video/mp4 +This allows you to get the currently enabled plugins and their details. - **Authentication is required for this call.** +This takes no parameters and returns - ### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl-listPlugins} +- loadedPlugins: list of current production plugins +- testPlugins: list of temporarily loaded development plugins, usually + running on a different server. - This allows you to get the currently enabled plugins and their details. +Eg - This takes no parameters and returns +rclone rc pluginsctl/listPlugins - - loadedPlugins: list of current production plugins - - testPlugins: list of temporarily loaded development plugins, usually running on a different server. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/listTestPlugins: Show currently loaded test plugins - rclone rc pluginsctl/listPlugins +allows listing of test plugins with the rclone.test set to true in +package.json of the plugin - **Authentication is required for this call.** +This takes no parameters and returns - ### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl-listTestPlugins} +- loadedTestPlugins: list of currently available test plugins - allows listing of test plugins with the rclone.test set to true in package.json of the plugin +Eg - This takes no parameters and returns + rclone rc pluginsctl/listTestPlugins - - loadedTestPlugins: list of currently available test plugins +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/removePlugin: Remove a loaded plugin - rclone rc pluginsctl/listTestPlugins +This allows you to remove a plugin using it's name - **Authentication is required for this call.** +This takes parameters - ### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl-removePlugin} +- name: name of the plugin in the format author/plugin_name - This allows you to remove a plugin using it's name +Eg - This takes parameters +rclone rc pluginsctl/removePlugin name=rclone/video-plugin - - name: name of the plugin in the format / +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +pluginsctl/removeTestPlugin: Remove a test plugin - rclone rc pluginsctl/removePlugin name=rclone/video-plugin +This allows you to remove a plugin using it's name - **Authentication is required for this call.** +This takes the following parameters - ### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl-removeTestPlugin} +- name: name of the plugin in the format author/plugin_name - This allows you to remove a plugin using it's name +Eg - This takes the following parameters + rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react - - name: name of the plugin in the format / +AUTHENTICATION IS REQUIRED FOR THIS CALL. - Eg +rc/error: This returns an error - rclone rc pluginsctl/removeTestPlugin name=rclone/rclone-webui-react +This returns an error with the input as part of its error string. Useful +for testing error handling. - **Authentication is required for this call.** +rc/list: List all the registered remote control commands - ### rc/error: This returns an error {#rc-error} +This lists all the registered remote control commands as a JSON map in +the commands response. - This returns an error with the input as part of its error string. - Useful for testing error handling. +rc/noop: Echo the input to the output parameters - ### rc/list: List all the registered remote control commands {#rc-list} +This echoes the input parameters to the output parameters for testing +purposes. It can be used to check that rclone is still alive and to +check that parameter passing is working properly. - This lists all the registered remote control commands as a JSON map in - the commands response. +rc/noopauth: Echo the input to the output parameters requiring auth - ### rc/noop: Echo the input to the output parameters {#rc-noop} +This echoes the input parameters to the output parameters for testing +purposes. It can be used to check that rclone is still alive and to +check that parameter passing is working properly. - This echoes the input parameters to the output parameters for testing - purposes. It can be used to check that rclone is still alive and to - check that parameter passing is working properly. +AUTHENTICATION IS REQUIRED FOR THIS CALL. - ### rc/noopauth: Echo the input to the output parameters requiring auth {#rc-noopauth} +sync/copy: copy a directory from source remote to destination remote - This echoes the input parameters to the output parameters for testing - purposes. It can be used to check that rclone is still alive and to - check that parameter passing is working properly. +This takes the following parameters - **Authentication is required for this call.** +- srcFs - a remote name string e.g. "drive:src" for the source +- dstFs - a remote name string e.g. "drive:dst" for the destination - ### sync/copy: copy a directory from source remote to destination remote {#sync-copy} +See the copy command command for more information on the above. - This takes the following parameters +AUTHENTICATION IS REQUIRED FOR THIS CALL. - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination +sync/move: move a directory from source remote to destination remote +This takes the following parameters - See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above. +- srcFs - a remote name string e.g. "drive:src" for the source +- dstFs - a remote name string e.g. "drive:dst" for the destination +- deleteEmptySrcDirs - delete empty src directories if set - **Authentication is required for this call.** +See the move command command for more information on the above. - ### sync/move: move a directory from source remote to destination remote {#sync-move} +AUTHENTICATION IS REQUIRED FOR THIS CALL. - This takes the following parameters +sync/sync: sync a directory from source remote to destination remote - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination - - deleteEmptySrcDirs - delete empty src directories if set +This takes the following parameters +- srcFs - a remote name string e.g. "drive:src" for the source +- dstFs - a remote name string e.g. "drive:dst" for the destination - See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above. +See the sync command command for more information on the above. - **Authentication is required for this call.** +AUTHENTICATION IS REQUIRED FOR THIS CALL. - ### sync/sync: sync a directory from source remote to destination remote {#sync-sync} +vfs/forget: Forget files or directories in the directory cache. - This takes the following parameters +This forgets the paths in the directory cache causing them to be re-read +from the remote when needed. - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination +If no paths are passed in then it will forget all the paths in the +directory cache. + rclone rc vfs/forget - See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. +Otherwise pass files or dirs in as file=path or dir=path. Any parameter +key starting with file will forget that file and any starting with dir +will forget that dir, e.g. - **Authentication is required for this call.** + rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - ### vfs/forget: Forget files or directories in the directory cache. {#vfs-forget} +This command takes an "fs" parameter. If this parameter is not supplied +and if there is only one VFS in use then that VFS will be used. If there +is more than one VFS in use then the "fs" parameter must be supplied. - This forgets the paths in the directory cache causing them to be - re-read from the remote when needed. +vfs/list: List active VFSes. - If no paths are passed in then it will forget all the paths in the - directory cache. +This lists the active VFSes. - rclone rc vfs/forget +It returns a list under the key "vfses" where the values are the VFS +names that could be passed to the other VFS commands in the "fs" +parameter. - Otherwise pass files or dirs in as file=path or dir=path. Any - parameter key starting with file will forget that file and any - starting with dir will forget that dir, eg +vfs/poll-interval: Get the status or update the value of the poll-interval option. - rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - - This command takes an "fs" parameter. If this parameter is not - supplied and if there is only one VFS in use then that VFS will be - used. If there is more than one VFS in use then the "fs" parameter - must be supplied. +Without any parameter given this returns the current status of the +poll-interval setting. - ### vfs/list: List active VFSes. {#vfs-list} +When the interval=duration parameter is set, the poll-interval value is +updated and the polling function is notified. Setting interval=0 +disables poll-interval. - This lists the active VFSes. + rclone rc vfs/poll-interval interval=5m - It returns a list under the key "vfses" where the values are the VFS - names that could be passed to the other VFS commands in the "fs" - parameter. +The timeout=duration parameter can be used to specify a time to wait for +the current poll function to apply the new value. If timeout is less or +equal 0, which is the default, wait indefinitely. - ### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs-poll-interval} +The new poll-interval value will only be active when the timeout is not +reached. - Without any parameter given this returns the current status of the - poll-interval setting. +If poll-interval is updated or disabled temporarily, some changes might +not get picked up by the polling function, depending on the used remote. - When the interval=duration parameter is set, the poll-interval value - is updated and the polling function is notified. - Setting interval=0 disables poll-interval. +This command takes an "fs" parameter. If this parameter is not supplied +and if there is only one VFS in use then that VFS will be used. If there +is more than one VFS in use then the "fs" parameter must be supplied. - rclone rc vfs/poll-interval interval=5m +vfs/refresh: Refresh the directory cache. - The timeout=duration parameter can be used to specify a time to wait - for the current poll function to apply the new value. - If timeout is less or equal 0, which is the default, wait indefinitely. +This reads the directories for the specified paths and freshens the +directory cache. - The new poll-interval value will only be active when the timeout is - not reached. +If no paths are passed in then it will refresh the root directory. - If poll-interval is updated or disabled temporarily, some changes - might not get picked up by the polling function, depending on the - used remote. - - This command takes an "fs" parameter. If this parameter is not - supplied and if there is only one VFS in use then that VFS will be - used. If there is more than one VFS in use then the "fs" parameter - must be supplied. + rclone rc vfs/refresh - ### vfs/refresh: Refresh the directory cache. {#vfs-refresh} +Otherwise pass directories in as dir=path. Any parameter key starting +with dir will refresh that directory, e.g. - This reads the directories for the specified paths and freshens the - directory cache. + rclone rc vfs/refresh dir=home/junk dir2=data/misc - If no paths are passed in then it will refresh the root directory. +If the parameter recursive=true is given the whole directory tree will +get refreshed. This refresh will use --fast-list if enabled. - rclone rc vfs/refresh +This command takes an "fs" parameter. If this parameter is not supplied +and if there is only one VFS in use then that VFS will be used. If there +is more than one VFS in use then the "fs" parameter must be supplied. - Otherwise pass directories in as dir=path. Any parameter key - starting with dir will refresh that directory, eg - rclone rc vfs/refresh dir=home/junk dir2=data/misc +Accessing the remote control via HTTP - If the parameter recursive=true is given the whole directory tree - will get refreshed. This refresh will use --fast-list if enabled. - - This command takes an "fs" parameter. If this parameter is not - supplied and if there is only one VFS in use then that VFS will be - used. If there is more than one VFS in use then the "fs" parameter - must be supplied. +Rclone implements a simple HTTP based protocol. +Each endpoint takes an JSON object and returns a JSON object or an +error. The JSON objects are essentially a map of string names to values. +All calls must made using POST. - ## Accessing the remote control via HTTP +The input objects can be supplied using URL parameters, POST parameters +or by supplying "Content-Type: application/json" and a JSON blob in the +body. There are examples of these below using curl. - Rclone implements a simple HTTP based protocol. +The response will be a JSON blob in the body of the response. This is +formatted to be reasonably human readable. - Each endpoint takes an JSON object and returns a JSON object or an - error. The JSON objects are essentially a map of string names to - values. +Error returns - All calls must made using POST. +If an error occurs then there will be an HTTP error status (e.g. 500) +and the body of the response will contain a JSON encoded error object, +e.g. - The input objects can be supplied using URL parameters, POST - parameters or by supplying "Content-Type: application/json" and a JSON - blob in the body. There are examples of these below using `curl`. + { + "error": "Expecting string value for key \"remote\" (was float64)", + "input": { + "fs": "/tmp", + "remote": 3 + }, + "status": 400 + "path": "operations/rmdir", + } - The response will be a JSON blob in the body of the response. This is - formatted to be reasonably human readable. +The keys in the error response are - error - error string - input - the +input parameters to the call - status - the HTTP status code - path - +the path of the call - ### Error returns +CORS - If an error occurs then there will be an HTTP error status (eg 500) - and the body of the response will contain a JSON encoded error object, - eg +The sever implements basic CORS support and allows all origins for that. +The response to a preflight OPTIONS request will echo the requested +"Access-Control-Request-Headers" back. -{ "error": "Expecting string value for key "remote" (was float64)", -"input": { "fs": "/tmp", "remote": 3 }, "status": 400 "path": -"operations/rmdir", } +Using POST with URL parameters only + curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' - The keys in the error response are - - error - error string - - input - the input parameters to the call - - status - the HTTP status code - - path - the path of the call +Response - ### CORS + { + "potato": "1", + "sausage": "2" + } - The sever implements basic CORS support and allows all origins for that. - The response to a preflight OPTIONS request will echo the requested "Access-Control-Request-Headers" back. +Here is what an error response looks like: - ### Using POST with URL parameters only + curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' -curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' + { + "error": "arbitrary error on input map[potato:1 sausage:2]", + "input": { + "potato": "1", + "sausage": "2" + } + } +Note that curl doesn't return errors to the shell unless you use the -f +option - Response + $ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' + curl: (22) The requested URL returned error: 400 Bad Request + $ echo $? + 22 -{ "potato": "1", "sausage": "2" } +Using POST with a form + curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop - Here is what an error response looks like: +Response -curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' + { + "potato": "1", + "sausage": "2" + } -{ "error": "arbitrary error on input map[potato:1 sausage:2]", "input": -{ "potato": "1", "sausage": "2" } } +Note that you can combine these with URL parameters too with the POST +parameters taking precedence. + curl --data "potato=1" --data "sausage=2" "http://localhost:5572/rc/noop?rutabaga=3&sausage=4" - Note that curl doesn't return errors to the shell unless you use the `-f` option +Response -$ curl -f -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' -curl: (22) The requested URL returned error: 400 Bad Request $ echo $? -22 + { + "potato": "1", + "rutabaga": "3", + "sausage": "4" + } +Using POST with a JSON blob - ### Using POST with a form + curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop -curl --data "potato=1" --data "sausage=2" http://localhost:5572/rc/noop +response + { + "password": "xyz", + "username": "xyz" + } - Response +This can be combined with URL parameters too if required. The JSON blob +takes precedence. -{ "potato": "1", "sausage": "2" } + curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4' + { + "potato": 2, + "rutabaga": "3", + "sausage": 1 + } - Note that you can combine these with URL parameters too with the POST - parameters taking precedence. -curl --data "potato=1" --data "sausage=2" -"http://localhost:5572/rc/noop?rutabaga=3&sausage=4" +Debugging rclone with pprof +If you use the --rc flag this will also enable the use of the go +profiling tools on the same port. - Response +To use these, first install go. -{ "potato": "1", "rutabaga": "3", "sausage": "4" } +Debugging memory use +To profile rclone's memory use you can run: - ### Using POST with a JSON blob + go tool pprof -web http://localhost:5572/debug/pprof/heap -curl -H "Content-Type: application/json" -X POST -d -'{"potato":2,"sausage":1}' http://localhost:5572/rc/noop +This should open a page in your browser showing what is using what +memory. +You can also use the -text flag to produce a textual summary - response + $ go tool pprof -text http://localhost:5572/debug/pprof/heap + Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total + flat flat% sum% cum cum% + 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode + 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 + 0 0% 100% 1024.03kB 66.62% main.init + 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest + 0 0% 100% 513kB 33.38% net/http.(*conn).serve + 0 0% 100% 1024.03kB 66.62% runtime.main -{ "password": "xyz", "username": "xyz" } +Debugging go routine leaks +Memory leaks are most often caused by go routine leaks keeping memory +alive which should have been garbage collected. - This can be combined with URL parameters too if required. The JSON - blob takes precedence. +See all active go routines using -curl -H "Content-Type: application/json" -X POST -d -'{"potato":2,"sausage":1}' -'http://localhost:5572/rc/noop?rutabaga=3&potato=4' + curl http://localhost:5572/debug/pprof/goroutine?debug=1 -{ "potato": 2, "rutabaga": "3", "sausage": 1 } +Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your +browser. +Other profiles to look at - ## Debugging rclone with pprof ## +You can see a summary of profiles available at +http://localhost:5572/debug/pprof/ - If you use the `--rc` flag this will also enable the use of the go - profiling tools on the same port. +Here is how to use some of them: - To use these, first [install go](https://golang.org/doc/install). +- Memory: go tool pprof http://localhost:5572/debug/pprof/heap +- Go routines: + curl http://localhost:5572/debug/pprof/goroutine?debug=1 +- 30-second CPU profile: + go tool pprof http://localhost:5572/debug/pprof/profile +- 5-second execution trace: + wget http://localhost:5572/debug/pprof/trace?seconds=5 +- Goroutine blocking profile + - Enable first with: rclone rc debug/set-block-profile-rate rate=1 + (docs) + - go tool pprof http://localhost:5572/debug/pprof/block +- Contended mutexes: + - Enable first with: + rclone rc debug/set-mutex-profile-fraction rate=1 (docs) + - go tool pprof http://localhost:5572/debug/pprof/mutex - ### Debugging memory use +See the net/http/pprof docs for more info on how to use the profiling +and for a general overview see the Go team's blog post on profiling go +programs. - To profile rclone's memory use you can run: +The profiling hook is zero overhead unless it is used. - go tool pprof -web http://localhost:5572/debug/pprof/heap - This should open a page in your browser showing what is using what - memory. - You can also use the `-text` flag to produce a textual summary +OVERVIEW OF CLOUD STORAGE SYSTEMS -$ go tool pprof -text http://localhost:5572/debug/pprof/heap Showing -nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% -cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode -513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% -1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% -100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% -net/http.(_conn).readRequest 0 0% 100% 513kB 33.38% -net/http.(_conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main +Each cloud storage system is slightly different. Rclone attempts to +provide a unified interface to them, but some underlying differences +show through. - ### Debugging go routine leaks - Memory leaks are most often caused by go routine leaks keeping memory - alive which should have been garbage collected. +Features - See all active go routines using +Here is an overview of the major features of each cloud storage system. - curl http://localhost:5572/debug/pprof/goroutine?debug=1 + Name Hash ModTime Case Insensitive Duplicate Files MIME Type + ------------------------------ ------------- --------- ------------------ ----------------- ----------- + 1Fichier Whirlpool No No Yes R + Amazon Drive MD5 No Yes No R + Amazon S3 MD5 Yes No No R/W + Backblaze B2 SHA1 Yes No No R/W + Box SHA1 Yes Yes No - + Citrix ShareFile MD5 Yes Yes No - + Dropbox DBHASH ¹ Yes Yes No - + Enterprise File Fabric - Yes Yes No R/W + 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 + HDFS - Yes No No - + HTTP - No No No R + Hubic MD5 Yes No No R/W + Jottacloud MD5 Yes Yes No R + Koofr MD5 No Yes No - + Mail.ru Cloud Mailru ⁶ Yes Yes No - + Mega - No No Yes - + Memory MD5 Yes No No - + Microsoft Azure Blob Storage MD5 Yes No No R/W + Microsoft OneDrive SHA1 ⁵ Yes Yes No R + OpenDrive MD5 Yes Yes Partial ⁸ - + OpenStack Swift MD5 Yes No No R/W + pCloud MD5, SHA1 ⁷ Yes No No W + premiumize.me - No Yes No R + put.io CRC-32 Yes No Yes R + QingStor MD5 No No No R/W + Seafile - No No No - + SFTP MD5, SHA1 ² Yes Depends No - + SugarSync - No No No - + Tardigrade - Yes No No - + WebDAV MD5, SHA1 ³ Yes ⁴ Depends No - + Yandex Disk MD5 Yes No No R + Zoho WorkDrive - No No No - + The local filesystem All Yes Depends No - - Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. +Notes - ### Other profiles to look at +¹ Dropbox supports its own custom hash. This is an SHA256 sum of all the +4MB block SHA256s. - You can see a summary of profiles available at http://localhost:5572/debug/pprof/ +² SFTP supports checksums if the same login has shell access and md5sum +or sha1sum as well as echo are in the remote's PATH. - Here is how to use some of them: +³ WebDAV supports hashes 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` - - Goroutine blocking profile - - Enable first with: `rclone rc debug/set-block-profile-rate rate=1` ([docs](#debug/set-block-profile-rate)) - - `go tool pprof http://localhost:5572/debug/pprof/block` - - Contended mutexes: - - Enable first with: `rclone rc debug/set-mutex-profile-fraction rate=1` ([docs](#debug/set-mutex-profile-fraction)) - - `go tool pprof http://localhost:5572/debug/pprof/mutex` +⁴ WebDAV supports modtimes when used with Owncloud and Nextcloud only. - 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). +⁵ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive for +business and SharePoint server support Microsoft's own QuickXorHash. - The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). +⁶ Mail.ru uses its own modified SHA1 hash + +⁷ pCloud only supports SHA1 (not MD5) in its EU region + +⁸ Opendrive does not support creation of duplicate files using their web +client interface or other stock clients, but the underlying storage +platform has been determined to allow duplicate files, and it is +possible to create them with rclone. It may be that this is a mistake or +an unsupported feature. + +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. + +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, e.g. 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 (e.g. 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 to ensure correct +formatting and not necessarily the actual name used on the cloud +storage. + +This transformation is reversed when downloading a file or parsing +rclone arguments. For example, when uploading a file named my file?.txt +to Onedrive will be displayed as my file?.txt on the console, but stored +as my file？.txt (the ? gets replaced by the similar looking ？ +character) to Onedrive. The reverse transformation allows to read a +fileunusual/name.txt from Google Drive, by passing the name +unusual／name.txt (the / needs to be replaced by the similar looking ／ +character) on the command line. + +Default restricted characters + +The table below shows the characters that are replaced by default. + +When a replacement character is found in a filename, this character will +be escaped with the ‛ character to avoid ambiguous file names. (e.g. a +file named ␀.txt would shown as ‛␀.txt) + +Each cloud storage backend can use a different set of characters, which +will be specified in the documentation for each backend. + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + SOH 0x01 ␁ + STX 0x02 ␂ + ETX 0x03 ␃ + EOT 0x04 ␄ + ENQ 0x05 ␅ + ACK 0x06 ␆ + BEL 0x07 ␇ + BS 0x08 ␈ + HT 0x09 ␉ + LF 0x0A ␊ + VT 0x0B ␋ + FF 0x0C ␌ + CR 0x0D ␍ + SO 0x0E ␎ + SI 0x0F ␏ + DLE 0x10 ␐ + DC1 0x11 ␑ + DC2 0x12 ␒ + DC3 0x13 ␓ + DC4 0x14 ␔ + NAK 0x15 ␕ + SYN 0x16 ␖ + ETB 0x17 ␗ + CAN 0x18 ␘ + EM 0x19 ␙ + SUB 0x1A ␚ + ESC 0x1B ␛ + FS 0x1C ␜ + GS 0x1D ␝ + RS 0x1E ␞ + US 0x1F ␟ + / 0x2F ／ + DEL 0x7F ␡ + +The default encoding will also encode these file names as they are +problematic with many cloud storage systems. + + File name Replacement + ----------- ------------- + . ． + .. ．． + +Invalid UTF-8 bytes + +Some backends only support a sequence of well formed UTF-8 bytes as file +or directory names. + +In this case all invalid UTF-8 bytes will be replaced with a quoted +representation of the byte value to allow uploading a file to such a +backend. For example, the invalid byte 0xFE will be encoded as ‛FE. + +A common source of invalid UTF-8 bytes are local filesystems, that store +names in a different encoding than UTF-8 or UTF-16, like latin1. See the +local filenames section for details. + +Encoding option + +Most backends have an encoding options, specified as a flag +--backend-encoding where backend is the name of the backend, or as a +config parameter encoding (you'll need to select the Advanced config in +rclone config to see it). + +This will have default value which encodes and decodes characters in +such a way as to preserve the maximum number of characters (see above). + +However this can be incorrect in some scenarios, for example if you have +a Windows file system with characters such as ＊ and ？ that you want to +remain as those characters on the remote rather than being translated to +* and ?. + +The --backend-encoding flags allow you to change that. You can disable +the encoding completely with --backend-encoding None or set +encoding = None in the config file. + +Encoding takes a comma separated list of encodings. You can see the list +of all available characters by passing an invalid value to this flag, +e.g. --local-encoding "help" and rclone help flags encoding will show +you the defaults for the backends. + + Encoding Characters + --------------- ------------------------------------------------------------- + Asterisk * + BackQuote ` + BackSlash \ + Colon : + CrLf CR 0x0D, LF 0x0A + Ctl All control characters 0x00-0x1F + Del DEL 0x7F + Dollar $ + Dot . + DoubleQuote " + Hash # + InvalidUtf8 An invalid UTF-8 character (e.g. latin1) + LeftCrLfHtVt CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string + LeftPeriod . on the left of a string + LeftSpace SPACE on the left of a string + LeftTilde ~ on the left of a string + LtGt <, > + None No characters are encoded + Percent % + Pipe | + Question ? + RightCrLfHtVt CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string + RightPeriod . on the right of a string + RightSpace SPACE on the right of a string + SingleQuote ' + Slash / + +To take a specific example, the FTP backend's default encoding is + + --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot" + +However, let's say the FTP server is running on Windows and can't have +any of the invalid Windows characters in file names. You are backing up +Linux servers to this FTP server which do have those characters in file +names. So you would add the Windows set which are + + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot + +to the existing ones, giving: + + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace + +This can be specified using the --ftp-encoding flag or using an encoding +parameter in the config file. + +Or let's say you have a Windows server but you want to preserve ＊ and +？, you would then have this as the encoding (the Windows encoding minus +Asterisk and Question). + + Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot + +This can be specified using the --local-encoding flag or using an +encoding parameter in the config file. + +MIME Type + +MIME types (also known as media types) classify types of documents using +a simple text classification, e.g. 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 rclone remotes support a base command set. Other features depend +upon backend specific capabilities. + + Name Purge Copy Move DirMove CleanUp ListR StreamUpload LinkSharing About EmptyDir + ------------------------------ ------- ------ ------ --------- --------- ------- -------------- ------------- ------- ---------- + 1Fichier No No No No No No No No No Yes + Amazon Drive Yes No Yes Yes No #575 No No No #2178 No Yes + Amazon S3 No Yes No No Yes Yes Yes No #2178 No No + Backblaze B2 No Yes No No Yes Yes Yes Yes No No + Box Yes Yes Yes Yes Yes ‡‡ No Yes Yes No Yes + Citrix ShareFile Yes Yes Yes Yes No No Yes No No Yes + Dropbox Yes Yes Yes Yes No #575 No Yes Yes Yes Yes + Enterprise File Fabric Yes Yes Yes Yes No No No No No 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 + HDFS Yes No No No No No Yes No Yes Yes + HTTP No No No No No No No No #2178 No Yes + Hubic Yes † Yes No No No Yes Yes No #2178 Yes No + Jottacloud Yes Yes Yes Yes Yes Yes No Yes Yes Yes + Mail.ru Cloud Yes Yes Yes Yes Yes No No Yes Yes Yes + Mega Yes No Yes Yes Yes No No No #2178 Yes Yes + Memory No Yes No No No Yes Yes No No No + Microsoft Azure Blob Storage Yes Yes No No No Yes Yes No #2178 No No + Microsoft OneDrive Yes Yes Yes Yes Yes No No Yes Yes Yes + OpenDrive Yes Yes Yes Yes No No No No No Yes + OpenStack Swift Yes † Yes No No No Yes Yes No #2178 Yes No + pCloud Yes Yes Yes Yes Yes No No Yes Yes Yes + premiumize.me Yes No Yes Yes No No No Yes Yes Yes + put.io Yes No Yes Yes Yes No Yes No #2178 Yes Yes + QingStor No Yes No No Yes Yes No No #2178 No No + Seafile Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes + SFTP No No Yes Yes No No Yes No #2178 Yes Yes + SugarSync Yes Yes Yes Yes No No Yes Yes No Yes + Tardigrade Yes † No No No No Yes Yes No No No + WebDAV Yes Yes Yes Yes No No Yes ‡ No #2178 Yes Yes + Yandex Disk Yes Yes Yes Yes Yes No Yes Yes Yes Yes + Zoho WorkDrive Yes Yes Yes Yes No No No No Yes Yes + The local filesystem Yes No Yes Yes No No Yes No Yes Yes - # Overview of cloud storage systems # +Purge - Each cloud storage system is slightly different. Rclone attempts to - provide a unified interface to them, but some underlying differences - show through. +This deletes a directory quicker than just deleting all the files in the +directory. - ## Features ## +† Note Swift, Hubic, and Tardigrade implement this in order to delete +directory markers but they don't actually have a quicker way of deleting +files other than deleting them individually. - Here is an overview of the major features of each cloud storage system. +‡ StreamUpload is not supported with Nextcloud - | Name | Hash | ModTime | Case Insensitive | Duplicate Files | MIME Type | - | ---------------------------- |:-----------:|:-------:|:----------------:|:---------------:|:---------:| - | 1Fichier | Whirlpool | No | No | Yes | R | - | Amazon Drive | MD5 | No | Yes | No | R | - | Amazon S3 | MD5 | Yes | No | No | R/W | - | Backblaze B2 | SHA1 | Yes | No | No | R/W | - | Box | SHA1 | Yes | Yes | No | - | - | Citrix ShareFile | MD5 | Yes | Yes | No | - | - | Dropbox | DBHASH † | Yes | Yes | No | - | - | FTP | - | No | No | No | - | - | Google Cloud Storage | MD5 | Yes | No | No | R/W | - | Google Drive | MD5 | Yes | No | Yes | R/W | - | Google Photos | - | No | No | Yes | R | - | HTTP | - | No | No | No | R | - | Hubic | MD5 | Yes | No | No | R/W | - | Jottacloud | MD5 | Yes | Yes | No | R/W | - | Koofr | MD5 | No | Yes | No | - | - | Mail.ru Cloud | Mailru ‡‡‡ | Yes | Yes | No | - | - | Mega | - | No | No | Yes | - | - | Memory | MD5 | Yes | No | No | - | - | Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | - | Microsoft OneDrive | SHA1 ‡‡ | Yes | Yes | No | R | - | OpenDrive | MD5 | Yes | Yes | Partial \* | - | - | OpenStack Swift | MD5 | Yes | No | No | R/W | - | pCloud | MD5, SHA1 | Yes | No | No | W | - | premiumize.me | - | No | Yes | No | R | - | put.io | CRC-32 | Yes | No | Yes | R | - | QingStor | MD5 | No | No | No | R/W | - | Seafile | - | No | No | No | - | - | SFTP | MD5, SHA1 ‡ | Yes | Depends | No | - | - | SugarSync | - | No | No | No | - | - | Tardigrade | - | Yes | No | No | - | - | WebDAV | MD5, SHA1 ††| Yes ††† | Depends | No | - | - | Yandex Disk | MD5 | Yes | No | No | R/W | - | The local filesystem | All | Yes | Depends | No | - | - - ### Hash ### - - The cloud storage system supports various hash types of the objects. - The hashes are used when transferring data as an integrity check and - can be specifically used with the `--checksum` flag in syncs and in - the `check` command. - - To use the verify checksums when transferring between cloud storage - systems they must support a common hash type. - - † Note that Dropbox supports [its own custom - hash](https://www.dropbox.com/developers/reference/content-hash). - This is an SHA256 sum of all the 4MB block SHA256s. - - ‡ SFTP supports checksums if the same login has shell access and `md5sum` - or `sha1sum` as well as `echo` are in the remote's PATH. - - †† WebDAV supports hashes when used with Owncloud and Nextcloud only. - - ††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. - - ‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive - for business and SharePoint server support Microsoft's own - [QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). - - ‡‡‡ Mail.ru uses its own modified SHA1 hash - - ### ModTime ### - - The cloud storage system supports setting modification times on - objects. If it does then this enables a using the modification times - as part of the sync. If not then only the size will be checked by - default, though the MD5SUM can be checked with the `--checksum` flag. - - All cloud storage systems support some kind of date on the object and - these will be set when transferring from the cloud storage system. - - ### Case Insensitive ### - - If a cloud storage systems is case sensitive then it is possible to - have two files which differ only in case, eg `file.txt` and - `FILE.txt`. If a cloud storage system is case insensitive then that - isn't possible. - - This can cause problems when syncing between a case insensitive - system and a case sensitive system. The symptom of this is that no - matter how many times you run the sync it never completes fully. - - The local filesystem and SFTP may or may not be case sensitive - depending on OS. - - * Windows - usually case insensitive, though case is preserved - * OSX - usually case insensitive, though it is possible to format case sensitive - * Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys) - - Most of the time this doesn't cause any problems as people tend to - avoid files whose name differs only by case even on case sensitive - systems. - - ### Duplicate files ### - - If a cloud storage system allows duplicate files then it can have two - objects with the same name. - - This confuses rclone greatly when syncing - use the `rclone dedupe` - command to rename or remove duplicates. - - \* Opendrive does not support creation of duplicate files using - their web client interface or other stock clients, but the underlying - storage platform has been determined to allow duplicate files, and it - is possible to create them with `rclone`. It may be that this is a - mistake or an unsupported feature. - - ### Restricted filenames ### - - Some cloud storage systems might have restrictions on the characters - that are usable in file or directory names. - When `rclone` detects such a name during a file upload, it will - transparently replace the restricted characters with similar looking - Unicode characters. - - This process is designed to avoid ambiguous file names as much as - possible and allow to move files between many cloud storage systems - transparently. - - The name shown by `rclone` to the user or during log output will only - contain a minimal set of [replaced characters](#restricted-characters) - to ensure correct formatting and not necessarily the actual name used - on the cloud storage. - - This transformation is reversed when downloading a file or parsing - `rclone` arguments. - For example, when uploading a file named `my file?.txt` to Onedrive - will be displayed as `my file?.txt` on the console, but stored as - `my file？.txt` (the `?` gets replaced by the similar looking `？` - character) to Onedrive. - The reverse transformation allows to read a file`unusual/name.txt` - from Google Drive, by passing the name `unusual／name.txt` (the `/` needs - to be replaced by the similar looking `／` character) on the command line. - - #### Default restricted characters {#restricted-characters} - - The table below shows the characters that are replaced by default. - - When a replacement character is found in a filename, this character - will be escaped with the `‛` character to avoid ambiguous file names. - (e.g. a file named `␀.txt` would shown as `‛␀.txt`) - - Each cloud storage backend can use a different set of characters, - which will be specified in the documentation for each backend. - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | SOH | 0x01 | ␁ | - | STX | 0x02 | ␂ | - | ETX | 0x03 | ␃ | - | EOT | 0x04 | ␄ | - | ENQ | 0x05 | ␅ | - | ACK | 0x06 | ␆ | - | BEL | 0x07 | ␇ | - | BS | 0x08 | ␈ | - | HT | 0x09 | ␉ | - | LF | 0x0A | ␊ | - | VT | 0x0B | ␋ | - | FF | 0x0C | ␌ | - | CR | 0x0D | ␍ | - | SO | 0x0E | ␎ | - | SI | 0x0F | ␏ | - | DLE | 0x10 | ␐ | - | DC1 | 0x11 | ␑ | - | DC2 | 0x12 | ␒ | - | DC3 | 0x13 | ␓ | - | DC4 | 0x14 | ␔ | - | NAK | 0x15 | ␕ | - | SYN | 0x16 | ␖ | - | ETB | 0x17 | ␗ | - | CAN | 0x18 | ␘ | - | EM | 0x19 | ␙ | - | SUB | 0x1A | ␚ | - | ESC | 0x1B | ␛ | - | FS | 0x1C | ␜ | - | GS | 0x1D | ␝ | - | RS | 0x1E | ␞ | - | US | 0x1F | ␟ | - | / | 0x2F | ／ | - | DEL | 0x7F | ␡ | - - The default encoding will also encode these file names as they are - problematic with many cloud storage systems. - - | File name | Replacement | - | --------- |:-----------:| - | . | ． | - | .. | ．． | - - #### Invalid UTF-8 bytes {#invalid-utf8} - - Some backends only support a sequence of well formed UTF-8 bytes - as file or directory names. - - In this case all invalid UTF-8 bytes will be replaced with a quoted - representation of the byte value to allow uploading a file to such a - backend. For example, the invalid byte `0xFE` will be encoded as `‛FE`. - - A common source of invalid UTF-8 bytes are local filesystems, that store - names in a different encoding than UTF-8 or UTF-16, like latin1. See the - [local filenames](https://rclone.org/local/#filenames) section for details. - - #### Encoding option {#encoding} - - Most backends have an encoding options, specified as a flag - `--backend-encoding` where `backend` is the name of the backend, or as - a config parameter `encoding` (you'll need to select the Advanced - config in `rclone config` to see it). - - This will have default value which encodes and decodes characters in - such a way as to preserve the maximum number of characters (see - above). - - However this can be incorrect in some scenarios, for example if you - have a Windows file system with characters such as `＊` and `？` that - you want to remain as those characters on the remote rather than being - translated to `*` and `?`. - - The `--backend-encoding` flags allow you to change that. You can - disable the encoding completely with `--backend-encoding None` or set - `encoding = None` in the config file. - - Encoding takes a comma separated list of encodings. You can see the - list of all available characters by passing an invalid value to this - flag, eg `--local-encoding "help"` and `rclone help flags encoding` - will show you the defaults for the backends. - - | Encoding | Characters | - | --------- | ---------- | - | Asterisk | `*` | - | BackQuote | `` ` `` | - | BackSlash | `\` | - | Colon | `:` | - | CrLf | CR 0x0D, LF 0x0A | - | Ctl | All control characters 0x00-0x1F | - | Del | DEL 0x7F | - | Dollar | `$` | - | Dot | `.` | - | DoubleQuote | `"` | - | Hash | `#` | - | InvalidUtf8 | An invalid UTF-8 character (eg latin1) | - | LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string | - | LeftPeriod | `.` on the left of a string | - | LeftSpace | SPACE on the left of a string | - | LeftTilde | `~` on the left of a string | - | LtGt | `<`, `>` | - | None | No characters are encoded | - | Percent | `%` | - | Pipe | \| | - | Question | `?` | - | RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string | - | RightPeriod | `.` on the right of a string | - | RightSpace | SPACE on the right of a string | - | SingleQuote | `'` | - | Slash | `/` | - - To take a specific example, the FTP backend's default encoding is - - --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot" - - However, let's say the FTP server is running on Windows and can't have - any of the invalid Windows characters in file names. You are backing - up Linux servers to this FTP server which do have those characters in - file names. So you would add the Windows set which are - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - - to the existing ones, giving: - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace - - This can be specified using the `--ftp-encoding` flag or using an `encoding` parameter in the config file. - - Or let's say you have a Windows server but you want to preserve `＊` - and `？`, you would then have this as the encoding (the Windows - encoding minus `Asterisk` and `Question`). - - Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - - This can be specified using the `--local-encoding` flag or using an - `encoding` parameter in the config file. - - ### MIME Type ### - - MIME types (also known as media types) classify types of documents - using a simple text classification, eg `text/html` or - `application/pdf`. - - Some cloud storage systems support reading (`R`) the MIME type of - objects and some support writing (`W`) the MIME type of objects. - - The MIME type can be important if you are serving files directly to - HTTP from the storage system. - - If you are copying from a remote which supports reading (`R`) to a - remote which supports writing (`W`) then rclone will preserve the MIME - types. Otherwise they will be guessed from the extension, or the - remote itself may assign the MIME type. - - ## Optional Features ## - - All the remotes support a basic set of features, but there are some - optional features supported by some remotes used to make some - operations more efficient. - - | Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir | - | ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| :------: | - | 1Fichier | No | No | No | No | No | No | No | No | No | Yes | - | Amazon Drive | Yes | No | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Amazon S3 | No | Yes | No | No | Yes | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | Yes | No | No | - | Box | Yes | Yes | Yes | Yes | Yes ‡‡ | No | Yes | Yes | No | Yes | - | Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | Yes | No | No | Yes | - | Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | Yes | Yes | - | FTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Google Cloud Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Google Drive | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Google Photos | No | No | No | No | No | No | No | No | No | No | - | HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Hubic | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | - | Jottacloud | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | - | Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | Memory | No | Yes | No | No | No | Yes | Yes | No | No | No | - | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Microsoft OneDrive | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | - | OpenStack Swift | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | - | pCloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | premiumize.me | Yes | No | Yes | Yes | No | No | No | Yes | Yes | Yes | - | put.io | Yes | No | Yes | Yes | Yes | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | QingStor | No | Yes | No | No | Yes | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Seafile | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | - | Tardigrade | Yes † | No | No | No | No | Yes | Yes | No | No | No | - | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | - | The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | +Copy - ### Purge ### +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. - This deletes a directory quicker than just deleting all the files in - the directory. +If the server doesn't support Copy directly then for copy operations the +file is downloaded then re-uploaded. - † Note Swift, Hubic, and Tardigrade implement this in order to delete - directory markers but they don't actually have a quicker way of deleting - files other than deleting them individually. +Move - ‡ StreamUpload is not supported with Nextcloud +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. - ### Copy ### +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. - Used when copying an object to and from the same remote. This known - as a server side copy so you can copy a file without downloading it - and uploading it again. It is used if you use `rclone copy` or - `rclone move` if the remote doesn't support `Move` directly. - - If the server doesn't support `Copy` directly then for copy operations - the file is downloaded then re-uploaded. - - ### Move ### - - Used when moving/renaming an object on the same remote. This is known - as a server side move of a file. This is used in `rclone move` if the - server doesn't support `DirMove`. - - If the server isn't capable of `Move` then rclone simulates it with - `Copy` then delete. If the server doesn't support `Copy` then rclone - will download the file and re-upload it. - - ### DirMove ### - - This is used to implement `rclone move` to move a directory if - possible. If it isn't then it will use `Move` on each file (which - falls back to `Copy` then download and upload - see `Move` section). - - ### CleanUp ### - - This is used for emptying the trash for a remote by `rclone cleanup`. - - If the server can't do `CleanUp` then `rclone cleanup` will return an - error. - - ‡‡ Note that while Box implements this it has to delete every file - idividually so it will be slower than emptying the trash via the WebUI - - ### ListR ### - - The remote supports a recursive list to list all the contents beneath - a directory quickly. This enables the `--fast-list` flag to work. - See the [rclone docs](https://rclone.org/docs/#fast-list) for more details. - - ### StreamUpload ### - - Some remotes allow files to be uploaded without knowing the file size - in advance. This allows certain operations to work without spooling the - file to local disk first, e.g. `rclone rcat`. - - ### LinkSharing ### - - Sets the necessary permissions on a file or folder and prints a link - that allows others to access them, even if they don't have an account - on the particular cloud provider. - - ### About ### - - This is used to fetch quota information from the remote, like bytes - used/free/quota and bytes used in the trash. - - This is also used to return the space used, available for `rclone mount`. - - If the server can't do `About` then `rclone about` will return an - error. - - ### EmptyDir ### - - The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations) - for details. Most Object/Bucket based remotes do not support this. - - # Global Flags - - This describes the global flags available to every rclone command - split into two groups, non backend and backend flags. - - ## Non Backend Flags - - These flags are available for every command. - - --ask-password Allow prompt for password for encrypted configuration. (default true) - --auto-confirm If enabled, do not request console confirmation. - --backup-dir string Make backups into hierarchy based in DIR. - --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. - --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) - --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. - --bwlimit-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. - --ca-cert string CA certificate used to verify servers - --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") - --check-first Do all the checks before starting transfers. - --checkers int Number of checkers to run in parallel. (default 8) - --c, --checksum Skip based on checksum (if available) & size, not -mod-time & size --client-cert string Client SSL certificate (PEM) for -mutual TLS auth --client-key string Client SSL private key (PEM) for -mutual TLS auth --compare-dest string Include additional server-side -path during comparison. --config string Config file. (default -"$HOME/.config/rclone/rclone.conf") --contimeout duration Connect -timeout (default 1m0s) --copy-dest string Implies --compare-dest but -also copies files from path into destination. --cpuprofile string Write -cpu profile to file --cutoff-mode string Mode to stop transfers when -reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") ---delete-after When synchronizing, delete files on destination after -transferring (default) --delete-before When synchronizing, delete files -on destination before transferring --delete-during When synchronizing, -delete files during transfer --delete-excluded Delete files on dest -excluded from sync --disable string Disable a comma separated list of -features. Use help to see a list. -n, --dry-run Do a trial run with no -permanent changes --dump DumpFlags List of items to dump from: -headers,bodies,requests,responses,auth,filters,goroutines,openfiles ---dump-bodies Dump HTTP headers and bodies - may contain sensitive info ---dump-headers Dump HTTP headers - may contain sensitive info ---error-on-no-transfer Sets exit code 9 if no files are transferred, -useful in scripts --exclude stringArray Exclude files matching pattern ---exclude-from stringArray Read exclude patterns from file (use - to -read from stdin) --exclude-if-present string Exclude directories if -filename is present --expect-continue-timeout duration Timeout when -using expect / 100-continue in HTTP (default 1s) --fast-list Use -recursive list if available. Uses more memory but fewer transactions. ---files-from stringArray Read list of source-file names from file (use - -to read from stdin) --files-from-raw stringArray Read list of -source-file names from file without any processing of lines (use - to -read from stdin) -f, --filter stringArray Add a file-filtering rule ---filter-from stringArray Read filtering patterns from a file (use - to -read from stdin) --header stringArray Set HTTP header for all -transactions --header-download stringArray Set HTTP header for download -transactions --header-upload stringArray Set HTTP header for upload -transactions --ignore-case Ignore case in filters (case insensitive) ---ignore-case-sync Ignore case when synchronizing --ignore-checksum Skip -post copy check of checksums. --ignore-errors delete even if there are -I/O errors --ignore-existing Skip all files that exist on destination ---ignore-size Ignore size when skipping use mod-time or checksum. -I, ---ignore-times Don't skip files that match size and time - transfer all -files --immutable Do not modify files. Fail if existing files have been -modified. --include stringArray Include files matching pattern ---include-from stringArray Read include patterns from file (use - to -read from stdin) -i, --interactive Enable interactive mode --log-file -string Log everything to this file --log-format string Comma separated -list of log format options (default "date,time") --log-level string Log -level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") --low-level-retries int -Number of low level retries to do. (default 10) --max-age Duration Only -transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y -(default off) --max-backlog int Maximum number of objects in sync or -check backlog. (default 10000) --max-delete int When synchronizing, -limit the number of deletes (default -1) --max-depth int If set limits -the recursion depth to this. (default -1) --max-duration duration -Maximum duration rclone will transfer data for. --max-size SizeSuffix -Only transfer files smaller than this in k or suffix b|k|M|G (default -off) --max-stats-groups int Maximum number of stats groups to keep in -memory. On max oldest is discarded. (default 1000) --max-transfer -SizeSuffix Maximum size of data to transfer. (default off) --memprofile -string Write memory profile to file --min-age Duration Only transfer -files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) ---min-size SizeSuffix Only transfer files bigger than this in k or -suffix b|k|M|G (default off) --modify-window duration Max time diff to -be considered the same (default 1ns) --multi-thread-cutoff SizeSuffix -Use multi-thread downloads for files above this size. (default 250M) ---multi-thread-streams int Max number of streams to use for multi-thread -downloads. (default 4) --no-check-certificate Do not verify the server -SSL certificate. Insecure. --no-check-dest Don't check the destination, -copy regardless. --no-gzip-encoding Don't set Accept-Encoding: gzip. ---no-traverse Don't traverse destination file system on copy. ---no-unicode-normalization Don't normalize unicode characters in -filenames. --no-update-modtime Don't update destination mod-time if -files identical. --order-by string Instructions on how to order the -transfers, eg 'size,descending' --password-command SpaceSepList Command -for supplying password for encrypted configuration. -P, --progress Show -progress during transfer. -q, --quiet Print as little stuff as possible ---rc Enable the remote control server. --rc-addr string IPaddress:Port -or :Port to bind server to. (default "localhost:5572") --rc-allow-origin -string Set the allowed origin for CORS. --rc-baseurl string Prefix for -URLs - leave blank for root. --rc-cert string SSL PEM key (concatenation -of certificate and CA certificate) --rc-client-ca string Client -certificate authority to verify clients with --rc-enable-metrics Enable -prometheus metrics on /metrics --rc-files string Path to local files to -serve on the HTTP server. --rc-htpasswd string htpasswd file - if not -provided no authentication is done --rc-job-expire-duration duration -expire finished async jobs older than this value (default 1m0s) ---rc-job-expire-interval duration interval to check for expired async -jobs (default 10s) --rc-key string SSL PEM Private key ---rc-max-header-bytes int Maximum size of request header (default 4096) ---rc-no-auth Don't require auth for certain methods. --rc-pass string -Password for authentication. --rc-realm string realm for authentication -(default "rclone") --rc-serve Enable the serving of remote objects. ---rc-server-read-timeout duration Timeout for server reading data -(default 1h0m0s) --rc-server-write-timeout duration Timeout for server -writing data (default 1h0m0s) --rc-template string User Specified -Template. --rc-user string User name for authentication. ---rc-web-fetch-url string URL to fetch the releases for webgui. (default -"https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") ---rc-web-gui Launch WebGUI on localhost --rc-web-gui-force-update Force -update to latest version of web gui --rc-web-gui-no-open-browser Don't -open the browser automatically --rc-web-gui-update Check and update to -latest version of web gui --refresh-times Refresh the modtime of remote -files. --retries int Retry operations this many times if they fail -(default 3) --retries-sleep duration Interval between retrying -operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) --size-only -Skip based on size only, not mod-time or checksum --stats duration -Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) -(default 1m0s) --stats-file-name-length int Max file name length in -stats. 0 for no limit (default 45) --stats-log-level string Log level to -show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") ---stats-one-line Make the stats fit on one line. --stats-one-line-date -Enables --stats-one-line and add current date/time prefix. ---stats-one-line-date-format string Enables --stats-one-line-date and -uses custom formatted date. Enclose date string in double quotes ("). -See https://golang.org/pkg/time/#Time.Format --stats-unit string Show -data rate in stats as either 'bits' or 'bytes'/s (default "bytes") ---streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked -upload if file size is unknown. Upload starts after reaching cutoff or -when file ends. (default 100k) --suffix string Suffix to add to changed -files. --suffix-keep-extension Preserve the extension when using ---suffix. --syslog Use Syslog for logging --syslog-facility string -Facility for syslog, eg KERN,USER,... (default "DAEMON") --timeout -duration IO idle timeout (default 5m0s) --tpslimit float Limit HTTP -transactions per second to this. --tpslimit-burst int Max burst of -transactions for --tpslimit. (default 1) --track-renames When -synchronizing, track file renames and do a server side move if possible ---track-renames-strategy string Strategies to use when synchronizing -using track-renames hash|modtime|leaf (default "hash") --transfers int -Number of file transfers to run in parallel. (default 4) -u, --update -Skip files that are newer on the destination. --use-cookies Enable -session cookiejar. --use-json-log Use json log format. --use-mmap Use -mmap allocator (see docs). --use-server-modtime Use server modified time -instead of object metadata --user-agent string Set the user-agent to a -specified string. The default is rclone/ version (default -"rclone/v1.53.0") -v, --verbose count Print lots more stuff (repeat for -more) - - - ## Backend Flags - - These flags are available for every command. They control the backends - and may be set in the config file. - - --acd-auth-url string Auth server URL. - --acd-client-id string OAuth Client Id - --acd-client-secret string OAuth Client Secret - --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) - --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - --acd-token string OAuth Access Token as a JSON blob. - --acd-token-url string Token server url. - --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) - --alias-remote string Remote or path to alias. - --azureblob-access-tier string Access tier of blob: hot, cool or archive. - --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) - --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) - --azureblob-disable-checksum Don't store MD5 checksum with object metadata. - --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) - --azureblob-endpoint string Endpoint for the service - --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) - --azureblob-list-chunk int Size of blob list. (default 5000) - --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --azureblob-sas-url string SAS URL for container level access only - --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) - --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) - --b2-account string Account ID or Application Key ID - --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) - --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) - --b2-disable-checksum Disable checksums for large (> upload cutoff) files - --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) - --b2-download-url string Custom endpoint for downloads. - --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - --b2-endpoint string Endpoint for the service. - --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. - --b2-key string Application Key - --b2-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - --b2-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. - --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. - --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) - --b2-versions Include old versions in directory listings. - --box-access-token string Box App Primary Access Token - --box-auth-url string Auth server URL. - --box-box-config-file string Box App config.json location - --box-box-sub-type string (default "user") - --box-client-id string OAuth Client Id - --box-client-secret string OAuth Client Secret - --box-commit-retries int Max number of times to try committing a multipart file. (default 100) - --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) - --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. - --box-token string OAuth Access Token as a JSON blob. - --box-token-url string Token server url. - --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) - --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) - --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. - --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") - --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) - --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) - --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") - --cache-db-purge Clear all the cached data for this remote on start. - --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) - --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) - --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server - --cache-plex-password string The password of the Plex user (obscured) - --cache-plex-url string The URL of the Plex server - --cache-plex-username string The username of the Plex user - --cache-read-retries int How many times to retry a read from a cache storage. (default 10) - --cache-remote string Remote to cache. - --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) - --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. - --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) - --cache-workers int How many workers should run in parallel to download chunks. (default 4) - --cache-writes Cache file data on writes through the FS - --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) - --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. - --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") - --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") - --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") - --chunker-remote string Remote to chunk/unchunk. - --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) - --L, --copy-links Follow symlinks and copy the pointed to item. ---crypt-directory-name-encryption Option to either encrypt directory -names or leave them intact. (default true) --crypt-filename-encryption -string How to encrypt the filenames. (default "standard") ---crypt-password string Password or pass phrase for encryption. -(obscured) --crypt-password2 string Password or pass phrase for salt. -Optional but recommended. (obscured) --crypt-remote string Remote to -encrypt/decrypt. --crypt-server-side-across-configs Allow server side -operations (eg copy) to work across different crypt configs. ---crypt-show-mapping For all files listed show how the names encrypt. ---drive-acknowledge-abuse Set to allow files which return -cannotDownloadAbusiveFile to be downloaded. ---drive-allow-import-name-change Allow the filetype to change when -uploading Google docs (e.g. file.doc to file.docx). This will confuse -sync and reupload every time. --drive-auth-owner-only Only consider -files owned by the authenticated user. --drive-auth-url string Auth -server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a -power of 2 >= 256k. (default 8M) --drive-client-id string OAuth Client -Id --drive-client-secret string OAuth Client Secret ---drive-disable-http2 Disable drive using http2 (default true) ---drive-encoding MultiEncoder This sets the encoding for the backend. -(default InvalidUtf8) --drive-export-formats string Comma separated list -of preferred formats for downloading Google docs. (default -"docx,xlsx,pptx,svg") --drive-formats string Deprecated: see -export_formats --drive-impersonate string Impersonate this user when -using a service account. --drive-import-formats string Comma separated -list of preferred formats for uploading Google docs. ---drive-keep-revision-forever Keep new head revision of each file -forever. --drive-list-chunk int Size of listing chunk 100-1000. 0 to -disable. (default 1000) --drive-pacer-burst int Number of API calls to -allow without sleeping. (default 100) --drive-pacer-min-sleep Duration -Minimum time to sleep between API calls. (default 100ms) ---drive-root-folder-id string ID of the root folder --drive-scope string -Scope that rclone should use when requesting access from drive. ---drive-server-side-across-configs Allow server side operations (eg -copy) to work across different drive configs. ---drive-service-account-credentials string Service Account Credentials -JSON blob --drive-service-account-file string Service Account -Credentials JSON file path --drive-shared-with-me Only show files that -are shared with me. --drive-size-as-quota Show sizes as storage quota -usage, not actual size. --drive-skip-checksum-gphotos Skip MD5 checksum -on Google photos and videos only. --drive-skip-gdocs Skip google -documents in all listings. --drive-skip-shortcuts If set skip shortcut -files --drive-starred-only Only show files that are starred. ---drive-stop-on-upload-limit Make upload limit errors be fatal ---drive-team-drive string ID of the Team Drive --drive-token string -OAuth Access Token as a JSON blob. --drive-token-url string Token server -url. --drive-trashed-only Only show files that are in the trash. ---drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload -(default 8M) --drive-use-created-date Use file created date instead of -modified date., --drive-use-shared-date Use date file was shared instead -of modified date. --drive-use-trash Send files to the trash instead of -deleting permanently. (default true) --drive-v2-download-min-size -SizeSuffix If Object's are greater, use drive v2 API to download. -(default off) --dropbox-auth-url string Auth server URL. ---dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default -48M) --dropbox-client-id string OAuth Client Id --dropbox-client-secret -string OAuth Client Secret --dropbox-encoding MultiEncoder This sets the -encoding for the backend. (default -Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-impersonate -string Impersonate this user when using a business account. ---dropbox-token string OAuth Access Token as a JSON blob. ---dropbox-token-url string Token server url. --fichier-api-key string -Your API Key, get it from https://1fichier.com/console/params.pl ---fichier-encoding MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) ---fichier-shared-folder string If you want to download a shared folder, -add this parameter --ftp-concurrency int Maximum number of FTP -simultaneous connections, 0 for unlimited --ftp-disable-epsv Disable -using EPSV even if server advertises support --ftp-encoding MultiEncoder -This sets the encoding for the backend. (default -Slash,Del,Ctl,RightSpace,Dot) --ftp-explicit-tls Use FTP over TLS -(Explicit) --ftp-host string FTP host to connect to ---ftp-no-check-certificate Do not verify the TLS certificate of the -server --ftp-pass string FTP password (obscured) --ftp-port string FTP -port, leave blank to use default (21) --ftp-tls Use FTPS over TLS -(Implicit) --ftp-user string FTP username, leave blank for current -username, $USER --gcs-anonymous Access public buckets and objects -without credentials --gcs-auth-url string Auth server URL. ---gcs-bucket-acl string Access Control List for new buckets. ---gcs-bucket-policy-only Access checks should use bucket-level IAM -policies. --gcs-client-id string OAuth Client Id --gcs-client-secret -string OAuth Client Secret --gcs-encoding MultiEncoder This sets the -encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) ---gcs-location string Location for the newly created buckets. ---gcs-object-acl string Access Control List for new objects. ---gcs-project-number string Project number. --gcs-service-account-file -string Service Account Credentials JSON file path --gcs-storage-class -string The storage class to use when storing objects in Google Cloud -Storage. --gcs-token string OAuth Access Token as a JSON blob. ---gcs-token-url string Token server url. --gphotos-auth-url string Auth -server URL. --gphotos-client-id string OAuth Client Id ---gphotos-client-secret string OAuth Client Secret --gphotos-read-only -Set to make the Google Photos backend read only. --gphotos-read-size Set -to read the size of media items. --gphotos-start-year int Year limits -the photos to be downloaded to those which are uploaded after the given -year (default 2000) --gphotos-token string OAuth Access Token as a JSON -blob. --gphotos-token-url string Token server url. --http-headers -CommaSepList Set HTTP headers for all transactions --http-no-head Don't -use HEAD requests to find file sizes in dir listing --http-no-slash Set -this if the site doesn't end directories with / --http-url string URL of -http host to connect to --hubic-auth-url string Auth server URL. ---hubic-chunk-size SizeSuffix Above this size files will be chunked into -a _segments container. (default 5G) --hubic-client-id string OAuth -Client Id --hubic-client-secret string OAuth Client Secret ---hubic-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8) --hubic-no-chunk Don't chunk files during -streaming upload. --hubic-token string OAuth Access Token as a JSON -blob. --hubic-token-url string Token server url. --jottacloud-encoding -MultiEncoder This sets the encoding for the backend. (default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) ---jottacloud-hard-delete Delete files permanently rather than putting -them into the trash. --jottacloud-md5-memory-limit SizeSuffix Files -bigger than this will be cached on disk to calculate the MD5 if -required. (default 10M) --jottacloud-trashed-only Only show files that -are in the trash. --jottacloud-upload-resume-limit SizeSuffix Files -bigger than this can be resumed if the upload fail's. (default 10M) ---koofr-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --koofr-endpoint -string The Koofr API endpoint to use (default "https://app.koofr.net") ---koofr-mountid string Mount ID of the mount to use. If omitted, the -primary mount is used. --koofr-password string Your Koofr password for -rclone (generate one at -https://app.koofr.net/app/admin/preferences/password) (obscured) ---koofr-setmtime Does the backend support setting modification time. Set -this to false if you use a mount ID that points to a Dropbox or Amazon -Drive backend. (default true) --koofr-user string Your Koofr user name --l, --links Translate symlinks to/from regular files with a -'.rclonelink' extension --local-case-insensitive Force the filesystem to -report itself as case insensitive --local-case-sensitive Force the -filesystem to report itself as case sensitive. --local-encoding -MultiEncoder This sets the encoding for the backend. (default Slash,Dot) ---local-no-check-updated Don't check to see if the files change during -upload --local-no-set-modtime Disable setting modtime --local-no-sparse -Disable sparse files for multi-thread downloads ---local-no-unicode-normalization Don't apply unicode normalization to -paths and filenames (Deprecated) --local-nounc string Disable UNC (long -path names) conversion on Windows --mailru-check-hash What should copy -do if file checksum is mismatched or invalid (default true) ---mailru-encoding MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) ---mailru-pass string Password (obscured) --mailru-speedup-enable Skip -full upload if there is another file with same data hash. (default true) ---mailru-speedup-file-patterns string Comma separated list of file name -patterns eligible for speedup (put by hash). (default -"_.mkv,_.avi,_.mp4,_.mp3,_.zip,_.gz,_.rar,_.pdf") ---mailru-speedup-max-disk SizeSuffix This option allows you to disable -speedup (put by hash) for large files (default 3G) ---mailru-speedup-max-memory SizeSuffix Files larger than the size given -below will always be hashed on disk. (default 32M) --mailru-user string -User name (usually email) --mega-debug Output more debug from Mega. ---mega-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8,Dot) --mega-hard-delete Delete files -permanently rather than putting them into the trash. --mega-pass string -Password. (obscured) --mega-user string User name -x, --one-file-system -Don't cross filesystem boundaries (unix/macOS only). --onedrive-auth-url -string Auth server URL. --onedrive-chunk-size SizeSuffix Chunk size to -upload files with - must be multiple of 320k (327,680 bytes). (default -10M) --onedrive-client-id string OAuth Client Id ---onedrive-client-secret string OAuth Client Secret --onedrive-drive-id -string The ID of the drive to use --onedrive-drive-type string The type -of the drive ( personal | business | documentLibrary ) ---onedrive-encoding MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) ---onedrive-expose-onenote-files Set to make OneNote files show up in -directory listings. --onedrive-no-versions Remove all versions on -modifying operations --onedrive-server-side-across-configs Allow server -side operations (eg copy) to work across different onedrive configs. ---onedrive-token string OAuth Access Token as a JSON blob. ---onedrive-token-url string Token server url. --opendrive-chunk-size -SizeSuffix Files will be uploaded in chunks this size. (default 10M) ---opendrive-encoding MultiEncoder This sets the encoding for the -backend. (default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) ---opendrive-password string Password. (obscured) --opendrive-username -string Username --pcloud-auth-url string Auth server URL. ---pcloud-client-id string OAuth Client Id --pcloud-client-secret string -OAuth Client Secret --pcloud-encoding MultiEncoder This sets the -encoding for the backend. (default -Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) --pcloud-hostname string -Hostname to connect to. (default "api.pcloud.com") ---pcloud-root-folder-id string Fill in for rclone to use a non root -folder as its starting point. (default "d0") --pcloud-token string OAuth -Access Token as a JSON blob. --pcloud-token-url string Token server url. ---premiumizeme-encoding MultiEncoder This sets the encoding for the -backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) ---putio-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) ---qingstor-access-key-id string QingStor Access Key ID ---qingstor-chunk-size SizeSuffix Chunk size to use for uploading. -(default 4M) --qingstor-connection-retries int Number of connection -retries. (default 3) --qingstor-encoding MultiEncoder This sets the -encoding for the backend. (default Slash,Ctl,InvalidUtf8) ---qingstor-endpoint string Enter an endpoint URL to connection QingStor -API. --qingstor-env-auth Get QingStor credentials from runtime. Only -applies if access_key_id and secret_access_key is blank. ---qingstor-secret-access-key string QingStor Secret Access Key -(password) --qingstor-upload-concurrency int Concurrency for multipart -uploads. (default 1) --qingstor-upload-cutoff SizeSuffix Cutoff for -switching to chunked upload (default 200M) --qingstor-zone string Zone -to connect to. --s3-access-key-id string AWS Access Key ID. --s3-acl -string Canned ACL used when creating buckets and storing or copying -objects. --s3-bucket-acl string Canned ACL used when creating buckets. ---s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) ---s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy -(default 4.656G) --s3-disable-checksum Don't store MD5 checksum with -object metadata --s3-encoding MultiEncoder This sets the encoding for -the backend. (default Slash,InvalidUtf8,Dot) --s3-endpoint string -Endpoint for S3 API. --s3-env-auth Get AWS credentials from runtime -(environment variables or EC2/ECS meta data if no env vars). ---s3-force-path-style If true use path style access if false use virtual -hosted style. (default true) --s3-leave-parts-on-error If true avoid -calling abort upload on a failure, leaving all successfully uploaded -parts on S3 for manual recovery. --s3-list-chunk int Size of listing -chunk (response list for each ListObject S3 request). (default 1000) ---s3-location-constraint string Location constraint - must be set to -match the Region. --s3-max-upload-parts int Maximum number of parts in a -multipart upload. (default 10000) --s3-memory-pool-flush-time Duration -How often internal memory buffer pools will be flushed. (default 1m0s) ---s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory -pool. --s3-no-check-bucket If set don't attempt to check the bucket -exists or create it --s3-profile string Profile to use in the shared -credentials file --s3-provider string Choose your S3 provider. ---s3-region string Region to connect to. --s3-secret-access-key string -AWS Secret Access Key (password) --s3-server-side-encryption string The -server-side encryption algorithm used when storing this object in S3. ---s3-session-token string An AWS session token ---s3-shared-credentials-file string Path to the shared credentials file ---s3-sse-customer-algorithm string If using SSE-C, the server-side -encryption algorithm used when storing this object in S3. ---s3-sse-customer-key string If using SSE-C you must provide the secret -encryption key used to encrypt/decrypt your data. ---s3-sse-customer-key-md5 string If using SSE-C you must provide the -secret encryption key MD5 checksum. --s3-sse-kms-key-id string If using -KMS ID you must provide the ARN of Key. --s3-storage-class string The -storage class to use when storing new objects in S3. ---s3-upload-concurrency int Concurrency for multipart uploads. (default -4) --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload -(default 200M) --s3-use-accelerate-endpoint If true use the AWS S3 -accelerated endpoint. --s3-v2-auth If true use v2 authentication. ---seafile-2fa Two-factor authentication ('true' if the account has 2FA -enabled) --seafile-create-library Should rclone create a library if it -doesn't exist --seafile-encoding MultiEncoder This sets the encoding for -the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) ---seafile-library string Name of the library. Leave blank to access all -non-encrypted libraries. --seafile-library-key string Library password -(for encrypted libraries only). Leave blank if you pass it through the -command line. (obscured) --seafile-pass string Password (obscured) ---seafile-url string URL of seafile host to connect to --seafile-user -string User name (usually email address) --sftp-ask-password Allow -asking for SFTP password when needed. --sftp-disable-hashcheck Disable -the execution of SSH commands to determine if remote file hashing is -available. --sftp-host string SSH host to connect to --sftp-key-file -string Path to PEM-encoded private key file, leave blank or set -key-use-agent to use ssh-agent. --sftp-key-file-pass string The -passphrase to decrypt the PEM-encoded private key file. (obscured) ---sftp-key-pem string Raw PEM-encoded private key, If specified, will -override key_file parameter. --sftp-key-use-agent When set forces the -usage of the ssh-agent. --sftp-md5sum-command string The command used to -read md5 hashes. Leave blank for autodetect. --sftp-pass string SSH -password, leave blank to use ssh-agent. (obscured) --sftp-path-override -string Override path used by SSH connection. --sftp-port string SSH -port, leave blank to use default (22) --sftp-server-command string -Specifies the path or command to run a sftp server on the remote host. ---sftp-set-modtime Set the modified time on the remote if set. (default -true) --sftp-sha1sum-command string The command used to read sha1 -hashes. Leave blank for autodetect. --sftp-skip-links Set to skip any -symlinks and any other non regular files. --sftp-subsystem string -Specifies the SSH2 subsystem on the remote host. (default "sftp") ---sftp-use-insecure-cipher Enable the use of insecure ciphers and key -exchange methods. --sftp-user string SSH username, leave blank for -current username, ncw --sharefile-chunk-size SizeSuffix Upload chunk -size. Must a power of 2 >= 256k. (default 64M) --sharefile-encoding -MultiEncoder This sets the encoding for the backend. (default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) ---sharefile-endpoint string Endpoint for API calls. ---sharefile-root-folder-id string ID of the root folder ---sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart -upload. (default 128M) --skip-links Don't warn about skipped symlinks. ---sugarsync-access-key-id string Sugarsync Access Key ID. ---sugarsync-app-id string Sugarsync App ID. --sugarsync-authorization -string Sugarsync authorization --sugarsync-authorization-expiry string -Sugarsync authorization expiry --sugarsync-deleted-id string Sugarsync -deleted folder id --sugarsync-encoding MultiEncoder This sets the -encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) ---sugarsync-hard-delete Permanently delete files if true ---sugarsync-private-access-key string Sugarsync Private Access Key ---sugarsync-refresh-token string Sugarsync refresh token ---sugarsync-root-id string Sugarsync root id --sugarsync-user string -Sugarsync user --swift-application-credential-id string Application -Credential ID (OS_APPLICATION_CREDENTIAL_ID) ---swift-application-credential-name string Application Credential Name -(OS_APPLICATION_CREDENTIAL_NAME) --swift-application-credential-secret -string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) ---swift-auth string Authentication URL for server (OS_AUTH_URL). ---swift-auth-token string Auth Token from alternate authentication - -optional (OS_AUTH_TOKEN) --swift-auth-version int AuthVersion - optional -- set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) ---swift-chunk-size SizeSuffix Above this size files will be chunked into -a _segments container. (default 5G) --swift-domain string User domain - -optional (v3 auth) (OS_USER_DOMAIN_NAME) --swift-encoding MultiEncoder -This sets the encoding for the backend. (default Slash,InvalidUtf8) ---swift-endpoint-type string Endpoint type to choose from the service -catalogue (OS_ENDPOINT_TYPE) (default "public") --swift-env-auth Get -swift credentials from environment variables in standard OpenStack form. ---swift-key string API key or password (OS_PASSWORD). --swift-no-chunk -Don't chunk files during streaming upload. --swift-region string Region -name - optional (OS_REGION_NAME) --swift-storage-policy string The -storage policy to use when creating a new container --swift-storage-url -string Storage URL - optional (OS_STORAGE_URL) --swift-tenant string -Tenant name - optional for v1 auth, this or tenant_id required otherwise -(OS_TENANT_NAME or OS_PROJECT_NAME) --swift-tenant-domain string Tenant -domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) --swift-tenant-id -string Tenant ID - optional for v1 auth, this or tenant required -otherwise (OS_TENANT_ID) --swift-user string User name to log in -(OS_USERNAME). --swift-user-id string User ID to log in - optional - -most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). ---tardigrade-access-grant string Access Grant. --tardigrade-api-key -string API Key. --tardigrade-passphrase string Encryption Passphrase. To -access existing objects enter passphrase used for uploading. ---tardigrade-provider string Choose an authentication method. (default -"existing") --tardigrade-satellite-address @ -: Satellite Address. Custom satellite address should match the format: @ -:. (default "us-central-1.tardigrade.io") --union-action-policy string -Policy to choose upstream on ACTION category. (default "epall") ---union-cache-time int Cache time of usage and free space (in seconds). -This option is only useful when a path preserving policy is used. -(default 120) --union-create-policy string Policy to choose upstream on -CREATE category. (default "epmfs") --union-search-policy string Policy -to choose upstream on SEARCH category. (default "ff") --union-upstreams -string List of space separated upstreams. --webdav-bearer-token string -Bearer token instead of user/pass (eg a Macaroon) ---webdav-bearer-token-command string Command to run to get a bearer -token --webdav-pass string Password. (obscured) --webdav-url string URL -of http host to connect to --webdav-user string User name ---webdav-vendor string Name of the Webdav site/service/software you are -using --yandex-auth-url string Auth server URL. --yandex-client-id -string OAuth Client Id --yandex-client-secret string OAuth Client Secret ---yandex-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-token string OAuth -Access Token as a JSON blob. --yandex-token-url string Token server url. - - - 1Fichier - ----------------------------------------- - - This is a backend for the [1fichier](https://1fichier.com) cloud - storage service. Note that a Premium subscription is required to use - the API. - - Paths are specified as `remote:path` - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - The initial setup for 1Fichier involves getting the API key from the website which you - need to do in your browser. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value [snip] XX / -1Fichier  "fichier" [snip] Storage> fichier ** See help for fichier -backend at: https://rclone.org/fichier/ ** - -Your API Key, get it from https://1fichier.com/console/params.pl Enter a -string value. Press Enter for the default (""). api_key> example_key - -Edit advanced config? (y/n) y) Yes n) No y/n> Remote config --------------------- [remote] type = fichier api_key = example_key --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - Once configured you can then use `rclone` like this, - - List directories in top level of your 1Fichier account - - rclone lsd remote: - - List all the files in your 1Fichier account - - rclone ls remote: - - To copy a local directory to a 1Fichier directory called backup - - rclone copy /home/source remote:backup - - ### Modified time and hashes ### - - 1Fichier does not support modification times. It supports the Whirlpool hash algorithm. - - ### Duplicated files ### - - 1Fichier can have two files with exactly the same name and path (unlike a - normal file system). - - Duplicated files cause problems with the syncing and you will see - messages in the log about duplicates. - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | - | < | 0x3C | ＜ | - | > | 0x3E | ＞ | - | " | 0x22 | ＂ | - | $ | 0x24 | ＄ | - | ` | 0x60 | ｀ | - | ' | 0x27 | ＇ | - - File names can also not start or end with the following characters. - These only get replaced if they are the first or last character in the - name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to fichier (1Fichier). - - #### --fichier-api-key +DirMove + +This is used to implement rclone move to move a directory if possible. +If it isn't then it will use Move on each file (which falls back to Copy +then download and upload - see Move section). + +CleanUp + +This is used for emptying the trash for a remote by rclone cleanup. + +If the server can't do CleanUp then rclone cleanup will return an error. + +‡‡ Note that while Box implements this it has to delete every file +individually so it will be slower than emptying the trash via the WebUI + +ListR + +The remote supports a recursive list to list all the contents beneath a +directory quickly. This enables the --fast-list flag to work. See the +rclone docs for more details. + +StreamUpload + +Some remotes allow files to be uploaded without knowing the file size in +advance. This allows certain operations to work without spooling the +file to local disk first, e.g. rclone rcat. + +LinkSharing + +Sets the necessary permissions on a file or folder and prints a link +that allows others to access them, even if they don't have an account on +the particular cloud provider. + +About + +Rclone about prints quota information for a remote. Typical output +includes bytes used, free, quota and in trash. + +If a remote lacks about capability rclone about remote:returns an error. + +Backends without about capability cannot determine free space for an +rclone mount, or use policy mfs (most free space) as a member of an +rclone union remote. + +See rclone about command + +EmptyDir + +The remote supports empty directories. See Limitations for details. Most +Object/Bucket based remotes do not support this. + + + +GLOBAL FLAGS + + +This describes the global flags available to every rclone command split +into two groups, non backend and backend flags. + + +Non Backend Flags + +These flags are available for every command. + + --ask-password Allow prompt for password for encrypted configuration. (default true) + --auto-confirm If enabled, do not request console confirmation. + --backup-dir string Make backups into hierarchy based in DIR. + --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) + --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + --bwlimit-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. + --ca-cert string CA certificate used to verify servers + --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") + --check-first Do all the checks before starting transfers. + --checkers int Number of checkers to run in parallel. (default 8) + -c, --checksum Skip based on checksum (if available) & size, not mod-time & size + --client-cert string Client SSL certificate (PEM) for mutual TLS auth + --client-key string Client SSL private key (PEM) for mutual TLS auth + --compare-dest string Include additional server-side path during comparison. + --config string Config file. (default "$HOME/.config/rclone/rclone.conf") + --contimeout duration Connect timeout (default 1m0s) + --copy-dest string Implies --compare-dest but also copies files from path into destination. + --cpuprofile string Write cpu profile to file + --cutoff-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default "HARD") + --delete-after When synchronizing, delete files on destination after transferring (default) + --delete-before When synchronizing, delete files on destination before transferring + --delete-during When synchronizing, delete files during transfer + --delete-excluded Delete files on dest excluded from sync + --disable string Disable a comma separated list of features. Use help to see a list. + -n, --dry-run Do a trial run with no permanent changes + --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + --dump-bodies Dump HTTP headers and bodies - may contain sensitive info + --dump-headers Dump HTTP headers - may contain sensitive info + --error-on-no-transfer Sets exit code 9 if no files are transferred, useful in scripts + --exclude stringArray Exclude files matching pattern + --exclude-from stringArray Read exclude patterns from file (use - to read from stdin) + --exclude-if-present string Exclude directories if filename is present + --expect-continue-timeout duration Timeout when using expect / 100-continue in HTTP (default 1s) + --fast-list Use recursive list if available. Uses more memory but fewer transactions. + --files-from stringArray Read list of source-file names from file (use - to read from stdin) + --files-from-raw stringArray Read list of source-file names from file without any processing of lines (use - to read from stdin) + -f, --filter stringArray Add a file-filtering rule + --filter-from stringArray Read filtering patterns from a file (use - to read from stdin) + --header stringArray Set HTTP header for all transactions + --header-download stringArray Set HTTP header for download transactions + --header-upload stringArray Set HTTP header for upload transactions + --ignore-case Ignore case in filters (case insensitive) + --ignore-case-sync Ignore case when synchronizing + --ignore-checksum Skip post copy check of checksums. + --ignore-errors delete even if there are I/O errors + --ignore-existing Skip all files that exist on destination + --ignore-size Ignore size when skipping use mod-time or checksum. + -I, --ignore-times Don't skip files that match size and time - transfer all files + --immutable Do not modify files. Fail if existing files have been modified. + --include stringArray Include files matching pattern + --include-from stringArray Read include patterns from file (use - to read from stdin) + -i, --interactive Enable interactive mode + --log-file string Log everything to this file + --log-format string Comma separated list of log format options (default "date,time") + --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") + --log-systemd Activate systemd integration for the logger. + --low-level-retries int Number of low level retries to do. (default 10) + --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) + --max-delete int When synchronizing, limit the number of deletes (default -1) + --max-depth int If set limits the recursion depth to this. (default -1) + --max-duration duration Maximum duration rclone will transfer data for. + --max-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) + --max-stats-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) + --max-transfer SizeSuffix Maximum size of data to transfer. (default off) + --memprofile string Write memory profile to file + --min-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --min-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) + --modify-window duration Max time diff to be considered the same (default 1ns) + --multi-thread-cutoff SizeSuffix Use multi-thread downloads for files above this size. (default 250M) + --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) + --no-check-certificate Do not verify the server SSL certificate. Insecure. + --no-check-dest Don't check the destination, copy regardless. + --no-console Hide console window. Supported on Windows only. + --no-gzip-encoding Don't set Accept-Encoding: gzip. + --no-traverse Don't traverse destination file system on copy. + --no-unicode-normalization Don't normalize unicode characters in filenames. + --no-update-modtime Don't update destination mod-time if files identical. + --order-by string Instructions on how to order the transfers, e.g. 'size,descending' + --password-command SpaceSepList Command for supplying password for encrypted configuration. + -P, --progress Show progress during transfer. + --progress-terminal-title Show progress on the terminal title. Requires -P/--progress. + -q, --quiet Print as little stuff as possible + --rc Enable the remote control server. + --rc-addr string IPaddress:Port or :Port to bind server to. (default "localhost:5572") + --rc-allow-origin string Set the allowed origin for CORS. + --rc-baseurl string Prefix for URLs - leave blank for root. + --rc-cert string SSL PEM key (concatenation of certificate and CA certificate) + --rc-client-ca string Client certificate authority to verify clients with + --rc-enable-metrics Enable prometheus metrics on /metrics + --rc-files string Path to local files to serve on the HTTP server. + --rc-htpasswd string htpasswd file - if not provided no authentication is done + --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) + --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) + --rc-key string SSL PEM Private key + --rc-max-header-bytes int Maximum size of request header (default 4096) + --rc-no-auth Don't require auth for certain methods. + --rc-pass string Password for authentication. + --rc-realm string realm for authentication (default "rclone") + --rc-serve Enable the serving of remote objects. + --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) + --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) + --rc-template string User Specified Template. + --rc-user string User name for authentication. + --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") + --rc-web-gui Launch WebGUI on localhost + --rc-web-gui-force-update Force update to latest version of web gui + --rc-web-gui-no-open-browser Don't open the browser automatically + --rc-web-gui-update Check and update to latest version of web gui + --refresh-times Refresh the modtime of remote files. + --retries int Retry operations this many times if they fail (default 3) + --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) + --size-only Skip based on size only, not mod-time or checksum + --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) + --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) + --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") + --stats-one-line Make the stats fit on one line. + --stats-one-line-date Enables --stats-one-line and add current date/time prefix. + --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format + --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") + --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) + --suffix string Suffix to add to changed files. + --suffix-keep-extension Preserve the extension when using --suffix. + --syslog Use Syslog for logging + --syslog-facility string Facility for syslog, e.g. KERN,USER,... (default "DAEMON") + --timeout duration IO idle timeout (default 5m0s) + --tpslimit float Limit HTTP transactions per second to this. + --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) + --track-renames When synchronizing, track file renames and do a server-side move if possible + --track-renames-strategy string Strategies to use when synchronizing using track-renames hash|modtime|leaf (default "hash") + --transfers int Number of file transfers to run in parallel. (default 4) + -u, --update Skip files that are newer on the destination. + --use-cookies Enable session cookiejar. + --use-json-log Use json log format. + --use-mmap Use mmap allocator (see docs). + --use-server-modtime Use server modified time instead of object metadata + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.54.0") + -v, --verbose count Print lots more stuff (repeat for more) + + +Backend Flags + +These flags are available for every command. They control the backends +and may be set in the config file. + + --acd-auth-url string Auth server URL. + --acd-client-id string OAuth Client Id + --acd-client-secret string OAuth Client Secret + --acd-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + --acd-token string OAuth Access Token as a JSON blob. + --acd-token-url string Token server url. + --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) + --alias-remote string Remote or path to alias. + --azureblob-access-tier string Access tier of blob: hot, cool or archive. + --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) + --azureblob-archive-tier-delete Delete archive tier blobs before overwriting. + --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) + --azureblob-disable-checksum Don't store MD5 checksum with object metadata. + --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) + --azureblob-endpoint string Endpoint for the service + --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) + --azureblob-list-chunk int Size of blob list. (default 5000) + --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified. + --azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified. + --azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified. + --azureblob-sas-url string SAS URL for container level access only + --azureblob-service-principal-file string Path to file containing credentials for use with a service principal. + --azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256MB). (Deprecated) + --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) + --azureblob-use-msi Use a managed service identity to authenticate (only works in Azure) + --b2-account string Account ID or Application Key ID + --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) + --b2-disable-checksum Disable checksums for large (> upload cutoff) files + --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + --b2-download-url string Custom endpoint for downloads. + --b2-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --b2-endpoint string Endpoint for the service. + --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. + --b2-key string Application Key + --b2-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --b2-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. + --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + --b2-versions Include old versions in directory listings. + --box-access-token string Box App Primary Access Token + --box-auth-url string Auth server URL. + --box-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") + --box-client-id string OAuth Client Id + --box-client-secret string OAuth Client Secret + --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + --box-root-folder-id string Fill in for rclone to use a non root folder as its starting point. + --box-token string OAuth Access Token as a JSON blob. + --box-token-url string Token server url. + --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. + --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") + --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) + --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") + --cache-db-purge Clear all the cached data for this remote on start. + --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) + --cache-info-age Duration How long to cache file structure information (directory listings, file size, times, etc.). (default 6h0m0s) + --cache-plex-insecure string Skip all certificate verification when connecting to the Plex server + --cache-plex-password string The password of the Plex user (obscured) + --cache-plex-url string The URL of the Plex server + --cache-plex-username string The username of the Plex user + --cache-read-retries int How many times to retry a read from a cache storage. (default 10) + --cache-remote string Remote to cache. + --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) + --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. + --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) + --cache-workers int How many workers should run in parallel to download chunks. (default 4) + --cache-writes Cache file data on writes through the FS + --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. + --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") + --chunker-remote string Remote to chunk/unchunk. + --compress-level int GZIP compression level (-2 to 9). (default -1) + --compress-mode string Compression mode. (default "gzip") + --compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size. (default 20M) + --compress-remote string Remote to compress. + -L, --copy-links Follow symlinks and copy the pointed to item. + --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) + --crypt-filename-encryption string How to encrypt the filenames. (default "standard") + --crypt-password string Password or pass phrase for encryption. (obscured) + --crypt-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) + --crypt-remote string Remote to encrypt/decrypt. + --crypt-server-side-across-configs Allow server-side operations (e.g. copy) to work across different crypt configs. + --crypt-show-mapping For all files listed show how the names encrypt. + --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + --drive-auth-owner-only Only consider files owned by the authenticated user. + --drive-auth-url string Auth server URL. + --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + --drive-client-id string Google Application Client Id + --drive-client-secret string OAuth Client Secret + --drive-disable-http2 Disable drive using http2 (default true) + --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) + --drive-export-formats string Comma separated list of preferred formats for downloading Google docs. (default "docx,xlsx,pptx,svg") + --drive-formats string Deprecated: see export_formats + --drive-impersonate string Impersonate this user when using a service account. + --drive-import-formats string Comma separated list of preferred formats for uploading Google docs. + --drive-keep-revision-forever Keep new head revision of each file forever. + --drive-list-chunk int Size of listing chunk 100-1000. 0 to disable. (default 1000) + --drive-pacer-burst int Number of API calls to allow without sleeping. (default 100) + --drive-pacer-min-sleep Duration Minimum time to sleep between API calls. (default 100ms) + --drive-root-folder-id string ID of the root folder + --drive-scope string Scope that rclone should use when requesting access from drive. + --drive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different drive configs. + --drive-service-account-credentials string Service Account Credentials JSON blob + --drive-service-account-file string Service Account Credentials JSON file path + --drive-shared-with-me Only show files that are shared with me. + --drive-size-as-quota Show sizes as storage quota usage, not actual size. + --drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and videos only. + --drive-skip-gdocs Skip google documents in all listings. + --drive-skip-shortcuts If set skip shortcut files + --drive-starred-only Only show files that are starred. + --drive-stop-on-download-limit Make download limit errors be fatal + --drive-stop-on-upload-limit Make upload limit errors be fatal + --drive-team-drive string ID of the Team Drive + --drive-token string OAuth Access Token as a JSON blob. + --drive-token-url string Token server url. + --drive-trashed-only Only show files that are in the trash. + --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + --drive-use-created-date Use file created date instead of modified date., + --drive-use-shared-date Use date file was shared instead of modified date. + --drive-use-trash Send files to the trash instead of deleting permanently. (default true) + --drive-v2-download-min-size SizeSuffix If Object's are greater, use drive v2 API to download. (default off) + --dropbox-auth-url string Auth server URL. + --dropbox-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + --dropbox-client-id string OAuth Client Id + --dropbox-client-secret string OAuth Client Secret + --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) + --dropbox-impersonate string Impersonate this user when using a business account. + --dropbox-shared-files Instructs rclone to work on individual shared files. + --dropbox-shared-folders Instructs rclone to work on shared folders. + --dropbox-token string OAuth Access Token as a JSON blob. + --dropbox-token-url string Token server url. + --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl + --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) + --fichier-shared-folder string If you want to download a shared folder, add this parameter + --filefabric-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --filefabric-permanent-token string Permanent Authentication Token + --filefabric-root-folder-id string ID of the root folder + --filefabric-token string Session Token + --filefabric-token-expiry string Token expiry time + --filefabric-url string URL of the Enterprise File Fabric to connect to + --filefabric-version string Version read from the file fabric + --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited + --ftp-disable-epsv Disable using EPSV even if server advertises support + --ftp-disable-mlsd Disable using MLSD even if server advertises support + --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) + --ftp-explicit-tls Use Explicit FTPS (FTP over TLS) + --ftp-host string FTP host to connect to + --ftp-no-check-certificate Do not verify the TLS certificate of the server + --ftp-pass string FTP password (obscured) + --ftp-port string FTP port, leave blank to use default (21) + --ftp-tls Use Implicit FTPS (FTP over TLS) + --ftp-user string FTP username, leave blank for current username, $USER + --gcs-anonymous Access public buckets and objects without credentials + --gcs-auth-url string Auth server URL. + --gcs-bucket-acl string Access Control List for new buckets. + --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. + --gcs-client-id string OAuth Client Id + --gcs-client-secret string OAuth Client Secret + --gcs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) + --gcs-location string Location for the newly created buckets. + --gcs-object-acl string Access Control List for new objects. + --gcs-project-number string Project number. + --gcs-service-account-file string Service Account Credentials JSON file path + --gcs-storage-class string The storage class to use when storing objects in Google Cloud Storage. + --gcs-token string OAuth Access Token as a JSON blob. + --gcs-token-url string Token server url. + --gphotos-auth-url string Auth server URL. + --gphotos-client-id string OAuth Client Id + --gphotos-client-secret string OAuth Client Secret + --gphotos-include-archived Also view and download archived media. + --gphotos-read-only Set to make the Google Photos backend read only. + --gphotos-read-size Set to read the size of media items. + --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) + --gphotos-token string OAuth Access Token as a JSON blob. + --gphotos-token-url string Token server url. + --hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy + --hdfs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot) + --hdfs-namenode string hadoop name node and port + --hdfs-service-principal-name string Kerberos service principal name for the namenode + --hdfs-username string hadoop user name + --http-headers CommaSepList Set HTTP headers for all transactions + --http-no-head Don't use HEAD requests to find file sizes in dir listing + --http-no-slash Set this if the site doesn't end directories with / + --http-url string URL of http host to connect to + --hubic-auth-url string Auth server URL. + --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --hubic-client-id string OAuth Client Id + --hubic-client-secret string OAuth Client Secret + --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --hubic-no-chunk Don't chunk files during streaming upload. + --hubic-token string OAuth Access Token as a JSON blob. + --hubic-token-url string Token server url. + --jottacloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) + --jottacloud-hard-delete Delete files permanently rather than putting them into the trash. + --jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) + --jottacloud-trashed-only Only show files that are in the trash. + --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --koofr-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --koofr-endpoint string The Koofr API endpoint to use (default "https://app.koofr.net") + --koofr-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. + --koofr-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) + --koofr-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) + --koofr-user string Your Koofr user name + -l, --links Translate symlinks to/from regular files with a '.rclonelink' extension + --local-case-insensitive Force the filesystem to report itself as case insensitive + --local-case-sensitive Force the filesystem to report itself as case sensitive. + --local-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) + --local-no-check-updated Don't check to see if the files change during upload + --local-no-set-modtime Disable setting modtime + --local-no-sparse Disable sparse files for multi-thread downloads + --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) + --local-nounc string Disable UNC (long path names) conversion on Windows + --local-zero-size-links Assume the Stat size of links is zero (and read them instead) + --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) + --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --mailru-pass string Password (obscured) + --mailru-speedup-enable Skip full upload if there is another file with same data hash. (default true) + --mailru-speedup-file-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf") + --mailru-speedup-max-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) + --mailru-speedup-max-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) + --mailru-user string User name (usually email) + --mega-debug Output more debug from Mega. + --mega-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --mega-hard-delete Delete files permanently rather than putting them into the trash. + --mega-pass string Password. (obscured) + --mega-user string User name + -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). + --onedrive-auth-url string Auth server URL. + --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) + --onedrive-client-id string OAuth Client Id + --onedrive-client-secret string OAuth Client Secret + --onedrive-drive-id string The ID of the drive to use + --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. + --onedrive-link-password string Set the password for links created by the link command. + --onedrive-link-scope string Set the scope of the links created by the link command. (default "anonymous") + --onedrive-link-type string Set the type of the links created by the link command. (default "view") + --onedrive-no-versions Remove all versions on modifying operations + --onedrive-region string Choose national cloud region for OneDrive. (default "global") + --onedrive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different onedrive configs. + --onedrive-token string OAuth Access Token as a JSON blob. + --onedrive-token-url string Token server url. + --opendrive-chunk-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) + --opendrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) + --opendrive-password string Password. (obscured) + --opendrive-username string Username + --pcloud-auth-url string Auth server URL. + --pcloud-client-id string OAuth Client Id + --pcloud-client-secret string OAuth Client Secret + --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --pcloud-hostname string Hostname to connect to. (default "api.pcloud.com") + --pcloud-root-folder-id string Fill in for rclone to use a non root folder as its starting point. (default "d0") + --pcloud-token string OAuth Access Token as a JSON blob. + --pcloud-token-url string Token server url. + --premiumizeme-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --putio-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --qingstor-access-key-id string QingStor Access Key ID + --qingstor-chunk-size SizeSuffix Chunk size to use for uploading. (default 4M) + --qingstor-connection-retries int Number of connection retries. (default 3) + --qingstor-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) + --qingstor-endpoint string Enter an endpoint URL to connection QingStor API. + --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + --qingstor-secret-access-key string QingStor Secret Access Key (password) + --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) + --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --qingstor-zone string Zone to connect to. + --s3-access-key-id string AWS Access Key ID. + --s3-acl string Canned ACL used when creating buckets and storing or copying objects. + --s3-bucket-acl string Canned ACL used when creating buckets. + --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) + --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) + --s3-disable-checksum Don't store MD5 checksum with object metadata + --s3-disable-http2 Disable usage of http2 for S3 backends + --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + --s3-endpoint string Endpoint for S3 API. + --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + --s3-force-path-style If true use path style access if false use virtual hosted style. (default true) + --s3-leave-parts-on-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. + --s3-list-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) + --s3-location-constraint string Location constraint - must be set to match the Region. + --s3-max-upload-parts int Maximum number of parts in a multipart upload. (default 10000) + --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --s3-no-check-bucket If set, don't attempt to check the bucket exists or create it + --s3-no-head If set, don't HEAD uploaded objects to check integrity + --s3-profile string Profile to use in the shared credentials file + --s3-provider string Choose your S3 provider. + --s3-region string Region to connect to. + --s3-requester-pays Enables requester pays option when interacting with S3 bucket. + --s3-secret-access-key string AWS Secret Access Key (password) + --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. + --s3-session-token string An AWS session token + --s3-shared-credentials-file string Path to the shared credentials file + --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. + --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. + --s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional). + --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. + --s3-storage-class string The storage class to use when storing new objects in S3. + --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) + --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. + --s3-v2-auth If true use v2 authentication. + --seafile-2fa Two-factor authentication ('true' if the account has 2FA enabled) + --seafile-create-library Should rclone create a library if it doesn't exist + --seafile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) + --seafile-library string Name of the library. Leave blank to access all non-encrypted libraries. + --seafile-library-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) + --seafile-pass string Password (obscured) + --seafile-url string URL of seafile host to connect to + --seafile-user string User name (usually email address) + --sftp-ask-password Allow asking for SFTP password when needed. + --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + --sftp-host string SSH host to connect to + --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. + --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) + --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. + --sftp-key-use-agent When set forces the usage of the ssh-agent. + --sftp-known-hosts-file string Optional path to known_hosts file. + --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. + --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) + --sftp-path-override string Override path used by SSH connection. + --sftp-port string SSH port, leave blank to use default (22) + --sftp-pubkey-file string Optional path to public key file. + --sftp-server-command string Specifies the path or command to run a sftp server on the remote host. + --sftp-set-modtime Set the modified time on the remote if set. (default true) + --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. + --sftp-skip-links Set to skip any symlinks and any other non regular files. + --sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp") + --sftp-use-fstat If set use fstat instead of stat + --sftp-use-insecure-cipher Enable the use of insecure ciphers and key exchange methods. + --sftp-user string SSH username, leave blank for current username, $USER + --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) + --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) + --sharefile-endpoint string Endpoint for API calls. + --sharefile-root-folder-id string ID of the root folder + --sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) + --skip-links Don't warn about skipped symlinks. + --sugarsync-access-key-id string Sugarsync Access Key ID. + --sugarsync-app-id string Sugarsync App ID. + --sugarsync-authorization string Sugarsync authorization + --sugarsync-authorization-expiry string Sugarsync authorization expiry + --sugarsync-deleted-id string Sugarsync deleted folder id + --sugarsync-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) + --sugarsync-hard-delete Permanently delete files if true + --sugarsync-private-access-key string Sugarsync Private Access Key + --sugarsync-refresh-token string Sugarsync refresh token + --sugarsync-root-id string Sugarsync root id + --sugarsync-user string Sugarsync user + --swift-application-credential-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) + --swift-application-credential-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) + --swift-application-credential-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) + --swift-auth string Authentication URL for server (OS_AUTH_URL). + --swift-auth-token string Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) + --swift-auth-version int AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) + --swift-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --swift-domain string User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME) + --swift-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --swift-endpoint-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default "public") + --swift-env-auth Get swift credentials from environment variables in standard OpenStack form. + --swift-key string API key or password (OS_PASSWORD). + --swift-leave-parts-on-error If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions. + --swift-no-chunk Don't chunk files during streaming upload. + --swift-region string Region name - optional (OS_REGION_NAME) + --swift-storage-policy string The storage policy to use when creating a new container + --swift-storage-url string Storage URL - optional (OS_STORAGE_URL) + --swift-tenant string Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) + --swift-tenant-domain string Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) + --swift-tenant-id string Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) + --swift-user string User name to log in (OS_USERNAME). + --swift-user-id string User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). + --tardigrade-access-grant string Access Grant. + --tardigrade-api-key string API Key. + --tardigrade-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. + --tardigrade-provider string Choose an authentication method. (default "existing") + --tardigrade-satellite-address @
    : Satellite Address. Custom satellite address should match the format: @
    :. (default "us-central-1.tardigrade.io") + --union-action-policy string Policy to choose upstream on ACTION category. (default "epall") + --union-cache-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) + --union-create-policy string Policy to choose upstream on CREATE category. (default "epmfs") + --union-search-policy string Policy to choose upstream on SEARCH category. (default "ff") + --union-upstreams string List of space separated upstreams. + --webdav-bearer-token string Bearer token instead of user/pass (e.g. a Macaroon) + --webdav-bearer-token-command string Command to run to get a bearer token + --webdav-pass string Password. (obscured) + --webdav-url string URL of http host to connect to + --webdav-user string User name + --webdav-vendor string Name of the Webdav site/service/software you are using + --yandex-auth-url string Auth server URL. + --yandex-client-id string OAuth Client Id + --yandex-client-secret string OAuth Client Secret + --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --yandex-token string OAuth Access Token as a JSON blob. + --yandex-token-url string Token server url. + --zoho-encoding MultiEncoder This sets the encoding for the backend. (default Del,Ctl,InvalidUtf8) + --zoho-region string Zoho region to connect to. You'll have to use the region you organization is registered in. + + +1Fichier + +This is a backend for the 1fichier cloud storage service. Note that a +Premium subscription is required to use the API. + +Paths are specified as remote:path + +Paths may be as deep as required, e.g. remote:directory/subdirectory. + +The initial setup for 1Fichier involves getting the API key from the +website which you need to do in your browser. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / 1Fichier + \ "fichier" + [snip] + Storage> fichier + ** See help for fichier backend at: https://rclone.org/fichier/ ** Your API Key, get it from https://1fichier.com/console/params.pl + Enter a string value. Press Enter for the default (""). + api_key> example_key - - Config: api_key - - Env Var: RCLONE_FICHIER_API_KEY - - Type: string - - Default: "" + Edit advanced config? (y/n) + y) Yes + n) No + y/n> + Remote config + -------------------- + [remote] + type = fichier + api_key = example_key + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - ### Advanced Options +Once configured you can then use rclone like this, - Here are the advanced options specific to fichier (1Fichier). +List directories in top level of your 1Fichier account - #### --fichier-shared-folder + rclone lsd remote: - If you want to download a shared folder, add this parameter +List all the files in your 1Fichier account - - Config: shared_folder - - Env Var: RCLONE_FICHIER_SHARED_FOLDER - - Type: string - - Default: "" + rclone ls remote: - #### --fichier-encoding +To copy a local directory to a 1Fichier directory called backup - This sets the encoding for the backend. + rclone copy /home/source remote:backup - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Modified time and hashes - - Config: encoding - - Env Var: RCLONE_FICHIER_ENCODING - - Type: MultiEncoder - - Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +1Fichier does not support modification times. It supports the Whirlpool +hash algorithm. + +Duplicated files + +1Fichier can have two files with exactly the same name and path (unlike +a normal file system). + +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. + +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + < 0x3C ＜ + > 0x3E ＞ + " 0x22 ＂ + $ 0x24 ＄ + ` 0x60 ｀ + ' 0x27 ＇ + +File names can also not start or end with the following characters. +These only get replaced if they are the first or last character in the +name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. + +Standard Options + +Here are the standard options specific to fichier (1Fichier). + +--fichier-api-key + +Your API Key, get it from https://1fichier.com/console/params.pl + +- Config: api_key +- Env Var: RCLONE_FICHIER_API_KEY +- Type: string +- Default: "" + +Advanced Options + +Here are the advanced options specific to fichier (1Fichier). + +--fichier-shared-folder + +If you want to download a shared folder, add this parameter + +- Config: shared_folder +- Env Var: RCLONE_FICHIER_SHARED_FOLDER +- Type: string +- Default: "" + +--fichier-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_FICHIER_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot + +Limitations + +rclone about is not supported by the 1Fichier backend. Backends without +this capability cannot determine free space for an rclone mount or use +policy mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about +Alias - Alias - ----------------------------------------- +The alias remote provides a new name for another remote. - The `alias` remote provides a new name for another remote. +Paths may be as deep as required or a local path, e.g. +remote:directory/subdirectory or /directory/subdirectory. - Paths may be as deep as required or a local path, - eg `remote:directory/subdirectory` or `/directory/subdirectory`. +During the initial setup with rclone config you will specify the target +remote. The target remote can either be a local path or another remote. - During the initial setup with `rclone config` you will specify the target - remote. The target remote can either be a local path or another remote. +Subfolders can be used in target remote. Assume an alias remote named +backup with the target mydrive:private/backup. Invoking +rclone mkdir backup:desktop is exactly the same as invoking +rclone mkdir mydrive:private/backup/desktop. - Subfolders can be used in target remote. Assume an alias remote named `backup` - with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop` - is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`. +There will be no special handling of paths containing .. segments. +Invoking rclone mkdir backup:../desktop is exactly the same as invoking +rclone mkdir mydrive:private/backup/../desktop. The empty path is not +allowed as a remote. To alias the current directory use . instead. - There will be no special handling of paths containing `..` segments. - Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking - `rclone mkdir mydrive:private/backup/../desktop`. - The empty path is not allowed as a remote. To alias the current directory - use `.` instead. +Here is an example of how to make an alias called remote for local +folder. First run: - Here is an example of how to make an alias called `remote` for local folder. - First run: + rclone config - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Alias for an existing remote  "alias" [snip] Storage> alias Remote -or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", -"myremote:" or "/local/path". remote> /mnt/storage/backup Remote config --------------------- [remote] remote = /mnt/storage/backup --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y Current remotes: - -Name Type ==== ==== remote alias - -e) Edit existing remote -f) New remote -g) Delete remote -h) Rename remote -i) Copy remote -j) Set configuration password -k) Quit config e/n/d/r/c/s/q> q - - - Once configured you can then use `rclone` like this, - - List directories in top level in `/mnt/storage/backup` - - rclone lsd remote: - - List all the files in `/mnt/storage/backup` - - rclone ls remote: - - Copy another local directory to the alias directory called source - - rclone copy /home/source remote:source - - - ### Standard Options - - Here are the standard options specific to alias (Alias for an existing remote). - - #### --alias-remote +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Alias for an existing remote + \ "alias" + [snip] + Storage> alias Remote or path to alias. Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". + remote> /mnt/storage/backup + Remote config + -------------------- + [remote] + remote = /mnt/storage/backup + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + Current remotes: - - Config: remote - - Env Var: RCLONE_ALIAS_REMOTE - - Type: string - - Default: "" + Name Type + ==== ==== + remote alias + e) Edit existing remote + n) New remote + d) Delete remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + e/n/d/r/c/s/q> q +Once configured you can then use rclone like this, - Amazon Drive - ----------------------------------------- +List directories in top level in /mnt/storage/backup - Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage - service run by Amazon for consumers. + rclone lsd remote: + +List all the files in /mnt/storage/backup + + rclone ls remote: + +Copy another local directory to the alias directory called source + + rclone copy /home/source remote:source + +Standard Options + +Here are the standard options specific to alias (Alias for an existing +remote). + +--alias-remote + +Remote or path to alias. Can be "myremote:path/to/dir", +"myremote:bucket", "myremote:" or "/local/path". + +- Config: remote +- Env Var: RCLONE_ALIAS_REMOTE +- Type: string +- Default: "" + + +Amazon Drive + +Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage +service run by Amazon for consumers. + + +Status + +IMPORTANT: rclone supports Amazon Drive only if you have your own set of +API keys. Unfortunately the Amazon Drive developer program is now closed +to new entries so if you don't already have your own set of keys you +will not be able to use rclone with Amazon Drive. + +For the history on why rclone no longer has a set of Amazon Drive API +keys see the forum. + +If you happen to know anyone who works at Amazon then please ask them to +re-instate rclone into the Amazon Drive developer program - thanks! - ## Status - **Important:** rclone supports Amazon Drive only if you have your own - set of API keys. Unfortunately the [Amazon Drive developer - program](https://developer.amazon.com/amazon-drive) is now closed to - new entries so if you don't already have your own set of keys you will - not be able to use rclone with Amazon Drive. +Setup + +The initial setup for Amazon Drive involves getting a token from Amazon +which you need to do in your browser. rclone config walks you through +it. - For the history on why rclone no longer has a set of Amazon Drive API - keys see [the forum](https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314). +The configuration process for Amazon Drive may involve using an oauth +proxy. This is used to keep the Amazon credentials out of the source +code. The proxy runs in Google's very secure App Engine environment and +doesn't store any credentials which pass through it. - If you happen to know anyone who works at Amazon then please ask them - to re-instate rclone into the Amazon Drive developer program - thanks! +Since rclone doesn't currently have its own Amazon Drive credentials so +you will either need to have your own client_id and client_secret with +Amazon Drive, or use a third party oauth proxy in which case you will +need to enter client_id, client_secret, auth_url and token_url. - ## Setup +Note also if you are not using Amazon's auth_url and token_url, (ie you +filled in something for those) then if setting up on a remote machine +you can only use the copying the config method of configuration - +rclone authorize will not work. - The initial setup for Amazon Drive involves getting a token from - Amazon which you need to do in your browser. `rclone config` walks - you through it. +Here is an example of how to make a remote called remote. First run: - The configuration process for Amazon Drive may involve using an [oauth - proxy](https://github.com/ncw/oauthproxy). This is used to keep the - Amazon credentials out of the source code. The proxy runs in Google's - very secure App Engine environment and doesn't store any credentials - which pass through it. + rclone config - Since rclone doesn't currently have its own Amazon Drive credentials - so you will either need to have your own `client_id` and - `client_secret` with Amazon Drive, or use a third party oauth proxy - in which case you will need to enter `client_id`, `client_secret`, - `auth_url` and `token_url`. +This will guide you through an interactive setup process: - Note also if you are not using Amazon's `auth_url` and `token_url`, - (ie you filled in something for those) then if setting up on a remote - machine you can only use the [copying the config method of - configuration](https://rclone.org/remote_setup/#configuring-by-copying-the-config-file) - - `rclone authorize` will not work. + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon Drive + \ "amazon cloud drive" + [snip] + Storage> amazon cloud drive + Amazon Application Client Id - required. + client_id> your client ID goes here + Amazon Application Client Secret - required. + client_secret> your client secret goes here + Auth server URL - leave blank to use Amazon's. + auth_url> Optional auth URL + Token server url - leave blank to use Amazon's. + token_url> Optional token URL + Remote config + Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + client_id = your client ID goes here + client_secret = your client secret goes here + auth_url = Optional auth URL + token_url = Optional token URL + token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - Here is an example of how to make a remote called `remote`. First run: +See the remote setup docs for how to set it up on a machine with no +Internet browser available. - rclone config +Note that rclone runs a webserver on your local machine to collect the +token as returned from Amazon. This only runs from the moment it opens +your browser to the moment you get back the verification code. This is +on http://127.0.0.1:53682/ and this it may require you to unblock it +temporarily if you are running a host firewall. - This will guide you through an interactive setup process: +Once configured you can then use rclone like this, -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Choose a number from below, or type -in your own value [snip] XX / Amazon Drive  "amazon cloud drive" [snip] -Storage> amazon cloud drive Amazon Application Client Id - required. -client_id> your client ID goes here Amazon Application Client Secret - -required. client_secret> your client secret goes here Auth server URL - -leave blank to use Amazon's. auth_url> Optional auth URL Token server -url - leave blank to use Amazon's. token_url> Optional token URL Remote -config Make sure your Redirect URL is set to "http://127.0.0.1:53682/" -in your custom config. Use auto config? * Say Y if not sure * Say N if -you are working on a remote or headless machine y) Yes n) No y/n> y If -your browser doesn't open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code... Got code -------------------- [remote] client_id = -your client ID goes here client_secret = your client secret goes here -auth_url = Optional auth URL token_url = Optional token URL token = -{"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y +List directories in top level of your Amazon Drive + rclone lsd remote: - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet browser available. +List all the files in your Amazon Drive - Note that rclone runs a webserver on your local machine to collect the - token as returned from Amazon. This only runs from the moment it - opens your browser to the moment you get back the verification - code. This is on `http://127.0.0.1:53682/` and this it may require - you to unblock it temporarily if you are running a host firewall. + rclone ls remote: - Once configured you can then use `rclone` like this, +To copy a local directory to an Amazon Drive directory called backup - List directories in top level of your Amazon Drive + rclone copy /home/source remote:backup - rclone lsd remote: +Modified time and MD5SUMs - List all the files in your Amazon Drive +Amazon Drive doesn't allow modification times to be changed via the API +so these won't be accurate or used for syncing. - rclone ls remote: +It does store MD5SUMs so for a more accurate sync, you can use the +--checksum flag. - To copy a local directory to an Amazon Drive directory called backup +Restricted filename characters - rclone copy /home/source remote:backup + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ - ### Modified time and MD5SUMs ### +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - Amazon Drive doesn't allow modification times to be changed via - the API so these won't be accurate or used for syncing. +Deleting files - It does store MD5SUMs so for a more accurate sync, you can use the - `--checksum` flag. +Any files you delete with rclone will end up in the trash. Amazon don't +provide an API to permanently delete files, nor to empty the trash, so +you will have to do that with one of Amazon's apps or via the Amazon +Drive website. As of November 17, 2016, files are automatically deleted +by Amazon from the trash after 30 days. - #### Restricted filename characters +Using with non .com Amazon accounts - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | +Let's say you usually use amazon.co.uk. When you authenticate with +rclone it will take you to an amazon.com page to log in. Your +amazon.co.uk email and password should work here just fine. - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. +Standard Options - ### Deleting files ### +Here are the standard options specific to amazon cloud drive (Amazon +Drive). - Any files you delete with rclone will end up in the trash. Amazon - don't provide an API to permanently delete files, nor to empty the - trash, so you will have to do that with one of Amazon's apps or via - the Amazon Drive website. As of November 17, 2016, files are - automatically deleted by Amazon from the trash after 30 days. +--acd-client-id - ### Using with non `.com` Amazon accounts ### +OAuth Client Id Leave blank normally. - Let's say you usually use `amazon.co.uk`. When you authenticate with - rclone it will take you to an `amazon.com` page to log in. Your - `amazon.co.uk` email and password should work here just fine. +- Config: client_id +- Env Var: RCLONE_ACD_CLIENT_ID +- Type: string +- Default: "" +--acd-client-secret - ### Standard Options +OAuth Client Secret Leave blank normally. - Here are the standard options specific to amazon cloud drive (Amazon Drive). +- Config: client_secret +- Env Var: RCLONE_ACD_CLIENT_SECRET +- Type: string +- Default: "" - #### --acd-client-id +Advanced Options - OAuth Client Id - Leave blank normally. +Here are the advanced options specific to amazon cloud drive (Amazon +Drive). - - Config: client_id - - Env Var: RCLONE_ACD_CLIENT_ID - - Type: string - - Default: "" +--acd-token - #### --acd-client-secret +OAuth Access Token as a JSON blob. - OAuth Client Secret - Leave blank normally. +- Config: token +- Env Var: RCLONE_ACD_TOKEN +- Type: string +- Default: "" - - Config: client_secret - - Env Var: RCLONE_ACD_CLIENT_SECRET - - Type: string - - Default: "" +--acd-auth-url - ### Advanced Options +Auth server URL. Leave blank to use the provider defaults. - Here are the advanced options specific to amazon cloud drive (Amazon Drive). +- Config: auth_url +- Env Var: RCLONE_ACD_AUTH_URL +- Type: string +- Default: "" - #### --acd-token +--acd-token-url - OAuth Access Token as a JSON blob. +Token server url. Leave blank to use the provider defaults. - - Config: token - - Env Var: RCLONE_ACD_TOKEN - - Type: string - - Default: "" +- Config: token_url +- Env Var: RCLONE_ACD_TOKEN_URL +- Type: string +- Default: "" - #### --acd-auth-url +--acd-checkpoint - Auth server URL. - Leave blank to use the provider defaults. +Checkpoint for internal polling (debug). - - Config: auth_url - - Env Var: RCLONE_ACD_AUTH_URL - - Type: string - - Default: "" +- Config: checkpoint +- Env Var: RCLONE_ACD_CHECKPOINT +- Type: string +- Default: "" - #### --acd-token-url +--acd-upload-wait-per-gb - Token server url. - Leave blank to use the provider defaults. +Additional time per GB to wait after a failed complete upload to see if +it appears. - - Config: token_url - - Env Var: RCLONE_ACD_TOKEN_URL - - Type: string - - Default: "" +Sometimes Amazon Drive gives an error when a file has been fully +uploaded but the file appears anyway after a little while. This happens +sometimes for files over 1GB in size and nearly every time for files +bigger than 10GB. This parameter controls the time rclone waits for the +file to appear. - #### --acd-checkpoint +The default value for this parameter is 3 minutes per GB, so by default +it will wait 3 minutes for every GB uploaded to see if the file appears. - Checkpoint for internal polling (debug). +You can disable this feature by setting it to 0. This may cause conflict +errors as rclone retries the failed upload but the file will most likely +appear correctly eventually. - - Config: checkpoint - - Env Var: RCLONE_ACD_CHECKPOINT - - Type: string - - Default: "" +These values were determined empirically by observing lots of uploads of +big files for a range of file sizes. - #### --acd-upload-wait-per-gb +Upload with the "-v" flag to see more info about what rclone is doing in +this situation. - Additional time per GB to wait after a failed complete upload to see if it appears. +- Config: upload_wait_per_gb +- Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB +- Type: Duration +- Default: 3m0s - Sometimes Amazon Drive gives an error when a file has been fully - uploaded but the file appears anyway after a little while. This - happens sometimes for files over 1GB in size and nearly every time for - files bigger than 10GB. This parameter controls the time rclone waits - for the file to appear. +--acd-templink-threshold - The default value for this parameter is 3 minutes per GB, so by - default it will wait 3 minutes for every GB uploaded to see if the - file appears. +Files >= this size will be downloaded via their tempLink. - You can disable this feature by setting it to 0. This may cause - conflict errors as rclone retries the failed upload but the file will - most likely appear correctly eventually. +Files this size or more will be downloaded via their "tempLink". This is +to work around a problem with Amazon Drive which blocks downloads of +files bigger than about 10GB. The default for this is 9GB which +shouldn't need to be changed. - These values were determined empirically by observing lots of uploads - of big files for a range of file sizes. +To download files above this threshold, rclone requests a "tempLink" +which downloads the file through a temporary URL directly from the +underlying S3 storage. - Upload with the "-v" flag to see more info about what rclone is doing - in this situation. +- Config: templink_threshold +- Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD +- Type: SizeSuffix +- Default: 9G - - Config: upload_wait_per_gb - - Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB - - Type: Duration - - Default: 3m0s +--acd-encoding - #### --acd-templink-threshold +This sets the encoding for the backend. - Files >= this size will be downloaded via their tempLink. +See: the encoding section in the overview for more info. - Files this size or more will be downloaded via their "tempLink". This - is to work around a problem with Amazon Drive which blocks downloads - of files bigger than about 10GB. The default for this is 9GB which - shouldn't need to be changed. +- Config: encoding +- Env Var: RCLONE_ACD_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot - To download files above this threshold, rclone requests a "tempLink" - which downloads the file through a temporary URL directly from the - underlying S3 storage. +Limitations - - Config: templink_threshold - - Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD - - Type: SizeSuffix - - Default: 9G +Note that Amazon Drive is case insensitive so you can't have a file +called "Hello.doc" and one called "hello.doc". - #### --acd-encoding +Amazon Drive has rate limiting so you may notice errors in the sync (429 +errors). rclone will automatically retry the sync up to 3 times by +default (see --retries flag) which should hopefully work around this +problem. - This sets the encoding for the backend. +Amazon Drive has an internal limit of file sizes that can be uploaded to +the service. This limit is not officially published, but all files +larger than this will fail. - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +At the time of writing (Jan 2016) is in the area of 50GB per file. This +means that larger files are likely to fail. - - Config: encoding - - Env Var: RCLONE_ACD_ENCODING - - Type: MultiEncoder - - Default: Slash,InvalidUtf8,Dot +Unfortunately there is no way for rclone to see that this failure is +because of file size, so it will retry the operation, as any other +failure. To avoid this problem, use --max-size 50000M option to limit +the maximum size of uploaded files. Note that --max-size does not split +files into segments, it only ignores files over this size. +rclone about is not supported by the Amazon Drive backend. Backends +without this capability cannot determine free space for an rclone mount +or use policy mfs (most free space) as a member of an rclone union +remote. +See List of backends that do not support rclone about See rclone about - ### Limitations ### - Note that Amazon Drive is case insensitive so you can't have a - file called "Hello.doc" and one called "hello.doc". +Amazon S3 Storage Providers - 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. +The S3 backend can be used with a number of different providers: - 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. +- AWS S3 +- Alibaba Cloud (Aliyun) Object Storage System (OSS) +- Ceph +- DigitalOcean Spaces +- Dreamhost +- IBM COS S3 +- Minio +- Scaleway +- StackPath +- Tencent Cloud Object Storage (COS) +- Wasabi - At the time of writing (Jan 2016) is in the area of 50GB per file. - This means that larger files are likely to fail. +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, e.g. remote:bucket/path/to/dir. - 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. +Once you have made a remote (see the provider specific section above) +you can use it like this: - Amazon S3 Storage Providers - -------------------------------------------------------- - - The S3 backend can be used with a number of different providers: - - - - AWS S3 - - Alibaba Cloud (Aliyun) Object Storage System (OSS) - - Ceph - - DigitalOcean Spaces - - Dreamhost - - IBM COS S3 - - Minio - - Scaleway - - StackPath - - Wasabi - - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - Once you have made a remote (see the provider specific section above) - you can use it like this: - - See all buckets - - rclone lsd remote: - - Make a new bucket - - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any excess - files in the bucket. - - rclone sync -i /home/local/directory remote:bucket - - ## AWS S3 {#amazon-s3} - - Here is an example of making an s3 configuration. First run - - rclone config - - This will guide you through an interactive setup process. - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM -COS, Minio)  "s3" [snip] Storage> s3 Choose your S3 provider. Choose a -number from below, or type in your own value 1 / Amazon Web Services -(AWS) S3  "AWS" 2 / Ceph Object Storage  "Ceph" 3 / Digital Ocean Spaces - "DigitalOcean" 4 / Dreamhost DreamObjects  "Dreamhost" 5 / IBM COS S3 - "IBMCOS" 6 / Minio Object Storage  "Minio" 7 / Wasabi Object Storage - "Wasabi" 8 / Any other S3 compatible provider  "Other" provider> 1 Get -AWS credentials from runtime (environment variables or EC2/ECS meta data -if no env vars). Only applies if access_key_id and secret_access_key is -blank. Choose a number from below, or type in your own value 1 / Enter -AWS credentials in the next step  "false" 2 / Get AWS credentials from -the environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID -- leave blank for anonymous access or runtime credentials. -access_key_id> XXX AWS Secret Access Key (password) - leave blank for -anonymous access or runtime credentials. secret_access_key> YYY Region -to connect to. Choose a number from below, or type in your own value / -The default endpoint - a good choice if you are unsure. 1 | US Region, -Northern Virginia or Pacific Northwest. | Leave location constraint -empty.  "us-east-1" / US East (Ohio) Region 2 | Needs location -constraint us-east-2.  "us-east-2" / US West (Oregon) Region 3 | Needs -location constraint us-west-2.  "us-west-2" / US West (Northern -California) Region 4 | Needs location constraint us-west-1.  "us-west-1" -/ Canada (Central) Region 5 | Needs location constraint ca-central-1. - "ca-central-1" / EU (Ireland) Region 6 | Needs location constraint EU -or eu-west-1.  "eu-west-1" / EU (London) Region 7 | Needs location -constraint eu-west-2.  "eu-west-2" / EU (Frankfurt) Region 8 | Needs -location constraint eu-central-1.  "eu-central-1" / Asia Pacific -(Singapore) Region 9 | Needs location constraint ap-southeast-1. - "ap-southeast-1" / Asia Pacific (Sydney) Region 10 | Needs location -constraint ap-southeast-2.  "ap-southeast-2" / Asia Pacific (Tokyo) -Region 11 | Needs location constraint ap-northeast-1.  "ap-northeast-1" -/ Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2. - "ap-northeast-2" / Asia Pacific (Mumbai) 13 | Needs location constraint -ap-south-1.  "ap-south-1" / Asia Patific (Hong Kong) Region 14 | Needs -location constraint ap-east-1.  "ap-east-1" / South America (Sao Paulo) -Region 15 | Needs location constraint sa-east-1.  "sa-east-1" region> 1 -Endpoint for S3 API. Leave blank if using AWS to use the default -endpoint for the region. endpoint> Location constraint - must be set to -match the Region. Used when creating buckets only. Choose a number from -below, or type in your own value 1 / Empty for US Region, Northern -Virginia or Pacific Northwest.  "" 2 / US East (Ohio) Region. - "us-east-2" 3 / US West (Oregon) Region.  "us-west-2" 4 / US West -(Northern California) Region.  "us-west-1" 5 / Canada (Central) Region. - "ca-central-1" 6 / EU (Ireland) Region.  "eu-west-1" 7 / EU (London) -Region.  "eu-west-2" 8 / EU Region.  "EU" 9 / Asia Pacific (Singapore) -Region.  "ap-southeast-1" 10 / Asia Pacific (Sydney) Region. - "ap-southeast-2" 11 / Asia Pacific (Tokyo) Region.  "ap-northeast-1" 12 -/ Asia Pacific (Seoul)  "ap-northeast-2" 13 / Asia Pacific (Mumbai) - "ap-south-1" 14 / Asia Pacific (Hong Kong)  "ap-east-1" 15 / South -America (Sao Paulo) Region.  "sa-east-1" location_constraint> 1 Canned -ACL used when creating buckets and/or storing objects in S3. For more -info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default).  "private" 2 / -Owner gets FULL_CONTROL. The AllUsers group gets READ access. - "public-read" / Owner gets FULL_CONTROL. The AllUsers group gets READ -and WRITE access. 3 | Granting this on a bucket is generally not -recommended.  "public-read-write" 4 / Owner gets FULL_CONTROL. The -AuthenticatedUsers group gets READ access.  "authenticated-read" / -Object owner gets FULL_CONTROL. Bucket owner gets READ access. 5 | If -you specify this canned ACL when creating a bucket, Amazon S3 ignores -it.  "bucket-owner-read" / Both the object owner and the bucket owner -get FULL_CONTROL over the object. 6 | If you specify this canned ACL -when creating a bucket, Amazon S3 ignores it. - "bucket-owner-full-control" acl> 1 The server-side encryption algorithm -used when storing this object in S3. Choose a number from below, or type -in your own value 1 / None  "" 2 / AES256  "AES256" -server_side_encryption> 1 The storage class to use when storing objects -in S3. Choose a number from below, or type in your own value 1 / Default - "" 2 / Standard storage class  "STANDARD" 3 / Reduced redundancy -storage class  "REDUCED_REDUNDANCY" 4 / Standard Infrequent Access -storage class  "STANDARD_IA" 5 / One Zone Infrequent Access storage -class  "ONEZONE_IA" 6 / Glacier storage class  "GLACIER" 7 / Glacier -Deep Archive storage class  "DEEP_ARCHIVE" 8 / Intelligent-Tiering -storage class  "INTELLIGENT_TIERING" storage_class> 1 Remote config --------------------- [remote] type = s3 provider = AWS env_auth = false -access_key_id = XXX secret_access_key = YYY region = us-east-1 endpoint -= location_constraint = acl = private server_side_encryption = -storage_class = -------------------- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> - - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - ### --update and --use-server-modtime ### - - As noted below, the modified time is stored on metadata on the object. It is - used by default for all operations that require checking the time a file was - last updated. It allows rclone to treat the remote more like a true filesystem, - but it is inefficient because it requires an extra API call to retrieve the - metadata. - - For many operations, the time the object was last uploaded to the remote is - sufficient to determine if it is "dirty". By using `--update` along with - `--use-server-modtime`, you can avoid the extra API call and simply upload - files whose local modtime is newer than the time it was last uploaded. - - ### Modified time ### - - The modified time is stored as metadata on the object as - `X-Amz-Meta-Mtime` as floating point since the epoch accurate to 1 ns. - - If the modification time needs to be updated rclone will attempt to perform a server - side copy to update the modification if the object can be copied in a single part. - In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive - storage the object will be uploaded rather than copied. - - ### Cleanup ### - - If you run `rclone cleanup s3:bucket` then it will remove all pending - multipart uploads older than 24 hours. You can use the `-i` flag to - see exactly what it will do. If you want more control over the expiry - date then run `rclone backend cleanup s3:bucket -o max-age=1h` to - expire all uploads older than one hour. You can use `rclone backend - list-multipart-uploads s3:bucket` to see the pending multipart - uploads. - - #### Restricted filename characters - - S3 allows any valid UTF-8 string as a key. - - Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), as - they can't be used in XML. - - The following characters are replaced since these are problematic when - dealing with the REST API: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - - The encoding will also encode these file names as they don't seem to - work with the SDK properly: - - | File name | Replacement | - | --------- |:-----------:| - | . | ． | - | .. | ．． | - - ### Multipart uploads ### - - rclone supports multipart uploads with S3 which means that it can - upload files bigger than 5GB. - - Note that files uploaded *both* with multipart upload *and* through - crypt remotes do not have MD5 sums. - - rclone switches from single part uploads to multipart uploads at the - point specified by `--s3-upload-cutoff`. This can be a maximum of 5GB - and a minimum of 0 (ie always upload multipart files). - - The chunk sizes used in the multipart upload are specified by - `--s3-chunk-size` and the number of chunks uploaded concurrently is - specified by `--s3-upload-concurrency`. +See all buckets - Multipart uploads will use `--transfers` * `--s3-upload-concurrency` * - `--s3-chunk-size` extra memory. Single part uploads to not use extra - memory. + rclone lsd remote: - 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. +Make a new bucket - Increasing `--s3-upload-concurrency` will increase throughput (8 would - be a sensible value) and increasing `--s3-chunk-size` also increases - throughput (16M would be sensible). Increasing either of these will - use more memory. The default values are high enough to gain most of - the possible performance without using too much memory. + rclone mkdir remote:bucket +List the contents of a bucket - ### Buckets and Regions ### + rclone ls remote:bucket - With Amazon S3 you can list buckets (`rclone lsd`) using any region, - but you can only access the content of a bucket from the region it was - created in. If you attempt to access a bucket from the wrong region, - you will get an error, `incorrect region, the bucket is not in 'XXX' - region`. +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. - ### Authentication ### + rclone sync -i /home/local/directory remote:bucket - 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: +AWS S3 - - Directly in the rclone configuration file (`env_auth = false` in the config file): - - `access_key_id` and `secret_access_key` are required. - - `session_token` can be optionally set when using AWS STS. - - Runtime configuration (`env_auth = true` in the config file): - - Export the following environment variables before running `rclone`: - - Access Key ID: `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` - - Secret Access Key: `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` - - Session Token: `AWS_SESSION_TOKEN` (optional) - - Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html): - - Profile files are standard files used by AWS CLI tools - - By default it will use the profile in your home directory (eg `~/.aws/credentials` on unix based systems) file and the "default" profile, to change set these environment variables: - - `AWS_SHARED_CREDENTIALS_FILE` to control which file. - - `AWS_PROFILE` to control which profile to use. - - Or, run `rclone` in an ECS task with an IAM role (AWS only). - - Or, run `rclone` on an EC2 instance with an IAM role (AWS only). - - Or, run `rclone` in an EKS pod with an IAM role that is associated with a service account (AWS only). +Here is an example of making an s3 configuration. First run - If none of these option actually end up providing `rclone` with AWS - credentials then S3 interaction will be non-authenticated (see below). + rclone config - ### S3 Permissions ### - - When using the `sync` subcommand of `rclone` the following minimum - permissions are required to be available on the bucket being written to: - - * `ListBucket` - * `DeleteObject` - * `GetObject` - * `PutObject` - * `PutObjectACL` - - When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required. - - Example policy: - -{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", -"Principal": { "AWS": "arn:aws:iam::USER_SID:user/USER_NAME" }, -"Action": [ "s3:ListBucket", "s3:DeleteObject", "s3:GetObject", -"s3:PutObject", "s3:PutObjectAcl" ], "Resource": [ -"arn:aws:s3:::BUCKET_NAME/*", "arn:aws:s3:::BUCKET_NAME" ] }, { -"Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": -"arn:aws:s3:::*" } -] } - - - Notes on above: - - 1. This is a policy that can be used when creating bucket. It assumes - that `USER_NAME` has been created. - 2. The Resource entry must include both resource ARNs, as one implies - the bucket and the other implies the bucket's objects. - - For reference, [here's an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) - that will generate one or more buckets that will work with `rclone sync`. - - ### Key Management System (KMS) ### - - If you are using server side encryption with KMS then you will find - you can't transfer small objects. As a work-around you can use the - `--ignore-checksum` flag. - - A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824). - - ### Glacier and Glacier Deep Archive ### - - You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html). - The bucket can still be synced or copied into normally, but if rclone - tries to access data from the glacier storage class you will see an error like below. - - 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file - - In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) - the object(s) in question before using rclone. - - Note that rclone only speaks the S3 API it does not speak the Glacier - Vault API, so rclone cannot directly access Glacier Vaults. - - - ### Standard Options - - Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - - #### --s3-provider +This will guide you through an interactive setup process. + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS + \ "s3" + [snip] + Storage> s3 Choose your S3 provider. - - - Config: provider - - Env Var: RCLONE_S3_PROVIDER - - Type: string - - Default: "" - - Examples: - - "AWS" - - Amazon Web Services (AWS) S3 - - "Alibaba" - - Alibaba Cloud Object Storage System (OSS) formerly Aliyun - - "Ceph" - - Ceph Object Storage - - "DigitalOcean" - - Digital Ocean Spaces - - "Dreamhost" - - Dreamhost DreamObjects - - "IBMCOS" - - IBM COS S3 - - "Minio" - - Minio Object Storage - - "Netease" - - Netease Object Storage (NOS) - - "Scaleway" - - Scaleway Object Storage - - "StackPath" - - StackPath Object Storage - - "Wasabi" - - Wasabi Object Storage - - "Other" - - Any other S3 compatible provider - - #### --s3-env-auth - - Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). - Only applies if access_key_id and secret_access_key is blank. - - - Config: env_auth - - Env Var: RCLONE_S3_ENV_AUTH - - Type: bool - - Default: false - - Examples: - - "false" - - Enter AWS credentials in the next step - - "true" - - Get AWS credentials from the environment (env vars or IAM) - - #### --s3-access-key-id - - AWS Access Key ID. - Leave blank for anonymous access or runtime credentials. - - - Config: access_key_id - - Env Var: RCLONE_S3_ACCESS_KEY_ID - - Type: string - - Default: "" - - #### --s3-secret-access-key - - AWS Secret Access Key (password) - Leave blank for anonymous access or runtime credentials. - - - Config: secret_access_key - - Env Var: RCLONE_S3_SECRET_ACCESS_KEY - - Type: string - - Default: "" - - #### --s3-region - + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + 2 / Ceph Object Storage + \ "Ceph" + 3 / Digital Ocean Spaces + \ "DigitalOcean" + 4 / Dreamhost DreamObjects + \ "Dreamhost" + 5 / IBM COS S3 + \ "IBMCOS" + 6 / Minio Object Storage + \ "Minio" + 7 / Wasabi Object Storage + \ "Wasabi" + 8 / Any other S3 compatible provider + \ "Other" + provider> 1 + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> XXX + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> YYY Region to connect to. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "us-east-1" - - The default endpoint - a good choice if you are unsure. - - US Region, Northern Virginia or Pacific Northwest. - - Leave location constraint empty. - - "us-east-2" - - US East (Ohio) Region - - Needs location constraint us-east-2. - - "us-west-2" - - US West (Oregon) Region - - Needs location constraint us-west-2. - - "us-west-1" - - US West (Northern California) Region - - Needs location constraint us-west-1. - - "ca-central-1" - - Canada (Central) Region - - Needs location constraint ca-central-1. - - "eu-west-1" - - EU (Ireland) Region - - Needs location constraint EU or eu-west-1. - - "eu-west-2" - - EU (London) Region - - Needs location constraint eu-west-2. - - "eu-north-1" - - EU (Stockholm) Region - - Needs location constraint eu-north-1. - - "eu-central-1" - - EU (Frankfurt) Region - - Needs location constraint eu-central-1. - - "ap-southeast-1" - - Asia Pacific (Singapore) Region - - Needs location constraint ap-southeast-1. - - "ap-southeast-2" - - Asia Pacific (Sydney) Region - - Needs location constraint ap-southeast-2. - - "ap-northeast-1" - - Asia Pacific (Tokyo) Region - - Needs location constraint ap-northeast-1. - - "ap-northeast-2" - - Asia Pacific (Seoul) - - Needs location constraint ap-northeast-2. - - "ap-south-1" - - Asia Pacific (Mumbai) - - Needs location constraint ap-south-1. - - "ap-east-1" - - Asia Patific (Hong Kong) Region - - Needs location constraint ap-east-1. - - "sa-east-1" - - South America (Sao Paulo) Region - - Needs location constraint sa-east-1. - - #### --s3-region - - Region to connect to. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "nl-ams" - - Amsterdam, The Netherlands - - "fr-par" - - Paris, France - - #### --s3-region - - Region to connect to. - Leave blank if you are using an S3 clone and you don't have a region. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "" - - Use this if unsure. Will use v4 signatures and an empty region. - - "other-v2-signature" - - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - - #### --s3-endpoint - + Choose a number from below, or type in your own value + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia, or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + / US East (Ohio) Region + 2 | Needs location constraint us-east-2. + \ "us-east-2" + / US West (Oregon) Region + 3 | Needs location constraint us-west-2. + \ "us-west-2" + / US West (Northern California) Region + 4 | Needs location constraint us-west-1. + \ "us-west-1" + / Canada (Central) Region + 5 | Needs location constraint ca-central-1. + \ "ca-central-1" + / EU (Ireland) Region + 6 | Needs location constraint EU or eu-west-1. + \ "eu-west-1" + / EU (London) Region + 7 | Needs location constraint eu-west-2. + \ "eu-west-2" + / EU (Frankfurt) Region + 8 | Needs location constraint eu-central-1. + \ "eu-central-1" + / Asia Pacific (Singapore) Region + 9 | Needs location constraint ap-southeast-1. + \ "ap-southeast-1" + / Asia Pacific (Sydney) Region + 10 | Needs location constraint ap-southeast-2. + \ "ap-southeast-2" + / Asia Pacific (Tokyo) Region + 11 | Needs location constraint ap-northeast-1. + \ "ap-northeast-1" + / Asia Pacific (Seoul) + 12 | Needs location constraint ap-northeast-2. + \ "ap-northeast-2" + / Asia Pacific (Mumbai) + 13 | Needs location constraint ap-south-1. + \ "ap-south-1" + / Asia Pacific (Hong Kong) Region + 14 | Needs location constraint ap-east-1. + \ "ap-east-1" + / South America (Sao Paulo) Region + 15 | Needs location constraint sa-east-1. + \ "sa-east-1" + region> 1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - #### --s3-endpoint - - Endpoint for IBM COS S3 API. - Specify if using an IBM COS On Premise. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Endpoint - - "s3.dal.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Dallas Endpoint - - "s3.wdc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Washington DC Endpoint - - "s3.sjc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region San Jose Endpoint - - "s3.private.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Private Endpoint - - "s3.private.dal.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Dallas Private Endpoint - - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region Washington DC Private Endpoint - - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud" - - US Cross Region San Jose Private Endpoint - - "s3.us-east.cloud-object-storage.appdomain.cloud" - - US Region East Endpoint - - "s3.private.us-east.cloud-object-storage.appdomain.cloud" - - US Region East Private Endpoint - - "s3.us-south.cloud-object-storage.appdomain.cloud" - - US Region South Endpoint - - "s3.private.us-south.cloud-object-storage.appdomain.cloud" - - US Region South Private Endpoint - - "s3.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Endpoint - - "s3.fra.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Frankfurt Endpoint - - "s3.mil.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Milan Endpoint - - "s3.ams.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Amsterdam Endpoint - - "s3.private.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Private Endpoint - - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Frankfurt Private Endpoint - - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Milan Private Endpoint - - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud" - - EU Cross Region Amsterdam Private Endpoint - - "s3.eu-gb.cloud-object-storage.appdomain.cloud" - - Great Britain Endpoint - - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud" - - Great Britain Private Endpoint - - "s3.eu-de.cloud-object-storage.appdomain.cloud" - - EU Region DE Endpoint - - "s3.private.eu-de.cloud-object-storage.appdomain.cloud" - - EU Region DE Private Endpoint - - "s3.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Endpoint - - "s3.tok.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Tokyo Endpoint - - "s3.hkg.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional HongKong Endpoint - - "s3.seo.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Seoul Endpoint - - "s3.private.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Private Endpoint - - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Tokyo Private Endpoint - - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional HongKong Private Endpoint - - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud" - - APAC Cross Regional Seoul Private Endpoint - - "s3.jp-tok.cloud-object-storage.appdomain.cloud" - - APAC Region Japan Endpoint - - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud" - - APAC Region Japan Private Endpoint - - "s3.au-syd.cloud-object-storage.appdomain.cloud" - - APAC Region Australia Endpoint - - "s3.private.au-syd.cloud-object-storage.appdomain.cloud" - - APAC Region Australia Private Endpoint - - "s3.ams03.cloud-object-storage.appdomain.cloud" - - Amsterdam Single Site Endpoint - - "s3.private.ams03.cloud-object-storage.appdomain.cloud" - - Amsterdam Single Site Private Endpoint - - "s3.che01.cloud-object-storage.appdomain.cloud" - - Chennai Single Site Endpoint - - "s3.private.che01.cloud-object-storage.appdomain.cloud" - - Chennai Single Site Private Endpoint - - "s3.mel01.cloud-object-storage.appdomain.cloud" - - Melbourne Single Site Endpoint - - "s3.private.mel01.cloud-object-storage.appdomain.cloud" - - Melbourne Single Site Private Endpoint - - "s3.osl01.cloud-object-storage.appdomain.cloud" - - Oslo Single Site Endpoint - - "s3.private.osl01.cloud-object-storage.appdomain.cloud" - - Oslo Single Site Private Endpoint - - "s3.tor01.cloud-object-storage.appdomain.cloud" - - Toronto Single Site Endpoint - - "s3.private.tor01.cloud-object-storage.appdomain.cloud" - - Toronto Single Site Private Endpoint - - "s3.seo01.cloud-object-storage.appdomain.cloud" - - Seoul Single Site Endpoint - - "s3.private.seo01.cloud-object-storage.appdomain.cloud" - - Seoul Single Site Private Endpoint - - "s3.mon01.cloud-object-storage.appdomain.cloud" - - Montreal Single Site Endpoint - - "s3.private.mon01.cloud-object-storage.appdomain.cloud" - - Montreal Single Site Private Endpoint - - "s3.mex01.cloud-object-storage.appdomain.cloud" - - Mexico Single Site Endpoint - - "s3.private.mex01.cloud-object-storage.appdomain.cloud" - - Mexico Single Site Private Endpoint - - "s3.sjc04.cloud-object-storage.appdomain.cloud" - - San Jose Single Site Endpoint - - "s3.private.sjc04.cloud-object-storage.appdomain.cloud" - - San Jose Single Site Private Endpoint - - "s3.mil01.cloud-object-storage.appdomain.cloud" - - Milan Single Site Endpoint - - "s3.private.mil01.cloud-object-storage.appdomain.cloud" - - Milan Single Site Private Endpoint - - "s3.hkg02.cloud-object-storage.appdomain.cloud" - - Hong Kong Single Site Endpoint - - "s3.private.hkg02.cloud-object-storage.appdomain.cloud" - - Hong Kong Single Site Private Endpoint - - "s3.par01.cloud-object-storage.appdomain.cloud" - - Paris Single Site Endpoint - - "s3.private.par01.cloud-object-storage.appdomain.cloud" - - Paris Single Site Private Endpoint - - "s3.sng01.cloud-object-storage.appdomain.cloud" - - Singapore Single Site Endpoint - - "s3.private.sng01.cloud-object-storage.appdomain.cloud" - - Singapore Single Site Private Endpoint - - #### --s3-endpoint - - Endpoint for OSS API. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "oss-cn-hangzhou.aliyuncs.com" - - East China 1 (Hangzhou) - - "oss-cn-shanghai.aliyuncs.com" - - East China 2 (Shanghai) - - "oss-cn-qingdao.aliyuncs.com" - - North China 1 (Qingdao) - - "oss-cn-beijing.aliyuncs.com" - - North China 2 (Beijing) - - "oss-cn-zhangjiakou.aliyuncs.com" - - North China 3 (Zhangjiakou) - - "oss-cn-huhehaote.aliyuncs.com" - - North China 5 (Huhehaote) - - "oss-cn-shenzhen.aliyuncs.com" - - South China 1 (Shenzhen) - - "oss-cn-hongkong.aliyuncs.com" - - Hong Kong (Hong Kong) - - "oss-us-west-1.aliyuncs.com" - - US West 1 (Silicon Valley) - - "oss-us-east-1.aliyuncs.com" - - US East 1 (Virginia) - - "oss-ap-southeast-1.aliyuncs.com" - - Southeast Asia Southeast 1 (Singapore) - - "oss-ap-southeast-2.aliyuncs.com" - - Asia Pacific Southeast 2 (Sydney) - - "oss-ap-southeast-3.aliyuncs.com" - - Southeast Asia Southeast 3 (Kuala Lumpur) - - "oss-ap-southeast-5.aliyuncs.com" - - Asia Pacific Southeast 5 (Jakarta) - - "oss-ap-northeast-1.aliyuncs.com" - - Asia Pacific Northeast 1 (Japan) - - "oss-ap-south-1.aliyuncs.com" - - Asia Pacific South 1 (Mumbai) - - "oss-eu-central-1.aliyuncs.com" - - Central Europe 1 (Frankfurt) - - "oss-eu-west-1.aliyuncs.com" - - West Europe (London) - - "oss-me-east-1.aliyuncs.com" - - Middle East 1 (Dubai) - - #### --s3-endpoint - - Endpoint for Scaleway Object Storage. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3.nl-ams.scw.cloud" - - Amsterdam Endpoint - - "s3.fr-par.scw.cloud" - - Paris Endpoint - - #### --s3-endpoint - - Endpoint for StackPath Object Storage. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3.us-east-2.stackpathstorage.com" - - US East Endpoint - - "s3.us-west-1.stackpathstorage.com" - - US West Endpoint - - "s3.eu-central-1.stackpathstorage.com" - - EU Endpoint - - #### --s3-endpoint - - Endpoint for S3 API. - Required when using an S3 clone. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "objects-us-east-1.dream.io" - - Dream Objects endpoint - - "nyc3.digitaloceanspaces.com" - - Digital Ocean Spaces New York 3 - - "ams3.digitaloceanspaces.com" - - Digital Ocean Spaces Amsterdam 3 - - "sgp1.digitaloceanspaces.com" - - Digital Ocean Spaces Singapore 1 - - "s3.wasabisys.com" - - Wasabi US East endpoint - - "s3.us-west-1.wasabisys.com" - - Wasabi US West endpoint - - "s3.eu-central-1.wasabisys.com" - - Wasabi EU Central endpoint - - #### --s3-location-constraint - - Location constraint - must be set to match the Region. - Used when creating buckets only. - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - Examples: - - "" - - Empty for US Region, Northern Virginia or Pacific Northwest. - - "us-east-2" - - US East (Ohio) Region. - - "us-west-2" - - US West (Oregon) Region. - - "us-west-1" - - US West (Northern California) Region. - - "ca-central-1" - - Canada (Central) Region. - - "eu-west-1" - - EU (Ireland) Region. - - "eu-west-2" - - EU (London) Region. - - "eu-north-1" - - EU (Stockholm) Region. - - "EU" - - EU Region. - - "ap-southeast-1" - - Asia Pacific (Singapore) Region. - - "ap-southeast-2" - - Asia Pacific (Sydney) Region. - - "ap-northeast-1" - - Asia Pacific (Tokyo) Region. - - "ap-northeast-2" - - Asia Pacific (Seoul) - - "ap-south-1" - - Asia Pacific (Mumbai) - - "ap-east-1" - - Asia Pacific (Hong Kong) - - "sa-east-1" - - South America (Sao Paulo) Region. - - #### --s3-location-constraint - - Location constraint - must match endpoint when using IBM Cloud Public. - For on-prem COS, do not make a selection from this list, hit enter - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - Examples: - - "us-standard" - - US Cross Region Standard - - "us-vault" - - US Cross Region Vault - - "us-cold" - - US Cross Region Cold - - "us-flex" - - US Cross Region Flex - - "us-east-standard" - - US East Region Standard - - "us-east-vault" - - US East Region Vault - - "us-east-cold" - - US East Region Cold - - "us-east-flex" - - US East Region Flex - - "us-south-standard" - - US South Region Standard - - "us-south-vault" - - US South Region Vault - - "us-south-cold" - - US South Region Cold - - "us-south-flex" - - US South Region Flex - - "eu-standard" - - EU Cross Region Standard - - "eu-vault" - - EU Cross Region Vault - - "eu-cold" - - EU Cross Region Cold - - "eu-flex" - - EU Cross Region Flex - - "eu-gb-standard" - - Great Britain Standard - - "eu-gb-vault" - - Great Britain Vault - - "eu-gb-cold" - - Great Britain Cold - - "eu-gb-flex" - - Great Britain Flex - - "ap-standard" - - APAC Standard - - "ap-vault" - - APAC Vault - - "ap-cold" - - APAC Cold - - "ap-flex" - - APAC Flex - - "mel01-standard" - - Melbourne Standard - - "mel01-vault" - - Melbourne Vault - - "mel01-cold" - - Melbourne Cold - - "mel01-flex" - - Melbourne Flex - - "tor01-standard" - - Toronto Standard - - "tor01-vault" - - Toronto Vault - - "tor01-cold" - - Toronto Cold - - "tor01-flex" - - Toronto Flex - - #### --s3-location-constraint - - Location constraint - must be set to match the Region. - Leave blank if not sure. Used when creating buckets only. - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - #### --s3-acl - - Canned ACL used when creating buckets and storing or copying objects. - - This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. - + endpoint> + Location constraint - must be set to match the Region. Used when creating buckets only. + Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. + \ "" + 2 / US East (Ohio) Region. + \ "us-east-2" + 3 / US West (Oregon) Region. + \ "us-west-2" + 4 / US West (Northern California) Region. + \ "us-west-1" + 5 / Canada (Central) Region. + \ "ca-central-1" + 6 / EU (Ireland) Region. + \ "eu-west-1" + 7 / EU (London) Region. + \ "eu-west-2" + 8 / EU Region. + \ "EU" + 9 / Asia Pacific (Singapore) Region. + \ "ap-southeast-1" + 10 / Asia Pacific (Sydney) Region. + \ "ap-southeast-2" + 11 / Asia Pacific (Tokyo) Region. + \ "ap-northeast-1" + 12 / Asia Pacific (Seoul) + \ "ap-northeast-2" + 13 / Asia Pacific (Mumbai) + \ "ap-south-1" + 14 / Asia Pacific (Hong Kong) + \ "ap-east-1" + 15 / South America (Sao Paulo) Region. + \ "sa-east-1" + location_constraint> 1 + Canned ACL used when creating buckets and/or storing objects in S3. For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl - - 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 - + 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> + +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. + +Note that reading this from the object takes an additional HEAD request +as the metadata isn't returned in object listings. + +Reducing costs + +Avoiding HEAD requests to read the modification time + +By default rclone will use the modification time of objects stored in S3 +for syncing. This is stored in object metadata which unfortunately takes +an extra HEAD request to read which can be expensive (in time and +money). + +The modification time 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 on S3 because +it requires an extra API call to retrieve the metadata. + +The extra API calls can be avoided when syncing (using rclone sync or +rclone copy) in a few different ways, each with its own tradeoffs. + +- --size-only + - Only checks the size of files. + - Uses no extra transactions. + - If the file doesn't change size then rclone won't detect it has + changed. + - rclone sync --size-only /path/to/source s3:bucket +- --checksum + - Checks the size and MD5 checksum of files. + - Uses no extra transactions. + - The most accurate detection of changes possible. + - Will cause the source to read an MD5 checksum which, if it is a + local disk, will cause lots of disk activity. + - If the source and destination are both S3 this is the + RECOMMENDED flag to use for maximum efficiency. + - rclone sync --checksum /path/to/source s3:bucket +- --update --use-server-modtime + - Uses no extra transactions. + - Modification time becomes the time the object was uploaded. + - For many operations this is sufficient to determine if it needs + uploading. + - Using --update along with --use-server-modtime, avoids the extra + API call and uploads files whose local modification time is + newer than the time it was last uploaded. + - Files created with timestamps in the past will be missed by the + sync. + - rclone sync --update --use-server-modtime /path/to/source s3:bucket + +These flags can and should be used in combination with --fast-list - see +below. + +If using rclone mount or any command using the VFS (eg rclone serve) +commands then you might want to consider using the VFS flag --no-modtime +which will stop rclone reading the modification time for every object. +You could also use --use-server-modtime if you are happy with the +modification times of the objects being the time of upload. + +Avoiding GET requests to read directory listings + +Rclone's default directory traversal is to process each directory +individually. This takes one API call per directory. Using the +--fast-list flag will read all info about the the objects into memory +first using a smaller number of API calls (one per 1000 objects). See +the rclone docs for more details. + + rclone sync --fast-list --checksum /path/to/source s3:bucket + +--fast-list trades off API transactions for memory use. As a rough guide +rclone uses 1k of memory per object stored, so using --fast-list on a +sync of a million objects will use roughly 1 GB of RAM. + +If you are only copying a small number of files into a big repository +then using --no-traverse is a good idea. This finds objects directly +instead of through directory listings. You can do a "top-up" sync very +cheaply by using --max-age and --no-traverse to copy only recent files, +eg + + rclone copy --min-age 24h --no-traverse /path/to/source s3:bucket + +You'd then do a full rclone sync less often. + +Note that --fast-list isn't required in the top-up sync. + +Hashes + +For small objects which weren't uploaded as multipart uploads (objects +sized below --s3-upload-cutoff if uploaded with rclone) rclone uses the +ETag: header as an MD5 checksum. + +However for objects which were uploaded as multipart uploads or with +server side encryption (SSE-AWS or SSE-C) the ETag header is no longer +the MD5 sum of the data, so rclone adds an additional piece of metadata +X-Amz-Meta-Md5chksum which is a base64 encoded MD5 hash (in the same +format as is required for Content-MD5). + +For large objects, calculating this hash can take some time so the +addition of this hash can be disabled with --s3-disable-checksum. This +will mean that these objects do not have an MD5 checksum. + +Note that reading this from the object takes an additional HEAD request +as the metadata isn't returned in object listings. + +Cleanup + +If you run rclone cleanup s3:bucket then it will remove all pending +multipart uploads older than 24 hours. You can use the -i flag to see +exactly what it will do. If you want more control over the expiry date +then run rclone backend cleanup s3:bucket -o max-age=1h to expire all +uploads older than one hour. You can use +rclone backend list-multipart-uploads s3:bucket to see the pending +multipart uploads. + +Restricted filename characters + +S3 allows any valid UTF-8 string as a key. + +Invalid UTF-8 bytes will be replaced, as they can't be used in XML. + +The following characters are replaced since these are problematic when +dealing with the REST API: + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + +The encoding will also encode these file names as they don't seem to +work with the SDK properly: + + File name Replacement + ----------- ------------- + . ． + .. ．． + +Multipart uploads + +rclone supports multipart uploads with S3 which means that it can upload +files bigger than 5GB. + +Note that files uploaded _both_ with multipart upload _and_ through +crypt remotes do not have MD5 sums. - - Config: server_side_encryption - - Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION - - Type: string - - Default: "" - - Examples: - - "" - - None - - "AES256" - - AES256 - - "aws:kms" - - aws:kms - - #### --s3-sse-kms-key-id - - If using KMS ID you must provide the ARN of Key. - - - Config: sse_kms_key_id - - Env Var: RCLONE_S3_SSE_KMS_KEY_ID - - Type: string - - Default: "" - - Examples: - - "" - - None - - "arn:aws:kms:us-east-1:*" - - arn:aws:kms:* - - #### --s3-storage-class - - The storage class to use when storing new objects in S3. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - Standard storage class - - "REDUCED_REDUNDANCY" - - Reduced redundancy storage class - - "STANDARD_IA" - - Standard Infrequent Access storage class - - "ONEZONE_IA" - - One Zone Infrequent Access storage class - - "GLACIER" - - Glacier storage class - - "DEEP_ARCHIVE" - - Glacier Deep Archive storage class - - "INTELLIGENT_TIERING" - - Intelligent-Tiering storage class - - #### --s3-storage-class - - The storage class to use when storing new objects in OSS. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - Standard storage class - - "GLACIER" - - Archive storage mode. - - "STANDARD_IA" - - Infrequent access storage mode. - - #### --s3-storage-class - - The storage class to use when storing new objects in S3. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - The Standard class for any upload; suitable for on-demand content like streaming or CDN. - - "GLACIER" - - Archived storage; prices are lower, but it needs to be restored first to be accessed. - - ### Advanced Options - - Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - - #### --s3-bucket-acl - - Canned ACL used when creating buckets. - - For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl - - Note that this ACL is applied when only when creating buckets. If it - isn't set then "acl" is used instead. - - - Config: bucket_acl - - Env Var: RCLONE_S3_BUCKET_ACL - - Type: string - - Default: "" - - Examples: - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - - Granting this on a bucket is generally not recommended. - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - - #### --s3-sse-customer-algorithm - - If using SSE-C, the server-side encryption algorithm used when storing this object in S3. - - - Config: sse_customer_algorithm - - Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM - - Type: string - - Default: "" - - Examples: - - "" - - None - - "AES256" - - AES256 +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). - #### --s3-sse-customer-key +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. - If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. - - - Config: sse_customer_key - - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY - - Type: string - - Default: "" - - Examples: - - "" - - None +Multipart uploads will use --transfers * --s3-upload-concurrency * +--s3-chunk-size extra memory. Single part uploads to not use extra +memory. - #### --s3-sse-customer-key-md5 +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. - If using SSE-C you must provide the secret encryption key MD5 checksum. +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. - - Config: sse_customer_key_md5 - - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 - - Type: string - - Default: "" - - Examples: - - "" - - None +Buckets and Regions - #### --s3-upload-cutoff +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. - Cutoff for switching to chunked upload +Authentication - Any files larger than this will be uploaded in chunks of chunk_size. - The minimum is 0 and the maximum is 5GB. +There are a number of ways to supply rclone with a set of AWS +credentials, with and without using the environment. - - Config: upload_cutoff - - Env Var: RCLONE_S3_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 200M +The different authentication methods are tried in this order: - #### --s3-chunk-size +- 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 + (e.g. ~/.aws/credentials on unix based systems) file and the + "default" profile, to change set these environment + variables: + - AWS_SHARED_CREDENTIALS_FILE to control which file. + - AWS_PROFILE to control which profile to use. + - Or, run rclone in an ECS task with an IAM role (AWS only). + - Or, run rclone on an EC2 instance with an IAM role (AWS only). + - Or, run rclone in an EKS pod with an IAM role that is associated + with a service account (AWS only). - Chunk size to use for uploading. +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: - When uploading files larger than upload_cutoff or files with unknown - size (eg from "rclone rcat" or uploaded with "rclone mount" or google - photos or google docs) they will be uploaded as multipart uploads - using this chunk size. - - Note that "--s3-upload-concurrency" chunks of this size are buffered - in memory per transfer. - - If you are transferring large files over high speed links and you have - enough memory, then increasing this will speed up the transfers. - - Rclone will automatically increase the chunk size when uploading a - large file of known size to stay below the 10,000 chunks limit. - - Files of unknown size are uploaded with the configured - chunk_size. Since the default chunk size is 5MB and there can be at - most 10,000 chunks, this means that by default the maximum size of - file you can stream upload is 48GB. If you wish to stream upload - larger files then you will need to increase chunk_size. - - - Config: chunk_size - - Env Var: RCLONE_S3_CHUNK_SIZE - - Type: SizeSuffix - - Default: 5M - - #### --s3-max-upload-parts - - Maximum number of parts in a multipart upload. - - This option defines the maximum number of multipart chunks to use - when doing a multipart upload. - - This can be useful if a service does not support the AWS S3 - specification of 10,000 chunks. - - Rclone will automatically increase the chunk size when uploading a - large file of a known size to stay below this number of chunks limit. - - - - Config: max_upload_parts - - Env Var: RCLONE_S3_MAX_UPLOAD_PARTS - - Type: int - - Default: 10000 - - #### --s3-copy-cutoff - - Cutoff for switching to multipart copy - - Any files larger than this that need to be server side copied will be - copied in chunks of this size. - - The minimum is 0 and the maximum is 5GB. - - - Config: copy_cutoff - - Env Var: RCLONE_S3_COPY_CUTOFF - - Type: SizeSuffix - - Default: 4.656G - - #### --s3-disable-checksum - - Don't store MD5 checksum with object metadata - - Normally rclone will calculate the MD5 checksum of the input before - uploading it so it can add it to metadata on the object. This is great - for data integrity checking but can cause long delays for large files - to start uploading. - - - Config: disable_checksum - - Env Var: RCLONE_S3_DISABLE_CHECKSUM - - Type: bool - - Default: false - - #### --s3-shared-credentials-file - - Path to the shared credentials file - - If env_auth = true then rclone can use a shared credentials file. - - If this variable is empty rclone will look for the - "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty - it will default to the current user's home directory. - - Linux/OSX: "$HOME/.aws/credentials" - Windows: "%USERPROFILE%\.aws\credentials" - - - - Config: shared_credentials_file - - Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE - - Type: string - - Default: "" - - #### --s3-profile - - Profile to use in the shared credentials file - - If env_auth = true then rclone can use a shared credentials file. This - variable controls which profile is used in that file. - - If empty it will default to the environment variable "AWS_PROFILE" or - "default" if that environment variable is also not set. - - - - Config: profile - - Env Var: RCLONE_S3_PROFILE - - Type: string - - Default: "" - - #### --s3-session-token - - An AWS session token - - - Config: session_token - - Env Var: RCLONE_S3_SESSION_TOKEN - - Type: string - - Default: "" - - #### --s3-upload-concurrency - - Concurrency for multipart uploads. - - This is the number of chunks of the same file that are uploaded - concurrently. - - If you are uploading small numbers of large file over high speed link - and these uploads do not fully utilize your bandwidth, then increasing - this may help to speed up the transfers. - - - Config: upload_concurrency - - Env Var: RCLONE_S3_UPLOAD_CONCURRENCY - - Type: int - - Default: 4 - - #### --s3-force-path-style - - If true use path style access if false use virtual hosted style. - - If this is true (the default) then rclone will use path style access, - if false then rclone will use virtual path style. See [the AWS S3 - docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) - for more info. - - Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to - false - rclone will do this automatically based on the provider - setting. - - - Config: force_path_style - - Env Var: RCLONE_S3_FORCE_PATH_STYLE - - Type: bool - - Default: true - - #### --s3-v2-auth - - If true use v2 authentication. - - If this is false (the default) then rclone will use v4 authentication. - If it is set then rclone will use v2 authentication. - - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - - - Config: v2_auth - - Env Var: RCLONE_S3_V2_AUTH - - Type: bool - - Default: false - - #### --s3-use-accelerate-endpoint - - If true use the AWS S3 accelerated endpoint. - - See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) - - - Config: use_accelerate_endpoint - - Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT - - Type: bool - - Default: false - - #### --s3-leave-parts-on-error - - If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. - - It should be set to true for resuming uploads across different sessions. - - WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. - - - - Config: leave_parts_on_error - - Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR - - Type: bool - - Default: false - - #### --s3-list-chunk - - Size of listing chunk (response list for each ListObject S3 request). - - This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. - Most services truncate the response list to 1000 objects even if requested more than that. - In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). - In Ceph, this can be increased with the "rgw list buckets max chunk" option. - - - - Config: list_chunk - - Env Var: RCLONE_S3_LIST_CHUNK - - Type: int - - Default: 1000 - - #### --s3-no-check-bucket - - If set don't attempt to check the bucket exists or create it - - This can be useful when trying to minimise the number of transactions - rclone does if you know the bucket exists already. - - - - Config: no_check_bucket - - Env Var: RCLONE_S3_NO_CHECK_BUCKET - - Type: bool - - Default: false - - #### --s3-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_S3_ENCODING - - Type: MultiEncoder - - Default: Slash,InvalidUtf8,Dot - - #### --s3-memory-pool-flush-time - - How often internal memory buffer pools will be flushed. - Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. - This option controls how often unused buffers will be removed from the pool. - - - Config: memory_pool_flush_time - - Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME - - Type: Duration - - Default: 1m0s - - #### --s3-memory-pool-use-mmap - - Whether to use mmap buffers in internal memory pool. - - - Config: memory_pool_use_mmap - - Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP - - Type: bool - - Default: false - - ### Backend commands - - Here are the commands specific to the s3 backend. - - Run them with - - rclone backend COMMAND remote: - - The help below will explain what arguments each command takes. - - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. - - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). - - #### restore - - Restore objects from GLACIER to normal storage - - rclone backend restore remote: [options] [+] - - This command can be used to restore one or more objects from GLACIER - to normal storage. - - Usage Examples: - - rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS] - rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS] - rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS] - - This flag also obeys the filters. Test first with -i/--interactive or --dry-run flags - - rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard - - All the objects shown will be marked for restore, then - - rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard - - It returns a list of status dictionaries with Remote and Status - keys. The Status will be OK if it was successfull or an error message - if not. - - [ +- ListBucket +- DeleteObject +- GetObject +- PutObject +- PutObjectACL + +When using the lsd subcommand, the ListAllMyBuckets permission is +required. + +Example policy: + + { + "Version": "2012-10-17", + "Statement": [ { - "Status": "OK", - "Path": "test.txt" + "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" + ] }, { - "Status": "OK", - "Path": "test/file4.txt" - } + "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. - Options: +For reference, here's an Ansible script that will generate one or more +buckets that will work with rclone sync. - - "description": The optional description for the job. - - "lifetime": Lifetime of the active copy in days - - "priority": Priority of restore: Standard|Expedited|Bulk +Key Management System (KMS) - #### list-multipart-uploads +If you are using server-side encryption with KMS then you must make sure +rclone is configured with server_side_encryption = aws:kms otherwise you +will find you can't transfer small objects - these will create checksum +errors. - List the unfinished multipart uploads +Glacier and Glacier Deep Archive - rclone backend list-multipart-uploads remote: [options] [+] +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. - This command lists the unfinished multipart uploads in JSON format. + 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file - rclone backend list-multipart s3:bucket/path/to/object +In this case you need to restore the object(s) in question before using +rclone. - It returns a dictionary of buckets with values as lists of unfinished - multipart uploads. +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. - You can call it with no bucket in which case it lists all bucket, with - a bucket or with a bucket and path. +Standard Options +Here are the standard options specific to s3 (Amazon S3 Compliant +Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, +Dreamhost, IBM COS, Minio, and Tencent COS). + +--s3-provider + +Choose your S3 provider. + +- Config: provider +- Env Var: RCLONE_S3_PROVIDER +- Type: string +- Default: "" +- Examples: + - "AWS" + - Amazon Web Services (AWS) S3 + - "Alibaba" + - Alibaba Cloud Object Storage System (OSS) formerly Aliyun + - "Ceph" + - Ceph Object Storage + - "DigitalOcean" + - Digital Ocean Spaces + - "Dreamhost" + - Dreamhost DreamObjects + - "IBMCOS" + - IBM COS S3 + - "Minio" + - Minio Object Storage + - "Netease" + - Netease Object Storage (NOS) + - "Scaleway" + - Scaleway Object Storage + - "StackPath" + - StackPath Object Storage + - "TencentCOS" + - Tencent Cloud Object Storage (COS) + - "Wasabi" + - Wasabi Object Storage + - "Other" + - Any other S3 compatible provider + +--s3-env-auth + +Get AWS credentials from runtime (environment variables or EC2/ECS meta +data if no env vars). Only applies if access_key_id and +secret_access_key is blank. + +- Config: env_auth +- Env Var: RCLONE_S3_ENV_AUTH +- Type: bool +- Default: false +- Examples: + - "false" + - Enter AWS credentials in the next step + - "true" + - Get AWS credentials from the environment (env vars or IAM) + +--s3-access-key-id + +AWS Access Key ID. Leave blank for anonymous access or runtime +credentials. + +- Config: access_key_id +- Env Var: RCLONE_S3_ACCESS_KEY_ID +- Type: string +- Default: "" + +--s3-secret-access-key + +AWS Secret Access Key (password) Leave blank for anonymous access or +runtime credentials. + +- Config: secret_access_key +- Env Var: RCLONE_S3_SECRET_ACCESS_KEY +- Type: string +- Default: "" + +--s3-region + +Region to connect to. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "us-east-1" + - The default endpoint - a good choice if you are unsure. + - US Region, Northern Virginia, or Pacific Northwest. + - Leave location constraint empty. + - "us-east-2" + - US East (Ohio) Region + - Needs location constraint us-east-2. + - "us-west-1" + - US West (Northern California) Region + - Needs location constraint us-west-1. + - "us-west-2" + - US West (Oregon) Region + - Needs location constraint us-west-2. + - "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-west-3" + - EU (Paris) Region + - Needs location constraint eu-west-3. + - "eu-north-1" + - EU (Stockholm) Region + - Needs location constraint eu-north-1. + - "eu-south-1" + - EU (Milan) Region + - Needs location constraint eu-south-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-northeast-3" + - Asia Pacific (Osaka-Local) + - Needs location constraint ap-northeast-3. + - "ap-south-1" + - Asia Pacific (Mumbai) + - Needs location constraint ap-south-1. + - "ap-east-1" + - Asia Pacific (Hong Kong) Region + - Needs location constraint ap-east-1. + - "sa-east-1" + - South America (Sao Paulo) Region + - Needs location constraint sa-east-1. + - "me-south-1" + - Middle East (Bahrain) Region + - Needs location constraint me-south-1. + - "af-south-1" + - Africa (Cape Town) Region + - Needs location constraint af-south-1. + - "cn-north-1" + - China (Beijing) Region + - Needs location constraint cn-north-1. + - "cn-northwest-1" + - China (Ningxia) Region + - Needs location constraint cn-northwest-1. + - "us-gov-east-1" + - AWS GovCloud (US-East) Region + - Needs location constraint us-gov-east-1. + - "us-gov-west-1" + - AWS GovCloud (US) Region + - Needs location constraint us-gov-west-1. + +--s3-region + +Region to connect to. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "nl-ams" + - Amsterdam, The Netherlands + - "fr-par" + - Paris, France + +--s3-region + +Region to connect to. Leave blank if you are using an S3 clone and you +don't have a region. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "" + - Use this if unsure. Will use v4 signatures and an empty + region. + - "other-v2-signature" + - Use this only if v4 signatures don't work, e.g. pre + Jewel/v10 CEPH. + +--s3-endpoint + +Endpoint for S3 API. Leave blank if using AWS to use the default +endpoint for the region. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" + +--s3-endpoint + +Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Endpoint + - "s3.dal.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Dallas Endpoint + - "s3.wdc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Washington DC Endpoint + - "s3.sjc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region San Jose Endpoint + - "s3.private.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Private Endpoint + - "s3.private.dal.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Dallas Private Endpoint + - "s3.private.wdc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region Washington DC Private Endpoint + - "s3.private.sjc.us.cloud-object-storage.appdomain.cloud" + - US Cross Region San Jose Private Endpoint + - "s3.us-east.cloud-object-storage.appdomain.cloud" + - US Region East Endpoint + - "s3.private.us-east.cloud-object-storage.appdomain.cloud" + - US Region East Private Endpoint + - "s3.us-south.cloud-object-storage.appdomain.cloud" + - US Region South Endpoint + - "s3.private.us-south.cloud-object-storage.appdomain.cloud" + - US Region South Private Endpoint + - "s3.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Endpoint + - "s3.fra.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Frankfurt Endpoint + - "s3.mil.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Milan Endpoint + - "s3.ams.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Amsterdam Endpoint + - "s3.private.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Private Endpoint + - "s3.private.fra.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Frankfurt Private Endpoint + - "s3.private.mil.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Milan Private Endpoint + - "s3.private.ams.eu.cloud-object-storage.appdomain.cloud" + - EU Cross Region Amsterdam Private Endpoint + - "s3.eu-gb.cloud-object-storage.appdomain.cloud" + - Great Britain Endpoint + - "s3.private.eu-gb.cloud-object-storage.appdomain.cloud" + - Great Britain Private Endpoint + - "s3.eu-de.cloud-object-storage.appdomain.cloud" + - EU Region DE Endpoint + - "s3.private.eu-de.cloud-object-storage.appdomain.cloud" + - EU Region DE Private Endpoint + - "s3.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Endpoint + - "s3.tok.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Tokyo Endpoint + - "s3.hkg.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional HongKong Endpoint + - "s3.seo.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Seoul Endpoint + - "s3.private.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Private Endpoint + - "s3.private.tok.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Tokyo Private Endpoint + - "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional HongKong Private Endpoint + - "s3.private.seo.ap.cloud-object-storage.appdomain.cloud" + - APAC Cross Regional Seoul Private Endpoint + - "s3.jp-tok.cloud-object-storage.appdomain.cloud" + - APAC Region Japan Endpoint + - "s3.private.jp-tok.cloud-object-storage.appdomain.cloud" + - APAC Region Japan Private Endpoint + - "s3.au-syd.cloud-object-storage.appdomain.cloud" + - APAC Region Australia Endpoint + - "s3.private.au-syd.cloud-object-storage.appdomain.cloud" + - APAC Region Australia Private Endpoint + - "s3.ams03.cloud-object-storage.appdomain.cloud" + - Amsterdam Single Site Endpoint + - "s3.private.ams03.cloud-object-storage.appdomain.cloud" + - Amsterdam Single Site Private Endpoint + - "s3.che01.cloud-object-storage.appdomain.cloud" + - Chennai Single Site Endpoint + - "s3.private.che01.cloud-object-storage.appdomain.cloud" + - Chennai Single Site Private Endpoint + - "s3.mel01.cloud-object-storage.appdomain.cloud" + - Melbourne Single Site Endpoint + - "s3.private.mel01.cloud-object-storage.appdomain.cloud" + - Melbourne Single Site Private Endpoint + - "s3.osl01.cloud-object-storage.appdomain.cloud" + - Oslo Single Site Endpoint + - "s3.private.osl01.cloud-object-storage.appdomain.cloud" + - Oslo Single Site Private Endpoint + - "s3.tor01.cloud-object-storage.appdomain.cloud" + - Toronto Single Site Endpoint + - "s3.private.tor01.cloud-object-storage.appdomain.cloud" + - Toronto Single Site Private Endpoint + - "s3.seo01.cloud-object-storage.appdomain.cloud" + - Seoul Single Site Endpoint + - "s3.private.seo01.cloud-object-storage.appdomain.cloud" + - Seoul Single Site Private Endpoint + - "s3.mon01.cloud-object-storage.appdomain.cloud" + - Montreal Single Site Endpoint + - "s3.private.mon01.cloud-object-storage.appdomain.cloud" + - Montreal Single Site Private Endpoint + - "s3.mex01.cloud-object-storage.appdomain.cloud" + - Mexico Single Site Endpoint + - "s3.private.mex01.cloud-object-storage.appdomain.cloud" + - Mexico Single Site Private Endpoint + - "s3.sjc04.cloud-object-storage.appdomain.cloud" + - San Jose Single Site Endpoint + - "s3.private.sjc04.cloud-object-storage.appdomain.cloud" + - San Jose Single Site Private Endpoint + - "s3.mil01.cloud-object-storage.appdomain.cloud" + - Milan Single Site Endpoint + - "s3.private.mil01.cloud-object-storage.appdomain.cloud" + - Milan Single Site Private Endpoint + - "s3.hkg02.cloud-object-storage.appdomain.cloud" + - Hong Kong Single Site Endpoint + - "s3.private.hkg02.cloud-object-storage.appdomain.cloud" + - Hong Kong Single Site Private Endpoint + - "s3.par01.cloud-object-storage.appdomain.cloud" + - Paris Single Site Endpoint + - "s3.private.par01.cloud-object-storage.appdomain.cloud" + - Paris Single Site Private Endpoint + - "s3.sng01.cloud-object-storage.appdomain.cloud" + - Singapore Single Site Endpoint + - "s3.private.sng01.cloud-object-storage.appdomain.cloud" + - Singapore Single Site Private Endpoint + +--s3-endpoint + +Endpoint for OSS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "oss-cn-hangzhou.aliyuncs.com" + - East China 1 (Hangzhou) + - "oss-cn-shanghai.aliyuncs.com" + - East China 2 (Shanghai) + - "oss-cn-qingdao.aliyuncs.com" + - North China 1 (Qingdao) + - "oss-cn-beijing.aliyuncs.com" + - North China 2 (Beijing) + - "oss-cn-zhangjiakou.aliyuncs.com" + - North China 3 (Zhangjiakou) + - "oss-cn-huhehaote.aliyuncs.com" + - North China 5 (Huhehaote) + - "oss-cn-shenzhen.aliyuncs.com" + - South China 1 (Shenzhen) + - "oss-cn-hongkong.aliyuncs.com" + - Hong Kong (Hong Kong) + - "oss-us-west-1.aliyuncs.com" + - US West 1 (Silicon Valley) + - "oss-us-east-1.aliyuncs.com" + - US East 1 (Virginia) + - "oss-ap-southeast-1.aliyuncs.com" + - Southeast Asia Southeast 1 (Singapore) + - "oss-ap-southeast-2.aliyuncs.com" + - Asia Pacific Southeast 2 (Sydney) + - "oss-ap-southeast-3.aliyuncs.com" + - Southeast Asia Southeast 3 (Kuala Lumpur) + - "oss-ap-southeast-5.aliyuncs.com" + - Asia Pacific Southeast 5 (Jakarta) + - "oss-ap-northeast-1.aliyuncs.com" + - Asia Pacific Northeast 1 (Japan) + - "oss-ap-south-1.aliyuncs.com" + - Asia Pacific South 1 (Mumbai) + - "oss-eu-central-1.aliyuncs.com" + - Central Europe 1 (Frankfurt) + - "oss-eu-west-1.aliyuncs.com" + - West Europe (London) + - "oss-me-east-1.aliyuncs.com" + - Middle East 1 (Dubai) + +--s3-endpoint + +Endpoint for Scaleway Object Storage. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.nl-ams.scw.cloud" + - Amsterdam Endpoint + - "s3.fr-par.scw.cloud" + - Paris Endpoint + +--s3-endpoint + +Endpoint for StackPath Object Storage. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "s3.us-east-2.stackpathstorage.com" + - US East Endpoint + - "s3.us-west-1.stackpathstorage.com" + - US West Endpoint + - "s3.eu-central-1.stackpathstorage.com" + - EU Endpoint + +--s3-endpoint + +Endpoint for Tencent COS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "cos.ap-beijing.myqcloud.com" + - Beijing Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-shanghai.myqcloud.com" + - Shanghai Region. + - "cos.ap-guangzhou.myqcloud.com" + - Guangzhou Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-chengdu.myqcloud.com" + - Chengdu Region. + - "cos.ap-chongqing.myqcloud.com" + - Chongqing Region. + - "cos.ap-hongkong.myqcloud.com" + - Hong Kong (China) Region. + - "cos.ap-singapore.myqcloud.com" + - Singapore Region. + - "cos.ap-mumbai.myqcloud.com" + - Mumbai Region. + - "cos.ap-seoul.myqcloud.com" + - Seoul Region. + - "cos.ap-bangkok.myqcloud.com" + - Bangkok Region. + - "cos.ap-tokyo.myqcloud.com" + - Tokyo Region. + - "cos.na-siliconvalley.myqcloud.com" + - Silicon Valley Region. + - "cos.na-ashburn.myqcloud.com" + - Virginia Region. + - "cos.na-toronto.myqcloud.com" + - Toronto Region. + - "cos.eu-frankfurt.myqcloud.com" + - Frankfurt Region. + - "cos.eu-moscow.myqcloud.com" + - Moscow Region. + - "cos.accelerate.myqcloud.com" + - Use Tencent COS Accelerate Endpoint. + +--s3-endpoint + +Endpoint for S3 API. Required when using an S3 clone. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "objects-us-east-1.dream.io" + - Dream Objects endpoint + - "nyc3.digitaloceanspaces.com" + - Digital Ocean Spaces New York 3 + - "ams3.digitaloceanspaces.com" + - Digital Ocean Spaces Amsterdam 3 + - "sgp1.digitaloceanspaces.com" + - Digital Ocean Spaces Singapore 1 + - "s3.wasabisys.com" + - Wasabi US East endpoint + - "s3.us-west-1.wasabisys.com" + - Wasabi US West endpoint + - "s3.eu-central-1.wasabisys.com" + - Wasabi EU Central endpoint + +--s3-location-constraint + +Location constraint - must be set to match the Region. Used when +creating buckets only. + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" +- Examples: + - "" + - Empty for US Region, Northern Virginia, or Pacific + Northwest. + - "us-east-2" + - US East (Ohio) Region. + - "us-west-1" + - US West (Northern California) Region. + - "us-west-2" + - US West (Oregon) Region. + - "ca-central-1" + - Canada (Central) Region. + - "eu-west-1" + - EU (Ireland) Region. + - "eu-west-2" + - EU (London) Region. + - "eu-west-3" + - EU (Paris) Region. + - "eu-north-1" + - EU (Stockholm) Region. + - "eu-south-1" + - EU (Milan) 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) Region. + - "ap-northeast-3" + - Asia Pacific (Osaka-Local) Region. + - "ap-south-1" + - Asia Pacific (Mumbai) Region. + - "ap-east-1" + - Asia Pacific (Hong Kong) Region. + - "sa-east-1" + - South America (Sao Paulo) Region. + - "me-south-1" + - Middle East (Bahrain) Region. + - "af-south-1" + - Africa (Cape Town) Region. + - "cn-north-1" + - China (Beijing) Region + - "cn-northwest-1" + - China (Ningxia) Region. + - "us-gov-east-1" + - AWS GovCloud (US-East) Region. + - "us-gov-west-1" + - AWS GovCloud (US) Region. + +--s3-location-constraint + +Location constraint - must match endpoint when using IBM Cloud Public. +For on-prem COS, do not make a selection from this list, hit enter + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" +- Examples: + - "us-standard" + - US Cross Region Standard + - "us-vault" + - US Cross Region Vault + - "us-cold" + - US Cross Region Cold + - "us-flex" + - US Cross Region Flex + - "us-east-standard" + - US East Region Standard + - "us-east-vault" + - US East Region Vault + - "us-east-cold" + - US East Region Cold + - "us-east-flex" + - US East Region Flex + - "us-south-standard" + - US South Region Standard + - "us-south-vault" + - US South Region Vault + - "us-south-cold" + - US South Region Cold + - "us-south-flex" + - US South Region Flex + - "eu-standard" + - EU Cross Region Standard + - "eu-vault" + - EU Cross Region Vault + - "eu-cold" + - EU Cross Region Cold + - "eu-flex" + - EU Cross Region Flex + - "eu-gb-standard" + - Great Britain Standard + - "eu-gb-vault" + - Great Britain Vault + - "eu-gb-cold" + - Great Britain Cold + - "eu-gb-flex" + - Great Britain Flex + - "ap-standard" + - APAC Standard + - "ap-vault" + - APAC Vault + - "ap-cold" + - APAC Cold + - "ap-flex" + - APAC Flex + - "mel01-standard" + - Melbourne Standard + - "mel01-vault" + - Melbourne Vault + - "mel01-cold" + - Melbourne Cold + - "mel01-flex" + - Melbourne Flex + - "tor01-standard" + - Toronto Standard + - "tor01-vault" + - Toronto Vault + - "tor01-cold" + - Toronto Cold + - "tor01-flex" + - Toronto Flex + +--s3-location-constraint + +Location constraint - must be set to match the Region. Leave blank if +not sure. Used when creating buckets only. + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" + +--s3-acl + +Canned ACL used when creating buckets and storing or copying objects. + +This ACL is used for creating objects and if bucket_acl isn't set, for +creating buckets too. + +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + +Note that this ACL is applied when server-side copying objects as S3 +doesn't copy the ACL from the source but rather writes a fresh one. + +- Config: acl +- Env Var: RCLONE_S3_ACL +- Type: string +- Default: "" +- Examples: + - "default" + - Owner gets Full_CONTROL. No one else has access rights + (default). + - "private" + - Owner gets FULL_CONTROL. No one else has access rights + (default). + - "public-read" + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. + - "public-read-write" + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. + - Granting this on a bucket is generally not recommended. + - "authenticated-read" + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. + - "bucket-owner-read" + - Object owner gets FULL_CONTROL. Bucket owner gets READ + access. + - If you specify this canned ACL when creating a bucket, + Amazon S3 ignores it. + - "bucket-owner-full-control" + - Both the object owner and the bucket owner get FULL_CONTROL + over the object. + - If you specify this canned ACL when creating a bucket, + Amazon S3 ignores it. + - "private" + - Owner gets FULL_CONTROL. No one else has access rights + (default). This acl is available on IBM Cloud (Infra), IBM + Cloud (Storage), On-Premise COS + - "public-read" + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. This acl is available on IBM Cloud (Infra), IBM + Cloud (Storage), On-Premise IBM COS + - "public-read-write" + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. This acl is available on IBM Cloud (Infra), + On-Premise IBM COS + - "authenticated-read" + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. Not supported on Buckets. This acl is available + on IBM Cloud (Infra) and On-Premise IBM COS + +--s3-server-side-encryption + +The server-side encryption algorithm used when storing this object in +S3. + +- Config: server_side_encryption +- Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION +- Type: string +- Default: "" +- Examples: + - "" + - None + - "AES256" + - AES256 + - "aws:kms" + - aws:kms + +--s3-sse-kms-key-id + +If using KMS ID you must provide the ARN of Key. + +- Config: sse_kms_key_id +- Env Var: RCLONE_S3_SSE_KMS_KEY_ID +- Type: string +- Default: "" +- Examples: + - "" + - None + - "arn:aws:kms:us-east-1:*" + - arn:aws:kms:* + +--s3-storage-class + +The storage class to use when storing new objects in S3. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "REDUCED_REDUNDANCY" + - Reduced redundancy storage class + - "STANDARD_IA" + - Standard Infrequent Access storage class + - "ONEZONE_IA" + - One Zone Infrequent Access storage class + - "GLACIER" + - Glacier storage class + - "DEEP_ARCHIVE" + - Glacier Deep Archive storage class + - "INTELLIGENT_TIERING" + - Intelligent-Tiering storage class + +--s3-storage-class + +The storage class to use when storing new objects in OSS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "GLACIER" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +--s3-storage-class + +The storage class to use when storing new objects in Tencent COS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "ARCHIVE" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +--s3-storage-class + +The storage class to use when storing new objects in S3. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - The Standard class for any upload; suitable for on-demand + content like streaming or CDN. + - "GLACIER" + - Archived storage; prices are lower, but it needs to be + restored first to be accessed. + +Advanced Options + +Here are the advanced options specific to s3 (Amazon S3 Compliant +Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, +Dreamhost, IBM COS, Minio, and Tencent COS). + +--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-requester-pays + +Enables requester pays option when interacting with S3 bucket. + +- Config: requester_pays +- Env Var: RCLONE_S3_REQUESTER_PAYS +- Type: bool +- Default: false + +--s3-sse-customer-algorithm + +If using SSE-C, the server-side encryption algorithm used when storing +this object in S3. + +- Config: sse_customer_algorithm +- Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM +- Type: string +- Default: "" +- Examples: + - "" + - None + - "AES256" + - AES256 + +--s3-sse-customer-key + +If using SSE-C you must provide the secret encryption key used to +encrypt/decrypt your data. + +- Config: sse_customer_key +- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY +- Type: string +- Default: "" +- Examples: + - "" + - None + +--s3-sse-customer-key-md5 + +If using SSE-C you may provide the secret encryption key MD5 checksum +(optional). + +If you leave it blank, this is calculated automatically from the +sse_customer_key provided. + +- Config: sse_customer_key_md5 +- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 +- Type: string +- Default: "" +- Examples: + - "" + - None + +--s3-upload-cutoff + +Cutoff for switching to chunked upload + +Any files larger than this will be uploaded in chunks of chunk_size. The +minimum is 0 and the maximum is 5GB. + +- Config: upload_cutoff +- Env Var: RCLONE_S3_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 200M + +--s3-chunk-size + +Chunk size to use for uploading. + +When uploading files larger than upload_cutoff or files with unknown +size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google +photos or google docs) they will be uploaded as multipart uploads using +this chunk size. + +Note that "--s3-upload-concurrency" chunks of this size are buffered in +memory per transfer. + +If you are transferring large files over high-speed links and you have +enough memory, then increasing this will speed up the transfers. + +Rclone will automatically increase the chunk size when uploading a large +file of known size to stay below the 10,000 chunks limit. + +Files of unknown size are uploaded with the configured chunk_size. Since +the default chunk size is 5MB and there can be at most 10,000 chunks, +this means that by default the maximum size of a file you can stream +upload is 48GB. If you wish to stream upload larger files then you will +need to increase chunk_size. + +- Config: chunk_size +- Env Var: RCLONE_S3_CHUNK_SIZE +- Type: SizeSuffix +- Default: 5M + +--s3-max-upload-parts + +Maximum number of parts in a multipart upload. + +This option defines the maximum number of multipart chunks to use when +doing a multipart upload. + +This can be useful if a service does not support the AWS S3 +specification of 10,000 chunks. + +Rclone will automatically increase the chunk size when uploading a large +file of a known size to stay below this number of chunks limit. + +- Config: max_upload_parts +- Env Var: RCLONE_S3_MAX_UPLOAD_PARTS +- Type: int +- Default: 10000 + +--s3-copy-cutoff + +Cutoff for switching to multipart copy + +Any files larger than this that need to be server-side copied will be +copied in chunks of this size. + +The minimum is 0 and the maximum is 5GB. + +- Config: copy_cutoff +- Env Var: RCLONE_S3_COPY_CUTOFF +- Type: SizeSuffix +- Default: 4.656G + +--s3-disable-checksum + +Don't store MD5 checksum with object metadata + +Normally rclone will calculate the MD5 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files to +start uploading. + +- Config: disable_checksum +- Env Var: RCLONE_S3_DISABLE_CHECKSUM +- Type: bool +- Default: false + +--s3-shared-credentials-file + +Path to the shared credentials file + +If env_auth = true then rclone can use a shared credentials file. + +If this variable is empty rclone will look for the +"AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it +will default to the current user's home directory. + + Linux/OSX: "$HOME/.aws/credentials" + Windows: "%USERPROFILE%\.aws\credentials" + +- Config: shared_credentials_file +- Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE +- Type: string +- Default: "" + +--s3-profile + +Profile to use in the shared credentials file + +If env_auth = true then rclone can use a shared credentials file. This +variable controls which profile is used in that file. + +If empty it will default to the environment variable "AWS_PROFILE" or +"default" if that environment variable is also not set. + +- Config: profile +- Env Var: RCLONE_S3_PROFILE +- Type: string +- Default: "" + +--s3-session-token + +An AWS session token + +- Config: session_token +- Env Var: RCLONE_S3_SESSION_TOKEN +- Type: string +- Default: "" + +--s3-upload-concurrency + +Concurrency for multipart uploads. + +This is the number of chunks of the same file that are uploaded +concurrently. + +If you are uploading small numbers of large files over high-speed links +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 (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) +require this set to false - rclone will do this automatically based on +the provider setting. + +- Config: force_path_style +- Env Var: RCLONE_S3_FORCE_PATH_STYLE +- Type: bool +- Default: true + +--s3-v2-auth + +If true use v2 authentication. + +If this is false (the default) then rclone will use v4 authentication. +If it is set then rclone will use v2 authentication. + +Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH. + +- Config: v2_auth +- Env Var: RCLONE_S3_V2_AUTH +- Type: bool +- Default: false + +--s3-use-accelerate-endpoint + +If true use the AWS S3 accelerated endpoint. + +See: AWS S3 Transfer acceleration + +- Config: use_accelerate_endpoint +- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +- Type: bool +- Default: false + +--s3-leave-parts-on-error + +If true avoid calling abort upload on a failure, leaving all +successfully uploaded parts on S3 for manual recovery. + +It should be set to true for resuming uploads across different sessions. + +WARNING: Storing parts of an incomplete multipart upload counts towards +space usage on S3 and will add additional costs if not cleaned up. + +- Config: leave_parts_on_error +- Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR +- Type: bool +- Default: false + +--s3-list-chunk + +Size of listing chunk (response list for each ListObject S3 request). + +This option is also known as "MaxKeys", "max-items", or "page-size" from +the AWS S3 specification. Most services truncate the response list to +1000 objects even if requested more than that. In AWS S3 this is a +global maximum and cannot be changed, see AWS S3. In Ceph, this can be +increased with the "rgw list buckets max chunk" option. + +- Config: list_chunk +- Env Var: RCLONE_S3_LIST_CHUNK +- Type: int +- Default: 1000 + +--s3-no-check-bucket + +If set, don't attempt to check the bucket exists or create it + +This can be useful when trying to minimise the number of transactions +rclone does if you know the bucket exists already. + +It can also be needed if the user you are using does not have bucket +creation permissions. Before v1.52.0 this would have passed silently due +to a bug. + +- Config: no_check_bucket +- Env Var: RCLONE_S3_NO_CHECK_BUCKET +- Type: bool +- Default: false + +--s3-no-head + +If set, don't HEAD uploaded objects to check integrity + +This can be useful when trying to minimise the number of transactions +rclone does. + +Setting it means that if rclone receives a 200 OK message after +uploading an object with PUT then it will assume that it got uploaded +properly. + +In particular it will assume: + +- the metadata, including modtime, storage class and content type was + as uploaded +- the size was as uploaded + +It reads the following items from the response for a single part PUT: + +- the MD5SUM +- The uploaded date + +For multipart uploads these items aren't read. + +If an source object of unknown length is uploaded then rclone WILL do a +HEAD request. + +Setting this flag increases the chance for undetected upload failures, +in particular an incorrect size, so it isn't recommended for normal +operation. In practice the chance of an undetected upload failure is +very small even with this flag. + +- Config: no_head +- Env Var: RCLONE_S3_NO_HEAD +- Type: bool +- Default: false + +--s3-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_S3_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + +--s3-memory-pool-flush-time + +How often internal memory buffer pools will be flushed. Uploads which +requires additional buffers (f.e multipart) will use memory pool for +allocations. This option controls how often unused buffers will be +removed from the pool. + +- Config: memory_pool_flush_time +- Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME +- Type: Duration +- Default: 1m0s + +--s3-memory-pool-use-mmap + +Whether to use mmap buffers in internal memory pool. + +- Config: memory_pool_use_mmap +- Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP +- Type: bool +- Default: false + +--s3-disable-http2 + +Disable usage of http2 for S3 backends + +There is currently an unsolved issue with the s3 (specifically minio) +backend and HTTP/2. HTTP/2 is enabled by default for the s3 backend but +can be disabled here. When the issue is solved this flag will be +removed. + +See: https://github.com/rclone/rclone/issues/4673, +https://github.com/rclone/rclone/issues/3631 + +- Config: disable_http2 +- Env Var: RCLONE_S3_DISABLE_HTTP2 +- Type: bool +- Default: false + +Backend commands + +Here are the commands specific to the s3 backend. + +Run them with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See the "rclone backend" command for more info on how to pass options +and arguments. + +These can be run on a running backend using the rc command +backend/command. + +restore + +Restore objects from GLACIER to normal storage + + rclone backend restore remote: [options] [+] + +This command can be used to restore one or more objects from GLACIER to +normal storage. + +Usage Examples: + + rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS] + rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS] + rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS] + +This flag also obeys the filters. Test first with -i/--interactive or +--dry-run flags + + rclone -i backend restore --include "*.txt" s3:bucket/path -o priority=Standard + +All the objects shown will be marked for restore, then + + rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard + +It returns a list of status dictionaries with Remote and Status keys. +The Status will be OK if it was successful or an error message if not. + + [ { - "rclone": [ - { - "Initiated": "2020-06-26T14:20:36Z", - "Initiator": { - "DisplayName": "XXX", - "ID": "arn:aws:iam::XXX:user/XXX" - }, - "Key": "KEY", - "Owner": { - "DisplayName": null, - "ID": "XXX" - }, - "StorageClass": "STANDARD", - "UploadId": "XXX" - } - ], - "rclone-1000files": [], - "rclone-dst": [] + "Status": "OK", + "Path": "test.txt" + }, + { + "Status": "OK", + "Path": "test/file4.txt" } + ] +Options: +- "description": The optional description for the job. +- "lifetime": Lifetime of the active copy in days +- "priority": Priority of restore: Standard|Expedited|Bulk - #### cleanup +list-multipart-uploads - Remove unfinished multipart uploads. +List the unfinished multipart uploads - rclone backend cleanup remote: [options] [+] + rclone backend list-multipart-uploads remote: [options] [+] - This command removes unfinished multipart uploads of age greater than - max-age which defaults to 24 hours. +This command lists the unfinished multipart uploads in JSON format. - Note that you can use -i/--dry-run with this command to see what it - would do. + rclone backend list-multipart s3:bucket/path/to/object - rclone backend cleanup s3:bucket/path/to/object - rclone backend cleanup -o max-age=7w s3:bucket/path/to/object +It returns a dictionary of buckets with values as lists of unfinished +multipart uploads. - Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. +You can call it with no bucket in which case it lists all bucket, with a +bucket or with a bucket and path. + { + "rclone": [ + { + "Initiated": "2020-06-26T14:20:36Z", + "Initiator": { + "DisplayName": "XXX", + "ID": "arn:aws:iam::XXX:user/XXX" + }, + "Key": "KEY", + "Owner": { + "DisplayName": null, + "ID": "XXX" + }, + "StorageClass": "STANDARD", + "UploadId": "XXX" + } + ], + "rclone-1000files": [], + "rclone-dst": [] + } - Options: +cleanup - - "max-age": Max age of upload to delete +Remove unfinished multipart uploads. + rclone backend cleanup remote: [options] [+] +This command removes unfinished multipart uploads of age greater than +max-age which defaults to 24 hours. - ### Anonymous access to public buckets ### +Note that you can use -i/--dry-run with this command to see what it +would do. - 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: + rclone backend cleanup s3:bucket/path/to/object + rclone backend cleanup -o max-age=7w s3:bucket/path/to/object -[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 = +Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. +Options: - Then use it as normal with the name of the public bucket, eg +- "max-age": Max age of upload to delete - rclone lsd anons3:1000genomes +Anonymous access to public buckets - You will be able to list and copy data but not upload it. +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: - ### Ceph ### + [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 = - [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. +Then use it as normal with the name of the public bucket, e.g. - 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: + rclone lsd anons3:1000genomes -[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 = +You will be able to list and copy data but not upload it. +Ceph - 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. +Ceph is an open source unified, distributed storage system designed for +excellent performance, reliability and scalability. It has an S3 +compatible object storage interface. - 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. +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: - Eg the dump from Ceph looks something like this (irrelevant keys - removed). + [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 = -{ "user_id": "xxx", "display_name": "xxxx", "keys": [ { "user": "xxx", -"access_key": "xxxxxx", "secret_key": "xxxxxx/xxxx" } ], } +If you are using an older version of CEPH, e.g. 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. - 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. +Eg the dump from Ceph looks something like this (irrelevant keys +removed). - ### Dreamhost ### + { + "user_id": "xxx", + "display_name": "xxxx", + "keys": [ + { + "user": "xxx", + "access_key": "xxxxxx", + "secret_key": "xxxxxx\/xxxx" + } + ], + } - Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is - an object storage system based on CEPH. +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. - 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: +Dreamhost -[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 = +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: - ### DigitalOcean Spaces ### + [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 = - [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. +DigitalOcean Spaces - To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when prompted by `rclone config` for your `access_key_id` and `secret_access_key`. +Spaces is an S3-interoperable object storage service from cloud provider +DigitalOcean. - 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. +To connect to DigitalOcean Spaces you will need an access key and secret +key. These can be retrieved on the "Applications & API" page of the +DigitalOcean control panel. They will be needed when prompted by +rclone config for your access_key_id and secret_access_key. - Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below: +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. -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> +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: +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 = + [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: - 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 -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) - ### IBM COS (S3) ### +To configure access to IBM COS S3, follow the steps below: - 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) +1. Run rclone config and select n for a new remote. - To configure access to IBM COS S3, follow the steps below: + 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. Run rclone config and select n for a new remote. +2. Enter the name for the configuration - 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults + 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 endpoint 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 (Storage) supports "public-read" and + "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise + COS supports all the canned ACLs. + + Canned ACL used when creating buckets and/or storing objects in S3. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS + \ "private" + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS + \ "public-read" + 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS + \ "public-read-write" + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS + \ "authenticated-read" + acl> 1 + +12. Review the displayed configuration and accept to save the "remote" + then quit. The config file should look like this + + [xxx] + type = s3 + Provider = IBMCOS + access_key_id = xxx + secret_access_key = yyy + endpoint = s3-api.us-geo.objectstorage.softlayer.net + location_constraint = us-standard + acl = private + +13. Execute rclone commands + + 1) Create a bucket. + rclone mkdir IBM-COS-XREGION:newbucket + 2) List available buckets. + rclone lsd IBM-COS-XREGION: + -1 2017-11-08 21:16:22 -1 test + -1 2018-02-14 20:16:39 -1 newbucket + 3) List contents of a bucket. + rclone ls IBM-COS-XREGION:newbucket + 18685952 test.exe + 4) Copy a file from local to remote. + rclone copy /Users/file.txt IBM-COS-XREGION:newbucket + 5) Copy a file from remote to local. + rclone copy IBM-COS-XREGION:newbucket/file.txt . + 6) Delete a file on remote. + rclone delete IBM-COS-XREGION:newbucket/file.txt + +Minio + +Minio is an object storage server built for cloud application developers +and devops. + +It is very easy to install and provides an S3 compatible server which +can be used by rclone. + +To use it, install Minio following the instructions here. + +When it configures itself Minio will print something like this + + Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 + AccessKey: USWUXHGYZQYFYFFIT3RE + SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + Region: us-east-1 + SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis + + Browser Access: + http://192.168.1.106:9000 http://172.23.0.1:9000 + + Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide + $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + + Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang-client-quickstart-guide + Java: https://docs.minio.io/docs/java-client-quickstart-guide + Python: https://docs.minio.io/docs/python-client-quickstart-guide + JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide + .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide + + Drive Capacity: 26 GiB Free, 165 GiB Total + +These details need to go into rclone config like this. Note that it is +important to put the region in as stated above. + + env_auth> 1 + access_key_id> USWUXHGYZQYFYFFIT3RE + secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + region> us-east-1 + endpoint> http://192.168.1.106:9000 + location_constraint> + server_side_encryption> + +Which makes the config file look like this + + [minio] + type = s3 + provider = Minio + env_auth = false + access_key_id = USWUXHGYZQYFYFFIT3RE + secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + region = us-east-1 + endpoint = http://192.168.1.106:9000 + location_constraint = + server_side_encryption = + +So once set up, for example to copy files into a bucket + + rclone copy /path/to/files minio:bucket + +Scaleway + +Scaleway The Object Storage platform allows you to store anything from +backups, logs and web assets to documents and photos. Files can be +dropped from the Scaleway console or transferred through our API and CLI +or using any S3-compatible tool. + +Scaleway provides an S3 interface which can be configured for use with +rclone like this: + + [scaleway] + type = s3 + provider = Scaleway + env_auth = false + endpoint = s3.nl-ams.scw.cloud + access_key_id = SCWXXXXXXXXXXXXXX + secret_access_key = 1111111-2222-3333-44444-55555555555555 + region = nl-ams + location_constraint = + acl = private + server_side_encryption = + storage_class = + +Wasabi + +Wasabi is a cloud-based object storage service for a broad range of +applications and use cases. Wasabi is designed for individuals and +organizations that require a high-performance, reliable, and secure data +storage infrastructure at minimal cost. + +Wasabi provides an S3 interface which can be configured for use with +rclone like this. + + No remotes found - make a new one + n) New remote + s) Set configuration password + n/s> n + name> wasabi + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon S3 (also Dreamhost, Ceph, Minio) + \ "s3" + [snip] + Storage> s3 + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> YOURACCESSKEY + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> YOURSECRETACCESSKEY + Region to connect to. + Choose a number from below, or type in your own value + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia, or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + [snip] + region> us-east-1 + Endpoint for S3 API. + Leave blank if using AWS to use the default endpoint for the region. + Specify if using an S3 clone such as Ceph. + endpoint> s3.wasabisys.com + Location constraint - must be set to match the Region. Used when creating buckets only. + Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. + \ "" + [snip] + location_constraint> + Canned ACL used when creating buckets and/or storing objects in S3. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \ "private" + [snip] + acl> + The server-side encryption algorithm used when storing this object in S3. + Choose a number from below, or type in your own value + 1 / None + \ "" + 2 / AES256 + \ "AES256" + server_side_encryption> + The storage class to use when storing objects in S3. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Standard storage class + \ "STANDARD" + 3 / Reduced redundancy storage class + \ "REDUCED_REDUNDANCY" + 4 / Standard Infrequent Access storage class + \ "STANDARD_IA" + storage_class> + Remote config + -------------------- + [wasabi] + env_auth = false + access_key_id = YOURACCESSKEY + secret_access_key = YOURSECRETACCESSKEY + region = us-east-1 + endpoint = s3.wasabisys.com + location_constraint = + acl = + server_side_encryption = + storage_class = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +This will leave the config file looking like this. + + [wasabi] + type = s3 + provider = Wasabi + env_auth = false + access_key_id = YOURACCESSKEY + secret_access_key = YOURSECRETACCESSKEY + region = + endpoint = s3.wasabisys.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +Alibaba OSS + +Here is an example of making an Alibaba Cloud (Aliyun) OSS +configuration. First run: + + rclone config + +This will guide you through an interactive setup process. + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> oss + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + \ "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 + +Tencent COS + +Tencent Cloud Object Storage (COS) is a distributed storage service +offered by Tencent Cloud for unstructured data. It is secure, stable, +massive, convenient, low-delay and low-cost. + +To configure access to Tencent COS, follow the steps below: + +1. Run rclone config and select n for a new remote. + + rclone config No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n +2. Give the name of the configuration. For example, name it 'cos'. - 2. Enter the name for the configuration + name> cos - name> +3. Select s3 storage. - - 3. Select "s3" storage. - -Choose a number from below, or type in your own value 1 / Alias for an -existing remote  "alias" 2 / Amazon Drive  "amazon cloud drive" 3 / -Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) - "s3" 4 / Backblaze B2  "b2" [snip] 23 / http Connection  "http" -Storage> 3 - - - 4. Select IBM COS as the S3 Storage Provider. - -Choose the S3 provider. Choose a number from below, or type in your own -value 1 / Choose this option to configure Storage to AWS S3  "AWS" 2 / -Choose this option to configure Storage to Ceph Systems  "Ceph" 3 / -Choose this option to configure Storage to Dreamhost  "Dreamhost" 4 / -Choose this option to the configure Storage to IBM COS S3  "IBMCOS" 5 / -Choose this option to the configure Storage to Minio  "Minio" Provider>4 - - - 5. Enter the Access Key and Secret. - - AWS Access Key ID - leave blank for anonymous access or runtime credentials. - access_key_id> <> - AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. - secret_access_key> <> - - - 6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address. - - Endpoint for IBM COS S3 API. - Specify if using an IBM COS On Premise. Choose a number from below, or type in your own value - 1 / US Cross Region Endpoint - \ "s3-api.us-geo.objectstorage.softlayer.net" - 2 / US Cross Region Dallas Endpoint - \ "s3-api.dal.us-geo.objectstorage.softlayer.net" - 3 / US Cross Region Washington DC Endpoint - \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" - 4 / US Cross Region San Jose Endpoint - \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" - 5 / US Cross Region Private Endpoint - \ "s3-api.us-geo.objectstorage.service.networklayer.com" - 6 / US Cross Region Dallas Private Endpoint - \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" - 7 / US Cross Region Washington DC Private Endpoint - \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" - 8 / US Cross Region San Jose Private Endpoint - \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" - 9 / US Region East Endpoint - \ "s3.us-east.objectstorage.softlayer.net" - 10 / US Region East Private Endpoint - \ "s3.us-east.objectstorage.service.networklayer.com" - 11 / US Region South Endpoint - -[snip] 34 / Toronto Single Site Private Endpoint - "s3.tor01.objectstorage.service.networklayer.com" endpoint>1 - - - - 7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on-prem COS, do not make a selection from this list, hit enter - - 1 / US Cross Region Standard - \ "us-standard" - 2 / US Cross Region Vault - \ "us-vault" - 3 / US Cross Region Cold - \ "us-cold" - 4 / US Cross Region Flex - \ "us-flex" - 5 / US East Region Standard - \ "us-east-standard" - 6 / US East Region Vault - \ "us-east-vault" - 7 / US East Region Cold - \ "us-east-cold" - 8 / US East Region Flex - \ "us-east-flex" - 9 / US South Region Standard - \ "us-south-standard" - 10 / US South Region Vault - \ "us-south-vault" - -[snip] 32 / Toronto Flex  "tor01-flex" location_constraint>1 - - - 9. Specify a canned ACL. IBM Cloud (Strorage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs. - -Canned ACL used when creating buckets and/or storing objects in S3. For -more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default). This acl is -available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS - "private" 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ -access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On-Premise IBM COS  "public-read" 3 / Owner gets FULL_CONTROL. The -AllUsers group gets READ and WRITE access. This acl is available on IBM -Cloud (Infra), On-Premise IBM COS  "public-read-write" 4 / Owner gets -FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not -supported on Buckets. This acl is available on IBM Cloud (Infra) and -On-Premise IBM COS  "authenticated-read" acl> 1 - - - - 12. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this - - [xxx] - type = s3 - Provider = IBMCOS - access_key_id = xxx - secret_access_key = yyy - endpoint = s3-api.us-geo.objectstorage.softlayer.net - location_constraint = us-standard - acl = private - - - 13. Execute rclone commands - - 1) Create a bucket. - rclone mkdir IBM-COS-XREGION:newbucket - 2) List available buckets. - rclone lsd IBM-COS-XREGION: - -1 2017-11-08 21:16:22 -1 test - -1 2018-02-14 20:16:39 -1 newbucket - 3) List contents of a bucket. - rclone ls IBM-COS-XREGION:newbucket - 18685952 test.exe - 4) Copy a file from local to remote. - rclone copy /Users/file.txt IBM-COS-XREGION:newbucket - 5) Copy a file from remote to local. - rclone copy IBM-COS-XREGION:newbucket/file.txt . - 6) Delete a file on remote. - rclone delete IBM-COS-XREGION:newbucket/file.txt - - - ### Minio ### - - [Minio](https://minio.io/) is an object storage server built for cloud application developers and devops. - - It is very easy to install and provides an S3 compatible server which can be used by rclone. - - To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio-quickstart-guide). - - When it configures itself Minio will print something like this - -Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: -USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 -Region: us-east-1 SQS ARNs: arn:minio:sqs:us-east-1:1:redis -arn:minio:sqs:us-east-1:2:redis - -Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000 - -Command-line Access: -https://docs.minio.io/docs/minio-client-quickstart-guide $ mc config -host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 - -Object API (Amazon S3 compatible): Go: -https://docs.minio.io/docs/golang-client-quickstart-guide Java: -https://docs.minio.io/docs/java-client-quickstart-guide Python: -https://docs.minio.io/docs/python-client-quickstart-guide JavaScript: -https://docs.minio.io/docs/javascript-client-quickstart-guide .NET: -https://docs.minio.io/docs/dotnet-client-quickstart-guide - -Drive Capacity: 26 GiB Free, 165 GiB Total - - - These details need to go into `rclone config` like this. Note that it - is important to put the region in as stated above. - -env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us-east-1 endpoint> -http://192.168.1.106:9000 location_constraint> server_side_encryption> - - - Which makes the config file look like this - -[minio] type = s3 provider = Minio env_auth = false access_key_id = -USWUXHGYZQYFYFFIT3RE secret_access_key = -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us-east-1 endpoint = -http://192.168.1.106:9000 location_constraint = server_side_encryption = - - - So once set up, for example to copy files into a bucket - -rclone copy /path/to/files minio:bucket - - - ### Scaleway {#scaleway} - - [Scaleway](https://www.scaleway.com/object-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. - Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool. - - Scaleway provides an S3 interface which can be configured for use with rclone like this: - -[scaleway] type = s3 provider = Scaleway env_auth = false endpoint = -s3.nl-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key -= 1111111-2222-3333-44444-55555555555555 region = nl-ams -location_constraint = acl = private server_side_encryption = -storage_class = - - - ### Wasabi ### - - [Wasabi](https://wasabi.com) is a cloud-based object storage service for a - broad range of applications and use cases. Wasabi is designed for - individuals and organizations that require a high-performance, - reliable, and secure data storage infrastructure at minimal cost. - - Wasabi provides an S3 interface which can be configured for use with - rclone like this. - -No remotes found - make a new one n) New remote s) Set configuration -password n/s> n name> wasabi Type of storage to configure. Choose a -number from below, or type in your own value [snip] XX / Amazon S3 (also -Dreamhost, Ceph, Minio)  "s3" [snip] Storage> s3 Get AWS credentials -from runtime (environment variables or EC2/ECS meta data if no env -vars). Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step  "false" 2 / Get AWS credentials from the -environment (env vars or IAM)  "true" env_auth> 1 AWS Access Key ID - -leave blank for anonymous access or runtime credentials. access_key_id> -YOURACCESSKEY AWS Secret Access Key (password) - leave blank for -anonymous access or runtime credentials. secret_access_key> -YOURSECRETACCESSKEY Region to connect to. Choose a number from below, or -type in your own value / The default endpoint - a good choice if you are -unsure. 1 | US Region, Northern Virginia or Pacific Northwest. | Leave -location constraint empty.  "us-east-1" [snip] region> us-east-1 -Endpoint for S3 API. Leave blank if using AWS to use the default -endpoint for the region. Specify if using an S3 clone such as Ceph. -endpoint> s3.wasabisys.com Location constraint - must be set to match -the Region. Used when creating buckets only. Choose a number from below, -or type in your own value 1 / Empty for US Region, Northern Virginia or -Pacific Northwest.  "" [snip] location_constraint> Canned ACL used when -creating buckets and/or storing objects in S3. For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default).  "private" [snip] -acl> The server-side encryption algorithm used when storing this object -in S3. Choose a number from below, or type in your own value 1 / None - "" 2 / AES256  "AES256" server_side_encryption> The storage class to -use when storing objects in S3. Choose a number from below, or type in -your own value 1 / Default  "" 2 / Standard storage class  "STANDARD" 3 -/ Reduced redundancy storage class  "REDUCED_REDUNDANCY" 4 / Standard -Infrequent Access storage class  "STANDARD_IA" storage_class> Remote -config -------------------- [wasabi] env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = us-east-1 -endpoint = s3.wasabisys.com location_constraint = acl = -server_side_encryption = storage_class = -------------------- y) Yes -this is OK e) Edit this remote d) Delete this remote y/e/d> y - - - This will leave the config file looking like this. - -[wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint -= s3.wasabisys.com location_constraint = acl = server_side_encryption = -storage_class = - - - ### Alibaba OSS {#alibaba-oss} - - Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/) - configuration. First run: - - rclone config - - This will guide you through an interactive setup process. - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> oss Type of storage to configure. -Enter a string value. Press Enter for the default (""). Choose a number -from below, or type in your own value [snip] 4 / Amazon S3 Compliant -Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, -Minio, etc)  "s3" [snip] Storage> s3 Choose your S3 provider. Enter a -string value. Press Enter for the default (""). Choose a number from -below, or type in your own value 1 / Amazon Web Services (AWS) S3  "AWS" -2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun  "Alibaba" -3 / Ceph Object Storage  "Ceph" [snip] provider> Alibaba Get AWS -credentials from runtime (environment variables or EC2/ECS meta data if -no env vars). Only applies if access_key_id and secret_access_key is -blank. Enter a boolean value (true or false). Press Enter for the -default ("false"). Choose a number from below, or type in your own value -1 / Enter AWS credentials in the next step  "false" 2 / Get AWS -credentials from the environment (env vars or IAM)  "true" env_auth> 1 -AWS Access Key ID. Leave blank for anonymous access or runtime -credentials. Enter a string value. Press Enter for the default (""). -access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank -for anonymous access or runtime credentials. Enter a string value. Press -Enter for the default (""). secret_access_key> secretaccesskey Endpoint -for OSS API. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value 1 / East China 1 -(Hangzhou)  "oss-cn-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai) - "oss-cn-shanghai.aliyuncs.com" 3 / North China 1 (Qingdao) - "oss-cn-qingdao.aliyuncs.com" [snip] endpoint> 1 Canned ACL used when -creating buckets and storing or copying objects. - -Note that this ACL is applied when server side copying objects as S3 -doesn't copy the ACL from the source but rather writes a fresh one. -Enter a string value. Press Enter for the default (""). Choose a number -from below, or type in your own value 1 / Owner gets FULL_CONTROL. No -one else has access rights (default).  "private" 2 / Owner gets -FULL_CONTROL. The AllUsers group gets READ access.  "public-read" / -Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. -[snip] acl> 1 The storage class to use when storing new objects in OSS. -Enter a string value. Press Enter for the default (""). Choose a number -from below, or type in your own value 1 / Default  "" 2 / Standard -storage class  "STANDARD" 3 / Archive storage mode.  "GLACIER" 4 / -Infrequent access storage mode.  "STANDARD_IA" storage_class> 1 Edit -advanced config? (y/n) y) Yes n) No y/n> n Remote config --------------------- [oss] type = s3 provider = Alibaba env_auth = false -access_key_id = accesskeyid secret_access_key = secretaccesskey endpoint -= oss-cn-hangzhou.aliyuncs.com acl = private storage_class = Standard --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - ### Netease NOS ### - - For Netease NOS configure as per the configurator `rclone config` - setting the provider `Netease`. This will automatically set - `force_path_style = false` which is necessary for it to run properly. - - Backblaze B2 - ---------------------------------------- - - B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/). - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - Here is an example of making a b2 configuration. First run - - rclone config - - This will guide you through an interactive setup process. To authenticate - you will either need your Account ID (a short hex number) and Master - Application Key (a long hex number) OR an Application Key, which is the - recommended method. See below for further details on generating and using - an Application Key. - -No remotes found - make a new one n) New remote q) Quit config n/q> n -name> remote Type of storage to configure. Choose a number from below, -or type in your own value [snip] XX / Backblaze B2  "b2" [snip] Storage> -b2 Account ID or Application Key ID account> 123456789abc Application -Key key> 0123456789abcdef0123456789abcdef0123456789 Endpoint for the -service - leave blank normally. endpoint> Remote config --------------------- [remote] account = 123456789abc key = -0123456789abcdef0123456789abcdef0123456789 endpoint = --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - This remote is called `remote` and can now be used like this - - See all buckets - - rclone lsd remote: - - Create a new bucket - - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any - excess files in the bucket. - - rclone sync -i /home/local/directory remote:bucket - - ### Application Keys ### - - B2 supports multiple [Application Keys for different access permission - to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html). - - You can use these with rclone too; you will need to use rclone version 1.43 - or later. - - Follow Backblaze's docs to create an Application Key with the required - permission and add the `applicationKeyId` as the `account` and the - `Application Key` itself as the `key`. - - Note that you must put the _applicationKeyId_ as the `account` – you - can't use the master Account ID. If you try then B2 will return 401 - errors. - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - ### Modified time ### - - The modified time is stored as metadata on the object as - `X-Bz-Info-src_last_modified_millis` as milliseconds since 1970-01-01 - in the Backblaze standard. Other tools should be able to use this as - a modified time. - - Modified times are used in syncing and are fully supported. Note that - if a modification time needs to be updated on an object then it will - create a new version of the object. - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - Note that in 2020-05 Backblaze started allowing \ characters in file - names. Rclone hasn't changed its encoding as this could cause syncs to - re-transfer files. If you want rclone not to replace \ then see the - `--b2-encoding` flag below and remove the `BackSlash` from the - string. This can be set in the config. - - ### SHA1 checksums ### - - The SHA1 checksums of the files are checked on upload and download and - will be used in the syncing process. - - Large files (bigger than the limit in `--b2-upload-cutoff`) which are - uploaded in chunks will store their SHA1 on the object as - `X-Bz-Info-large_file_sha1` as recommended by Backblaze. - - For a large file to be uploaded with an SHA1 checksum, the source - needs to support SHA1 checksums. The local disk supports SHA1 - checksums so large file transfers from local disk will have an SHA1. - See [the overview](https://rclone.org/overview/#features) for exactly which remotes - support SHA1. - - Sources which don't support SHA1, in particular `crypt` will upload - large files without SHA1 checksums. This may be fixed in the future - (see [#1767](https://github.com/rclone/rclone/issues/1767)). - - Files sizes below `--b2-upload-cutoff` will always have an SHA1 - regardless of the source. - - ### Transfers ### - - Backblaze recommends that you do lots of transfers simultaneously for - maximum speed. In tests from my SSD equipped laptop the optimum - setting is about `--transfers 32` though higher numbers may be used - for a slight speed improvement. The optimum number for you may vary - depending on your hardware, how big the files are, how much you want - to load your computer, etc. The default of `--transfers 4` is - definitely too low for Backblaze B2 though. - - Note that uploading big files (bigger than 200 MB by default) will use - a 96 MB RAM buffer by default. There can be at most `--transfers` of - these in use at any moment, so this sets the upper limit on the memory - used. - - ### Versions ### - - When rclone uploads a new version of a file it creates a [new version - of it](https://www.backblaze.com/b2/docs/file_versions.html). - Likewise when you delete a file, the old version will be marked hidden - and still be available. Conversely, you may opt in to a "hard delete" - of files with the `--b2-hard-delete` flag which would permanently remove - the file instead of hiding it. - - Old versions of files, where available, are visible using the - `--b2-versions` flag. - - **NB** Note that `--b2-versions` does not work with crypt at the - moment [#1627](https://github.com/rclone/rclone/issues/1627). Using - [--backup-dir](https://rclone.org/docs/#backup-dir-dir) with rclone is the recommended - way of working around this. - - If you wish to remove all the old versions then you can use the - `rclone cleanup remote:bucket` command which will delete all the old - versions of files, leaving the current ones intact. You can also - supply a path and only old versions under that path will be deleted, - eg `rclone cleanup remote:bucket/path/to/stuff`. - - Note that `cleanup` will remove partially uploaded files from the bucket - if they are more than a day old. - - When you `purge` a bucket, the current and the old versions will be - deleted then the bucket will be deleted. - - However `delete` will cause the current versions of the files to - become hidden old versions. - - Here is a session showing the listing and retrieval of an old - version followed by a `cleanup` of the old versions. - - Show current version and all the versions with `--b2-versions` flag. - -$ rclone -q ls b2:cleanup-test 9 one.txt - -$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 -one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 -one-v2016-07-02-155621-000.txt - - - Retrieve an old version - -$ rclone -q --b2-versions copy -b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp - -$ ls -l /tmp/one-v2016-07-04-141003-000.txt -rw-rw-r-- 1 ncw ncw 16 Jul -2 17:46 /tmp/one-v2016-07-04-141003-000.txt - - - Clean up all the old versions and show that they've gone. - -$ rclone -q cleanup b2:cleanup-test - -$ rclone -q ls b2:cleanup-test 9 one.txt - -$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt - - - ### Data usage ### - - It is useful to know how many requests are sent to the server in different scenarios. - - All copy commands send the following 4 requests: - -/b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket -/b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names - - - The `b2_list_file_names` request will be sent once for every 1k files - in the remote path, providing the checksum and modification time of - the listed files. As of version 1.33 issue - [#818](https://github.com/rclone/rclone/issues/818) causes extra requests - to be sent when using B2 with Crypt. When a copy operation does not - require any files to be uploaded, no more requests will be sent. - - Uploading files that do not require chunking, will send 2 requests per - file upload: - -/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ - - - Uploading files requiring chunking, will send 2 requests (one each to - start and finish the upload) and another 2 requests for each chunk: - -/b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url -/b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file - - - #### Versions #### - - Versions can be viewed with the `--b2-versions` flag. When it is set - rclone will show and act on older versions of files. For example - - Listing without `--b2-versions` - -$ rclone -q ls b2:cleanup-test 9 one.txt - - - And with - -$ rclone -q --b2-versions ls b2:cleanup-test 9 one.txt 8 -one-v2016-07-04-141032-000.txt 16 one-v2016-07-04-141003-000.txt 15 -one-v2016-07-02-155621-000.txt - - - Showing that the current version is unchanged but older versions can - be seen. These have the UTC date that they were uploaded to the - server to the nearest millisecond appended to them. - - Note that when using `--b2-versions` no file write operations are - permitted, so you can't upload files or delete them. - - ### B2 and rclone link ### - - Rclone supports generating file share links for private B2 buckets. - They can either be for a file for example: - -./rclone link B2:bucket/path/to/file.txt -https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx - - - or if run on a directory you will get: - -./rclone link B2:bucket/path -https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx - - - you can then use the authorization token (the part of the url from the - `?Authorization=` on) on any file path under that directory. For example: - -https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx -https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx -https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx - - - - ### Standard Options - - Here are the standard options specific to b2 (Backblaze B2). - - #### --b2-account - - Account ID or Application Key ID - - - Config: account - - Env Var: RCLONE_B2_ACCOUNT - - Type: string - - Default: "" - - #### --b2-key - - Application Key - - - Config: key - - Env Var: RCLONE_B2_KEY - - Type: string - - Default: "" - - #### --b2-hard-delete - - Permanently delete files on remote removal, otherwise hide files. - - - Config: hard_delete - - Env Var: RCLONE_B2_HARD_DELETE - - Type: bool - - Default: false - - ### Advanced Options - - Here are the advanced options specific to b2 (Backblaze B2). - - #### --b2-endpoint - - Endpoint for the service. - Leave blank normally. - - - Config: endpoint - - Env Var: RCLONE_B2_ENDPOINT - - Type: string - - Default: "" - - #### --b2-test-mode - - A flag string for X-Bz-Test-Mode header for debugging. - - This is for debugging purposes only. Setting it to one of the strings - below will cause b2 to return specific errors: - - * "fail_some_uploads" - * "expire_some_account_authorization_tokens" - * "force_cap_exceeded" - - These will be set in the "X-Bz-Test-Mode" header which is documented - in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html). - - - Config: test_mode - - Env Var: RCLONE_B2_TEST_MODE - - Type: string - - Default: "" - - #### --b2-versions - - Include old versions in directory listings. - Note that when using this no file write operations are permitted, - so you can't upload files or delete them. - - - Config: versions - - Env Var: RCLONE_B2_VERSIONS - - Type: bool - - Default: false - - #### --b2-upload-cutoff - - Cutoff for switching to chunked upload. - - Files above this size will be uploaded in chunks of "--b2-chunk-size". - - This value should be set no larger than 4.657GiB (== 5GB). - - - Config: upload_cutoff - - Env Var: RCLONE_B2_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 200M - - #### --b2-copy-cutoff - - Cutoff for switching to multipart copy - - Any files larger than this that need to be server side copied will be - copied in chunks of this size. - - The minimum is 0 and the maximum is 4.6GB. - - - Config: copy_cutoff - - Env Var: RCLONE_B2_COPY_CUTOFF - - Type: SizeSuffix - - Default: 4G - - #### --b2-chunk-size - - Upload chunk size. Must fit in memory. - - When uploading large files, chunk the file into this size. Note that - these chunks are buffered in memory and there might a maximum of - "--transfers" chunks in progress at once. 5,000,000 Bytes is the - minimum size. - - - Config: chunk_size - - Env Var: RCLONE_B2_CHUNK_SIZE - - Type: SizeSuffix - - Default: 96M - - #### --b2-disable-checksum - - Disable checksums for large (> upload cutoff) files - - Normally rclone will calculate the SHA1 checksum of the input before - uploading it so it can add it to metadata on the object. This is great - for data integrity checking but can cause long delays for large files - to start uploading. - - - Config: disable_checksum - - Env Var: RCLONE_B2_DISABLE_CHECKSUM - - Type: bool - - Default: false - - #### --b2-download-url - - Custom endpoint for downloads. - - This is usually set to a Cloudflare CDN URL as Backblaze offers - free egress for data downloaded through the Cloudflare network. - This is probably only useful for a public bucket. - Leave blank if you want to use the endpoint provided by Backblaze. - - - Config: download_url - - Env Var: RCLONE_B2_DOWNLOAD_URL - - Type: string - - Default: "" - - #### --b2-download-auth-duration - - Time before the authorization token will expire in s or suffix ms|s|m|h|d. - - The duration before the download authorization token will expire. - The minimum value is 1 second. The maximum value is one week. - - - Config: download_auth_duration - - Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION - - Type: Duration - - Default: 1w - - #### --b2-memory-pool-flush-time - - How often internal memory buffer pools will be flushed. - Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. - This option controls how often unused buffers will be removed from the pool. - - - Config: memory_pool_flush_time - - Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME - - Type: Duration - - Default: 1m0s - - #### --b2-memory-pool-use-mmap - - Whether to use mmap buffers in internal memory pool. - - - Config: memory_pool_use_mmap - - Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP - - Type: bool - - Default: false - - #### --b2-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_B2_ENCODING - - Type: MultiEncoder - - Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - - - - Box - ----------------------------------------- - - Paths are specified as `remote:path` - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - The initial setup for Box involves getting a token from Box which you - can do either in your browser, or with a config.json downloaded from Box - to use JWT authentication. `rclone config` walks you through it. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Box  "box" [snip] Storage> box Box App Client Id - leave blank -normally. client_id> Box App Client Secret - leave blank normally. -client_secret> Box App config.json location Leave blank normally. Enter -a string value. Press Enter for the default (""). box_config_file> Box -App Primary Access Token Leave blank normally. Enter a string value. -Press Enter for the default (""). access_token> - -Enter a string value. Press Enter for the default ("user"). Choose a -number from below, or type in your own value 1 / Rclone should act on -behalf of a user  "user" 2 / Rclone should act on behalf of a service -account  "enterprise" box_sub_type> Remote config Use auto config? * Say -Y if not sure * Say N if you are working on a remote or headless machine -y) Yes n) No y/n> y If your browser doesn't open automatically go to the -following link: http://127.0.0.1:53682/auth Log in and authorize rclone -for access Waiting for code... Got code -------------------- [remote] -client_id = client_secret = token = -{"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet browser available. - - Note that rclone runs a webserver on your local machine to collect the - token as returned from Box. This only runs from the moment it opens - your browser to the moment you get back the verification code. This - is on `http://127.0.0.1:53682/` and this it may require you to unblock - it temporarily if you are running a host firewall. - - Once configured you can then use `rclone` like this, - - List directories in top level of your Box - - rclone lsd remote: - - List all the files in your Box - - rclone ls remote: - - To copy a local directory to an Box directory called backup - - rclone copy /home/source remote:backup - - ### Using rclone with an Enterprise account with SSO ### - - If you have an "Enterprise" account type with Box with single sign on - (SSO), you need to create a password to use Box with rclone. This can - be done at your Enterprise Box account by going to Settings, "Account" - Tab, and then set the password in the "Authentication" field. - - Once you have done this, you can setup your Enterprise Box account - using the same procedure detailed above in the, using the password you - have just set. - - ### Invalid refresh token ### - - According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): - - > Each refresh_token is valid for one use in 60 days. - - This means that if you - - * Don't use the box remote for 60 days - * Copy the config file with a box refresh token in and use it in two places - * Get an error on a token refresh - - then rclone will return an error which includes the text `Invalid - refresh token`. - - To fix this you will need to use oauth2 again to update the refresh - token. You can use the methods in [the remote setup - docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the - config file method, you should not use that remote on the computer you - did the authentication on. - - Here is how to do it. - -$ rclone config Current remotes: - -Name Type ==== ==== remote box - -e) Edit existing remote -f) New remote -g) Delete remote -h) Rename remote -i) Copy remote -j) Set configuration password -k) Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in - an existing value 1 > remote remote> remote -------------------- - [remote] type = box token = - {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} - -------------------- Edit remote Value "client_id" = "" Edit? (y/n)> -l) Yes -m) No y/n> n Value "client_secret" = "" Edit? (y/n)> -n) Yes -o) No y/n> n Remote config Already have a token - refresh? -p) Yes -q) No y/n> y Use auto config? - -- Say Y if not sure -- Say N if you are working on a remote or headless machine - -y) Yes -z) No y/n> y If your browser doesn't open automatically go to the - following link: http://127.0.0.1:53682/auth Log in and authorize - rclone for access Waiting for code... Got code -------------------- - [remote] type = box token = - {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} + 1 / 1Fichier + \ "fichier" + 2 / Alias for an existing remote + \ "alias" + 3 / Amazon Drive + \ "amazon cloud drive" + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + \ "s3" + [snip] + Storage> s3 + +4. Select TencentCOS provider. + + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + [snip] + 11 / Tencent Cloud Object Storage (COS) + \ "TencentCOS" + [snip] + provider> TencentCOS + +5. Enter your SecretId and SecretKey of Tencent Cloud. + + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + Only applies if access_key_id and secret_access_key is blank. + Enter a boolean value (true or false). Press Enter for the default ("false"). + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID. + Leave blank for anonymous access or runtime credentials. + Enter a string value. Press Enter for the default (""). + access_key_id> AKIDxxxxxxxxxx + AWS Secret Access Key (password) + Leave blank for anonymous access or runtime credentials. + Enter a string value. Press Enter for the default (""). + secret_access_key> xxxxxxxxxxx + +6. Select endpoint for Tencent COS. This is the standard endpoint for + different region. + + 1 / Beijing Region. + \ "cos.ap-beijing.myqcloud.com" + 2 / Nanjing Region. + \ "cos.ap-nanjing.myqcloud.com" + 3 / Shanghai Region. + \ "cos.ap-shanghai.myqcloud.com" + 4 / Guangzhou Region. + \ "cos.ap-guangzhou.myqcloud.com" + [snip] + endpoint> 4 + +7. Choose acl and storage class. + + Note that this ACL is applied when server-side copying objects as S3 + doesn't copy the ACL from the source but rather writes a fresh one. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Owner gets Full_CONTROL. No one else has access rights (default). + \ "default" + [snip] + acl> 1 + The storage class to use when storing new objects in Tencent COS. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Default + \ "" + [snip] + storage_class> 1 + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> n + Remote config -------------------- -a) Yes this is OK -b) Edit this remote -c) Delete this remote y/e/d> y + [cos] + type = s3 + provider = TencentCOS + env_auth = false + access_key_id = xxx + secret_access_key = xxx + endpoint = cos.ap-guangzhou.myqcloud.com + acl = default + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y + Current remotes: + + Name Type + ==== ==== + cos s3 + +Netease NOS + +For Netease NOS configure as per the configurator rclone config setting +the provider Netease. This will automatically set +force_path_style = false which is necessary for it to run properly. + +Limitations + +rclone about is not supported by the S3 backend. Backends without this +capability cannot determine free space for an rclone mount or use policy +mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about - ### Modified time and hashes ### +Backblaze B2 - Box allows modification times to be set on objects accurate to 1 - second. These will be used to detect whether objects need syncing or - not. +B2 is Backblaze's cloud storage system. - Box supports SHA1 type hashes, so you can use the `--checksum` - flag. +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, e.g. remote:bucket/path/to/dir. - #### Restricted filename characters +Here is an example of making a b2 configuration. First run - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: + rclone config - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | +This will guide you through an interactive setup process. To +authenticate you will either need your Account ID (a short hex number) +and Master Application Key (a long hex number) OR an Application Key, +which is the recommended method. See below for further details on +generating and using an Application Key. - File names can also not end with the following characters. - These only get replaced if they are the last character in the name: + No remotes found - make a new one + n) New remote + q) Quit config + n/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Backblaze B2 + \ "b2" + [snip] + Storage> b2 + Account ID or Application Key ID + account> 123456789abc + Application Key + key> 0123456789abcdef0123456789abcdef0123456789 + Endpoint for the service - leave blank normally. + endpoint> + Remote config + -------------------- + [remote] + account = 123456789abc + key = 0123456789abcdef0123456789abcdef0123456789 + endpoint = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | +This remote is called remote and can now be used like this - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. +See all buckets - ### Transfers ### + rclone lsd remote: - For files above 50MB rclone will use a chunked transfer. Rclone will - upload up to `--transfers` chunks at the same time (shared among all - the multipart uploads). Chunks are buffered in memory and are - normally 8MB so increasing `--transfers` will increase memory use. +Create a new bucket - ### Deleting files ### + rclone mkdir remote:bucket - Depending on the enterprise settings for your user, the item will - either be actually deleted from Box or moved to the trash. +List the contents of a bucket - Emptying the trash is supported via the rclone however cleanup command - however this deletes every trashed file and folder individually so it - may take a very long time. - Emptying the trash via the WebUI does not have this limitation - so it is advised to empty the trash via the WebUI. + rclone ls remote:bucket - ### Root folder ID ### +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. - You can set the `root_folder_id` for rclone. This is the directory - (identified by its `Folder ID`) that rclone considers to be the root - of your Box drive. + rclone sync -i /home/local/directory remote:bucket - Normally you will leave this blank and rclone will determine the - correct root to use itself. +Application Keys - However you can set this to restrict rclone to a specific folder - hierarchy. +B2 supports multiple Application Keys for different access permission to +B2 Buckets. - In order to do this you will have to find the `Folder ID` of the - directory you wish rclone to display. This will be the last segment - of the URL when you open the relevant folder in the Box web - interface. +You can use these with rclone too; you will need to use rclone version +1.43 or later. - So if the folder you want rclone to use has a URL which looks like - `https://app.box.com/folder/11xxxxxxxxx8` - in the browser, then you use `11xxxxxxxxx8` as - the `root_folder_id` in the config. +Follow Backblaze's docs to create an Application Key with the required +permission and add the applicationKeyId as the account and the +Application Key itself as the key. + +Note that you must put the _applicationKeyId_ as the account – you can't +use the master Account ID. If you try then B2 will return 401 errors. + +--fast-list + +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. + +Modified time + +The modified time is stored as metadata on the object as +X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in +the Backblaze standard. Other tools should be able to use this as a +modified time. + +Modified times are used in syncing and are fully supported. Note that if +a modification time needs to be updated on an object then it will create +a new version of the object. + +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. + +Note that in 2020-05 Backblaze started allowing  characters in file +names. Rclone hasn't changed its encoding as this could cause syncs to +re-transfer files. If you want rclone not to replace  then see the +--b2-encoding flag below and remove the BackSlash from the string. This +can be set in the config. + +SHA1 checksums + +The SHA1 checksums of the files are checked on upload and download and +will be used in the syncing process. + +Large files (bigger than the limit in --b2-upload-cutoff) which are +uploaded in chunks will store their SHA1 on the object as +X-Bz-Info-large_file_sha1 as recommended by Backblaze. + +For a large file to be uploaded with an SHA1 checksum, the source needs +to support SHA1 checksums. The local disk supports SHA1 checksums so +large file transfers from local disk will have an SHA1. See the overview +for exactly which remotes support SHA1. + +Sources which don't support SHA1, in particular crypt will upload large +files without SHA1 checksums. This may be fixed in the future (see +#1767). + +Files sizes below --b2-upload-cutoff will always have an SHA1 regardless +of the source. + +Transfers + +Backblaze recommends that you do lots of transfers simultaneously for +maximum speed. In tests from my SSD equipped laptop the optimum setting +is about --transfers 32 though higher numbers may be used for a slight +speed improvement. The optimum number for you may vary depending on your +hardware, how big the files are, how much you want to load your +computer, etc. The default of --transfers 4 is definitely too low for +Backblaze B2 though. + +Note that uploading big files (bigger than 200 MB by default) will use a +96 MB RAM buffer by default. There can be at most --transfers of these +in use at any moment, so this sets the upper limit on the memory used. + +Versions + +When rclone uploads a new version of a file it creates a new version of +it. Likewise when you delete a file, the old version will be marked +hidden and still be available. Conversely, you may opt in to a "hard +delete" of files with the --b2-hard-delete flag which would permanently +remove the file instead of hiding it. + +Old versions of files, where available, are visible using the +--b2-versions flag. + +NB Note that --b2-versions does not work with crypt at the moment #1627. +Using --backup-dir with rclone is the recommended way of working around +this. + +If you wish to remove all the old versions then you can use the +rclone cleanup remote:bucket command which will delete all the old +versions of files, leaving the current ones intact. You can also supply +a path and only old versions under that path will be deleted, e.g. +rclone cleanup remote:bucket/path/to/stuff. + +Note that cleanup will remove partially uploaded files from the bucket +if they are more than a day old. + +When you purge a bucket, the current and the old versions will be +deleted then the bucket will be deleted. + +However delete will cause the current versions of the files to become +hidden old versions. + +Here is a session showing the listing and retrieval of an old version +followed by a cleanup of the old versions. + +Show current version and all the versions with --b2-versions flag. + + $ rclone -q ls b2:cleanup-test + 9 one.txt + + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt + 8 one-v2016-07-04-141032-000.txt + 16 one-v2016-07-04-141003-000.txt + 15 one-v2016-07-02-155621-000.txt + +Retrieve an old version + + $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp + + $ ls -l /tmp/one-v2016-07-04-141003-000.txt + -rw-rw-r-- 1 ncw ncw 16 Jul 2 17:46 /tmp/one-v2016-07-04-141003-000.txt + +Clean up all the old versions and show that they've gone. + + $ rclone -q cleanup b2:cleanup-test + + $ rclone -q ls b2:cleanup-test + 9 one.txt + + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt + +Data usage + +It is useful to know how many requests are sent to the server in +different scenarios. + +All copy commands send the following 4 requests: + + /b2api/v1/b2_authorize_account + /b2api/v1/b2_create_bucket + /b2api/v1/b2_list_buckets + /b2api/v1/b2_list_file_names + +The b2_list_file_names request will be sent once for every 1k files in +the remote path, providing the checksum and modification time of the +listed files. As of version 1.33 issue #818 causes extra requests to be +sent when using B2 with Crypt. When a copy operation does not require +any files to be uploaded, no more requests will be sent. + +Uploading files that do not require chunking, will send 2 requests per +file upload: + + /b2api/v1/b2_get_upload_url + /b2api/v1/b2_upload_file/ + +Uploading files requiring chunking, will send 2 requests (one each to +start and finish the upload) and another 2 requests for each chunk: + + /b2api/v1/b2_start_large_file + /b2api/v1/b2_get_upload_part_url + /b2api/v1/b2_upload_part/ + /b2api/v1/b2_finish_large_file + +Versions + +Versions can be viewed with the --b2-versions flag. When it is set +rclone will show and act on older versions of files. For example + +Listing without --b2-versions + + $ rclone -q ls b2:cleanup-test + 9 one.txt + +And with + + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt + 8 one-v2016-07-04-141032-000.txt + 16 one-v2016-07-04-141003-000.txt + 15 one-v2016-07-02-155621-000.txt + +Showing that the current version is unchanged but older versions can be +seen. These have the UTC date that they were uploaded to the server to +the nearest millisecond appended to them. + +Note that when using --b2-versions no file write operations are +permitted, so you can't upload files or delete them. + +B2 and rclone link + +Rclone supports generating file share links for private B2 buckets. They +can either be for a file for example: + + ./rclone link B2:bucket/path/to/file.txt + https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx + +or if run on a directory you will get: + + ./rclone link B2:bucket/path + https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx + +you can then use the authorization token (the part of the url from the +?Authorization= on) on any file path under that directory. For example: + + https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx + https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx + https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx + +Standard Options + +Here are the standard options specific to b2 (Backblaze B2). + +--b2-account + +Account ID or Application Key ID + +- Config: account +- Env Var: RCLONE_B2_ACCOUNT +- Type: string +- Default: "" + +--b2-key + +Application Key + +- Config: key +- Env Var: RCLONE_B2_KEY +- Type: string +- Default: "" + +--b2-hard-delete + +Permanently delete files on remote removal, otherwise hide files. + +- Config: hard_delete +- Env Var: RCLONE_B2_HARD_DELETE +- Type: bool +- Default: false + +Advanced Options + +Here are the advanced options specific to b2 (Backblaze B2). + +--b2-endpoint + +Endpoint for the service. Leave blank normally. + +- Config: endpoint +- Env Var: RCLONE_B2_ENDPOINT +- Type: string +- Default: "" + +--b2-test-mode + +A flag string for X-Bz-Test-Mode header for debugging. + +This is for debugging purposes only. Setting it to one of the strings +below will cause b2 to return specific errors: + +- "fail_some_uploads" +- "expire_some_account_authorization_tokens" +- "force_cap_exceeded" + +These will be set in the "X-Bz-Test-Mode" header which is documented in +the b2 integrations checklist. + +- Config: test_mode +- Env Var: RCLONE_B2_TEST_MODE +- Type: string +- Default: "" + +--b2-versions + +Include old versions in directory listings. Note that when using this no +file write operations are permitted, so you can't upload files or delete +them. + +- Config: versions +- Env Var: RCLONE_B2_VERSIONS +- Type: bool +- Default: false + +--b2-upload-cutoff + +Cutoff for switching to chunked upload. + +Files above this size will be uploaded in chunks of "--b2-chunk-size". + +This value should be set no larger than 4.657GiB (== 5GB). + +- Config: upload_cutoff +- Env Var: RCLONE_B2_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 200M + +--b2-copy-cutoff + +Cutoff for switching to multipart copy + +Any files larger than this that need to be server-side copied will be +copied in chunks of this size. + +The minimum is 0 and the maximum is 4.6GB. + +- Config: copy_cutoff +- Env Var: RCLONE_B2_COPY_CUTOFF +- Type: SizeSuffix +- Default: 4G + +--b2-chunk-size + +Upload chunk size. Must fit in memory. + +When uploading large files, chunk the file into this size. Note that +these chunks are buffered in memory and there might a maximum of +"--transfers" chunks in progress at once. 5,000,000 Bytes is the minimum +size. + +- Config: chunk_size +- Env Var: RCLONE_B2_CHUNK_SIZE +- Type: SizeSuffix +- Default: 96M + +--b2-disable-checksum + +Disable checksums for large (> upload cutoff) files + +Normally rclone will calculate the SHA1 checksum of the input before +uploading it so it can add it to metadata on the object. This is great +for data integrity checking but can cause long delays for large files to +start uploading. + +- Config: disable_checksum +- Env Var: RCLONE_B2_DISABLE_CHECKSUM +- Type: bool +- Default: false + +--b2-download-url + +Custom endpoint for downloads. + +This is usually set to a Cloudflare CDN URL as Backblaze offers free +egress for data downloaded through the Cloudflare network. Rclone works +with private buckets by sending an "Authorization" header. If the custom +endpoint rewrites the requests for authentication, e.g., in Cloudflare +Workers, this header needs to be handled properly. Leave blank if you +want to use the endpoint provided by Backblaze. + +- Config: download_url +- Env Var: RCLONE_B2_DOWNLOAD_URL +- Type: string +- Default: "" + +--b2-download-auth-duration + +Time before the authorization token will expire in s or suffix +ms|s|m|h|d. + +The duration before the download authorization token will expire. The +minimum value is 1 second. The maximum value is one week. + +- Config: download_auth_duration +- Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION +- Type: Duration +- Default: 1w + +--b2-memory-pool-flush-time + +How often internal memory buffer pools will be flushed. Uploads which +requires additional buffers (f.e multipart) will use memory pool for +allocations. This option controls how often unused buffers will be +removed from the pool. + +- Config: memory_pool_flush_time +- Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME +- Type: Duration +- Default: 1m0s + +--b2-memory-pool-use-mmap + +Whether to use mmap buffers in internal memory pool. + +- Config: memory_pool_use_mmap +- Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP +- Type: bool +- Default: false + +--b2-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_B2_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + +Limitations + +rclone about is not supported by the B2 backend. Backends without this +capability cannot determine free space for an rclone mount or use policy +mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about - ### Standard Options +Box - Here are the standard options specific to box (Box). +Paths are specified as remote:path - #### --box-client-id +Paths may be as deep as required, e.g. remote:directory/subdirectory. - OAuth Client Id - Leave blank normally. +The initial setup for Box involves getting a token from Box which you +can do either in your browser, or with a config.json downloaded from Box +to use JWT authentication. rclone config walks you through it. - - Config: client_id - - Env Var: RCLONE_BOX_CLIENT_ID - - Type: string - - Default: "" +Here is an example of how to make a remote called remote. First run: - #### --box-client-secret + rclone config - OAuth Client Secret - Leave blank normally. - - - Config: client_secret - - Env Var: RCLONE_BOX_CLIENT_SECRET - - Type: string - - Default: "" - - #### --box-box-config-file +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Box + \ "box" + [snip] + Storage> box + Box App Client Id - leave blank normally. + client_id> + Box App Client Secret - leave blank normally. + client_secret> Box App config.json location Leave blank normally. - - Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. - - - - Config: box_config_file - - Env Var: RCLONE_BOX_BOX_CONFIG_FILE - - Type: string - - Default: "" - - #### --box-access-token - + Enter a string value. Press Enter for the default (""). + box_config_file> Box App Primary Access Token Leave blank normally. + Enter a string value. Press Enter for the default (""). + access_token> + + Enter a string value. Press Enter for the default ("user"). + Choose a number from below, or type in your own value + 1 / Rclone should act on behalf of a user + \ "user" + 2 / Rclone should act on behalf of a service account + \ "enterprise" + box_sub_type> + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + client_id = + client_secret = + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs for how to set it up on a machine with no +Internet browser available. + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Box. This only runs from the moment it opens your +browser to the moment you get back the verification code. This is on +http://127.0.0.1:53682/ and this it may require you to unblock it +temporarily if you are running a host firewall. + +Once configured you can then use rclone like this, + +List directories in top level of your Box + + rclone lsd remote: + +List all the files in your Box + + rclone ls remote: + +To copy a local directory to an Box directory called backup + + rclone copy /home/source remote:backup + +Using rclone with an Enterprise account with SSO + +If you have an "Enterprise" account type with Box with single sign on +(SSO), you need to create a password to use Box with rclone. This can be +done at your Enterprise Box account by going to Settings, "Account" Tab, +and then set the password in the "Authentication" field. + +Once you have done this, you can setup your Enterprise Box account using +the same procedure detailed above in the, using the password you have +just set. + +Invalid refresh token + +According to the box docs: + + Each refresh_token is valid for one use in 60 days. + +This means that if you + +- Don't use the box remote for 60 days +- Copy the config file with a box refresh token in and use it in two + places +- Get an error on a token refresh + +then rclone will return an error which includes the text +Invalid refresh token. + +To fix this you will need to use oauth2 again to update the refresh +token. You can use the methods in the remote setup docs, bearing in mind +that if you use the copy the config file method, you should not use that +remote on the computer you did the authentication on. + +Here is how to do it. + + $ rclone config + Current remotes: + + Name Type + ==== ==== + remote box + + e) Edit existing remote + n) New remote + d) Delete remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + e/n/d/r/c/s/q> e + Choose a number from below, or type in an existing value + 1 > remote + remote> remote + -------------------- + [remote] + type = box + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"} + -------------------- + Edit remote + Value "client_id" = "" + Edit? (y/n)> + y) Yes + n) No + y/n> n + Value "client_secret" = "" + Edit? (y/n)> + y) Yes + n) No + y/n> n + Remote config + Already have a token - refresh? + y) Yes + n) No + y/n> y + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = box + token = {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: access_token - - Env Var: RCLONE_BOX_ACCESS_TOKEN - - Type: string - - Default: "" +Modified time and hashes - #### --box-box-sub-type +Box allows modification times to be set on objects accurate to 1 second. +These will be used to detect whether objects need syncing or not. +Box supports SHA1 type hashes, so you can use the --checksum flag. +Restricted filename characters - - Config: box_sub_type - - Env Var: RCLONE_BOX_BOX_SUB_TYPE - - Type: string - - Default: "user" - - Examples: - - "user" - - Rclone should act on behalf of a user - - "enterprise" - - Rclone should act on behalf of a service account +In addition to the default restricted characters set the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + +File names can also not end with the following characters. These only +get replaced if they are the last character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. + +Transfers + +For files above 50MB rclone will use a chunked transfer. Rclone will +upload up to --transfers chunks at the same time (shared among all the +multipart uploads). Chunks are buffered in memory and are normally 8MB +so increasing --transfers will increase memory use. + +Deleting files + +Depending on the enterprise settings for your user, the item will either +be actually deleted from Box or moved to the trash. + +Emptying the trash is supported via the rclone however cleanup command +however this deletes every trashed file and folder individually so it +may take a very long time. Emptying the trash via the WebUI does not +have this limitation so it is advised to empty the trash via the WebUI. + +Root folder ID + +You can set the root_folder_id for rclone. This is the directory +(identified by its Folder ID) that rclone considers to be the root of +your Box drive. + +Normally you will leave this blank and rclone will determine the correct +root to use itself. - ### Advanced Options +However you can set this to restrict rclone to a specific folder +hierarchy. - Here are the advanced options specific to box (Box). +In order to do this you will have to find the Folder ID of the directory +you wish rclone to display. This will be the last segment of the URL +when you open the relevant folder in the Box web interface. - #### --box-token +So if the folder you want rclone to use has a URL which looks like +https://app.box.com/folder/11xxxxxxxxx8 in the browser, then you use +11xxxxxxxxx8 as the root_folder_id in the config. - OAuth Access Token as a JSON blob. +Standard Options - - Config: token - - Env Var: RCLONE_BOX_TOKEN - - Type: string - - Default: "" +Here are the standard options specific to box (Box). - #### --box-auth-url +--box-client-id - Auth server URL. - Leave blank to use the provider defaults. +OAuth Client Id Leave blank normally. - - Config: auth_url - - Env Var: RCLONE_BOX_AUTH_URL - - Type: string - - Default: "" +- Config: client_id +- Env Var: RCLONE_BOX_CLIENT_ID +- Type: string +- Default: "" - #### --box-token-url +--box-client-secret - Token server url. - Leave blank to use the provider defaults. +OAuth Client Secret Leave blank normally. - - Config: token_url - - Env Var: RCLONE_BOX_TOKEN_URL - - Type: string - - Default: "" +- Config: client_secret +- Env Var: RCLONE_BOX_CLIENT_SECRET +- Type: string +- Default: "" - #### --box-root-folder-id +--box-box-config-file - Fill in for rclone to use a non root folder as its starting point. +Box App config.json location Leave blank normally. - - Config: root_folder_id - - Env Var: RCLONE_BOX_ROOT_FOLDER_ID - - Type: string - - Default: "0" +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. - #### --box-upload-cutoff +- Config: box_config_file +- Env Var: RCLONE_BOX_BOX_CONFIG_FILE +- Type: string +- Default: "" - Cutoff for switching to multipart upload (>= 50MB). +--box-access-token - - Config: upload_cutoff - - Env Var: RCLONE_BOX_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 50M +Box App Primary Access Token Leave blank normally. - #### --box-commit-retries +- Config: access_token +- Env Var: RCLONE_BOX_ACCESS_TOKEN +- Type: string +- Default: "" - Max number of times to try committing a multipart file. +--box-box-sub-type - - Config: commit_retries - - Env Var: RCLONE_BOX_COMMIT_RETRIES - - Type: int - - Default: 100 +- Config: box_sub_type +- Env Var: RCLONE_BOX_BOX_SUB_TYPE +- Type: string +- Default: "user" +- Examples: + - "user" + - Rclone should act on behalf of a user + - "enterprise" + - Rclone should act on behalf of a service account - #### --box-encoding +Advanced Options - This sets the encoding for the backend. +Here are the advanced options specific to box (Box). - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +--box-token - - Config: encoding - - Env Var: RCLONE_BOX_ENCODING - - Type: MultiEncoder - - Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot +OAuth Access Token as a JSON blob. +- Config: token +- Env Var: RCLONE_BOX_TOKEN +- Type: string +- Default: "" +--box-auth-url - ### Limitations ### +Auth server URL. Leave blank to use the provider defaults. - Note that Box is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". +- Config: auth_url +- Env Var: RCLONE_BOX_AUTH_URL +- Type: string +- Default: "" - Box file names can't have the `\` character in. rclone maps this to - and from an identical looking unicode equivalent `＼`. +--box-token-url - Box only supports filenames up to 255 characters in length. +Token server url. Leave blank to use the provider defaults. - Cache (BETA) - ----------------------------------------- +- Config: token_url +- Env Var: RCLONE_BOX_TOKEN_URL +- Type: string +- Default: "" - The `cache` remote wraps another existing remote and stores file structure - and its data for long running tasks like `rclone mount`. +--box-root-folder-id - ## Status +Fill in for rclone to use a non root folder as its starting point. - The cache backend code is working but it currently doesn't - have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren't getting fixed. +- Config: root_folder_id +- Env Var: RCLONE_BOX_ROOT_FOLDER_ID +- Type: string +- Default: "0" - The cache backend is due to be phased out in favour of the VFS caching - layer eventually which is more tightly integrated into rclone. +--box-upload-cutoff - Until this happens we recommend only using the cache backend if you - find you can't work without it. There are many docs online describing - the use of the cache backend to minimize API hits and by-and-large - these are out of date and the cache backend isn't needed in those - scenarios any more. +Cutoff for switching to multipart upload (>= 50MB). - ## Setup +- Config: upload_cutoff +- Env Var: RCLONE_BOX_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 50M - To get started you just need to have an existing remote which can be configured - with `cache`. +--box-commit-retries - Here is an example of how to make a remote called `test-cache`. First run: +Max number of times to try committing a multipart file. - rclone config +- Config: commit_retries +- Env Var: RCLONE_BOX_COMMIT_RETRIES +- Type: int +- Default: 100 - This will guide you through an interactive setup process: +--box-encoding -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -test-cache Type of storage to configure. Choose a number from below, or -type in your own value [snip] XX / Cache a remote  "cache" [snip] -Storage> cache Remote to cache. Normally should contain a ':' and a -path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" -(not recommended). remote> local:/test Optional: The URL of the Plex -server plex_url> http://127.0.0.1:32400 Optional: The username of the -Plex user plex_username> dummyusername Optional: The password of the -Plex user y) Yes type in my own password g) Generate random password n) -No leave this optional password blank y/g/n> y Enter the password: -password: Confirm the password: password: The size of a chunk. Lower -value good for slow connections but can affect seamless reading. -Default: 5M Choose a number from below, or type in your own value 1 / -1MB  "1m" 2 / 5 MB  "5M" 3 / 10 MB  "10M" chunk_size> 2 How much time -should object info (file size, file hashes etc) be stored in cache. Use -a very high value if you don't plan on changing the source FS from -outside the cache. Accepted units are: "s", "m", "h". Default: 5m Choose -a number from below, or type in your own value 1 / 1 hour  "1h" 2 / 24 -hours  "24h" 3 / 24 hours  "48h" info_age> 2 The maximum size of stored -chunks. When the storage grows beyond this size, the oldest chunks will -be deleted. Default: 10G Choose a number from below, or type in your own -value 1 / 500 MB  "500M" 2 / 1 GB  "1G" 3 / 10 GB  "10G" -chunk_total_size> 3 Remote config -------------------- [test-cache] -remote = local:/test plex_url = http://127.0.0.1:32400 plex_username = -dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age -= 48h chunk_total_size = 10G +This sets the encoding for the backend. +See: the encoding section in the overview for more info. - You can then use it like this, +- Config: encoding +- Env Var: RCLONE_BOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot - List directories in top level of your drive +Limitations - rclone lsd test-cache: +Note that Box is case insensitive so you can't have a file called +"Hello.doc" and one called "hello.doc". - List all the files in your drive +Box file names can't have the \ character in. rclone maps this to and +from an identical looking unicode equivalent ＼ (U+FF3C Fullwidth +Reverse Solidus). - rclone ls test-cache: +Box only supports filenames up to 255 characters in length. - To start a cached mount +rclone about is not supported by the Box backend. Backends without this +capability cannot determine free space for an rclone mount or use policy +mfs (most free space) as a member of an rclone union remote. - rclone mount --allow-other test-cache: /var/tmp/test-cache +See List of backends that do not support rclone about See rclone about - ### Write Features ### - ### Offline uploading ### +Cache (BETA) - 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`. +The cache remote wraps another existing remote and stores file structure +and its data for long running tasks like rclone mount. - 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) +Status - 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. +The cache backend code is working but it currently doesn't have a +maintainer so there are outstanding bugs which aren't getting fixed. - ### Write Support ### +The cache backend is due to be phased out in favour of the VFS caching +layer eventually which is more tightly integrated into rclone. - 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. +Until this happens we recommend only using the cache backend if you find +you can't work without it. There are many docs online describing the use +of the cache backend to minimize API hits and by-and-large these are out +of date and the cache backend isn't needed in those scenarios any more. - 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 ### +Setup - #### Multiple connections #### +To get started you just need to have an existing remote which can be +configured with cache. - 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. +Here is an example of how to make a remote called test-cache. First run: - 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. + rclone config - #### Plex Integration #### - - There is a direct integration with Plex which allows cache to detect during reading - if the file is in playback or not. This helps cache to adapt how it queries - the cloud provider depending on what is needed for. - - Scans will have a minimum amount of workers (1) while in a confirmed playback cache - will deploy the configured number of workers. - - This integration opens the doorway to additional performance improvements - which will be explored in the near future. - - **Note:** If Plex options are not configured, `cache` will function with its - configured options without adapting any of its settings. - - How to enable? Run `rclone config` and add all the Plex options (endpoint, username - and password) in your remote and it will be automatically enabled. - - Affected settings: - - `cache-workers`: _Configured value_ during confirmed playback or _1_ all the other times - - ##### Certificate Validation ##### - - When the Plex server is configured to only accept secure connections, it is - possible to use `.plex.direct` URLs to ensure certificate validation succeeds. - These URLs are used by Plex internally to connect to the Plex server securely. - - The format for these URLs is the following: - - https://ip-with-dots-replaced.server-hash.plex.direct:32400/ - - The `ip-with-dots-replaced` part can be any IPv4 address, where the dots - have been replaced with dashes, e.g. `127.0.0.1` becomes `127-0-0-1`. - - To get the `server-hash` part, the easiest way is to visit - - https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token - - This page will list all the available Plex servers for your account - with at least one `.plex.direct` link for each. Copy one URL and replace - the IP address with the desired address. This can be used as the - `plex_url` value. - - ### Known issues ### - - #### Mount and --dir-cache-time #### - - --dir-cache-time controls the first layer of directory caching which works at the mount layer. - Being an independent caching mechanism from the `cache` backend, it will manage its own entries - based on the configured time. - - To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct - one, try to set `--dir-cache-time` to a lower time than `--cache-info-age`. Default values are - already configured in this way. - - #### Windows support - Experimental #### - - There are a couple of issues with Windows `mount` functionality that still require some investigations. - It should be considered as experimental thus far as fixes come in for this OS. - - Most of the issues seem to be related to the difference between filesystems - on Linux flavors and Windows as cache is heavily dependent on them. - - Any reports or feedback on how cache behaves on this OS is greatly appreciated. - - - https://github.com/rclone/rclone/issues/1935 - - https://github.com/rclone/rclone/issues/1907 - - https://github.com/rclone/rclone/issues/1834 - - #### Risk of throttling #### - - Future iterations of the cache backend will make use of the pooling functionality - of the cloud provider to synchronize and at the same time make writing through it - more tolerant to failures. - - There are a couple of enhancements in track to add these but in the meantime - there is a valid concern that the expiring cache listings can lead to cloud provider - throttles or bans due to repeated queries on it for very large mounts. - - Some recommendations: - - don't use a very small interval for entry information (`--cache-info-age`) - - while writes aren't yet optimised, you can still write through `cache` which gives you the advantage - of adding the file in the cache at the same time if configured to do so. - - Future enhancements: - - - https://github.com/rclone/rclone/issues/1937 - - https://github.com/rclone/rclone/issues/1936 - - #### cache and crypt #### - - One common scenario is to keep your data encrypted in the cloud provider - using the `crypt` remote. `crypt` uses a similar technique to wrap around - an existing remote and handles this translation in a seamless way. - - There is an issue with wrapping the remotes in this order: - **cloud remote** -> **crypt** -> **cache** - - During testing, I experienced a lot of bans with the remotes in this order. - I suspect it might be related to how crypt opens files on the cloud provider - which makes it think we're downloading the full file instead of small chunks. - Organizing the remotes in this order yields better results: - **cloud remote** -> **cache** -> **crypt** - - #### absolute remote paths #### - - `cache` can not differentiate between relative and absolute paths for the wrapped remote. - Any path given in the `remote` config setting and on the command line will be passed to - the wrapped remote as is, but for storing the chunks on disk the path will be made - relative by removing any leading `/` character. - - This behavior is irrelevant for most backend types, but there are backends where a leading `/` - changes the effective directory, e.g. in the `sftp` backend paths starting with a `/` are - relative to the root of the SSH server and paths without are relative to the user home directory. - As a result `sftp:bin` and `sftp:/bin` will share the same cache folder, even if they represent - a different directory on the SSH server. - - ### Cache and Remote Control (--rc) ### - Cache supports the new `--rc` mode in rclone and can be remote controlled through the following end points: - By default, the listener is disabled if you do not add the flag. - - ### rc cache/expire - Purge a remote from the cache backend. Supports either a directory or a file. - It supports both encrypted and unencrypted file names if cache is wrapped by crypt. - - Params: - - **remote** = path to remote **(required)** - - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - - - ### Standard Options - - Here are the standard options specific to cache (Cache a remote). - - #### --cache-remote +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> test-cache + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Cache a remote + \ "cache" + [snip] + Storage> cache Remote to cache. - Normally should contain a ':' and a path, eg "myremote:path/to/dir", + Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). + remote> local:/test + Optional: The URL of the Plex server + plex_url> http://127.0.0.1:32400 + Optional: The username of the Plex user + plex_username> dummyusername + Optional: The password of the Plex user + y) Yes type in my own password + g) Generate random password + n) No leave this optional password blank + y/g/n> y + Enter the password: + password: + Confirm the password: + password: + The size of a chunk. Lower value good for slow connections but can affect seamless reading. + Default: 5M + Choose a number from below, or type in your own value + 1 / 1MB + \ "1m" + 2 / 5 MB + \ "5M" + 3 / 10 MB + \ "10M" + chunk_size> 2 + How much time should object info (file size, file hashes, etc.) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. + Accepted units are: "s", "m", "h". + Default: 5m + Choose a number from below, or type in your own value + 1 / 1 hour + \ "1h" + 2 / 24 hours + \ "24h" + 3 / 24 hours + \ "48h" + info_age> 2 + The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. + Default: 10G + Choose a number from below, or type in your own value + 1 / 500 MB + \ "500M" + 2 / 1 GB + \ "1G" + 3 / 10 GB + \ "10G" + chunk_total_size> 3 + Remote config + -------------------- + [test-cache] + remote = local:/test + plex_url = http://127.0.0.1:32400 + plex_username = dummyusername + plex_password = *** ENCRYPTED *** + chunk_size = 5M + info_age = 48h + chunk_total_size = 10G + +You can then use it like this, + +List directories in top level of your drive + + rclone lsd test-cache: + +List all the files in your drive + + rclone ls test-cache: + +To start a cached mount + + rclone mount --allow-other test-cache: /var/tmp/test-cache + +Write Features + +Offline uploading + +In an effort to make writing through cache more reliable, the backend +now supports this feature which can be activated by specifying a +cache-tmp-upload-path. + +A files goes through these states when using this feature: + +1. An upload is started (usually by copying a file on the cache remote) +2. When the copy to the temporary location is complete the file is part + of the cached remote and looks and behaves like any other file + (reading included) +3. After cache-tmp-wait-time passes and the file is next in line, + rclone move is used to move the file to the cloud provider +4. Reading the file still works during the upload but most + modifications on it will be prohibited +5. Once the move is complete the file is unlocked for modifications as + it becomes as any other regular file +6. If the file is being read through cache when it's actually deleted + from the temporary path then cache will simply swap the source to + the cloud provider without interrupting the reading (small blip can + happen though) + +Files are uploaded in sequence and only one file is uploaded at a time. +Uploads will be stored in a queue and be processed based on the order +they were added. The queue and the temporary storage is persistent +across restarts but can be cleared on startup with the --cache-db-purge +flag. + +Write Support + +Writes are supported through cache. One caveat is that a mounted cache +remote does not add any retry or fallback mechanism to the upload +operation. This will depend on the implementation of the wrapped remote. +Consider using Offline uploading for reliable writes. + +One special case is covered with cache-writes which will cache the file +data at the same time as the upload when it is enabled making it +available from the cache store immediately once the upload is finished. + +Read Features + +Multiple connections + +To counter the high latency between a local PC where rclone is running +and cloud providers, the cache remote can split multiple requests to the +cloud provider for smaller file chunks and combines them together +locally where they can be available almost immediately before the reader +usually needs them. - - Config: remote - - Env Var: RCLONE_CACHE_REMOTE - - Type: string - - Default: "" +This is similar to buffering when media files are played online. Rclone +will stay around the current marker but always try its best to stay +ahead and prepare the data before. - #### --cache-plex-url +Plex Integration - The URL of the Plex server +There is a direct integration with Plex which allows cache to detect +during reading if the file is in playback or not. This helps cache to +adapt how it queries the cloud provider depending on what is needed for. - - Config: plex_url - - Env Var: RCLONE_CACHE_PLEX_URL - - Type: string - - Default: "" +Scans will have a minimum amount of workers (1) while in a confirmed +playback cache will deploy the configured number of workers. - #### --cache-plex-username +This integration opens the doorway to additional performance +improvements which will be explored in the near future. - The username of the Plex user +NOTE: If Plex options are not configured, cache will function with its +configured options without adapting any of its settings. - - Config: plex_username - - Env Var: RCLONE_CACHE_PLEX_USERNAME - - Type: string - - Default: "" +How to enable? Run rclone config and add all the Plex options (endpoint, +username and password) in your remote and it will be automatically +enabled. - #### --cache-plex-password +Affected settings: - cache-workers: _Configured value_ during confirmed +playback or _1_ all the other times - The password of the Plex user +Certificate Validation - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). +When the Plex server is configured to only accept secure connections, it +is possible to use .plex.direct URLs to ensure certificate validation +succeeds. These URLs are used by Plex internally to connect to the Plex +server securely. - - Config: plex_password - - Env Var: RCLONE_CACHE_PLEX_PASSWORD - - Type: string - - Default: "" +The format for these URLs is the following: - #### --cache-chunk-size +https://ip-with-dots-replaced.server-hash.plex.direct:32400/ - The size of a chunk (partial file data). +The ip-with-dots-replaced part can be any IPv4 address, where the dots +have been replaced with dashes, e.g. 127.0.0.1 becomes 127-0-0-1. - Use lower numbers for slower connections. If the chunk size is - changed, any downloaded chunks will be invalid and cache-chunk-path - will need to be cleared or unexpected EOF errors will occur. +To get the server-hash part, the easiest way is to visit - - Config: chunk_size - - Env Var: RCLONE_CACHE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 5M - - Examples: - - "1m" - - 1MB - - "5M" - - 5 MB - - "10M" - - 10 MB +https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token - #### --cache-info-age +This page will list all the available Plex servers for your account with +at least one .plex.direct link for each. Copy one URL and replace the IP +address with the desired address. This can be used as the plex_url +value. - How long to cache file structure information (directory listings, file size, times etc). - If all write operations are done through the cache then you can safely make - this value very large as the cache store will also be updated in real time. +Known issues - - Config: info_age - - Env Var: RCLONE_CACHE_INFO_AGE - - Type: Duration - - Default: 6h0m0s - - Examples: - - "1h" - - 1 hour - - "24h" - - 24 hours - - "48h" - - 48 hours +Mount and --dir-cache-time - #### --cache-chunk-total-size +--dir-cache-time controls the first layer of directory caching which +works at the mount layer. Being an independent caching mechanism from +the cache backend, it will manage its own entries based on the +configured time. - The total size that the chunks can take up on the local disk. +To avoid getting in a scenario where dir cache has obsolete data and +cache would have the correct one, try to set --dir-cache-time to a lower +time than --cache-info-age. Default values are already configured in +this way. - If the cache exceeds this value then it will start to delete the - oldest chunks until it goes under this value. +Windows support - Experimental - - Config: chunk_total_size - - Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE - - Type: SizeSuffix - - Default: 10G - - Examples: - - "500M" - - 500 MB - - "1G" - - 1 GB - - "10G" - - 10 GB +There are a couple of issues with Windows mount functionality that still +require some investigations. It should be considered as experimental +thus far as fixes come in for this OS. - ### Advanced Options +Most of the issues seem to be related to the difference between +filesystems on Linux flavors and Windows as cache is heavily dependent +on them. - Here are the advanced options specific to cache (Cache a remote). +Any reports or feedback on how cache behaves on this OS is greatly +appreciated. - #### --cache-plex-token +- https://github.com/rclone/rclone/issues/1935 +- https://github.com/rclone/rclone/issues/1907 +- https://github.com/rclone/rclone/issues/1834 - The plex token for authentication - auto set normally +Risk of throttling - - Config: plex_token - - Env Var: RCLONE_CACHE_PLEX_TOKEN - - Type: string - - Default: "" +Future iterations of the cache backend will make use of the pooling +functionality of the cloud provider to synchronize and at the same time +make writing through it more tolerant to failures. - #### --cache-plex-insecure +There are a couple of enhancements in track to add these but in the +meantime there is a valid concern that the expiring cache listings can +lead to cloud provider throttles or bans due to repeated queries on it +for very large mounts. - Skip all certificate verification when connecting to the Plex server +Some recommendations: - don't use a very small interval for entry +information (--cache-info-age) - while writes aren't yet optimised, you +can still write through cache which gives you the advantage of adding +the file in the cache at the same time if configured to do so. - - Config: plex_insecure - - Env Var: RCLONE_CACHE_PLEX_INSECURE - - Type: string - - Default: "" +Future enhancements: - #### --cache-db-path +- https://github.com/rclone/rclone/issues/1937 +- https://github.com/rclone/rclone/issues/1936 - Directory to store file structure metadata DB. - The remote name is used as the DB file name. +cache and crypt - - Config: db_path - - Env Var: RCLONE_CACHE_DB_PATH - - Type: string - - Default: "$HOME/.cache/rclone/cache-backend" +One common scenario is to keep your data encrypted in the cloud provider +using the crypt remote. crypt uses a similar technique to wrap around an +existing remote and handles this translation in a seamless way. - #### --cache-chunk-path +There is an issue with wrapping the remotes in this order: CLOUD REMOTE +-> CRYPT -> CACHE - Directory to cache chunk files. +During testing, I experienced a lot of bans with the remotes in this +order. I suspect it might be related to how crypt opens files on the +cloud provider which makes it think we're downloading the full file +instead of small chunks. Organizing the remotes in this order yields +better results: CLOUD REMOTE -> CACHE -> CRYPT - Path to where partial file data (chunks) are stored locally. The remote - name is appended to the final path. +absolute remote paths - This config follows the "--cache-db-path". If you specify a custom - location for "--cache-db-path" and don't specify one for "--cache-chunk-path" - then "--cache-chunk-path" will use the same path as "--cache-db-path". +cache can not differentiate between relative and absolute paths for the +wrapped remote. Any path given in the remote config setting and on the +command line will be passed to the wrapped remote as is, but for storing +the chunks on disk the path will be made relative by removing any +leading / character. - - Config: chunk_path - - Env Var: RCLONE_CACHE_CHUNK_PATH - - Type: string - - Default: "$HOME/.cache/rclone/cache-backend" +This behavior is irrelevant for most backend types, but there are +backends where a leading / changes the effective directory, e.g. in the +sftp backend paths starting with a / are relative to the root of the SSH +server and paths without are relative to the user home directory. As a +result sftp:bin and sftp:/bin will share the same cache folder, even if +they represent a different directory on the SSH server. - #### --cache-db-purge +Cache and Remote Control (--rc) - Clear all the cached data for this remote on start. +Cache supports the new --rc mode in rclone and can be remote controlled +through the following end points: By default, the listener is disabled +if you do not add the flag. - - Config: db_purge - - Env Var: RCLONE_CACHE_DB_PURGE - - Type: bool - - Default: false +rc cache/expire - #### --cache-chunk-clean-interval +Purge a remote from the cache backend. Supports either a directory or a +file. It supports both encrypted and unencrypted file names if cache is +wrapped by crypt. - How often should the cache perform cleanups of the chunk storage. - The default value should be ok for most people. If you find that the - cache goes over "cache-chunk-total-size" too often then try to lower - this value to force it to perform cleanups more often. +Params: - REMOTE = path to remote (REQUIRED) - WITHDATA = true/false to +delete cached data (chunks) as well _(optional, false by default)_ - - Config: chunk_clean_interval - - Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL - - Type: Duration - - Default: 1m0s +Standard Options - #### --cache-read-retries +Here are the standard options specific to cache (Cache a remote). - How many times to retry a read from a cache storage. +--cache-remote - Since reading from a cache stream is independent from downloading file - data, readers can get to a point where there's no more data in the - cache. Most of the times this can indicate a connectivity issue if - cache isn't able to provide file data anymore. +Remote to cache. Normally should contain a ':' and a path, e.g. +"myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not +recommended). - For really slow connections, increase this to a point where the stream is - able to provide data but your experience will be very stuttering. +- Config: remote +- Env Var: RCLONE_CACHE_REMOTE +- Type: string +- Default: "" - - Config: read_retries - - Env Var: RCLONE_CACHE_READ_RETRIES - - Type: int - - Default: 10 +--cache-plex-url - #### --cache-workers +The URL of the Plex server - How many workers should run in parallel to download chunks. +- Config: plex_url +- Env Var: RCLONE_CACHE_PLEX_URL +- Type: string +- Default: "" - Higher values will mean more parallel processing (better CPU needed) - and more concurrent requests on the cloud provider. This impacts - several aspects like the cloud provider API limits, more stress on the - hardware that rclone runs on but it also means that streams will be - more fluid and data will be available much more faster to readers. +--cache-plex-username - **Note**: If the optional Plex integration is enabled then this - setting will adapt to the type of reading performed and the value - specified here will be used as a maximum number of workers to use. +The username of the Plex user - - Config: workers - - Env Var: RCLONE_CACHE_WORKERS - - Type: int - - Default: 4 +- Config: plex_username +- Env Var: RCLONE_CACHE_PLEX_USERNAME +- Type: string +- Default: "" - #### --cache-chunk-no-memory +--cache-plex-password - Disable the in-memory cache for storing chunks during streaming. +The password of the Plex user - By default, cache will keep file data during streaming in RAM as well - to provide it to readers as fast as possible. +NB Input to this must be obscured - see rclone obscure. - This transient data is evicted as soon as it is read and the number of - chunks stored doesn't exceed the number of workers. However, depending - on other settings like "cache-chunk-size" and "cache-workers" this footprint - can increase if there are parallel streams too (multiple files being read - at the same time). +- Config: plex_password +- Env Var: RCLONE_CACHE_PLEX_PASSWORD +- Type: string +- Default: "" - If the hardware permits it, use this feature to provide an overall better - performance during streaming but it can also be disabled if RAM is not - available on the local machine. +--cache-chunk-size - - Config: chunk_no_memory - - Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY - - Type: bool - - Default: false +The size of a chunk (partial file data). - #### --cache-rps +Use lower numbers for slower connections. If the chunk size is changed, +any downloaded chunks will be invalid and cache-chunk-path will need to +be cleared or unexpected EOF errors will occur. - Limits the number of requests per second to the source FS (-1 to disable) +- Config: chunk_size +- Env Var: RCLONE_CACHE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 5M +- Examples: + - "1m" + - 1MB + - "5M" + - 5 MB + - "10M" + - 10 MB - This setting places a hard limit on the number of requests per second - that cache will be doing to the cloud provider remote and try to - respect that value by setting waits between reads. +--cache-info-age - If you find that you're getting banned or limited on the cloud - provider through cache and know that a smaller number of requests per - second will allow you to work with it then you can use this setting - for that. +How long to cache file structure information (directory listings, file +size, times, etc.). If all write operations are done through the cache +then you can safely make this value very large as the cache store will +also be updated in real time. - A good balance of all the other settings should make this setting - useless but it is available to set for more special cases. +- Config: info_age +- Env Var: RCLONE_CACHE_INFO_AGE +- Type: Duration +- Default: 6h0m0s +- Examples: + - "1h" + - 1 hour + - "24h" + - 24 hours + - "48h" + - 48 hours - **NOTE**: This will limit the number of requests during streams but - other API calls to the cloud provider like directory listings will - still pass. +--cache-chunk-total-size - - Config: rps - - Env Var: RCLONE_CACHE_RPS - - Type: int - - Default: -1 +The total size that the chunks can take up on the local disk. - #### --cache-writes +If the cache exceeds this value then it will start to delete the oldest +chunks until it goes under this value. - Cache file data on writes through the FS +- Config: chunk_total_size +- Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE +- Type: SizeSuffix +- Default: 10G +- Examples: + - "500M" + - 500 MB + - "1G" + - 1 GB + - "10G" + - 10 GB - If you need to read files immediately after you upload them through - cache you can enable this flag to have their data stored in the - cache store at the same time during upload. +Advanced Options - - Config: writes - - Env Var: RCLONE_CACHE_WRITES - - Type: bool - - Default: false +Here are the advanced options specific to cache (Cache a remote). - #### --cache-tmp-upload-path +--cache-plex-token - Directory to keep temporary files until they are uploaded. +The plex token for authentication - auto set normally - This is the path where cache will use as a temporary storage for new - files that need to be uploaded to the cloud provider. +- Config: plex_token +- Env Var: RCLONE_CACHE_PLEX_TOKEN +- Type: string +- Default: "" - Specifying a value will enable this feature. Without it, it is - completely disabled and files will be uploaded directly to the cloud - provider +--cache-plex-insecure - - Config: tmp_upload_path - - Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH - - Type: string - - Default: "" +Skip all certificate verification when connecting to the Plex server - #### --cache-tmp-wait-time +- Config: plex_insecure +- Env Var: RCLONE_CACHE_PLEX_INSECURE +- Type: string +- Default: "" - How long should files be stored in local cache before being uploaded +--cache-db-path - This is the duration that a file must wait in the temporary location - _cache-tmp-upload-path_ before it is selected for upload. +Directory to store file structure metadata DB. The remote name is used +as the DB file name. - Note that only one file is uploaded at a time and it can take longer - to start the upload if a queue formed for this purpose. +- Config: db_path +- Env Var: RCLONE_CACHE_DB_PATH +- Type: string +- Default: "$HOME/.cache/rclone/cache-backend" - - Config: tmp_wait_time - - Env Var: RCLONE_CACHE_TMP_WAIT_TIME - - Type: Duration - - Default: 15s +--cache-chunk-path - #### --cache-db-wait-time +Directory to cache chunk files. - How long to wait for the DB to be available - 0 is unlimited +Path to where partial file data (chunks) are stored locally. The remote +name is appended to the final path. - Only one process can have the DB open at any one time, so rclone waits - for this duration for the DB to become available before it gives an - error. +This config follows the "--cache-db-path". If you specify a custom +location for "--cache-db-path" and don't specify one for +"--cache-chunk-path" then "--cache-chunk-path" will use the same path as +"--cache-db-path". - If you set it to 0 then it will wait forever. +- Config: chunk_path +- Env Var: RCLONE_CACHE_CHUNK_PATH +- Type: string +- Default: "$HOME/.cache/rclone/cache-backend" - - Config: db_wait_time - - Env Var: RCLONE_CACHE_DB_WAIT_TIME - - Type: Duration - - Default: 1s +--cache-db-purge - ### Backend commands +Clear all the cached data for this remote on start. - Here are the commands specific to the cache backend. +- Config: db_purge +- Env Var: RCLONE_CACHE_DB_PURGE +- Type: bool +- Default: false - Run them with +--cache-chunk-clean-interval - rclone backend COMMAND remote: +How often should the cache perform cleanups of the chunk storage. The +default value should be ok for most people. If you find that the cache +goes over "cache-chunk-total-size" too often then try to lower this +value to force it to perform cleanups more often. - The help below will explain what arguments each command takes. +- Config: chunk_clean_interval +- Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL +- Type: Duration +- Default: 1m0s - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. +--cache-read-retries - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). +How many times to retry a read from a cache storage. - #### stats +Since reading from a cache stream is independent from downloading file +data, readers can get to a point where there's no more data in the +cache. Most of the times this can indicate a connectivity issue if cache +isn't able to provide file data anymore. - Print stats on the cache backend in JSON format. +For really slow connections, increase this to a point where the stream +is able to provide data but your experience will be very stuttering. - rclone backend stats remote: [options] [+] +- Config: read_retries +- Env Var: RCLONE_CACHE_READ_RETRIES +- Type: int +- Default: 10 +--cache-workers +How many workers should run in parallel to download chunks. - Chunker (BETA) - ---------------------------------------- +Higher values will mean more parallel processing (better CPU needed) and +more concurrent requests on the cloud provider. This impacts several +aspects like the cloud provider API limits, more stress on the hardware +that rclone runs on but it also means that streams will be more fluid +and data will be available much more faster to readers. - The `chunker` overlay transparently splits large files into smaller chunks - during upload to wrapped remote and transparently assembles them back - when the file is downloaded. This allows to effectively overcome size limits - imposed by storage providers. +NOTE: If the optional Plex integration is enabled then this setting will +adapt to the type of reading performed and the value specified here will +be used as a maximum number of workers to use. - To use it, first set up the underlying remote following the configuration - instructions for that remote. You can also use a local pathname instead of - a remote. +- Config: workers +- Env Var: RCLONE_CACHE_WORKERS +- Type: int +- Default: 4 - First check your chosen remote is working - we'll call it `remote:path` here. - Note that anything inside `remote:path` will be chunked and anything outside - won't. This means that if you are using a bucket based remote (eg S3, B2, swift) - then you should probably put the bucket in the remote `s3:bucket`. +--cache-chunk-no-memory - Now configure `chunker` using `rclone config`. We will call this one `overlay` - to separate it from the `remote` itself. +Disable the in-memory cache for storing chunks during streaming. -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> overlay Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Transparently chunk/split large files  "chunker" [snip] Storage> -chunker Remote to chunk/unchunk. Normally should contain a ':' and a -path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" -(not recommended). Enter a string value. Press Enter for the default -(""). remote> remote:path Files larger than chunk size will be split in -chunks. Enter a size with suffix k,M,G,T. Press Enter for the default -("2G"). chunk_size> 100M Choose how chunker handles hash sums. All modes -but "none" require metadata. Enter a string value. Press Enter for the -default ("md5"). Choose a number from below, or type in your own value 1 -/ Pass any hash supported by wrapped remote for non-chunked files, -return nothing otherwise  "none" 2 / MD5 for composite files  "md5" 3 / -SHA1 for composite files  "sha1" 4 / MD5 for all files  "md5all" 5 / -SHA1 for all files  "sha1all" 6 / Copying a file to chunker will request -MD5 from the source falling back to SHA1 if unsupported  "md5quick" 7 / -Similar to "md5quick" but prefers SHA1 over MD5  "sha1quick" hash_type> -md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config --------------------- [overlay] type = chunker remote = remote:bucket -chunk_size = 100M hash_type = md5 -------------------- y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y +By default, cache will keep file data during streaming in RAM as well to +provide it to readers as fast as possible. +This transient data is evicted as soon as it is read and the number of +chunks stored doesn't exceed the number of workers. However, depending +on other settings like "cache-chunk-size" and "cache-workers" this +footprint can increase if there are parallel streams too (multiple files +being read at the same time). - ### Specifying the remote +If the hardware permits it, use this feature to provide an overall +better performance during streaming but it can also be disabled if RAM +is not available on the local machine. - In normal use, make sure the remote has a `:` in. If you specify the remote - without a `:` then rclone will use a local directory of that name. - So if you use a remote of `/path/to/secret/files` then rclone will - chunk stuff in that directory. If you use a remote of `name` then rclone - will put files in a directory called `name` in the current directory. +- Config: chunk_no_memory +- Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY +- Type: bool +- Default: false +--cache-rps - ### Chunking +Limits the number of requests per second to the source FS (-1 to +disable) - When rclone starts a file upload, chunker checks the file size. If it - doesn't exceed the configured chunk size, chunker will just pass the file - to the wrapped remote. If a file is large, chunker will transparently cut - data in pieces with temporary names and stream them one by one, on the fly. - Each data chunk will contain the specified number of bytes, except for the - last one which may have less data. If file size is unknown in advance - (this is called a streaming upload), chunker will internally create - a temporary copy, record its size and repeat the above process. +This setting places a hard limit on the number of requests per second +that cache will be doing to the cloud provider remote and try to respect +that value by setting waits between reads. - When upload completes, temporary chunk files are finally renamed. - This scheme guarantees that operations can be run in parallel and look - from outside as atomic. - A similar method with hidden temporary chunks is used for other operations - (copy/move/rename etc). If an operation fails, hidden chunks are normally - destroyed, and the target composite file stays intact. - - When a composite file download is requested, chunker transparently - assembles it by concatenating data chunks in order. As the split is trivial - one could even manually concatenate data chunks together to obtain the - original content. - - When the `list` rclone command scans a directory on wrapped remote, - the potential chunk files are accounted for, grouped and assembled into - composite directory entries. Any temporary chunks are hidden. - - List and other commands can sometimes come across composite files with - missing or invalid chunks, eg. shadowed by like-named directory or - another file. This usually means that wrapped file system has been directly - tampered with or damaged. If chunker detects a missing chunk it will - by default print warning, skip the whole incomplete group of chunks but - proceed with current command. - You can set the `--chunker-fail-hard` flag to have commands abort with - error message in such cases. - - - #### Chunk names - - The default chunk name format is `*.rclone_chunk.###`, hence by default - chunk names are `BIG_FILE_NAME.rclone_chunk.001`, - `BIG_FILE_NAME.rclone_chunk.002` etc. You can configure another name format - using the `name_format` configuration file option. The format uses asterisk - `*` as a placeholder for the base file name and one or more consecutive - hash characters `#` as a placeholder for sequential chunk number. - There must be one and only one asterisk. The number of consecutive hash - characters defines the minimum length of a string representing a chunk number. - If decimal chunk number has less digits than the number of hashes, it is - left-padded by zeros. If the decimal string is longer, it is left intact. - By default numbering starts from 1 but there is another option that allows - user to start from 0, eg. for compatibility with legacy software. - - For example, if name format is `big_*-##.part` and original file name is - `data.txt` and numbering starts from 0, then the first chunk will be named - `big_data.txt-00.part`, the 99th chunk will be `big_data.txt-98.part` - and the 302nd chunk will become `big_data.txt-301.part`. - - Note that `list` assembles composite directory entries only when chunk names - match the configured format and treats non-conforming file names as normal - non-chunked files. - - - ### Metadata - - Besides data chunks chunker will by default create metadata object for - a composite file. The object is named after the original file. - Chunker allows user to disable metadata completely (the `none` format). - Note that metadata is normally not created for files smaller than the - configured chunk size. This may change in future rclone releases. - - #### Simple JSON metadata format - - This is the default format. It supports hash sums and chunk validation - for composite files. Meta objects carry the following fields: - - - `ver` - version of format, currently `1` - - `size` - total size of composite file - - `nchunks` - number of data chunks in file - - `md5` - MD5 hashsum of composite file (if present) - - `sha1` - SHA1 hashsum (if present) - - There is no field for composite file name as it's simply equal to the name - of meta object on the wrapped remote. Please refer to respective sections - for details on hashsums and modified time handling. - - #### No metadata - - You can disable meta objects by setting the meta format option to `none`. - In this mode chunker will scan directory for all files that follow - configured chunk name format, group them by detecting chunks with the same - base name and show group names as virtual composite files. - This method is more prone to missing chunk errors (especially missing - last chunk) than format with metadata enabled. - - - ### Hashsums - - Chunker supports hashsums only when a compatible metadata is present. - Hence, if you choose metadata format of `none`, chunker will report hashsum - as `UNSUPPORTED`. - - Please note that by default metadata is stored only for composite files. - If a file is smaller than configured chunk size, chunker will transparently - redirect hash requests to wrapped remote, so support depends on that. - You will see the empty string as a hashsum of requested type for small - files if the wrapped remote doesn't support it. - - Many storage backends support MD5 and SHA1 hash types, so does chunker. - With chunker you can choose one or another but not both. - MD5 is set by default as the most supported type. - Since chunker keeps hashes for composite files and falls back to the - wrapped remote hash for non-chunked ones, we advise you to choose the same - hash type as supported by wrapped remote so that your file listings - look coherent. - - If your storage backend does not support MD5 or SHA1 but you need consistent - file hashing, configure chunker with `md5all` or `sha1all`. These two modes - guarantee given hash for all files. If wrapped remote doesn't support it, - chunker will then add metadata to all files, even small. However, this can - double the amount of small files in storage and incur additional service charges. - You can even use chunker to force md5/sha1 support in any other remote - at expense of sidecar meta objects by setting eg. `chunk_type=sha1all` - to force hashsums and `chunk_size=1P` to effectively disable chunking. - - Normally, when a file is copied to chunker controlled remote, chunker - will ask the file source for compatible file hash and revert to on-the-fly - calculation if none is found. This involves some CPU overhead but provides - a guarantee that given hashsum is available. Also, chunker will reject - a server-side copy or move operation if source and destination hashsum - types are different resulting in the extra network bandwidth, too. - In some rare cases this may be undesired, so chunker provides two optional - choices: `sha1quick` and `md5quick`. If the source does not support primary - hash type and the quick mode is enabled, chunker will try to fall back to - the secondary type. This will save CPU and bandwidth but can result in empty - hashsums at destination. Beware of consequences: the `sync` command will - revert (sometimes silently) to time/size comparison if compatible hashsums - between source and target are not found. - - - ### Modified time - - Chunker stores modification times using the wrapped remote so support - depends on that. For a small non-chunked file the chunker overlay simply - manipulates modification time of the wrapped remote file. - For a composite file with metadata chunker will get and set - modification time of the metadata object on the wrapped remote. - If file is chunked but metadata format is `none` then chunker will - use modification time of the first data chunk. - - - ### Migrations - - The idiomatic way to migrate to a different chunk size, hash type or - chunk naming scheme is to: - - - Collect all your chunked files under a directory and have your - chunker remote point to it. - - Create another directory (most probably on the same cloud storage) - and configure a new remote with desired metadata format, - hash type, chunk naming etc. - - Now run `rclone sync -i oldchunks: newchunks:` and all your data - will be transparently converted in transfer. - This may take some time, yet chunker will try server-side - copy if possible. - - After checking data integrity you may remove configuration section - of the old remote. - - If rclone gets killed during a long operation on a big composite file, - hidden temporary chunks may stay in the directory. They will not be - shown by the `list` command but will eat up your account quota. - Please note that the `deletefile` command deletes only active - chunks of a file. As a workaround, you can use remote of the wrapped - file system to see them. - An easy way to get rid of hidden garbage is to copy littered directory - somewhere using the chunker remote and purge the original directory. - The `copy` command will copy only active chunks while the `purge` will - remove everything including garbage. - - - ### Caveats and Limitations - - Chunker requires wrapped remote to support server side `move` (or `copy` + - `delete`) operations, otherwise it will explicitly refuse to start. - This is because it internally renames temporary chunk files to their final - names when an operation completes successfully. - - Chunker encodes chunk number in file name, so with default `name_format` - setting it adds 17 characters. Also chunker adds 7 characters of temporary - suffix during operations. Many file systems limit base file name without path - by 255 characters. Using rclone's crypt remote as a base file system limits - file name by 143 characters. Thus, maximum name length is 231 for most files - and 119 for chunker-over-crypt. A user in need can change name format to - eg. `*.rcc##` and save 10 characters (provided at most 99 chunks per file). - - Note that a move implemented using the copy-and-delete method may incur - double charging with some cloud storage providers. - - Chunker will not automatically rename existing chunks when you run - `rclone config` on a live remote and change the chunk name format. - Beware that in result of this some files which have been treated as chunks - before the change can pop up in directory listings as normal files - and vice versa. The same warning holds for the chunk size. - If you desperately need to change critical chunking settings, you should - run data migration as described above. - - If wrapped remote is case insensitive, the chunker overlay will inherit - that property (so you can't have a file called "Hello.doc" and "hello.doc" - in the same directory). - - - - ### Standard Options - - Here are the standard options specific to chunker (Transparently chunk/split large files). - - #### --chunker-remote +If you find that you're getting banned or limited on the cloud provider +through cache and know that a smaller number of requests per second will +allow you to work with it then you can use this setting for that. +A good balance of all the other settings should make this setting +useless but it is available to set for more special cases. + +NOTE: This will limit the number of requests during streams but other +API calls to the cloud provider like directory listings will still pass. + +- Config: rps +- Env Var: RCLONE_CACHE_RPS +- Type: int +- Default: -1 + +--cache-writes + +Cache file data on writes through the FS + +If you need to read files immediately after you upload them through +cache you can enable this flag to have their data stored in the cache +store at the same time during upload. + +- Config: writes +- Env Var: RCLONE_CACHE_WRITES +- Type: bool +- Default: false + +--cache-tmp-upload-path + +Directory to keep temporary files until they are uploaded. + +This is the path where cache will use as a temporary storage for new +files that need to be uploaded to the cloud provider. + +Specifying a value will enable this feature. Without it, it is +completely disabled and files will be uploaded directly to the cloud +provider + +- Config: tmp_upload_path +- Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH +- Type: string +- Default: "" + +--cache-tmp-wait-time + +How long should files be stored in local cache before being uploaded + +This is the duration that a file must wait in the temporary location +_cache-tmp-upload-path_ before it is selected for upload. + +Note that only one file is uploaded at a time and it can take longer to +start the upload if a queue formed for this purpose. + +- Config: tmp_wait_time +- Env Var: RCLONE_CACHE_TMP_WAIT_TIME +- Type: Duration +- Default: 15s + +--cache-db-wait-time + +How long to wait for the DB to be available - 0 is unlimited + +Only one process can have the DB open at any one time, so rclone waits +for this duration for the DB to become available before it gives an +error. + +If you set it to 0 then it will wait forever. + +- Config: db_wait_time +- Env Var: RCLONE_CACHE_DB_WAIT_TIME +- Type: Duration +- Default: 1s + +Backend commands + +Here are the commands specific to the cache backend. + +Run them with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See the "rclone backend" command for more info on how to pass options +and arguments. + +These can be run on a running backend using the rc command +backend/command. + +stats + +Print stats on the cache backend in JSON format. + + rclone backend stats remote: [options] [+] + + +Chunker (BETA) + +The chunker overlay transparently splits large files into smaller chunks +during upload to wrapped remote and transparently assembles them back +when the file is downloaded. This allows to effectively overcome size +limits imposed by storage providers. + +To use it, first set up the underlying remote following the +configuration instructions for that remote. You can also use a local +pathname instead of a remote. + +First check your chosen remote is working - we'll call it remote:path +here. Note that anything inside remote:path will be chunked and anything +outside won't. This means that if you are using a bucket based remote +(e.g. 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", + Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - - - Config: remote - - Env Var: RCLONE_CHUNKER_REMOTE - - Type: string - - Default: "" - - #### --chunker-chunk-size - + Enter a string value. Press Enter for the default (""). + remote> remote:path Files larger than chunk size will be split in chunks. - - - Config: chunk_size - - Env Var: RCLONE_CHUNKER_CHUNK_SIZE - - Type: SizeSuffix - - Default: 2G - - #### --chunker-hash-type - + Enter a size with suffix k,M,G,T. Press Enter for the default ("2G"). + chunk_size> 100M Choose how chunker handles hash sums. All modes but "none" require metadata. + Enter a string value. Press Enter for the default ("md5"). + Choose a number from below, or type in your own value + 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise + \ "none" + 2 / MD5 for composite files + \ "md5" + 3 / SHA1 for composite files + \ "sha1" + 4 / MD5 for all files + \ "md5all" + 5 / SHA1 for all files + \ "sha1all" + 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported + \ "md5quick" + 7 / Similar to "md5quick" but prefers SHA1 over MD5 + \ "sha1quick" + hash_type> md5 + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + -------------------- + [overlay] + type = chunker + remote = remote:bucket + chunk_size = 100M + hash_type = md5 + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: hash_type - - Env Var: RCLONE_CHUNKER_HASH_TYPE - - Type: string - - Default: "md5" - - Examples: - - "none" - - Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise - - "md5" - - MD5 for composite files - - "sha1" - - SHA1 for composite files - - "md5all" - - MD5 for all files - - "sha1all" - - SHA1 for all files - - "md5quick" - - Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported - - "sha1quick" - - Similar to "md5quick" but prefers SHA1 over MD5 +Specifying the remote - ### Advanced Options +In normal use, make sure the remote has a : in. If you specify the +remote without a : then rclone will use a local directory of that name. +So if you use a remote of /path/to/secret/files then rclone will chunk +stuff in that directory. If you use a remote of name then rclone will +put files in a directory called name in the current directory. - Here are the advanced options specific to chunker (Transparently chunk/split large files). +Chunking - #### --chunker-name-format +When rclone starts a file upload, chunker checks the file size. If it +doesn't exceed the configured chunk size, chunker will just pass the +file to the wrapped remote. If a file is large, chunker will +transparently cut data in pieces with temporary names and stream them +one by one, on the fly. Each data chunk will contain the specified +number of bytes, except for the last one which may have less data. If +file size is unknown in advance (this is called a streaming upload), +chunker will internally create a temporary copy, record its size and +repeat the above process. - String format of chunk file names. - The two placeholders are: base file name (*) and chunk number (#...). - There must be one and only one asterisk and one or more consecutive hash characters. - If chunk number has less digits than the number of hashes, it is left-padded by zeros. - If there are more digits in the number, they are left as is. - Possible chunk files are ignored if their name does not match given format. +When upload completes, temporary chunk files are finally renamed. This +scheme guarantees that operations can be run in parallel and look from +outside as atomic. A similar method with hidden temporary chunks is used +for other operations (copy/move/rename, etc.). If an operation fails, +hidden chunks are normally destroyed, and the target composite file +stays intact. - - Config: name_format - - Env Var: RCLONE_CHUNKER_NAME_FORMAT - - Type: string - - Default: "*.rclone_chunk.###" +When a composite file download is requested, chunker transparently +assembles it by concatenating data chunks in order. As the split is +trivial one could even manually concatenate data chunks together to +obtain the original content. - #### --chunker-start-from +When the list rclone command scans a directory on wrapped remote, the +potential chunk files are accounted for, grouped and assembled into +composite directory entries. Any temporary chunks are hidden. - Minimum valid chunk number. Usually 0 or 1. - By default chunk numbers start from 1. +List and other commands can sometimes come across composite files with +missing or invalid chunks, e.g. shadowed by like-named directory or +another file. This usually means that wrapped file system has been +directly tampered with or damaged. If chunker detects a missing chunk it +will by default print warning, skip the whole incomplete group of chunks +but proceed with current command. You can set the --chunker-fail-hard +flag to have commands abort with error message in such cases. - - Config: start_from - - Env Var: RCLONE_CHUNKER_START_FROM - - Type: int - - Default: 1 +Chunk names - #### --chunker-meta-format +The default chunk name format is *.rclone_chunk.###, hence by default +chunk names are BIG_FILE_NAME.rclone_chunk.001, +BIG_FILE_NAME.rclone_chunk.002 etc. You can configure another name +format using the name_format configuration file option. The format uses +asterisk * as a placeholder for the base file name and one or more +consecutive hash characters # as a placeholder for sequential chunk +number. There must be one and only one asterisk. The number of +consecutive hash characters defines the minimum length of a string +representing a chunk number. If decimal chunk number has less digits +than the number of hashes, it is left-padded by zeros. If the decimal +string is longer, it is left intact. By default numbering starts from 1 +but there is another option that allows user to start from 0, e.g. for +compatibility with legacy software. - Format of the metadata object or "none". By default "simplejson". - Metadata is a small JSON file named after the composite file. +For example, if name format is big_*-##.part and original file name is +data.txt and numbering starts from 0, then the first chunk will be named +big_data.txt-00.part, the 99th chunk will be big_data.txt-98.part and +the 302nd chunk will become big_data.txt-301.part. - - Config: meta_format - - Env Var: RCLONE_CHUNKER_META_FORMAT - - Type: string - - Default: "simplejson" - - Examples: - - "none" - - Do not use metadata files at all. Requires hash type "none". - - "simplejson" - - Simple JSON supports hash sums and chunk validation. - - It has the following fields: ver, size, nchunks, md5, sha1. +Note that list assembles composite directory entries only when chunk +names match the configured format and treats non-conforming file names +as normal non-chunked files. - #### --chunker-fail-hard +Metadata - Choose how chunker should handle files with missing or invalid chunks. +Besides data chunks chunker will by default create metadata object for a +composite file. The object is named after the original file. Chunker +allows user to disable metadata completely (the none format). Note that +metadata is normally not created for files smaller than the configured +chunk size. This may change in future rclone releases. - - Config: fail_hard - - Env Var: RCLONE_CHUNKER_FAIL_HARD - - Type: bool - - Default: false - - Examples: - - "true" - - Report errors and abort current command. - - "false" - - Warn user, skip incomplete file and proceed. +Simple JSON metadata format + +This is the default format. It supports hash sums and chunk validation +for composite files. Meta objects carry the following fields: + +- ver - version of format, currently 1 +- size - total size of composite file +- nchunks - number of data chunks in file +- md5 - MD5 hashsum of composite file (if present) +- sha1 - SHA1 hashsum (if present) + +There is no field for composite file name as it's simply equal to the +name of meta object on the wrapped remote. Please refer to respective +sections for details on hashsums and modified time handling. + +No metadata + +You can disable meta objects by setting the meta format option to none. +In this mode chunker will scan directory for all files that follow +configured chunk name format, group them by detecting chunks with the +same base name and show group names as virtual composite files. This +method is more prone to missing chunk errors (especially missing last +chunk) than format with metadata enabled. + +Hashsums + +Chunker supports hashsums only when a compatible metadata is present. +Hence, if you choose metadata format of none, chunker will report +hashsum as UNSUPPORTED. + +Please note that by default metadata is stored only for composite files. +If a file is smaller than configured chunk size, chunker will +transparently redirect hash requests to wrapped remote, so support +depends on that. You will see the empty string as a hashsum of requested +type for small files if the wrapped remote doesn't support it. + +Many storage backends support MD5 and SHA1 hash types, so does chunker. +With chunker you can choose one or another but not both. MD5 is set by +default as the most supported type. Since chunker keeps hashes for +composite files and falls back to the wrapped remote hash for +non-chunked ones, we advise you to choose the same hash type as +supported by wrapped remote so that your file listings look coherent. + +If your storage backend does not support MD5 or SHA1 but you need +consistent file hashing, configure chunker with md5all or sha1all. These +two modes guarantee given hash for all files. If wrapped remote doesn't +support it, chunker will then add metadata to all files, even small. +However, this can double the amount of small files in storage and incur +additional service charges. You can even use chunker to force md5/sha1 +support in any other remote at expense of sidecar meta objects by +setting e.g. chunk_type=sha1all to force hashsums and chunk_size=1P to +effectively disable chunking. + +Normally, when a file is copied to chunker controlled remote, chunker +will ask the file source for compatible file hash and revert to +on-the-fly calculation if none is found. This involves some CPU overhead +but provides a guarantee that given hashsum is available. Also, chunker +will reject a server-side copy or move operation if source and +destination hashsum types are different resulting in the extra network +bandwidth, too. In some rare cases this may be undesired, so chunker +provides two optional choices: sha1quick and md5quick. If the source +does not support primary hash type and the quick mode is enabled, +chunker will try to fall back to the secondary type. This will save CPU +and bandwidth but can result in empty hashsums at destination. Beware of +consequences: the sync command will revert (sometimes silently) to +time/size comparison if compatible hashsums between source and target +are not found. + +Modified time + +Chunker stores modification times using the wrapped remote so support +depends on that. For a small non-chunked file the chunker overlay simply +manipulates modification time of the wrapped remote file. For a +composite file with metadata chunker will get and set modification time +of the metadata object on the wrapped remote. If file is chunked but +metadata format is none then chunker will use modification time of the +first data chunk. + +Migrations + +The idiomatic way to migrate to a different chunk size, hash type or +chunk naming scheme is to: + +- Collect all your chunked files under a directory and have your + chunker remote point to it. +- Create another directory (most probably on the same cloud storage) + and configure a new remote with desired metadata format, hash type, + chunk naming etc. +- Now run rclone sync -i oldchunks: newchunks: and all your data will + be transparently converted in transfer. This may take some time, yet + chunker will try server-side copy if possible. +- After checking data integrity you may remove configuration section + of the old remote. + +If rclone gets killed during a long operation on a big composite file, +hidden temporary chunks may stay in the directory. They will not be +shown by the list command but will eat up your account quota. Please +note that the deletefile command deletes only active chunks of a file. +As a workaround, you can use remote of the wrapped file system to see +them. An easy way to get rid of hidden garbage is to copy littered +directory somewhere using the chunker remote and purge the original +directory. The copy command will copy only active chunks while the purge +will remove everything including garbage. + +Caveats and Limitations + +Chunker requires wrapped remote to support server-side move (or copy + +delete) operations, otherwise it will explicitly refuse to start. This +is because it internally renames temporary chunk files to their final +names when an operation completes successfully. + +Chunker encodes chunk number in file name, so with default name_format +setting it adds 17 characters. Also chunker adds 7 characters of +temporary suffix during operations. Many file systems limit base file +name without path by 255 characters. Using rclone's crypt remote as a +base file system limits file name by 143 characters. Thus, maximum name +length is 231 for most files and 119 for chunker-over-crypt. A user in +need can change name format to e.g. *.rcc## and save 10 characters +(provided at most 99 chunks per file). + +Note that a move implemented using the copy-and-delete method may incur +double charging with some cloud storage providers. + +Chunker will not automatically rename existing chunks when you run +rclone config on a live remote and change the chunk name format. Beware +that in result of this some files which have been treated as chunks +before the change can pop up in directory listings as normal files and +vice versa. The same warning holds for the chunk size. If you +desperately need to change critical chunking settings, you should run +data migration as described above. + +If wrapped remote is case insensitive, the chunker overlay will inherit +that property (so you can't have a file called "Hello.doc" and +"hello.doc" in the same directory). + +Chunker included in rclone releases up to v1.54 can sometimes fail to +detect metadata produced by recent versions of rclone. We recommend +users to keep rclone up-to-date to avoid data corruption. + +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, e.g. +"myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not +recommended). + +- Config: remote +- Env Var: RCLONE_CHUNKER_REMOTE +- Type: string +- Default: "" + +--chunker-chunk-size + +Files larger than chunk size will be split in chunks. + +- Config: chunk_size +- Env Var: RCLONE_CHUNKER_CHUNK_SIZE +- Type: SizeSuffix +- Default: 2G + +--chunker-hash-type + +Choose how chunker handles hash sums. All modes but "none" require +metadata. + +- Config: hash_type +- Env Var: RCLONE_CHUNKER_HASH_TYPE +- Type: string +- Default: "md5" +- Examples: + - "none" + - Pass any hash supported by wrapped remote for non-chunked + files, return nothing otherwise + - "md5" + - MD5 for composite files + - "sha1" + - SHA1 for composite files + - "md5all" + - MD5 for all files + - "sha1all" + - SHA1 for all files + - "md5quick" + - Copying a file to chunker will request MD5 from the source + falling back to SHA1 if unsupported + - "sha1quick" + - Similar to "md5quick" but prefers SHA1 over MD5 + +Advanced Options + +Here are the advanced options specific to chunker (Transparently +chunk/split large files). + +--chunker-name-format + +String format of chunk file names. The two placeholders are: base file +name (*) and chunk number (#...). There must be one and only one +asterisk and one or more consecutive hash characters. If chunk number +has less digits than the number of hashes, it is left-padded by zeros. +If there are more digits in the number, they are left as is. Possible +chunk files are ignored if their name does not match given format. + +- Config: name_format +- Env Var: RCLONE_CHUNKER_NAME_FORMAT +- Type: string +- Default: "*.rclone_chunk.###" + +--chunker-start-from + +Minimum valid chunk number. Usually 0 or 1. By default chunk numbers +start from 1. + +- Config: start_from +- Env Var: RCLONE_CHUNKER_START_FROM +- Type: int +- Default: 1 + +--chunker-meta-format + +Format of the metadata object or "none". By default "simplejson". +Metadata is a small JSON file named after the composite file. + +- Config: meta_format +- Env Var: RCLONE_CHUNKER_META_FORMAT +- Type: string +- Default: "simplejson" +- Examples: + - "none" + - Do not use metadata files at all. Requires hash type "none". + - "simplejson" + - Simple JSON supports hash sums and chunk validation. + - It has the following fields: ver, size, nchunks, md5, sha1. + +--chunker-fail-hard + +Choose how chunker should handle files with missing or invalid chunks. + +- Config: fail_hard +- Env Var: RCLONE_CHUNKER_FAIL_HARD +- Type: bool +- Default: false +- Examples: + - "true" + - Report errors and abort current command. + - "false" + - Warn user, skip incomplete file and proceed. +Citrix ShareFile - ## Citrix ShareFile +Citrix ShareFile is a secure file sharing and transfer service aimed as +business. - [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. +The initial setup for Citrix ShareFile involves getting a token from +Citrix ShareFile which you can in your browser. rclone config walks you +through it. - The initial setup for Citrix ShareFile involves getting a token from - Citrix ShareFile which you can in your browser. `rclone config` walks you - through it. +Here is an example of how to make a remote called remote. First run: - Here is an example of how to make a remote called `remote`. First run: + rclone config - rclone config +This will guide you through an interactive setup process: - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value XX / Citrix -Sharefile  "sharefile" Storage> sharefile ** See help for sharefile -backend at: https://rclone.org/sharefile/ ** - -ID of the root folder - -Leave blank to access "Personal Folders". You can use one of the -standard values here or any folder ID (long hex number ID). Enter a -string value. Press Enter for the default (""). Choose a number from -below, or type in your own value 1 / Access the Personal Folders. -(Default)  "" 2 / Access the Favorites folder.  "favorites" 3 / Access -all the shared folders.  "allshared" 4 / Access all the individual -connectors.  "connectors" 5 / Access the home, favorites, and shared -folders as well as the connectors.  "top" root_folder_id> Edit advanced -config? (y/n) y) Yes n) No y/n> n Remote config Use auto config? * Say Y -if not sure * Say N if you are working on a remote or headless machine -y) Yes n) No y/n> y If your browser doesn't open automatically go to the -following link: http://127.0.0.1:53682/auth?state=XXX Log in and -authorize rclone for access Waiting for code... Got code --------------------- [remote] type = sharefile endpoint = -https://XXX.sharefile.com token = -{"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet browser available. - - Note that rclone runs a webserver on your local machine to collect the - token as returned from Citrix ShareFile. This only runs from the moment it opens - your browser to the moment you get back the verification code. This - is on `http://127.0.0.1:53682/` and this it may require you to unblock - it temporarily if you are running a host firewall. - - Once configured you can then use `rclone` like this, - - List directories in top level of your ShareFile - - rclone lsd remote: - - List all the files in your ShareFile - - rclone ls remote: - - To copy a local directory to an ShareFile directory called backup - - rclone copy /home/source remote:backup - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - ### Modified time and hashes ### - - ShareFile allows modification times to be set on objects accurate to 1 - second. These will be used to detect whether objects need syncing or - not. - - ShareFile supports MD5 type hashes, so you can use the `--checksum` - flag. - - ### Transfers ### - - For files above 128MB rclone will use a chunked transfer. Rclone will - upload up to `--transfers` chunks at the same time (shared among all - the multipart uploads). Chunks are buffered in memory and are - normally 64MB so increasing `--transfers` will increase memory use. - - ### Limitations ### - - Note that ShareFile is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". - - ShareFile only supports filenames up to 256 characters in length. - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \\ | 0x5C | ＼ | - | * | 0x2A | ＊ | - | < | 0x3C | ＜ | - | > | 0x3E | ＞ | - | ? | 0x3F | ？ | - | : | 0x3A | ： | - | \| | 0x7C | ｜ | - | " | 0x22 | ＂ | - - File names can also not start or end with the following characters. - These only get replaced if they are the first or last character in the - name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - | . | 0x2E | ． | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to sharefile (Citrix Sharefile). - - #### --sharefile-root-folder-id + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + XX / Citrix Sharefile + \ "sharefile" + Storage> sharefile + ** See help for sharefile backend at: https://rclone.org/sharefile/ ** ID of the root folder Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID). + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Access the Personal Folders. (Default) + \ "" + 2 / Access the Favorites folder. + \ "favorites" + 3 / Access all the shared folders. + \ "allshared" + 4 / Access all the individual connectors. + \ "connectors" + 5 / Access the home, favorites, and shared folders as well as the connectors. + \ "top" + root_folder_id> + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = sharefile + endpoint = https://XXX.sharefile.com + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs for how to set it up on a machine with no +Internet browser available. + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Citrix ShareFile. This only runs from the moment +it opens your browser to the moment you get back the verification code. +This is on http://127.0.0.1:53682/ and this it may require you to +unblock it temporarily if you are running a host firewall. + +Once configured you can then use rclone like this, + +List directories in top level of your ShareFile + + rclone lsd remote: + +List all the files in your ShareFile + + rclone ls remote: + +To copy a local directory to an ShareFile directory called backup + + rclone copy /home/source remote:backup + +Paths may be as deep as required, e.g. remote:directory/subdirectory. + +Modified time and hashes + +ShareFile allows modification times to be set on objects accurate to 1 +second. These will be used to detect whether objects need syncing or +not. + +ShareFile supports MD5 type hashes, so you can use the --checksum flag. + +Transfers - - Config: root_folder_id - - Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID - - Type: string - - Default: "" - - Examples: - - "" - - Access the Personal Folders. (Default) - - "favorites" - - Access the Favorites folder. - - "allshared" - - Access all the shared folders. - - "connectors" - - Access all the individual connectors. - - "top" - - Access the home, favorites, and shared folders as well as the connectors. - - ### Advanced Options +For files above 128MB rclone will use a chunked transfer. Rclone will +upload up to --transfers chunks at the same time (shared among all the +multipart uploads). Chunks are buffered in memory and are normally 64MB +so increasing --transfers will increase memory use. - Here are the advanced options specific to sharefile (Citrix Sharefile). +Limitations - #### --sharefile-upload-cutoff +Note that ShareFile is case insensitive so you can't have a file called +"Hello.doc" and one called "hello.doc". - Cutoff for switching to multipart upload. +ShareFile only supports filenames up to 256 characters in length. - - Config: upload_cutoff - - Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 128M +Restricted filename characters - #### --sharefile-chunk-size +In addition to the default restricted characters set the following +characters are also replaced: - Upload chunk size. Must a power of 2 >= 256k. + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + * 0x2A ＊ + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + : 0x3A ： + | 0x7C ｜ + " 0x22 ＂ - Making this larger will improve performance, but note that each chunk - is buffered in memory one per transfer. +File names can also not start or end with the following characters. +These only get replaced if they are the first or last character in the +name: - Reducing this will reduce memory usage but decrease performance. + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + . 0x2E ． - - Config: chunk_size - - Env Var: RCLONE_SHAREFILE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 64M +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - #### --sharefile-endpoint +Standard Options - Endpoint for API calls. +Here are the standard options specific to sharefile (Citrix Sharefile). - This is usually auto discovered as part of the oauth process, but can - be set manually to something like: https://XXX.sharefile.com +--sharefile-root-folder-id +ID of the root folder - - Config: endpoint - - Env Var: RCLONE_SHAREFILE_ENDPOINT - - Type: string - - Default: "" +Leave blank to access "Personal Folders". You can use one of the +standard values here or any folder ID (long hex number ID). - #### --sharefile-encoding +- Config: root_folder_id +- Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID +- Type: string +- Default: "" +- Examples: + - "" + - Access the Personal Folders. (Default) + - "favorites" + - Access the Favorites folder. + - "allshared" + - Access all the shared folders. + - "connectors" + - Access all the individual connectors. + - "top" + - Access the home, favorites, and shared folders as well as + the connectors. - This sets the encoding for the backend. +Advanced Options - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Here are the advanced options specific to sharefile (Citrix Sharefile). - - Config: encoding - - Env Var: RCLONE_SHAREFILE_ENCODING - - Type: MultiEncoder - - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot +--sharefile-upload-cutoff +Cutoff for switching to multipart upload. +- Config: upload_cutoff +- Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 128M - Crypt - ---------------------------------------- +--sharefile-chunk-size - The `crypt` remote encrypts and decrypts another remote. +Upload chunk size. Must a power of 2 >= 256k. - To use it first set up the underlying remote following the config - instructions for that remote. You can also use a local pathname - instead of a remote which will encrypt and decrypt from that directory - which might be useful for encrypting onto a USB stick for example. +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. - First check your chosen remote is working - we'll call it - `remote:path` in these docs. Note that anything inside `remote:path` - will be encrypted and anything outside won't. This means that if you - are using a bucket based remote (eg S3, B2, swift) then you should - probably put the bucket in the remote `s3:bucket`. If you just use - `s3:` then rclone will make encrypted bucket names too (if using file - name encryption) which may or may not be what you want. +Reducing this will reduce memory usage but decrease performance. - Now configure `crypt` using `rclone config`. We will call this one - `secret` to differentiate it from the `remote`. +- Config: chunk_size +- Env Var: RCLONE_SHAREFILE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 64M -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n -name> secret Type of storage to configure. Choose a number from below, -or type in your own value [snip] XX / Encrypt/Decrypt a remote  "crypt" -[snip] Storage> crypt Remote to encrypt/decrypt. Normally should contain -a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe -"myremote:" (not recommended). remote> remote:path How to encrypt the -filenames. Choose a number from below, or type in your own value 1 / -Don't encrypt the file names. Adds a ".bin" extension only.  "off" 2 / -Encrypt the filenames see the docs for the details.  "standard" 3 / Very -simple filename obfuscation.  "obfuscate" filename_encryption> 2 Option -to either encrypt directory names or leave them intact. Choose a number -from below, or type in your own value 1 / Encrypt directory names. - "true" 2 / Don't encrypt directory names, leave them intact.  "false" -filename_encryption> 1 Password or pass phrase for encryption. y) Yes -type in my own password g) Generate random password y/g> y Enter the -password: password: Confirm the password: password: Password or pass -phrase for salt. Optional but recommended. Should be different to the -previous password. y) Yes type in my own password g) Generate random -password n) No leave this optional password blank y/g/n> g Password -strength in bits. 64 is just about memorable 128 is secure 1024 is the -maximum Bits> 128 Your password is: JAsJvRcgR-_veXNfy_sGmQ Use this -password? y) Yes n) No y/n> y Remote config -------------------- -[secret] remote = remote:path filename_encryption = standard password = -*** ENCRYPTED _ PASSWORD2 = _ ENCRYPTED *** -------------------- y) Yes -this is OK e) Edit this remote d) Delete this remote y/e/d> y +--sharefile-endpoint +Endpoint for API calls. - **Important** The password is stored in the config file is lightly - obscured so it isn't immediately obvious what it is. It is in no way - secure unless you use config file encryption. +This is usually auto discovered as part of the oauth process, but can be +set manually to something like: https://XXX.sharefile.com - A long passphrase is recommended, or you can use a random one. +- Config: endpoint +- Env Var: RCLONE_SHAREFILE_ENDPOINT +- Type: string +- Default: "" - The obscured password is created by using AES-CTR with a static key, with - the salt stored verbatim at the beginning of the obscured password. This - static key is shared by between all versions of rclone. - - If you reconfigure rclone with the same passwords/passphrases - elsewhere it will be compatible, but the obscured version will be different - due to the different salt. - - Note that rclone does not encrypt - - * file length - this can be calculated within 16 bytes - * modification time - used for syncing - - ## Specifying the remote ## - - In normal use, make sure the remote has a `:` in. If you specify the - remote without a `:` then rclone will use a local directory of that - name. So if you use a remote of `/path/to/secret/files` then rclone - will encrypt stuff to that directory. If you use a remote of `name` - then rclone will put files in a directory called `name` in the current - directory. - - If you specify the remote as `remote:path/to/dir` then rclone will - store encrypted files in `path/to/dir` on the remote. If you are using - file name encryption, then when you save files to - `secret:subdir/subfile` this will store them in the unencrypted path - `path/to/dir` but the `subdir/subpath` bit will be encrypted. - - Note that unless you want encrypted bucket names (which are difficult - to manage because you won't know what directory they represent in web - interfaces etc), you should probably specify a bucket, eg - `remote:secretbucket` when using bucket based remotes such as S3, - Swift, Hubic, B2, GCS. - - ## Example ## - - To test I made a little directory of files using "standard" file name - encryption. - -plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── -file3.txt └── subsubdir └── file4.txt - - - Copy these to the remote and list them back - -$ rclone -q copy plaintext secret: $ rclone -q ls secret: 7 file1.txt 6 -file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 -subdir/file3.txt - - - Now see what that looked like when encrypted - -$ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 -v05749mltvv1tf4onltun46gls 57 -86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 -86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc -56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps - - - Note that this retains the directory structure which means you can do this - -$ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 -subsubdir/file4.txt - - - If don't use file name encryption then the remote will look like this - - note the `.bin` extensions added to prevent the cloud provider - attempting to interpret the data. - -$ rclone -q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 -subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin - - - ### File name encryption modes ### - - Here are some of the features of the file name encryption modes - - Off - - * doesn't hide file names or directory structure - * allows for longer file names (~246 characters) - * can use sub paths and copy single files - - Standard - - * file names encrypted - * file names can't be as long (~143 characters) - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - * can use shortcuts to shorten the directory recursion - - Obfuscation - - This is a simple "rotate" of the filename, with each file having a rot - distance based on the filename. We store the distance at the beginning - of the filename. So a file called "hello" may become "53.jgnnq". - - This is not a strong encryption of filenames, but it may stop automated - scanning tools from picking up on filename patterns. As such it's an - intermediate between "off" and "standard". The advantage is that it - allows for longer path segment names. - - There is a possibility with some unicode based filenames that the - obfuscation is weak and may map lower case characters to upper case - equivalents. You can not rely on this for strong protection. - - * file names very lightly obfuscated - * file names can be longer than standard encryption - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - - Cloud storage systems have various limits on file name length and - total path length which you are more likely to hit using "Standard" - file name encryption. If you keep your file names to below 156 - characters in length then you should be OK on all providers. - - There may be an even more secure file name encryption mode in the - future which will address the long file name problem. - - ### Directory name encryption ### - Crypt offers the option of encrypting dir names or leaving them intact. - There are two options: - - True - - Encrypts the whole file path including directory names - Example: - `1/12/123.txt` is encrypted to - `p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0` - - False - - Only encrypts file names, skips directory names - Example: - `1/12/123.txt` is encrypted to - `1/12/qgm4avr35m5loi1th53ato71v0` - - - ### Modified time and hashes ### - - Crypt stores modification times using the underlying remote so support - depends on that. - - Hashes are not stored for crypt. However the data integrity is - protected by an extremely strong crypto authenticator. - - Note that you should use the `rclone cryptcheck` command to check the - integrity of a crypted remote instead of `rclone check` which can't - check the checksums properly. - - - ### Standard Options - - Here are the standard options specific to crypt (Encrypt/Decrypt a remote). - - #### --crypt-remote +--sharefile-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_SHAREFILE_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot + +Limitations + +rclone about is not supported by the Citrix ShareFile backend. Backends +without this capability cannot determine free space for an rclone mount +or use policy mfs (most free space) as a member of an rclone union +remote. + +See List of backends that do not support rclone about See rclone about + + +Crypt + +Rclone crypt remotes encrypt and decrypt other remotes. + +A remote of type crypt does not access a storage system directly, but +instead wraps another remote, which in turn accesses the storage system. +This is similar to how alias, union, chunker and a few others work. It +makes the usage very flexible, as you can add a layer, in this case an +encryption layer, on top of any other backend, even in multiple layers. +Rclone's functionality can be used as with any other remote, for example +you can mount a crypt remote. + +Accessing a storage system through a crypt remote realizes client-side +encryption, which makes it safe to keep your data in a location you do +not trust will not get compromised. When working against the crypt +remote, rclone will automatically encrypt (before uploading) and decrypt +(after downloading) on your local system as needed on the fly, leaving +the data encrypted at rest in the wrapped remote. If you access the +storage system using an application other than rclone, or access the +wrapped remote directly using rclone, there will not be any +encryption/decryption: Downloading existing content will just give you +the encrypted (scrambled) format, and anything you upload will _not_ +become encrypted. + +The encryption is a secret-key encryption (also called symmetric key +encryption) algorithm, where a password (or pass phrase) is used to +generate real encryption key. The password can be supplied by user, or +you may chose to let rclone generate one. It will be stored in the +configuration file, in a lightly obscured form. If you are in an +environment where you are not able to keep your configuration secured, +you should add configuration encryption as protection. As long as you +have this configuration file, you will be able to decrypt your data. +Without the configuration file, as long as you remember the password (or +keep it in a safe place), you can re-create the configuration and gain +access to the existing data. You may also configure a corresponding +remote in a different installation to access the same data. See below +for guidance to changing password. + +Encryption uses cryptographic salt, to permute the encryption key so +that the same string may be encrypted in different ways. When +configuring the crypt remote it is optional to enter a salt, or to let +rclone generate a unique salt. If omitted, rclone uses a built-in unique +string. Normally in cryptography, the salt is stored together with the +encrypted content, and do not have to be memorized by the user. This is +not the case in rclone, because rclone does not store any additional +information on the remotes. Use of custom salt is effectively a second +password that must be memorized. + +File content encryption is performed using NaCl SecretBox, based on +XSalsa20 cipher and Poly1305 for integrity. Names (file- and directory +names) are also encrypted by default, but this has some implications and +is therefore possible to turned off. + +Configuration + +Here is an example of how to make a remote called secret. + +To use crypt, first set up the underlying remote. Follow the +rclone config instructions for the specific backend. + +Before configuring the crypt remote, check the underlying remote is +working. In this example the underlying remote is called remote. We will +configure a path path within this remote to contain the encrypted +content. Anything inside remote:path will be encrypted and anything +outside will not. + +Configure crypt using rclone config. In this example the crypt remote is +called secret, to differentiate it from the underlying remote. + +When you are done you can use the crypt remote named secret just as you +would with any other remote, e.g. rclone copy D:\docs secret:\docs, and +rclone will encrypt and decrypt as needed on the fly. If you access the +wrapped remote remote:path directly you will bypass the encryption, and +anything you read will be in encrypted form, and anything you write will +be undencrypted. To avoid issues it is best to configure a dedicated +path for encrypted content, and access it exclusively through a 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. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / Encrypt/Decrypt a remote + \ "crypt" + [snip] + Storage> crypt + ** See help for crypt backend at: https://rclone.org/crypt/ ** Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - - - Config: remote - - Env Var: RCLONE_CRYPT_REMOTE - - Type: string - - Default: "" - - #### --crypt-filename-encryption - + Enter a string value. Press Enter for the default (""). + remote> remote:path How to encrypt the filenames. - - - Config: filename_encryption - - Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION - - Type: string - - Default: "standard" - - Examples: - - "standard" - - Encrypt the filenames see the docs for the details. - - "obfuscate" - - Very simple filename obfuscation. - - "off" - - Don't encrypt the file names. Adds a ".bin" extension only. - - #### --crypt-directory-name-encryption - + Enter a string value. Press Enter for the default ("standard"). + Choose a number from below, or type in your own value + 1 / Encrypt the filenames see the docs for the details. + \ "standard" + 2 / Very simple filename obfuscation. + \ "obfuscate" + 3 / Don't encrypt the file names. Adds a ".bin" extension only. + \ "off" + filename_encryption> Option to either encrypt directory names or leave them intact. NB If filename_encryption is "off" then this option will do nothing. - - - Config: directory_name_encryption - - Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION - - Type: bool - - Default: true - - Examples: - - "true" - - Encrypt directory names. - - "false" - - Don't encrypt directory names, leave them intact. - - #### --crypt-password - + 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 / Encrypt directory names. + \ "true" + 2 / Don't encrypt directory names, leave them intact. + \ "false" + directory_name_encryption> Password or pass phrase for encryption. - - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - - - Config: password - - Env Var: RCLONE_CRYPT_PASSWORD - - Type: string - - Default: "" - - #### --crypt-password2 - + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. + y) Yes type in my own password + g) Generate random password + n) No leave this optional password blank (default) + 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? Please note that an obscured version of this + password (and not the password itself) will be stored under your + configuration file, so keep this generated password in a safe place. + y) Yes (default) + n) No + y/n> + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> + Remote config + -------------------- + [secret] + type = crypt + remote = remote:path + password = *** ENCRYPTED *** + password2 = *** ENCRYPTED *** + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> + +IMPORTANT The crypt password stored in rclone.conf is lightly obscured. +That only protects it from cursory inspection. It is not secure unless +configuration encryption of rclone.conf is specified. + +A long passphrase is recommended, or rclone config can generate a random +one. + +The obscured password is created using AES-CTR with a static key. The +salt is stored verbatim at the beginning of the obscured password. This +static key is shared between all versions of rclone. + +If you reconfigure rclone with the same passwords/passphrases elsewhere +it will be compatible, but the obscured version will be different due to +the different salt. + +Rclone does not encrypt + +- file length - this can be calculated within 16 bytes +- modification time - used for syncing + +Specifying the remote + +When configuring the remote to encrypt/decrypt, you may specify any +string that rclone accepts as a source/destination of other commands. + +The primary use case is to specify the path into an already configured +remote (e.g. remote:path/to/dir or remote:bucket), such that data in a +remote untrusted location can be stored encrypted. + +You may also specify a local filesystem path, such as /path/to/dir on +Linux, C:\path\to\dir on Windows. By creating a crypt remote pointing to +such a local filesystem path, you can use rclone as a utility for pure +local file encryption, for example to keep encrypted files on a +removable USB drive. + +NOTE: A string which do not contain a : will by rclone be treated as a +relative path in the local filesystem. For example, if you enter the +name remote without the trailing :, it will be treated as a subdirectory +of the current directory with name "remote". + +If a path remote:path/to/dir is specified, rclone stores encrypted files +in path/to/dir on the remote. With file name encryption, files saved to +secret:subdir/subfile are stored in the unencrypted path path/to/dir but +the subdir/subpath element is encrypted. + +The path you specify does not have to exist, rclone will create it when +needed. + +If you intend to use the wrapped remote both directly for keeping +unencrypted content, as well as through a crypt remote for encrypted +content, it is recommended to point the crypt remote to a separate +directory within the wrapped remote. If you use a bucket based storage +system (e.g. Swift, S3, Google Compute Storage, B2, Hubic) it is +generally advisable to wrap the crypt remote around a specific bucket +(s3:bucket). If wrapping around the entire root of the storage (s3:), +and use the optional file name encryption, rclone will encrypt the +bucket name. + +Changing password + +Should the password, or the configuration file containing a lightly +obscured form of the password, be compromised, you need to re-encrypt +your data with a new password. Since rclone uses secret-key encryption, +where the encryption key is generated directly from the password kept on +the client, it is not possible to change the password/key of already +encrypted content. Just changing the password configured for an existing +crypt remote means you will no longer able to decrypt any of the +previously encrypted content. The only possibility is to re-upload +everything via a crypt remote configured with your new password. + +Depending on the size of your data, your bandwith, storage quota etc, +there are different approaches you can take: - If you have everything in +a different location, for example on your local system, you could remove +all of the prior encrypted files, change the password for your +configured crypt remote (or delete and re-create the crypt +configuration), and then re-upload everything from the alternative +location. - If you have enough space on the storage system you can +create a new crypt remote pointing to a separate directory on the same +backend, and then use rclone to copy everything from the original crypt +remote to the new, effectively decrypting everything on the fly using +the old password and re-encrypting using the new password. When done, +delete the original crypt remote directory and finally the rclone crypt +configuration with the old password. All data will be streamed from the +storage system and back, so you will get half the bandwith and be +charged twice if you have upload and download quota on the storage +system. + +NOTE: A security problem related to the random password generator was +fixed in rclone version 1.53.3 (released 2020-11-19). Passwords +generated by rclone config in version 1.49.0 (released 2019-08-26) to +1.53.2 (released 2020-10-26) are not considered secure and should be +changed. If you made up your own password, or used rclone version older +than 1.49.0 or newer than 1.53.2 to generate it, you are _not_ affected +by this issue. See issue #4783 for more details, and a tool you can use +to check if you are affected. + +Example + +Create the following file structure 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 + + $ 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 + +The crypt remote looks like + + $ rclone -q ls remote:path + 55 hagjclgavj2mbiqm6u6cnjjqcg + 54 v05749mltvv1tf4onltun46gls + 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo + 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc + 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps + +The directory structure is preserved + + $ rclone -q ls secret:subdir + 8 file2.txt + 9 file3.txt + 10 subsubdir/file4.txt + +Without file name encryption .bin extensions are added to underlying +names. This prevents the cloud provider attempting to interpret file +content. + + $ 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 + +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. Rclone stores the distance at the +beginning of the filename. A file called "hello" may become "53.jgnnq". + +Obfuscation is not a strong encryption of filenames, but hinders +automated scanning tools picking up on filename patterns. It is an +intermediate between "off" and "standard" which allows for longer path +segment names. - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). +There is a possibility with some unicode based filenames that the +obfuscation is weak and may map lower case characters to upper case +equivalents. - - Config: password2 - - Env Var: RCLONE_CRYPT_PASSWORD2 - - Type: string - - Default: "" +Obfuscation cannot be relied upon for strong protection. - ### Advanced Options +- 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 - Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). +Cloud storage systems have limits on file name length and total path +length which rclone is more likely to breach using "Standard" file name +encryption. Where file names are less thn 156 characters in length +issues should not be encountered, irrespective of cloud storage +provider. - #### --crypt-server-side-across-configs +An alternative, future rclone file name encryption mode may tolerate +backend provider path length limits. - Allow server side operations (eg copy) to work across different crypt configs. +Directory name encryption - Normally this option is not what you want, but if you have two crypts - pointing to the same backend you can use it. +Crypt offers the option of encrypting dir names or leaving them intact. +There are two options: - This can be used, for example, to change file name encryption type - without re-uploading all the data. Just make two crypt backends - pointing to two different directories with the single changed - parameter and use rclone move to move the files between the crypt - remotes. +True - - Config: server_side_across_configs - - Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS - - Type: bool - - Default: false +Encrypts the whole file path including directory names Example: +1/12/123.txt is encrypted to +p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0 - #### --crypt-show-mapping +False - For all files listed show how the names encrypt. +Only encrypts file names, skips directory names Example: 1/12/123.txt is +encrypted to 1/12/qgm4avr35m5loi1th53ato71v0 - 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. +Modified time and hashes - 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. +Crypt stores modification times using the underlying remote so support +depends on that. - - Config: show_mapping - - Env Var: RCLONE_CRYPT_SHOW_MAPPING - - Type: bool - - Default: false +Hashes are not stored for crypt. However the data integrity is protected +by an extremely strong crypto authenticator. - ### Backend commands +Use the rclone cryptcheck command to check the integrity of a crypted +remote instead of rclone check which can't check the checksums properly. - Here are the commands specific to the crypt backend. +Standard Options - Run them with +Here are the standard options specific to crypt (Encrypt/Decrypt a +remote). - rclone backend COMMAND remote: +--crypt-remote - The help below will explain what arguments each command takes. +Remote to encrypt/decrypt. Normally should contain a ':' and a path, +e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not +recommended). - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. +- Config: remote +- Env Var: RCLONE_CRYPT_REMOTE +- Type: string +- Default: "" - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). +--crypt-filename-encryption - #### encode +How to encrypt the filenames. - Encode the given filename(s) +- Config: filename_encryption +- Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION +- Type: string +- Default: "standard" +- Examples: + - "standard" + - Encrypt the filenames see the docs for the details. + - "obfuscate" + - Very simple filename obfuscation. + - "off" + - Don't encrypt the file names. Adds a ".bin" extension only. - rclone backend encode remote: [options] [+] +--crypt-directory-name-encryption - This encodes the filenames given as arguments returning a list of - strings of the encoded results. +Option to either encrypt directory names or leave them intact. - Usage Example: +NB If filename_encryption is "off" then this option will do nothing. - rclone backend encode crypt: file1 [file2...] - rclone rc backend/command command=encode fs=crypt: file1 [file2...] +- 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 - #### decode +Password or pass phrase for encryption. - Decode the given filename(s) +NB Input to this must be obscured - see rclone obscure. - rclone backend decode remote: [options] [+] +- Config: password +- Env Var: RCLONE_CRYPT_PASSWORD +- Type: string +- Default: "" - This decodes the filenames given as arguments returning a list of - strings of the decoded results. It will return an error if any of the - inputs are invalid. +--crypt-password2 - Usage Example: +Password or pass phrase for salt. Optional but recommended. Should be +different to the previous password. - rclone backend decode crypt: encryptedfile1 [encryptedfile2...] - rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] +NB Input to this must be obscured - see rclone obscure. +- Config: password2 +- Env Var: RCLONE_CRYPT_PASSWORD2 +- Type: string +- Default: "" +Advanced Options +Here are the advanced options specific to crypt (Encrypt/Decrypt a +remote). - ## Backing up a crypted remote ## +--crypt-server-side-across-configs - If you wish to backup a crypted remote, it is recommended that you use - `rclone sync` on the encrypted files, and make sure the passwords are - the same in the new encrypted remote. +Allow server-side operations (e.g. copy) to work across different crypt +configs. - This will have the following advantages +Normally this option is not what you want, but if you have two crypts +pointing to the same backend you can use it. - * `rclone sync` will check the checksums while copying - * you can use `rclone check` between the encrypted remotes - * you don't decrypt and encrypt unnecessarily +This can be used, for example, to change file name encryption type +without re-uploading all the data. Just make two crypt backends pointing +to two different directories with the single changed parameter and use +rclone move to move the files between the crypt remotes. - For example, let's say you have your original remote at `remote:` with - the encrypted version at `eremote:` with path `remote:crypt`. You - would then set up the new remote `remote2:` and then the encrypted - version `eremote2:` with path `remote2:crypt` using the same passwords - as `eremote:`. +- Config: server_side_across_configs +- Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false - To sync the two remotes you would do +--crypt-show-mapping - rclone sync -i remote:crypt remote2:crypt +For all files listed show how the names encrypt. - And to check the integrity you would do +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. - rclone check remote:crypt remote2:crypt +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. - ## File formats ## +- Config: show_mapping +- Env Var: RCLONE_CRYPT_SHOW_MAPPING +- Type: bool +- Default: false - ### File encryption ### +Backend commands - Files are encrypted 1:1 source file to destination object. The file - has a header and is divided into chunks. +Here are the commands specific to the crypt backend. - #### Header #### +Run them with - * 8 bytes magic string `RCLONE\x00\x00` - * 24 bytes Nonce (IV) + rclone backend COMMAND remote: - 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. +The help below will explain what arguments each command takes. - #### Chunk #### +See the "rclone backend" command for more info on how to pass options +and arguments. - 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. +These can be run on a running backend using the rc command +backend/command. - Each chunk contains: +encode - * 16 Bytes of Poly1305 authenticator - * 1 - 65536 bytes XSalsa20 encrypted data +Encode the given filename(s) - 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. + rclone backend encode remote: [options] [+] - This uses a 32 byte (256 bit key) key derived from the user password. +This encodes the filenames given as arguments returning a list of +strings of the encoded results. - #### Examples #### +Usage Example: - 1 byte file will encrypt to + rclone backend encode crypt: file1 [file2...] + rclone rc backend/command command=encode fs=crypt: file1 [file2...] - * 32 bytes header - * 17 bytes data chunk +decode - 49 bytes total +Decode the given filename(s) - 1MB (1048576 bytes) file will encrypt to + rclone backend decode remote: [options] [+] - * 32 bytes header - * 16 chunks of 65568 bytes +This decodes the filenames given as arguments returning a list of +strings of the decoded results. It will return an error if any of the +inputs are invalid. - 1049120 bytes total (a 0.05% overhead). This is the overhead for big - files. +Usage Example: - ### Name encryption ### + rclone backend decode crypt: encryptedfile1 [encryptedfile2...] + rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] - File names are encrypted segment by segment - the path is broken up - into `/` separated strings and these are encrypted individually. - File segments are padded using PKCS#7 to a multiple of 16 bytes - before encryption. +Backing up a crypted remote - 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. +If you wish to backup a crypted remote, it is recommended that you use +rclone sync on the encrypted files, and make sure the passwords are the +same in the new encrypted remote. - This 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 will have the following advantages - This means that +- rclone sync will check the checksums while copying +- you can use rclone check between the encrypted remotes +- you don't decrypt and encrypt unnecessarily - * filenames with the same name will encrypt the same - * filenames which start the same won't have a common prefix +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:. - This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of - which are derived from the user password. +To sync the two remotes you would do - After encryption they are written out using a modified version of - standard `base32` encoding as described in RFC4648. The standard - encoding is modified in two ways: + rclone sync -i remote:crypt remote2:crypt - * it becomes lower case (no-one likes upper case filenames!) - * we strip the padding character `=` +And to check the integrity you would do - `base32` is used rather than the more efficient `base64` so rclone can be - used on case insensitive remotes (eg Windows, Amazon Drive). + rclone check remote:crypt remote2:crypt - ### 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. +File formats - `scrypt` makes it impractical to mount a dictionary attack on rclone - encrypted data. For full protection against this you should always use - a salt. +File encryption - Dropbox - --------------------------------- +Files are encrypted 1:1 source file to destination object. The file has +a header and is divided into chunks. - Paths are specified as `remote:path` +Header - Dropbox paths may be as deep as required, eg - `remote:directory/subdirectory`. +- 8 bytes magic string RCLONE\x00\x00 +- 24 bytes Nonce (IV) - 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. +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. - Here is an example of how to make a remote called `remote`. First run: +Chunk - rclone config +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. - This will guide you through an interactive setup process: +Each chunk contains: -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: +- 16 Bytes of Poly1305 authenticator +- 1 - 65536 bytes XSalsa20 encrypted data + +64k chunk size was chosen as the best performing chunk size (the +authenticator takes too much time below this and the performance drops +off due to cache effects above this). Note that these chunks are +buffered in memory so they can't be too big. + +This uses a 32 byte (256 bit key) key derived from the user password. + +Examples + +1 byte file will encrypt to + +- 32 bytes header +- 17 bytes data chunk + +49 bytes total + +1MB (1048576 bytes) file will encrypt to + +- 32 bytes header +- 16 chunks of 65568 bytes + +1049120 bytes total (a 0.05% overhead). This is the overhead for big +files. + +Name encryption + +File names are encrypted segment by segment - the path is broken up into +/ separated strings and these are encrypted individually. + +File segments are padded using PKCS#7 to a multiple of 16 bytes before +encryption. + +They are then encrypted with EME using AES with 256 bit key. EME +(ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 +paper "A Parallelizable Enciphering Mode" by Halevi and Rogaway. + +This makes for deterministic encryption which is what we want - the same +filename must encrypt to the same thing otherwise we can't find it on +the cloud storage system. + +This means that + +- filenames with the same name will encrypt the same +- filenames which start the same won't have a common prefix + +This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of +which are derived from the user password. + +After encryption they are written out using a modified version of +standard base32 encoding as described in RFC4648. The standard encoding +is modified in two ways: + +- it becomes lower case (no-one likes upper case filenames!) +- we strip the padding character = + +base32 is used rather than the more efficient base64 so rclone can be +used on case insensitive remotes (e.g. 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. + + +SEE ALSO + +- rclone cryptdecode - Show forward/reverse mapping of encrypted + filenames + + +Compress (Experimental) + +Warning + +This remote is currently EXPERIMENTAL. Things may break and data may be +lost. Anything you do with this remote is at your own risk. Please +understand the risks associated with using experimental code and don't +use this remote in critical applications. + +The Compress remote adds compression to another remote. It is best used +with remotes containing many large compressible files. + +To use this remote, all you need to do is specify another remote and a +compression mode to use: + + Current remotes: + + Name Type + ==== ==== + remote_to_press sometype + + e) Edit existing remote + $ rclone config + 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> n + name> compress + ... + 8 / Compress a remote + \ "compress" + ... + Storage> compress + ** See help for compress backend at: https://rclone.org/compress/ ** + + Remote to compress. + Enter a string value. Press Enter for the default (""). + remote> remote_to_press:subdir + Compression mode. + Enter a string value. Press Enter for the default ("gzip"). + Choose a number from below, or type in your own value + 1 / Gzip compression balanced for speed and compression strength. + \ "gzip" + compression_mode> gzip + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> n + Remote config + -------------------- + [compress] + type = compress + remote = remote_to_press:subdir + compression_mode = gzip + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y + +Compression Modes + +Currently only gzip compression is supported, it provides a decent +balance between speed and strength and is well supported by other +application. Compression strength can further be configured via an +advanced setting where 0 is no compression and 9 is strongest +compression. + +Filetype + +If you open a remote wrapped by press, you will see that there are many +files with an extension corresponding to the compression algorithm you +chose. These files are standard files that can be opened by various +archive programs, but they have some hidden metadata that allows them to +be used by rclone. While you may download and decompress these files at +will, do NOT manually delete or rename files. Files without correct +metadata files will not be recognized by rclone. + +File names + +The compressed files will be named *.###########.gz where * is the base +file and the # part is base64 encoded size of the uncompressed file. The +file names should not be changed by anything other than the rclone +compression backend. + +Standard Options + +Here are the standard options specific to compress (Compress a remote). + +--compress-remote + +Remote to compress. + +- Config: remote +- Env Var: RCLONE_COMPRESS_REMOTE +- Type: string +- Default: "" + +--compress-mode + +Compression mode. + +- Config: mode +- Env Var: RCLONE_COMPRESS_MODE +- Type: string +- Default: "gzip" +- Examples: + - "gzip" + - Standard gzip compression with fastest parameters. + +Advanced Options + +Here are the advanced options specific to compress (Compress a remote). + +--compress-level + +GZIP compression level (-2 to 9). + + Generally -1 (default, equivalent to 5) is recommended. + Levels 1 to 9 increase compressiong at the cost of speed.. Going past 6 + generally offers very little return. + + Level -2 uses Huffmann encoding only. Only use if you now what you + are doing + Level 0 turns off compression. + +- Config: level +- Env Var: RCLONE_COMPRESS_LEVEL +- Type: int +- Default: -1 + +--compress-ram-cache-limit + +Some remotes don't allow the upload of files with unknown size. In this +case the compressed file will need to be cached to determine it's size. + + Files smaller than this limit will be cached in RAM, file larger than + this limit will be cached on disk + +- Config: ram_cache_limit +- Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT +- Type: SizeSuffix +- Default: 20M + + +Dropbox + +Paths are specified as remote:path + +Dropbox paths may be as deep as required, e.g. +remote:directory/subdirectory. + +The initial setup for dropbox involves getting a token from Dropbox +which you need to do in your browser. rclone config walks you through +it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + n) New remote + d) Delete remote + q) Quit config + e/n/d/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Dropbox + \ "dropbox" + [snip] + Storage> dropbox + Dropbox App Key - leave blank normally. + app_key> + Dropbox App Secret - leave blank normally. + app_secret> + Remote config + Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX - -------------------- [remote] app_key = app_secret = token = - XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX -------------------- -q) Yes this is OK -r) Edit this remote -s) Delete this remote y/e/d> y - - - You can then use it like this, - - List directories in top level of your dropbox - - rclone lsd remote: - - List all the files in your dropbox - - rclone ls remote: - - To copy a local directory to a dropbox directory called backup - - rclone copy /home/source remote:backup - - ### Dropbox for business ### - - Rclone supports Dropbox for business and Team Folders. - - When using Dropbox for business `remote:` and `remote:path/to/file` - will refer to your personal folder. - - If you wish to see Team Folders you must use a leading `/` in the - path, so `rclone lsd remote:/` will refer to the root and show you all - Team Folders and your User Folder. - - You can then use team folders like this `remote:/TeamFolder` and - `remote:/TeamFolder/path/to/file`. - - A leading `/` for a Dropbox personal account will do nothing, but it - will take an extra HTTP transaction so it should be avoided. - - ### Modified time and Hashes ### - - Dropbox supports modified times, but the only way to set a - modification time is to re-upload the file. - - This means that if you uploaded your data with an older version of - rclone which didn't support the v2 API and modified times, rclone will - decide to upload all your old data to fix the modification times. If - you don't want this to happen use `--size-only` or `--checksum` flag - to stop it. - - Dropbox supports [its own hash - type](https://www.dropbox.com/developers/reference/content-hash) which - is checked for all transfers. - - #### Restricted filename characters - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - | DEL | 0x7F | ␡ | - | \ | 0x5C | ＼ | - - File names can also not end with the following characters. - These only get replaced if they are the last character in the name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to dropbox (Dropbox). - - #### --dropbox-client-id - - OAuth Client Id - Leave blank normally. - - - Config: client_id - - Env Var: RCLONE_DROPBOX_CLIENT_ID - - Type: string - - Default: "" - - #### --dropbox-client-secret - - OAuth Client Secret - Leave blank normally. - - - Config: client_secret - - Env Var: RCLONE_DROPBOX_CLIENT_SECRET - - Type: string - - Default: "" - - ### Advanced Options - - Here are the advanced options specific to dropbox (Dropbox). - - #### --dropbox-token - - OAuth Access Token as a JSON blob. - - - Config: token - - Env Var: RCLONE_DROPBOX_TOKEN - - Type: string - - Default: "" - - #### --dropbox-auth-url - - Auth server URL. - Leave blank to use the provider defaults. - - - Config: auth_url - - Env Var: RCLONE_DROPBOX_AUTH_URL - - Type: string - - Default: "" - - #### --dropbox-token-url - - Token server url. - Leave blank to use the provider defaults. - - - Config: token_url - - Env Var: RCLONE_DROPBOX_TOKEN_URL - - Type: string - - Default: "" - - #### --dropbox-chunk-size - - Upload chunk size. (< 150M). - - Any files larger than this will be uploaded in chunks of this size. - - Note that chunks are buffered in memory (one at a time) so rclone can - deal with retries. Setting this larger will increase the speed - slightly (at most 10% for 128MB in tests) at the cost of using more - memory. It can be set smaller if you are tight on memory. - - - Config: chunk_size - - Env Var: RCLONE_DROPBOX_CHUNK_SIZE - - Type: SizeSuffix - - Default: 48M - - #### --dropbox-impersonate - - Impersonate this user when using a business account. - - - Config: impersonate - - Env Var: RCLONE_DROPBOX_IMPERSONATE - - Type: string - - Default: "" - - #### --dropbox-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_DROPBOX_ENCODING - - Type: MultiEncoder - - Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - - - - ### Limitations ### - - Note that Dropbox is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". - - There are some file names such as `thumbs.db` which Dropbox can't - store. There is a full list of them in the ["Ignored Files" section - of this document](https://www.dropbox.com/en/help/145). Rclone will - issue an error message `File name disallowed - not uploading` if it - attempts to upload one of those file names, but the sync won't fail. - - Some errors may occur if you try to sync copyright-protected files - because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) that - prevents this sort of file being downloaded. This will return the error `ERROR : - /path/to/your/file: Failed to copy: failed to open source object: - path/restricted_content/.` - - If you have more than 10,000 files in a directory then `rclone purge - dropbox:dir` will return the error `Failed to purge: There are too - many files involved in this operation`. As a work-around do an - `rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir`. - - ### Get your own Dropbox App ID ### - - When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users. - - Here is how to create your own Dropbox App ID for rclone: - - 1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not - to be the same account as the Dropbox you want to access) - - 2. Choose an API => Usually this should be `Dropbox API` - - 3. Choose the type of access you want to use => `Full Dropbox` or `App Folder` - - 4. Name your App. The app name is global, so you can't use `rclone` for example - - 5. Click the button `Create App` - - 5. Fill `Redirect URIs` as `http://localhost:53682/` - - 6. Find the `App key` and `App secret` Use these values in rclone config to add a new remote or edit an existing remote. - - FTP - ------------------------------ - - FTP is the File Transfer Protocol. FTP support is provided using the - [github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) - package. - - Paths are specified as `remote:path`. If the path does not begin with - a `/` it is relative to the home directory of the user. An empty path - `remote:` refers to the user's home directory. - - Here is an example of making an FTP configuration. First run - - rclone config - - This will guide you through an interactive setup process. An FTP remote only - needs a host together with and a username and a password. With anonymous FTP - server, you will need to use `anonymous` as username and your email address as - the password. - -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Enter a string value. Press Enter -for the default (""). Choose a number from below, or type in your own -value [snip] XX / FTP Connection  "ftp" [snip] Storage> ftp ** See help -for ftp backend at: https://rclone.org/ftp/ ** - -FTP host to connect to Enter a string value. Press Enter for the default -(""). Choose a number from below, or type in your own value 1 / Connect -to ftp.example.com  "ftp.example.com" host> ftp.example.com FTP -username, leave blank for current username, ncw Enter a string value. -Press Enter for the default (""). user> FTP port, leave blank to use -default (21) Enter a string value. Press Enter for the default (""). -port> FTP password y) Yes type in my own password g) Generate random -password y/g> y Enter the password: password: Confirm the password: -password: Use FTP over TLS (Implicit) Enter a boolean value (true or -false). Press Enter for the default ("false"). tls> Use FTP over TLS -(Explicit) Enter a boolean value (true or false). Press Enter for the -default ("false"). explicit_tls> Remote config -------------------- -[remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** --------------------- y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> y - - - This remote is called `remote` and can now be used like this - - See all directories in the home directory - - rclone lsd remote: - - Make a new directory - - rclone mkdir remote:path/to/directory - - List the contents of a directory - - rclone ls remote:path/to/directory - - Sync `/home/local/directory` to the remote directory, deleting any - excess files in the directory. - - rclone sync -i /home/local/directory remote:directory - - ### Modified time ### - - FTP does not support modified times. Any times you see on the server - will be time of upload. - - ### Checksums ### - - FTP does not support any checksums. - - ### Usage without a config file ### - - An example how to use the ftp remote without a config file: - - rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy` - - #### Restricted filename characters - - In addition to the [default restricted characters set](https://rclone.org/overview/#restricted-characters) - the following characters are also replaced: - - File names can also not end with the following characters. - These only get replaced if they are the last character in the name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - - Note that not all FTP servers can have all characters in file names, for example: - - | FTP Server| Forbidden characters | - | --------- |:--------------------:| - | proftpd | `*` | - | pureftpd | `\ [ ]` | - - ### Implicit TLS ### - - FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled - in the config for the remote. The default FTPS port is `990` so the - port will likely have to be explicitly set in the config for the remote. - - - ### Standard Options - - Here are the standard options specific to ftp (FTP Connection). - - #### --ftp-host - - FTP host to connect to - - - Config: host - - Env Var: RCLONE_FTP_HOST - - Type: string - - Default: "" - - Examples: - - "ftp.example.com" - - Connect to ftp.example.com - - #### --ftp-user - - FTP username, leave blank for current username, $USER - - - Config: user - - Env Var: RCLONE_FTP_USER - - Type: string - - Default: "" - - #### --ftp-port - - FTP port, leave blank to use default (21) - - - Config: port - - Env Var: RCLONE_FTP_PORT - - Type: string - - Default: "" - - #### --ftp-pass - - FTP password - - **NB** Input to this must be obscured - see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - - - Config: pass - - Env Var: RCLONE_FTP_PASS - - Type: string - - Default: "" - - #### --ftp-tls - - Use FTPS over TLS (Implicit) - When using implicit FTP over TLS the client will connect using TLS - right from the start, which in turn breaks the compatibility with - non-TLS-aware servers. This is usually served over port 990 rather - than port 21. Cannot be used in combination with explicit FTP. - - - Config: tls - - Env Var: RCLONE_FTP_TLS - - Type: bool - - Default: false - - #### --ftp-explicit-tls - - Use FTP over TLS (Explicit) - When using explicit FTP over TLS the client explicitly request - security from the server in order to upgrade a plain text connection - to an encrypted one. Cannot be used in combination with implicit FTP. - - - Config: explicit_tls - - Env Var: RCLONE_FTP_EXPLICIT_TLS - - Type: bool - - Default: false - - ### Advanced Options - - Here are the advanced options specific to ftp (FTP Connection). - - #### --ftp-concurrency - - Maximum number of FTP simultaneous connections, 0 for unlimited - - - Config: concurrency - - Env Var: RCLONE_FTP_CONCURRENCY - - Type: int - - Default: 0 - - #### --ftp-no-check-certificate - - Do not verify the TLS certificate of the server - - - Config: no_check_certificate - - Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE - - Type: bool - - Default: false - - #### --ftp-disable-epsv - - Disable using EPSV even if server advertises support - - - Config: disable_epsv - - Env Var: RCLONE_FTP_DISABLE_EPSV - - Type: bool - - Default: false - - #### --ftp-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_FTP_ENCODING - - Type: MultiEncoder - - Default: Slash,Del,Ctl,RightSpace,Dot - - - - ### Limitations ### - - Note that FTP does have its own implementation of : `--dump headers`, - `--dump bodies`, `--dump auth` for debugging which isn't the same as - the HTTP based backends - it has less fine grained control. - - Note that `--timeout` isn't supported (but `--contimeout` is). - - Note that `--bind` isn't supported. - - FTP could support server side move but doesn't yet. - - Note that the ftp backend does not support the `ftp_proxy` environment - variable yet. - - Google Cloud Storage - ------------------------------------------------- - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - The initial setup for google cloud storage involves getting a token from Google Cloud Storage - which you need to do in your browser. `rclone config` walks you - through it. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -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 + [remote] + app_key = + app_secret = + token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX -------------------- -a) Yes this is OK -b) Edit this remote -c) Delete this remote y/e/d> y + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y +You can then use it like this, - 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. +List directories in top level of your dropbox - This remote is called `remote` and can now be used like this + rclone lsd remote: - See all the buckets in your project +List all the files in your dropbox - rclone lsd remote: + rclone ls remote: - Make a new bucket +To copy a local directory to a dropbox directory called backup - rclone mkdir remote:bucket + rclone copy /home/source remote:backup - List the contents of a bucket +Dropbox for business - rclone ls remote:bucket +Rclone supports Dropbox for business and Team Folders. - Sync `/home/local/directory` to the remote bucket, deleting any excess - files in the bucket. +When using Dropbox for business remote: and remote:path/to/file will +refer to your personal folder. - rclone sync -i /home/local/directory remote:bucket +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. - ### Service Account support ### +You can then use team folders like this remote:/TeamFolder and +remote:/TeamFolder/path/to/file. - 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. +A leading / for a Dropbox personal account will do nothing, but it will +take an extra HTTP transaction so it should be avoided. - 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. +Modified time and Hashes - 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. +Dropbox supports modified times, but the only way to set a modification +time is to re-upload the file. - ### Anonymous Access ### +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. - For downloads of objects that permit public access you can configure rclone - to use anonymous access by setting `anonymous` to `true`. - With unauthorized access you can't write or create files but only read or list - those buckets and objects that have public read access. +Dropbox supports its own hash type which is checked for all transfers. - ### Application Default Credentials ### +Restricted filename characters - 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). + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + DEL 0x7F ␡ + \ 0x5C ＼ - Note that in the case application default credentials are used, there - is no need to explicitly configure a project number. +File names can also not end with the following characters. These only +get replaced if they are the last character in the name: - ### --fast-list ### + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - ### Custom upload headers ### +Standard Options - You can set custom upload headers with the `--header-upload` - flag. Google Cloud Storage supports the headers as described in the - [working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) +Here are the standard options specific to dropbox (Dropbox). - - Cache-Control - - Content-Disposition - - Content-Encoding - - Content-Language - - Content-Type - - X-Goog-Meta- +--dropbox-client-id - Eg `--header-upload "Content-Type text/potato"` +OAuth Client Id Leave blank normally. - Note that the last of these is for setting custom metadata in the form - `--header-upload "x-goog-meta-key: value"` +- Config: client_id +- Env Var: RCLONE_DROPBOX_CLIENT_ID +- Type: string +- Default: "" - ### Modified time ### +--dropbox-client-secret - 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. +OAuth Client Secret Leave blank normally. - #### Restricted filename characters +- Config: client_secret +- Env Var: RCLONE_DROPBOX_CLIENT_SECRET +- Type: string +- Default: "" - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | LF | 0x0A | ␊ | - | CR | 0x0D | ␍ | - | / | 0x2F | ／ | +Advanced Options - Invalid UTF-8 bytes will also be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. +Here are the advanced options specific to dropbox (Dropbox). +--dropbox-token - ### Standard Options +OAuth Access Token as a JSON blob. - Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). +- Config: token +- Env Var: RCLONE_DROPBOX_TOKEN +- Type: string +- Default: "" - #### --gcs-client-id +--dropbox-auth-url - OAuth Client Id - Leave blank normally. +Auth server URL. Leave blank to use the provider defaults. - - Config: client_id - - Env Var: RCLONE_GCS_CLIENT_ID - - Type: string - - Default: "" +- Config: auth_url +- Env Var: RCLONE_DROPBOX_AUTH_URL +- Type: string +- Default: "" - #### --gcs-client-secret +--dropbox-token-url - OAuth Client Secret - Leave blank normally. +Token server url. Leave blank to use the provider defaults. - - Config: client_secret - - Env Var: RCLONE_GCS_CLIENT_SECRET - - Type: string - - Default: "" +- Config: token_url +- Env Var: RCLONE_DROPBOX_TOKEN_URL +- Type: string +- Default: "" - #### --gcs-project-number +--dropbox-chunk-size - Project number. - Optional - needed only for list/create/delete buckets - see your developer console. +Upload chunk size. (< 150M). - - Config: project_number - - Env Var: RCLONE_GCS_PROJECT_NUMBER - - Type: string - - Default: "" +Any files larger than this will be uploaded in chunks of this size. - #### --gcs-service-account-file +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. - Service Account Credentials JSON file path - Leave blank normally. - Needed only if you want use SA instead of interactive login. +- Config: chunk_size +- Env Var: RCLONE_DROPBOX_CHUNK_SIZE +- Type: SizeSuffix +- Default: 48M - Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. +--dropbox-impersonate +Impersonate this user when using a business account. - - Config: service_account_file - - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE - - Type: string - - Default: "" +- Config: impersonate +- Env Var: RCLONE_DROPBOX_IMPERSONATE +- Type: string +- Default: "" - #### --gcs-service-account-credentials +--dropbox-shared-files - Service Account Credentials JSON blob - Leave blank normally. - Needed only if you want use SA instead of interactive login. +Instructs rclone to work on individual shared files. - - Config: service_account_credentials - - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS - - Type: string - - Default: "" +In this mode rclone's features are extremely limited - only list (ls, +lsl, etc.) operations and read operations (e.g. downloading) are +supported in this mode. All other operations will be disabled. - #### --gcs-anonymous +- Config: shared_files +- Env Var: RCLONE_DROPBOX_SHARED_FILES +- Type: bool +- Default: false - Access public buckets and objects without credentials - Set to 'true' if you just want to download files and don't configure credentials. - - - Config: anonymous - - Env Var: RCLONE_GCS_ANONYMOUS - - Type: bool - - Default: false - - #### --gcs-object-acl - - Access Control List for new objects. - - - Config: object_acl - - Env Var: RCLONE_GCS_OBJECT_ACL - - Type: string - - Default: "" - - Examples: - - "authenticatedRead" - - Object owner gets OWNER access, and all Authenticated Users get READER access. - - "bucketOwnerFullControl" - - Object owner gets OWNER access, and project team owners get OWNER access. - - "bucketOwnerRead" - - Object owner gets OWNER access, and project team owners get READER access. - - "private" - - Object owner gets OWNER access [default if left blank]. - - "projectPrivate" - - Object owner gets OWNER access, and project team members get access according to their roles. - - "publicRead" - - Object owner gets OWNER access, and all Users get READER access. - - #### --gcs-bucket-acl - - Access Control List for new buckets. - - - Config: bucket_acl - - Env Var: RCLONE_GCS_BUCKET_ACL - - Type: string - - Default: "" - - Examples: - - "authenticatedRead" - - Project team owners get OWNER access, and all Authenticated Users get READER access. - - "private" - - Project team owners get OWNER access [default if left blank]. - - "projectPrivate" - - Project team members get access according to their roles. - - "publicRead" - - Project team owners get OWNER access, and all Users get READER access. - - "publicReadWrite" - - Project team owners get OWNER access, and all Users get WRITER access. - - #### --gcs-bucket-policy-only - - Access checks should use bucket-level IAM policies. - - If you want to upload objects to a bucket with Bucket Policy Only set - then you will need to set this. - - When it is set, rclone: - - - ignores ACLs set on buckets - - ignores ACLs set on objects - - creates buckets with Bucket Policy Only set - - Docs: https://cloud.google.com/storage/docs/bucket-policy-only - - - - Config: bucket_policy_only - - Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY - - Type: bool - - Default: false - - #### --gcs-location - - Location for the newly created buckets. - - - Config: location - - Env Var: RCLONE_GCS_LOCATION - - Type: string - - Default: "" - - Examples: - - "" - - Empty for default location (US). - - "asia" - - Multi-regional location for Asia. - - "eu" - - Multi-regional location for Europe. - - "us" - - Multi-regional location for United States. - - "asia-east1" - - Taiwan. - - "asia-east2" - - Hong Kong. - - "asia-northeast1" - - Tokyo. - - "asia-south1" - - Mumbai. - - "asia-southeast1" - - Singapore. - - "australia-southeast1" - - Sydney. - - "europe-north1" - - Finland. - - "europe-west1" - - Belgium. - - "europe-west2" - - London. - - "europe-west3" - - Frankfurt. - - "europe-west4" - - Netherlands. - - "us-central1" - - Iowa. - - "us-east1" - - South Carolina. - - "us-east4" - - Northern Virginia. - - "us-west1" - - Oregon. - - "us-west2" - - California. - - #### --gcs-storage-class - - The storage class to use when storing objects in Google Cloud Storage. - - - Config: storage_class - - Env Var: RCLONE_GCS_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "MULTI_REGIONAL" - - Multi-regional storage class - - "REGIONAL" - - Regional storage class - - "NEARLINE" - - Nearline storage class - - "COLDLINE" - - Coldline storage class - - "ARCHIVE" - - Archive storage class - - "DURABLE_REDUCED_AVAILABILITY" - - Durable reduced availability storage class - - ### Advanced Options - - Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - - #### --gcs-token - - OAuth Access Token as a JSON blob. - - - Config: token - - Env Var: RCLONE_GCS_TOKEN - - Type: string - - Default: "" - - #### --gcs-auth-url - - Auth server URL. - Leave blank to use the provider defaults. - - - Config: auth_url - - Env Var: RCLONE_GCS_AUTH_URL - - Type: string - - Default: "" - - #### --gcs-token-url - - Token server url. - Leave blank to use the provider defaults. - - - Config: token_url - - Env Var: RCLONE_GCS_TOKEN_URL - - Type: string - - Default: "" - - #### --gcs-encoding - - This sets the encoding for the backend. - - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - - - Config: encoding - - Env Var: RCLONE_GCS_ENCODING - - Type: MultiEncoder - - Default: Slash,CrLf,InvalidUtf8,Dot - - - - Google Drive - ----------------------------------------- +--dropbox-shared-folders - Paths are specified as `drive:path` +Instructs rclone to work on shared folders. - Drive paths may be as deep as required, eg `drive:directory/subdirectory`. +When this flag is used with no path only the List operation is supported +and all available shared folders will be listed. If you specify a path +the first part will be interpreted as the name of shared folder. Rclone +will then try to mount this shared to the root namespace. On success +shared folder rclone proceeds normally. The shared folder is now pretty +much a normal folder and all normal operations are supported. - 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. +Note that we don't unmount the shared folder afterwards so the +--dropbox-shared-folders can be omitted after the first use of a +particular shared folder. - Here is an example of how to make a remote called `remote`. First run: +- Config: shared_folders +- Env Var: RCLONE_DROPBOX_SHARED_FOLDERS +- Type: bool +- Default: false - rclone config +--dropbox-encoding - This will guide you through an interactive setup process: +This sets the encoding for the backend. -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 +See: the encoding section in the overview for more info. +- Config: encoding +- Env Var: RCLONE_DROPBOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - 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. +Limitations - You can then use it like this, +Note that Dropbox is case insensitive so you can't have a file called +"Hello.doc" and one called "hello.doc". - List directories in top level of your drive +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. - rclone lsd remote: +Some errors may occur if you try to sync copyright-protected files +because Dropbox has its own copyright detector that prevents this sort +of file being downloaded. This will return the error +ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/. - List all the files in your drive +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. - rclone ls remote: +Get your own Dropbox App ID - To copy a local directory to a drive directory called backup +When you use rclone with Dropbox in its default configuration you are +using rclone's App ID. This is shared between all the rclone users. - rclone copy /home/source remote:backup +Here is how to create your own Dropbox App ID for rclone: - ### Scopes ### +1. Log into the Dropbox App console with your Dropbox Account (It need + not to be the same account as the Dropbox you want to access) - 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). +2. Choose an API => Usually this should be Dropbox API - The scope are +3. Choose the type of access you want to use => Full Dropbox or + App Folder - #### drive #### +4. Name your App. The app name is global, so you can't use rclone for + example - This is the default scope and allows full access to all files, except - for the Application Data Folder (see below). +5. Click the button Create App - Choose this one if you aren't sure. +6. Fill Redirect URIs as http://localhost:53682/ - #### drive.readonly #### +7. Find the App key and App secret Use these values in rclone config to + add a new remote or edit an existing remote. - This allows read only access to all files. Files may be listed and - downloaded but not uploaded, renamed or deleted. - #### drive.file #### +Enterprise File Fabric - With this scope rclone can read/view/modify only those files and - folders it creates. +This backend supports Storage Made Easy's Enterprise File Fabric™ which +provides a software solution to integrate and unify File and Object +Storage accessible through a global file system. - So if you uploaded files to drive via the web interface (or any other - means) they will not be visible to rclone. +The initial setup for the Enterprise File Fabric backend involves +getting a token from the the Enterprise File Fabric which you need to do +in your browser. rclone config walks you through it. - 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. +Here is an example of how to make a remote called remote. First run: - Files created with this scope are visible in the web interface. + rclone config - #### drive.appfolder #### +This will guide you through an interactive setup process: - This gives rclone its own private area to store files. Rclone will - not be able to see any other files on your drive and you won't be able - to see rclone's files from the web interface either. - - #### drive.metadata.readonly #### - - This allows read only access to file names only. It does not allow - rclone to download or upload data, or rename or delete files or - directories. - - ### Root folder ID ### - - You can set the `root_folder_id` for rclone. This is the directory - (identified by its `Folder ID`) that rclone considers to be the root - of your drive. - - Normally you will leave this blank and rclone will determine the - correct root to use itself. - - However you can set this to restrict rclone to a specific folder - hierarchy or to access data within the "Computers" tab on the drive - web interface (where files from Google's Backup and Sync desktop - program go). - - In order to do this you will have to find the `Folder ID` of the - directory you wish rclone to display. This will be the last segment - of the URL when you open the relevant folder in the drive web - interface. - - So if the folder you want rclone to use has a URL which looks like - `https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` - in the browser, then you use `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` as - the `root_folder_id` in the config. - - **NB** folders under the "Computers" tab seem to be read only (drive - gives a 500 error) when using rclone. - - There doesn't appear to be an API to discover the folder IDs of the - "Computers" tab - please contact us if you know otherwise! - - Note also that rclone can't access any data under the "Backups" tab on - the google drive web interface yet. - - ### Service Account support ### - - You can set up rclone with Google Drive in an unattended mode, - i.e. not tied to a specific end-user Google account. This is useful - when you want to synchronise files onto machines that don't have - actively logged-in users, for example build machines. - - To use a Service Account instead of OAuth2 token flow, enter the path - to your Service Account credentials at the `service_account_file` - prompt during `rclone config` and rclone won't use the browser based - authentication flow. If you'd rather stuff the contents of the - credentials file into the rclone config file, you can set - `service_account_credentials` with the actual contents of the file - instead, or set the equivalent environment variable. - - #### Use case - Google Apps/G-suite account and individual Drive #### - - Let's say that you are the administrator of a Google Apps (old) or - G-suite account. - The goal is to store data on an individual's Drive account, who IS - a member of the domain. - We'll call the domain **example.com**, and the user - **foo@example.com**. - - There's a few steps we need to go through to accomplish this: - - ##### 1. Create a service account for example.com ##### - - To create a service account and obtain its credentials, go to the - [Google Developer Console](https://console.developers.google.com). - - You must have a project - create one if you don't. - - Then go to "IAM & admin" -> "Service Accounts". - - Use the "Create Credentials" button. Fill in "Service account name" - with something that identifies your client. "Role" can be empty. - - Tick "Furnish a new private key" - select "Key type JSON". - - Tick "Enable G Suite Domain-wide Delegation". This option makes - "impersonation" possible, as documented here: - [Delegating domain-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) - - These credentials are what rclone will use for authentication. - If you ever need to remove access, press the "Delete service - account key" button. - - ##### 2. Allowing API access to example.com Google Drive ##### - - Go to example.com's admin console - - Go into "Security" (or use the search bar) - - Select "Show more" and then "Advanced settings" - - Select "Manage API client access" in the "Authentication" section - - In the "Client Name" field enter the service account's - "Client ID" - this can be found in the Developer Console under - "IAM & Admin" -> "Service Accounts", then "View Client ID" for - the newly created service account. - It is a ~21 character numerical string. - - In the next field, "One or More API Scopes", enter - `https://www.googleapis.com/auth/drive` - to grant access to Google Drive specifically. - - ##### 3. Configure rclone, assuming a new install ##### - -rclone config - -n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select -the number shown for Google Drive client_id> # Can be left blank -client_secret> # Can be left blank scope> # Select your scope, 1 for -example root_folder_id> # Can be left blank service_account_file> -/home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # -Auto config, y - - - ##### 4. Verify that it's working ##### - - `rclone -v --drive-impersonate foo@example.com lsf gdrive:backup` - - The arguments do: - - `-v` - verbose logging - - `--drive-impersonate foo@example.com` - this is what does - the magic, pretending to be user foo. - - `lsf` - list files in a parsing friendly way - - `gdrive:backup` - use the remote called gdrive, work in - the folder named backup. - - Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using `--drive-impersonate`, do this instead: - - in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 - - use rclone without specifying the `--drive-impersonate` option, like this: - `rclone -v foo@example.com lsf gdrive:backup` - - - ### Team drives ### - - If you want to configure the remote to point to a Google Team Drive - then answer `y` to the question `Configure this as a team drive?`. - - This will fetch the list of Team Drives from google and allow you to - configure which one you want to use. You can also type in a team - drive ID if you prefer. - - For example: - -Configure this as a team drive? y) Yes n) No y/n> y Fetching team drive -list... Choose a number from below, or type in your own value 1 / Rclone -Test  "xxxxxxxxxxxxxxxxxxxx" 2 / Rclone Test 2  "yyyyyyyyyyyyyyyyyyyy" 3 -/ Rclone Test 3  "zzzzzzzzzzzzzzzzzzzz" Enter a Team Drive ID> 1 --------------------- [remote] client_id = client_secret = token = -{"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} -team_drive = xxxxxxxxxxxxxxxxxxxx -------------------- y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y - - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](https://rclone.org/docs/#fast-list) for more details. - - It does this by combining multiple `list` calls into a single API request. - - This works by combining many `'%s' in parents` filters into one expression. - To list the contents of directories a, b and c, the following requests will be send by the regular `List` function: - -trashed=false and 'a' in parents trashed=false and 'b' in parents -trashed=false and 'c' in parents - - These can now be combined into a single request: - -trashed=false and ('a' in parents or 'b' in parents or 'c' in parents) - - - The implementation of `ListR` will put up to 50 `parents` filters into one request. - It will use the `--checkers` value to specify the number of requests to run in parallel. - - In tests, these batch requests were up to 20x faster than the regular method. - Running the following command against different sized folders gives: - -rclone lsjson -vv -R --checkers=6 gdrive:folder - - - small folder (220 directories, 700 files): - - - without `--fast-list`: 38s - - with `--fast-list`: 10s - - large folder (10600 directories, 39000 files): - - - without `--fast-list`: 22:05 min - - with `--fast-list`: 58s - - ### Modified time ### - - Google drive stores modification times accurate to 1 ms. - - #### Restricted filename characters - - Only Invalid UTF-8 bytes will be [replaced](https://rclone.org/overview/#invalid-utf8), - as they can't be used in JSON strings. - - In contrast to other backends, `/` can also be used in names and `.` - or `..` are valid names. - - ### Revisions ### - - Google drive stores revisions of files. When you upload a change to - an existing file to google drive using rclone it will create a new - revision of that file. - - Revisions follow the standard google policy which at time of writing - was - - * They are deleted after 30 days or 100 revisions (whatever comes first). - * They do not count towards a user storage quota. - - ### Deleting files ### - - By default rclone will send all files to the trash when deleting - files. If deleting them permanently is required then use the - `--drive-use-trash=false` flag, or set the equivalent environment - variable. - - ### Shortcuts ### - - In March 2020 Google introduced a new feature in Google Drive called - [drive shortcuts](https://support.google.com/drive/answer/9700156) - ([API](https://developers.google.com/drive/api/v3/shortcuts)). These - will (by September 2020) [replace the ability for files or folders to - be in multiple folders at once](https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models). - - Shortcuts are files that link to other files on Google Drive somewhat - like a symlink in unix, except they point to the underlying file data - (eg the inode in unix terms) so they don't break if the source is - renamed or moved about. - - Be default rclone treats these as follows. - - For shortcuts pointing to files: - - - When listing a file shortcut appears as the destination file. - - When downloading the contents of the destination file is downloaded. - - When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. - - When server side moving (renaming) the shortcut is renamed, not the destination file. - - When server side copying the shortcut is copied, not the contents of the shortcut. - - When deleting the shortcut is deleted not the linked file. - - When setting the modification time, the modification time of the linked file will be set. - - For shortcuts pointing to folders: - - - When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) - - When downloading the contents of the linked folder and sub contents are downloaded - - When uploading to a shortcut folder the file will be placed in the linked folder - - When server side moving (renaming) the shortcut is renamed, not the destination folder - - When server side copying the contents of the linked folder is copied, not the shortcut. - - When deleting with `rclone rmdir` or `rclone purge` the shortcut is deleted not the linked folder. - - **NB** When deleting with `rclone remove` or `rclone mount` the contents of the linked folder will be deleted. - - The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts. - - Shortcuts can be completely ignored with the `--drive-skip-shortcuts` flag - or the corresponding `skip_shortcuts` configuration setting. - - ### Emptying trash ### - - If you wish to empty your trash you can use the `rclone cleanup remote:` - command which will permanently delete all your trashed files. This command - does not take any path arguments. - - Note that Google Drive takes some time (minutes to days) to empty the - trash even though the command returns within a few seconds. No output - is echoed, so there will be no confirmation even using -v or -vv. - - ### Quota information ### - - To view your current quota you can use the `rclone about remote:` - command which will display your usage limit (quota), the usage in Google - Drive, the size of all files in the Trash and the space used by other - Google services such as Gmail. This command does not take any path - arguments. - - #### Import/Export of google documents #### - - Google documents can be exported from and uploaded to Google Drive. - - When rclone downloads a Google doc it chooses a format to download - depending upon the `--drive-export-formats` setting. - By default the export formats are `docx,xlsx,pptx,svg` which are a - sensible default for an editable document. - - When choosing a format, rclone runs down the list provided in order - and chooses the first file format the doc can be exported as from the - list. If the file can't be exported to a format on the formats list, - then rclone will choose a format from the default list. - - If you prefer an archive copy then you might use `--drive-export-formats - pdf`, or if you prefer openoffice/libreoffice formats you might use - `--drive-export-formats ods,odt,odp`. - - Note that rclone adds the extension to the google doc, so if it is - called `My Spreadsheet` on google docs, it will be exported as `My - Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc. - - When importing files into Google Drive, rclone will convert all - files with an extension in `--drive-import-formats` to their - associated document type. - rclone will not convert any files by default, since the conversion - is lossy process. - - The conversion must result in a file with the same extension when - the `--drive-export-formats` rules are applied to the uploaded document. - - Here are some examples for allowed and prohibited conversions. - - | export-formats | import-formats | Upload Ext | Document Ext | Allowed | - | -------------- | -------------- | ---------- | ------------ | ------- | - | odt | odt | odt | odt | Yes | - | odt | docx,odt | odt | odt | Yes | - | | docx | docx | docx | Yes | - | | odt | odt | docx | No | - | odt,docx | docx,odt | docx | odt | No | - | docx,odt | docx,odt | docx | docx | Yes | - | docx,odt | docx,odt | odt | docx | No | - - This limitation can be disabled by specifying `--drive-allow-import-name-change`. - When using this flag, rclone can convert multiple files types resulting - in the same document type at once, eg with `--drive-import-formats docx,odt,txt`, - all files having these extension would result in a document represented as a docx file. - This brings the additional risk of overwriting a document, if multiple files - have the same stem. Many rclone operations will not handle this name change - in any way. They assume an equal name when copying files and might copy the - file again or delete them when the name changes. - - Here are the possible export extensions with their corresponding mime types. - Most of these can also be used for importing, but there more that are not - listed here. Some of these additional ones might only be available when - the operating system provides the correct MIME type entries. - - This list can be changed by Google Drive at any time and might not - represent the currently available conversions. - - | Extension | Mime Type | Description | - | --------- |-----------| ------------| - | csv | text/csv | Standard CSV format for Spreadsheets | - | docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Office Document | - | epub | application/epub+zip | E-book format | - | html | text/html | An HTML Document | - | jpg | image/jpeg | A JPEG Image File | - | json | application/vnd.google-apps.script+json | JSON Text Format | - | odp | application/vnd.oasis.opendocument.presentation | Openoffice Presentation | - | ods | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | - | ods | application/x-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | - | odt | application/vnd.oasis.opendocument.text | Openoffice Document | - | pdf | application/pdf | Adobe PDF Format | - | png | image/png | PNG Image Format| - | pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation | Microsoft Office Powerpoint | - | rtf | application/rtf | Rich Text Format | - | svg | image/svg+xml | Scalable Vector Graphics Format | - | tsv | text/tab-separated-values | Standard TSV format for spreadsheets | - | txt | text/plain | Plain Text | - | xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | - | zip | application/zip | A ZIP file of HTML, Images CSS | - - Google documents can also be exported as link files. These files will - open a browser window for the Google Docs website of that document - when opened. The link file extension has to be specified as a - `--drive-export-formats` parameter. They will match all available - Google Documents. - - | Extension | Description | OS Support | - | --------- | ----------- | ---------- | - | desktop | freedesktop.org specified desktop entry | Linux | - | link.html | An HTML Document with a redirect | All | - | url | INI style link file | macOS, Windows | - | webloc | macOS specific XML format | macOS | - - - ### Standard Options - - Here are the standard options specific to drive (Google Drive). - - #### --drive-client-id - - OAuth Client Id - Leave blank normally. - - - Config: client_id - - Env Var: RCLONE_DRIVE_CLIENT_ID - - Type: string - - Default: "" - - #### --drive-client-secret - - OAuth Client Secret - Leave blank normally. - - - Config: client_secret - - Env Var: RCLONE_DRIVE_CLIENT_SECRET - - Type: string - - Default: "" - - #### --drive-scope - - Scope that rclone should use when requesting access from drive. - - - Config: scope - - Env Var: RCLONE_DRIVE_SCOPE - - Type: string - - Default: "" - - Examples: - - "drive" - - Full access all files, excluding Application Data Folder. - - "drive.readonly" - - Read-only access to file metadata and file contents. - - "drive.file" - - Access to files created by rclone only. - - These are visible in the drive website. - - File authorization is revoked when the user deauthorizes the app. - - "drive.appfolder" - - Allows read and write access to the Application Data folder. - - This is not visible in the drive website. - - "drive.metadata.readonly" - - Allows read-only access to file metadata but - - does not allow any access to read or download file content. - - #### --drive-root-folder-id + 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 / Enterprise File Fabric + \ "filefabric" + [snip] + Storage> filefabric + ** See help for filefabric backend at: https://rclone.org/filefabric/ ** + URL of the Enterprise File Fabric to connect to + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Storage Made Easy US + \ "https://storagemadeeasy.com" + 2 / Storage Made Easy EU + \ "https://eu.storagemadeeasy.com" + 3 / Connect to your Enterprise File Fabric + \ "https://yourfabric.smestorage.com" + url> https://yourfabric.smestorage.com/ 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. + Fill in to make rclone start with directory of a given ID. + Enter a string value. Press Enter for the default (""). + root_folder_id> + Permanent Authentication Token - - Config: root_folder_id - - Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID - - Type: string - - Default: "" + A Permanent Authentication Token can be created in the Enterprise File + Fabric, on the users Dashboard under Security, there is an entry + you'll see called "My Authentication Tokens". Click the Manage button + to create one. - #### --drive-service-account-file + These tokens are normally valid for several years. - Service Account Credentials JSON file path - Leave blank normally. - Needed only if you want use SA instead of interactive login. + For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens - Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`. + Enter a string value. Press Enter for the default (""). + permanent_token> xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> n + Remote config + -------------------- + [remote] + type = filefabric + url = https://yourfabric.smestorage.com/ + permanent_token = xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y +Once configured you can then use rclone like this, - - Config: service_account_file - - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE - - Type: string - - Default: "" +List directories in top level of your Enterprise File Fabric - #### --drive-alternate-export + rclone lsd remote: - Deprecated: no longer needed +List all the files in your Enterprise File Fabric - - Config: alternate_export - - Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT - - Type: bool - - Default: false + rclone ls remote: - ### Advanced Options +To copy a local directory to an Enterprise File Fabric directory called +backup - Here are the advanced options specific to drive (Google Drive). + rclone copy /home/source remote:backup - #### --drive-token +Modified time and hashes - OAuth Access Token as a JSON blob. +The Enterprise File Fabric allows modification times to be set on files +accurate to 1 second. These will be used to detect whether objects need +syncing or not. - - Config: token - - Env Var: RCLONE_DRIVE_TOKEN - - Type: string - - Default: "" +The Enterprise File Fabric does not support any data hashes at this +time. - #### --drive-auth-url +Restricted filename characters - Auth server URL. - Leave blank to use the provider defaults. +The default restricted characters set will be replaced. - - Config: auth_url - - Env Var: RCLONE_DRIVE_AUTH_URL - - Type: string - - Default: "" +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - #### --drive-token-url +Empty files - Token server url. - Leave blank to use the provider defaults. +Empty files aren't supported by the Enterprise File Fabric. Rclone will +therefore upload an empty file as a single space with a mime type of +application/vnd.rclone.empty.file and files with that mime type are +treated as empty. - - Config: token_url - - Env Var: RCLONE_DRIVE_TOKEN_URL - - Type: string - - Default: "" +Root folder ID - #### --drive-service-account-credentials +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 Enterprise File Fabric. - Service Account Credentials JSON blob - Leave blank normally. - Needed only if you want use SA instead of interactive login. +Normally you will leave this blank and rclone will determine the correct +root to use itself. - - Config: service_account_credentials - - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS - - Type: string - - Default: "" +However you can set this to restrict rclone to a specific folder +hierarchy. - #### --drive-team-drive +In order to do this you will have to find the Folder ID of the directory +you wish rclone to display. These aren't displayed in the web interface, +but you can use rclone lsf to find them, for example - ID of the Team Drive + $ rclone lsf --dirs-only -Fip --csv filefabric: + 120673758,Burnt PDFs/ + 120673759,My Quick Uploads/ + 120673755,My Syncs/ + 120673756,My backups/ + 120673757,My contacts/ + 120673761,S3 Storage/ - - Config: team_drive - - Env Var: RCLONE_DRIVE_TEAM_DRIVE - - Type: string - - Default: "" +The ID for "S3 Storage" would be 120673761. - #### --drive-auth-owner-only +Standard Options - Only consider files owned by the authenticated user. +Here are the standard options specific to filefabric (Enterprise File +Fabric). - - Config: auth_owner_only - - Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY - - Type: bool - - Default: false +--filefabric-url - #### --drive-use-trash +URL of the Enterprise File Fabric to connect to - 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: url +- Env Var: RCLONE_FILEFABRIC_URL +- Type: string +- Default: "" +- Examples: + - "https://storagemadeeasy.com" + - Storage Made Easy US + - "https://eu.storagemadeeasy.com" + - Storage Made Easy EU + - "https://yourfabric.smestorage.com" + - Connect to your Enterprise File Fabric - - Config: use_trash - - Env Var: RCLONE_DRIVE_USE_TRASH - - Type: bool - - Default: true +--filefabric-root-folder-id - #### --drive-skip-gdocs +ID of the root folder Leave blank normally. - Skip google documents in all listings. - If given, gdocs practically become invisible to rclone. +Fill in to make rclone start with directory of a given ID. - - Config: skip_gdocs - - Env Var: RCLONE_DRIVE_SKIP_GDOCS - - Type: bool - - Default: false +- Config: root_folder_id +- Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID +- Type: string +- Default: "" - #### --drive-skip-checksum-gphotos +--filefabric-permanent-token - Skip MD5 checksum on Google photos and videos only. +Permanent Authentication Token - Use this if you get checksum errors when transferring Google photos or - videos. +A Permanent Authentication Token can be created in the Enterprise File +Fabric, on the users Dashboard under Security, there is an entry you'll +see called "My Authentication Tokens". Click the Manage button to create +one. - Setting this flag will cause Google photos and videos to return a - blank MD5 checksum. +These tokens are normally valid for several years. - Google photos are identified by being in the "photos" space. +For more info see: +https://docs.storagemadeeasy.com/organisationcloud/api-tokens - Corrupted checksums are caused by Google modifying the image/video but - not updating the checksum. +- Config: permanent_token +- Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN +- Type: string +- Default: "" - - Config: skip_checksum_gphotos - - Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS - - Type: bool - - Default: false +Advanced Options - #### --drive-shared-with-me +Here are the advanced options specific to filefabric (Enterprise File +Fabric). - Only show files that are shared with me. +--filefabric-token - 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). +Session Token - This works both with the "list" (lsd, lsl, etc) and the "copy" - commands (copy, sync, etc), and with all other commands too. +This is a session token which rclone caches in the config file. It is +usually valid for 1 hour. - - Config: shared_with_me - - Env Var: RCLONE_DRIVE_SHARED_WITH_ME - - Type: bool - - Default: false +Don't set this value - rclone will set it automatically. - #### --drive-trashed-only +- Config: token +- Env Var: RCLONE_FILEFABRIC_TOKEN +- Type: string +- Default: "" - Only show files that are in the trash. - This will show trashed files in their original directory structure. +--filefabric-token-expiry - - Config: trashed_only - - Env Var: RCLONE_DRIVE_TRASHED_ONLY - - Type: bool - - Default: false +Token expiry time - #### --drive-starred-only +Don't set this value - rclone will set it automatically. - Only show files that are starred. +- Config: token_expiry +- Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY +- Type: string +- Default: "" + +--filefabric-version - - Config: starred_only - - Env Var: RCLONE_DRIVE_STARRED_ONLY - - Type: bool - - Default: false +Version read from the file fabric - #### --drive-formats +Don't set this value - rclone will set it automatically. - Deprecated: see export_formats +- Config: version +- Env Var: RCLONE_FILEFABRIC_VERSION +- Type: string +- Default: "" - - Config: formats - - Env Var: RCLONE_DRIVE_FORMATS - - Type: string - - Default: "" +--filefabric-encoding - #### --drive-export-formats +This sets the encoding for the backend. - Comma separated list of preferred formats for downloading Google docs. +See: the encoding section in the overview for more info. - - Config: export_formats - - Env Var: RCLONE_DRIVE_EXPORT_FORMATS - - Type: string - - Default: "docx,xlsx,pptx,svg" +- Config: encoding +- Env Var: RCLONE_FILEFABRIC_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,InvalidUtf8,Dot - #### --drive-import-formats - Comma separated list of preferred formats for uploading Google docs. +FTP - - Config: import_formats - - Env Var: RCLONE_DRIVE_IMPORT_FORMATS - - Type: string - - Default: "" +FTP is the File Transfer Protocol. Rclone FTP support is provided using +the github.com/jlaffaye/ftp package. - #### --drive-allow-import-name-change +Limitations of Rclone's FTP backend - Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. +Paths are specified as remote:path. If the path does not begin with a / +it is relative to the home directory of the user. An empty path remote: +refers to the user's home directory. - - Config: allow_import_name_change - - Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE - - Type: bool - - Default: false +To create an FTP configuration named remote, run - #### --drive-use-created-date + rclone config - Use file created date instead of modified date., +Rclone config guides you through an interactive setup process. A minimal +rclone FTP remote definition only requires host, username and password. +For an anonymous FTP server, use anonymous as username and your email +address as password. - Useful when downloading data and you want the creation date used in - place of the last modified date. + 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/ ** - **WARNING**: This flag may have some unexpected consequences. + 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, $USER + Enter a string value. Press Enter for the default (""). + user> + FTP port, leave blank to use default (21) + Enter a string value. Press Enter for the default (""). + port> + FTP password + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: + Use FTP over TLS (Implicit) + Enter a boolean value (true or false). Press Enter for the default ("false"). + tls> + Use FTP over TLS (Explicit) + Enter a boolean value (true or false). Press Enter for the default ("false"). + explicit_tls> + Remote config + -------------------- + [remote] + type = ftp + host = ftp.example.com + pass = *** ENCRYPTED *** + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - 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. +To see all directories in the home directory of remote - 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. + rclone lsd remote: - - Config: use_created_date - - Env Var: RCLONE_DRIVE_USE_CREATED_DATE - - Type: bool - - Default: false +Make a new directory - #### --drive-use-shared-date + rclone mkdir remote:path/to/directory - Use date file was shared instead of modified date. +List the contents of a directory - Note that, as with "--drive-use-created-date", this flag may have - unexpected consequences when uploading/downloading files. + rclone ls remote:path/to/directory - If both this flag and "--drive-use-created-date" are set, the created - date is used. +Sync /home/local/directory to the remote directory, deleting any excess +files in the directory. - - Config: use_shared_date - - Env Var: RCLONE_DRIVE_USE_SHARED_DATE - - Type: bool - - Default: false + rclone sync -i /home/local/directory remote:directory - #### --drive-list-chunk +Example without a config file - Size of listing chunk 100-1000. 0 to disable. + rclone lsf :ftp: --ftp-host=speedtest.tele2.net --ftp-user=anonymous --ftp-pass=`rclone obscure dummy` - - Config: list_chunk - - Env Var: RCLONE_DRIVE_LIST_CHUNK - - Type: int - - Default: 1000 +Implicit TLS - #### --drive-impersonate +Rlone FTP supports implicit FTP over TLS servers (FTPS). This has to be +enabled in the FTP backend config for the remote, or with +[--ftp-tls]{#ftp-tls}. The default FTPS port is 990, not 21 and can be +set with [--ftp-port]{#ftp-port}. - Impersonate this user when using a service account. +Standard Options - - Config: impersonate - - Env Var: RCLONE_DRIVE_IMPERSONATE - - Type: string - - Default: "" +Here are the standard options specific to ftp (FTP Connection). - #### --drive-upload-cutoff +--ftp-host - Cutoff for switching to chunked upload +FTP host to connect to - - Config: upload_cutoff - - Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 8M +- Config: host +- Env Var: RCLONE_FTP_HOST +- Type: string +- Default: "" +- Examples: + - "ftp.example.com" + - Connect to ftp.example.com - #### --drive-chunk-size +--ftp-user - Upload chunk size. Must a power of 2 >= 256k. +FTP username, leave blank for current username, $USER - Making this larger will improve performance, but note that each chunk - is buffered in memory one per transfer. +- Config: user +- Env Var: RCLONE_FTP_USER +- Type: string +- Default: "" - Reducing this will reduce memory usage but decrease performance. +--ftp-port - - Config: chunk_size - - Env Var: RCLONE_DRIVE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 8M +FTP port, leave blank to use default (21) - #### --drive-acknowledge-abuse +- Config: port +- Env Var: RCLONE_FTP_PORT +- Type: string +- Default: "" - Set to allow files which return cannotDownloadAbusiveFile to be downloaded. +--ftp-pass - 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. +FTP password - - Config: acknowledge_abuse - - Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE - - Type: bool - - Default: false +NB Input to this must be obscured - see rclone obscure. - #### --drive-keep-revision-forever +- Config: pass +- Env Var: RCLONE_FTP_PASS +- Type: string +- Default: "" - Keep new head revision of each file forever. +--ftp-tls - - Config: keep_revision_forever - - Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER - - Type: bool - - Default: false +Use Implicit FTPS (FTP over TLS) When using implicit FTP over TLS the +client connects using TLS right from the start which breaks +compatibility with non-TLS-aware servers. This is usually served over +port 990 rather than port 21. Cannot be used in combination with +explicit FTP. - #### --drive-size-as-quota +- Config: tls +- Env Var: RCLONE_FTP_TLS +- Type: bool +- Default: false - Show sizes as storage quota usage, not actual size. +--ftp-explicit-tls - Show the size of a file as the storage quota used. This is the - current version plus any older versions that have been set to keep - forever. +Use Explicit FTPS (FTP over TLS) When using explicit FTP over TLS the +client explicitly requests security from the server in order to upgrade +a plain text connection to an encrypted one. Cannot be used in +combination with implicit FTP. - **WARNING**: This flag may have some unexpected consequences. +- Config: explicit_tls +- Env Var: RCLONE_FTP_EXPLICIT_TLS +- Type: bool +- Default: false - It is not recommended to set this flag in your config - the - recommended usage is using the flag form --drive-size-as-quota when - doing rclone ls/lsl/lsf/lsjson/etc only. +Advanced Options - If you do use this flag for syncing (not recommended) then you will - need to use --ignore size also. +Here are the advanced options specific to ftp (FTP Connection). - - Config: size_as_quota - - Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA - - Type: bool - - Default: false +--ftp-concurrency - #### --drive-v2-download-min-size +Maximum number of FTP simultaneous connections, 0 for unlimited - If Object's are greater, use drive v2 API to download. +- Config: concurrency +- Env Var: RCLONE_FTP_CONCURRENCY +- Type: int +- Default: 0 - - Config: v2_download_min_size - - Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE - - Type: SizeSuffix - - Default: off +--ftp-no-check-certificate - #### --drive-pacer-min-sleep +Do not verify the TLS certificate of the server - Minimum time to sleep between API calls. +- Config: no_check_certificate +- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +- Type: bool +- Default: false - - Config: pacer_min_sleep - - Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP - - Type: Duration - - Default: 100ms +--ftp-disable-epsv - #### --drive-pacer-burst +Disable using EPSV even if server advertises support - Number of API calls to allow without sleeping. +- Config: disable_epsv +- Env Var: RCLONE_FTP_DISABLE_EPSV +- Type: bool +- Default: false - - Config: pacer_burst - - Env Var: RCLONE_DRIVE_PACER_BURST - - Type: int - - Default: 100 +--ftp-disable-mlsd - #### --drive-server-side-across-configs +Disable using MLSD even if server advertises support - Allow server side operations (eg copy) to work across different drive configs. +- Config: disable_mlsd +- Env Var: RCLONE_FTP_DISABLE_MLSD +- Type: bool +- Default: false - 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. +--ftp-encoding - - Config: server_side_across_configs - - Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS - - Type: bool - - Default: false +This sets the encoding for the backend. - #### --drive-disable-http2 +See: the encoding section in the overview for more info. - Disable drive using http2 +- Config: encoding +- Env Var: RCLONE_FTP_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,RightSpace,Dot - 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. +Limitations - See: https://github.com/rclone/rclone/issues/3631 +Modified times are not supported. Times you see on the FTP server +through rclone are those of upload. +Rclone's FTP backend does not support any checksums but can compare file +sizes. +rclone about is not supported by the FTP backend. Backends without this +capability cannot determine free space for an rclone mount or use policy +mfs (most free space) as a member of an rclone union remote. - - Config: disable_http2 - - Env Var: RCLONE_DRIVE_DISABLE_HTTP2 - - Type: bool - - Default: true +See List of backends that do not support rclone about See rclone about - #### --drive-stop-on-upload-limit +The implementation of : --dump headers, --dump bodies, --dump auth for +debugging isn't the same as for rclone HTTP based backends - it has less +fine grained control. - Make upload limit errors be fatal +--timeout isn't supported (but --contimeout is). + +--bind isn't supported. + +Rclone's FTP backend could support server-side move but does not at +present. + +The ftp_proxy environment variable is not currently supported. + +FTP servers acting as rclone remotes must support 'passive' mode. +Rclone's FTP implementation is not compatible with 'active' mode. + +Restricted filename characters + +In addition to the default restricted characters set the following +characters are also replaced: + +File names cannot end with the following characters. Repacement is +limited to the last character in a file name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Not all FTP servers can have all characters in file names, for example: + + FTP Server Forbidden characters + ------------ ---------------------- + proftpd * + pureftpd \ [ ] + + +Google Cloud Storage + +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, e.g. remote:bucket/path/to/dir. + +The initial setup for google cloud storage involves getting a token from +Google Cloud Storage which you need to do in your browser. rclone config +walks you through it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + n) New remote + d) Delete remote + q) Quit config + e/n/d/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + [snip] + Storage> google cloud storage + Google Application Client Id - leave blank normally. + client_id> + Google Application Client Secret - leave blank normally. + client_secret> + Project number optional - needed only for list/create/delete buckets - see your developer console. + project_number> 12345678 + Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. + service_account_file> + Access Control List for new objects. + Choose a number from below, or type in your own value + 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. + \ "authenticatedRead" + 2 / Object owner gets OWNER access, and project team owners get OWNER access. + \ "bucketOwnerFullControl" + 3 / Object owner gets OWNER access, and project team owners get READER access. + \ "bucketOwnerRead" + 4 / Object owner gets OWNER access [default if left blank]. + \ "private" + 5 / Object owner gets OWNER access, and project team members get access according to their roles. + \ "projectPrivate" + 6 / Object owner gets OWNER access, and all Users get READER access. + \ "publicRead" + object_acl> 4 + Access Control List for new buckets. + Choose a number from below, or type in your own value + 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. + \ "authenticatedRead" + 2 / Project team owners get OWNER access [default if left blank]. + \ "private" + 3 / Project team members get access according to their roles. + \ "projectPrivate" + 4 / Project team owners get OWNER access, and all Users get READER access. + \ "publicRead" + 5 / Project team owners get OWNER access, and all Users get WRITER access. + \ "publicReadWrite" + bucket_acl> 2 + Location for the newly created buckets. + Choose a number from below, or type in your own value + 1 / Empty for default location (US). + \ "" + 2 / Multi-regional location for Asia. + \ "asia" + 3 / Multi-regional location for Europe. + \ "eu" + 4 / Multi-regional location for United States. + \ "us" + 5 / Taiwan. + \ "asia-east1" + 6 / Tokyo. + \ "asia-northeast1" + 7 / Singapore. + \ "asia-southeast1" + 8 / Sydney. + \ "australia-southeast1" + 9 / Belgium. + \ "europe-west1" + 10 / London. + \ "europe-west2" + 11 / Iowa. + \ "us-central1" + 12 / South Carolina. + \ "us-east1" + 13 / Northern Virginia. + \ "us-east4" + 14 / Oregon. + \ "us-west1" + location> 12 + The storage class to use when storing objects in Google Cloud Storage. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Multi-regional storage class + \ "MULTI_REGIONAL" + 3 / Regional storage class + \ "REGIONAL" + 4 / Nearline storage class + \ "NEARLINE" + 5 / Coldline storage class + \ "COLDLINE" + 6 / Durable reduced availability storage class + \ "DURABLE_REDUCED_AVAILABILITY" + storage_class> 5 + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn't work + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = google cloud storage + client_id = + client_secret = + token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} + project_number = 12345678 + object_acl = private + bucket_acl = private + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this it +may require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +This remote is called remote and can now be used like this + +See all the buckets in your project + + rclone lsd remote: + +Make a new bucket + + rclone mkdir remote:bucket + +List the contents of a bucket + + rclone ls remote:bucket + +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. + + rclone sync -i /home/local/directory remote:bucket + +Service Account support + +You can set up rclone with Google Cloud Storage in an unattended mode, +i.e. not tied to a specific end-user Google account. This is useful when +you want to synchronise files onto machines that don't have actively +logged-in users, for example build machines. + +To get credentials for Google Cloud Platform IAM Service Accounts, +please head to the Service Account section of the Google Developer +Console. Service Accounts behave just like normal User permissions in +Google Cloud Storage ACLs, so you can limit their access (e.g. make them +read only). After creating an account, a JSON file containing the +Service Account's credentials will be downloaded onto your machines. +These credentials are what rclone will use for authentication. + +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the service_account_file prompt and +rclone won't use the browser based authentication flow. If you'd rather +stuff the contents of the credentials file into the rclone config file, +you can set service_account_credentials with the actual contents of the +file instead, or set the equivalent environment variable. + +Anonymous Access + +For downloads of objects that permit public access you can configure +rclone to use anonymous access by setting anonymous to true. With +unauthorized access you can't write or create files but only read or +list those buckets and objects that have public read access. + +Application Default Credentials + +If no other source of credentials is provided, rclone will fall back to +Application Default Credentials this is useful both when you already +have configured authentication for your developer account, or in +production when running on a google compute host. Note that if running +in docker, you may need to run additional commands on your google +compute machine - see this page. + +Note that in the case application default credentials are used, there is +no need to explicitly configure a project number. - At the time of writing it is only possible to upload 750GB of data to - Google Drive a day (this is an undocumented limit). When this limit is - reached Google Drive produces a slightly different error message. When - this flag is set it causes these errors to be fatal. These will stop - the in-progress sync. +--fast-list - Note that this detection is relying on error message strings which - Google don't document so it may break in the future. +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. - See: https://github.com/rclone/rclone/issues/3857 +Custom upload headers +You can set custom upload headers with the --header-upload flag. Google +Cloud Storage supports the headers as described in the working with +metadata documentation - - Config: stop_on_upload_limit - - Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT - - Type: bool - - Default: false +- Cache-Control +- Content-Disposition +- Content-Encoding +- Content-Language +- Content-Type +- X-Goog-Storage-Class +- X-Goog-Meta- - #### --drive-skip-shortcuts +Eg --header-upload "Content-Type text/potato" - If set skip shortcut files +Note that the last of these is for setting custom metadata in the form +--header-upload "x-goog-meta-key: value" - Normally rclone dereferences shortcut files making them appear as if - they are the original file (see [the shortcuts section](#shortcuts)). - If this flag is set then rclone will ignore shortcut files completely. +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. - - Config: skip_shortcuts - - Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS - - Type: bool - - Default: false +Restricted filename characters - #### --drive-encoding + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + LF 0x0A ␊ + CR 0x0D ␍ + / 0x2F ／ - This sets the encoding for the backend. +Invalid UTF-8 bytes will also be replaced, as they can't be used in JSON +strings. - See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. +Standard Options - - Config: encoding - - Env Var: RCLONE_DRIVE_ENCODING - - Type: MultiEncoder - - Default: InvalidUtf8 +Here are the standard options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). - ### Backend commands +--gcs-client-id - Here are the commands specific to the drive backend. +OAuth Client Id Leave blank normally. - Run them with +- Config: client_id +- Env Var: RCLONE_GCS_CLIENT_ID +- Type: string +- Default: "" + +--gcs-client-secret + +OAuth Client Secret Leave blank normally. + +- Config: client_secret +- Env Var: RCLONE_GCS_CLIENT_SECRET +- Type: string +- Default: "" + +--gcs-project-number + +Project number. Optional - needed only for list/create/delete buckets - +see your developer console. - rclone backend COMMAND remote: +- Config: project_number +- Env Var: RCLONE_GCS_PROJECT_NUMBER +- Type: string +- Default: "" - The help below will explain what arguments each command takes. +--gcs-service-account-file - See [the "rclone backend" command](https://rclone.org/commands/rclone_backend/) for more - info on how to pass options and arguments. +Service Account Credentials JSON file path Leave blank normally. Needed +only if you want use SA instead of interactive login. - These can be run on a running backend using the rc command - [backend/command](https://rclone.org/rc/#backend/command). +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. - #### get +- Config: service_account_file +- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE +- Type: string +- Default: "" - Get command for fetching the drive config parameters +--gcs-service-account-credentials - rclone backend get remote: [options] [+] +Service Account Credentials JSON blob Leave blank normally. Needed only +if you want use SA instead of interactive login. - This is a get command which will be used to fetch the various drive config parameters +- Config: service_account_credentials +- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS +- Type: string +- Default: "" + +--gcs-anonymous + +Access public buckets and objects without credentials Set to 'true' if +you just want to download files and don't configure credentials. + +- Config: anonymous +- Env Var: RCLONE_GCS_ANONYMOUS +- Type: bool +- Default: false + +--gcs-object-acl + +Access Control List for new objects. + +- Config: object_acl +- Env Var: RCLONE_GCS_OBJECT_ACL +- Type: string +- Default: "" +- Examples: + - "authenticatedRead" + - Object owner gets OWNER access, and all Authenticated Users + get READER access. + - "bucketOwnerFullControl" + - Object owner gets OWNER access, and project team owners get + OWNER access. + - "bucketOwnerRead" + - Object owner gets OWNER access, and project team owners get + READER access. + - "private" + - Object owner gets OWNER access [default if left blank]. + - "projectPrivate" + - Object owner gets OWNER access, and project team members get + access according to their roles. + - "publicRead" + - Object owner gets OWNER access, and all Users get READER + access. + +--gcs-bucket-acl + +Access Control List for new buckets. + +- Config: bucket_acl +- Env Var: RCLONE_GCS_BUCKET_ACL +- Type: string +- Default: "" +- Examples: + - "authenticatedRead" + - Project team owners get OWNER access, and all Authenticated + Users get READER access. + - "private" + - Project team owners get OWNER access [default if left + blank]. + - "projectPrivate" + - Project team members get access according to their roles. + - "publicRead" + - Project team owners get OWNER access, and all Users get + READER access. + - "publicReadWrite" + - Project team owners get OWNER access, and all Users get + WRITER access. + +--gcs-bucket-policy-only + +Access checks should use bucket-level IAM policies. + +If you want to upload objects to a bucket with Bucket Policy Only set +then you will need to set this. + +When it is set, rclone: + +- ignores ACLs set on buckets +- ignores ACLs set on objects +- creates buckets with Bucket Policy Only set + +Docs: https://cloud.google.com/storage/docs/bucket-policy-only + +- Config: bucket_policy_only +- Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY +- Type: bool +- Default: false + +--gcs-location + +Location for the newly created buckets. + +- Config: location +- Env Var: RCLONE_GCS_LOCATION +- Type: string +- Default: "" +- Examples: + - "" + - Empty for default location (US). + - "asia" + - Multi-regional location for Asia. + - "eu" + - Multi-regional location for Europe. + - "us" + - Multi-regional location for United States. + - "asia-east1" + - Taiwan. + - "asia-east2" + - Hong Kong. + - "asia-northeast1" + - Tokyo. + - "asia-south1" + - Mumbai. + - "asia-southeast1" + - Singapore. + - "australia-southeast1" + - Sydney. + - "europe-north1" + - Finland. + - "europe-west1" + - Belgium. + - "europe-west2" + - London. + - "europe-west3" + - Frankfurt. + - "europe-west4" + - Netherlands. + - "us-central1" + - Iowa. + - "us-east1" + - South Carolina. + - "us-east4" + - Northern Virginia. + - "us-west1" + - Oregon. + - "us-west2" + - California. + +--gcs-storage-class + +The storage class to use when storing objects in Google Cloud Storage. + +- Config: storage_class +- Env Var: RCLONE_GCS_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "MULTI_REGIONAL" + - Multi-regional storage class + - "REGIONAL" + - Regional storage class + - "NEARLINE" + - Nearline storage class + - "COLDLINE" + - Coldline storage class + - "ARCHIVE" + - Archive storage class + - "DURABLE_REDUCED_AVAILABILITY" + - Durable reduced availability storage class + +Advanced Options + +Here are the advanced options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). + +--gcs-token + +OAuth Access Token as a JSON blob. + +- Config: token +- Env Var: RCLONE_GCS_TOKEN +- Type: string +- Default: "" + +--gcs-auth-url + +Auth server URL. Leave blank to use the provider defaults. + +- Config: auth_url +- Env Var: RCLONE_GCS_AUTH_URL +- Type: string +- Default: "" + +--gcs-token-url + +Token server url. Leave blank to use the provider defaults. + +- Config: token_url +- Env Var: RCLONE_GCS_TOKEN_URL +- Type: string +- Default: "" + +--gcs-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_GCS_ENCODING +- Type: MultiEncoder +- Default: Slash,CrLf,InvalidUtf8,Dot + +Limitations + +rclone about is not supported by the Google Cloud Storage backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy mfs (most free space) as a member of an +rclone union remote. + +See List of backends that do not support rclone about See rclone about + + +Google Drive + +Paths are specified as drive:path + +Drive paths may be as deep as required, e.g. +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). - Usage Examples: +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. - rclone backend get drive: [-o service_account_file] [-o chunk_size] - rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] +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. - Options: +There doesn't appear to be an API to discover the folder IDs of the +"Computers" tab - please contact us if you know otherwise! - - "chunk_size": show the current upload chunk size - - "service_account_file": show the current service account file +Note also that rclone can't access any data under the "Backups" tab on +the google drive web interface yet. - #### set +Service Account support - Set command for updating the drive config parameters +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. - rclone backend set remote: [options] [+] +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. - This is a set command which will be used to update the various drive config parameters +Use case - Google Apps/G-suite account and individual Drive - Usage Examples: +Let's say that you are the administrator of a Google Apps (old) or +G-suite account. The goal is to store data on an individual's Drive +account, who IS a member of the domain. We'll call the domain +EXAMPLE.COM, and the user FOO@EXAMPLE.COM. + +There's a few steps we need to go through to accomplish this: + +1. Create a service account for example.com + +- To create a service account and obtain its credentials, go to the + Google Developer Console. +- You must have a project - create one if you don't. +- Then go to "IAM & admin" -> "Service Accounts". +- Use the "Create Credentials" button. Fill in "Service account name" + with something that identifies your client. "Role" can be empty. +- Tick "Furnish a new private key" - select "Key type JSON". +- Tick "Enable G Suite Domain-wide Delegation". This option makes + "impersonation" possible, as documented here: Delegating domain-wide + authority to the service account +- These credentials are what rclone will use for authentication. If + you ever need to remove access, press the "Delete service account + key" button. + +2. Allowing API access to example.com Google Drive + +- Go to example.com's admin console +- Go into "Security" (or use the search bar) +- Select "Show more" and then "Advanced settings" +- Select "Manage API client access" in the "Authentication" section +- In the "Client Name" field enter the service account's "Client ID" - + this can be found in the Developer Console under "IAM & Admin" -> + "Service Accounts", then "View Client ID" for the newly created + service account. It is a ~21 character numerical string. +- In the next field, "One or More API Scopes", enter + https://www.googleapis.com/auth/drive to grant access to Google + Drive specifically. + +3. Configure rclone, assuming a new install + + rclone config + + n/s/q> n # New + name>gdrive # Gdrive is an example name + Storage> # Select the number shown for Google Drive + client_id> # Can be left blank + client_secret> # Can be left blank + scope> # Select your scope, 1 for example + root_folder_id> # Can be left blank + service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! + y/n> # Auto config, y + +4. Verify that it's working + +- rclone -v --drive-impersonate foo@example.com lsf gdrive:backup +- The arguments do: + - -v - verbose logging + - --drive-impersonate foo@example.com - this is what does the + magic, pretending to be user foo. + - lsf - list files in a parsing friendly way + - gdrive:backup - use the remote called gdrive, work in the folder + named backup. + +Note: in case you configured a specific root folder on gdrive and rclone +is unable to access the contents of that folder when using +--drive-impersonate, do this instead: - in the gdrive web interface, +share your root folder with the user/email of the new Service Account +you created/selected at step #1 - use rclone without specifying the +--drive-impersonate option, like this: +rclone -v foo@example.com lsf gdrive:backup + +Team drives + +If you want to configure the remote to point to a Google Team Drive then +answer y to the question Configure this as a team drive?. + +This will fetch the list of Team Drives from google and allow you to +configure which one you want to use. You can also type in a team drive +ID if you prefer. + +For example: + + Configure this as a team drive? + y) Yes + n) No + y/n> y + Fetching team drive list... + Choose a number from below, or type in your own value + 1 / Rclone Test + \ "xxxxxxxxxxxxxxxxxxxx" + 2 / Rclone Test 2 + \ "yyyyyyyyyyyyyyyyyyyy" + 3 / Rclone Test 3 + \ "zzzzzzzzzzzzzzzzzzzz" + Enter a Team Drive ID> 1 + -------------------- + [remote] + client_id = + client_secret = + token = {"AccessToken":"xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx","Expiry":"2014-03-16T13:57:58.955387075Z","Extra":null} + team_drive = xxxxxxxxxxxxxxxxxxxx + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +--fast-list + +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. + +It does this by combining multiple list calls into a single API request. + +This works by combining many '%s' in parents filters into one +expression. To list the contents of directories a, b and c, the +following requests will be send by the regular List function: + + trashed=false and 'a' in parents + trashed=false and 'b' in parents + trashed=false and 'c' in parents + +These can now be combined into a single request: + + trashed=false and ('a' in parents or 'b' in parents or 'c' in parents) + +The implementation of ListR will put up to 50 parents filters into one +request. It will use the --checkers value to specify the number of +requests to run in parallel. + +In tests, these batch requests were up to 20x faster than the regular +method. Running the following command against different sized folders +gives: + + rclone lsjson -vv -R --checkers=6 gdrive:folder + +small folder (220 directories, 700 files): + +- without --fast-list: 38s +- with --fast-list: 10s + +large folder (10600 directories, 39000 files): + +- without --fast-list: 22:05 min +- with --fast-list: 58s - rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] - rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] +Modified time +Google drive stores modification times accurate to 1 ms. - Options: +Restricted filename characters - - "chunk_size": update the current upload chunk size - - "service_account_file": update the current service account file +Only Invalid UTF-8 bytes will be replaced, as they can't be used in JSON +strings. - #### shortcut +In contrast to other backends, / can also be used in names and . or .. +are valid names. - Create shortcuts from files or directories +Revisions - rclone backend shortcut remote: [options] [+] +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. - This command creates shortcuts from files or directories. +Revisions follow the standard google policy which at time of writing was - Usage: +- They are deleted after 30 days or 100 revisions (whatever comes + first). +- They do not count towards a user storage quota. - rclone backend shortcut drive: source_item destination_shortcut - rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut +Deleting files - In the first example this creates a shortcut from the "source_item" - which can be a file or a directory to the "destination_shortcut". The - "source_item" and the "destination_shortcut" should be relative paths - from "drive:" +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. - In the second example this creates a shortcut from the "source_item" - relative to "drive:" to the "destination_shortcut" relative to - "drive2:". This may fail with a permission error if the user - authenticated with "drive2:" can't read files from "drive:". +Shortcuts +In March 2020 Google introduced a new feature in Google Drive called +drive shortcuts (API). These will (by September 2020) replace the +ability for files or folders to be in multiple folders at once. - Options: +Shortcuts are files that link to other files on Google Drive somewhat +like a symlink in unix, except they point to the underlying file data +(e.g. the inode in unix terms) so they don't break if the source is +renamed or moved about. - - "target": optional target remote for the shortcut destination +Be default rclone treats these as follows. - #### drives +For shortcuts pointing to files: - List the shared drives available to this account +- When listing a file shortcut appears as the destination file. +- When downloading the contents of the destination file is downloaded. +- When updating shortcut file with a non shortcut file, the shortcut + is removed then a new file is uploaded in place of the shortcut. +- When server-side moving (renaming) the shortcut is renamed, not the + destination file. +- When server-side copying the shortcut is copied, not the contents of + the shortcut. +- When deleting the shortcut is deleted not the linked file. +- When setting the modification time, the modification time of the + linked file will be set. - rclone backend drives remote: [options] [+] +For shortcuts pointing to folders: - This command lists the shared drives (teamdrives) available to this - account. +- When listing the shortcut appears as a folder and that folder will + contain the contents of the linked folder appear (including any sub + folders) +- When downloading the contents of the linked folder and sub contents + are downloaded +- When uploading to a shortcut folder the file will be placed in the + linked folder +- When server-side moving (renaming) the shortcut is renamed, not the + destination folder +- When server-side copying the contents of the linked folder is + copied, not the shortcut. +- When deleting with rclone rmdir or rclone purge the shortcut is + deleted not the linked folder. +- NB When deleting with rclone remove or rclone mount the contents of + the linked folder will be deleted. - Usage: +The rclone backend command can be used to create shortcuts. - rclone backend drives drive: +Shortcuts can be completely ignored with the --drive-skip-shortcuts flag +or the corresponding skip_shortcuts configuration setting. - This will return a JSON list of objects like this +Emptying trash - [ - { - "id": "0ABCDEF-01234567890", - "kind": "drive#teamDrive", - "name": "My Drive" - }, - { - "id": "0ABCDEFabcdefghijkl", - "kind": "drive#teamDrive", - "name": "Test Drive" - } - ] +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 - #### untrash +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. - Untrash files and directories +Import/Export of google documents - rclone backend untrash remote: [options] [+] +Google documents can be exported from and uploaded to Google Drive. - This command untrashes all the files and directories in the directory - passed in recursively. +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. - Usage: +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. - This takes an optional directory to trash which make this easier to - use via the API. +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. - rclone backend untrash drive:directory - rclone backend -i untrash drive:directory subdir +Note that rclone adds the extension to the google doc, so if it is +called My Spreadsheet on google docs, it will be exported as +My Spreadsheet.xlsx or My Spreadsheet.pdf etc. - Use the -i flag to see what would be restored before restoring it. +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. - Result: +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, e.g. 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 + +OAuth Client Secret Leave blank normally. + +- Config: client_secret +- Env Var: RCLONE_DRIVE_CLIENT_SECRET +- Type: string +- Default: "" + +--drive-scope + +Scope that rclone should use when requesting access from drive. + +- Config: scope +- Env Var: RCLONE_DRIVE_SCOPE +- Type: string +- Default: "" +- Examples: + - "drive" + - Full access all files, excluding Application Data Folder. + - "drive.readonly" + - Read-only access to file metadata and file contents. + - "drive.file" + - Access to files created by rclone only. + - These are visible in the drive website. + - File authorization is revoked when the user deauthorizes the + app. + - "drive.appfolder" + - Allows read and write access to the Application Data folder. + - This is not visible in the drive website. + - "drive.metadata.readonly" + - Allows read-only access to file metadata but + - does not allow any access to read or download file content. + +--drive-root-folder-id + +ID of the root folder Leave blank normally. + +Fill in to access "Computers" folders (see docs), or for rclone to use a +non root folder as its starting point. + +- Config: root_folder_id +- Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID +- Type: string +- Default: "" + +--drive-service-account-file + +Service Account Credentials JSON file path Leave blank normally. Needed +only if you want use SA instead of interactive login. + +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. + +- Config: service_account_file +- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +- Type: string +- Default: "" + +--drive-alternate-export + +Deprecated: no longer needed + +- Config: alternate_export +- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT +- Type: bool +- Default: false + +Advanced Options + +Here are the advanced options specific to drive (Google Drive). + +--drive-token + +OAuth Access Token as a JSON blob. + +- Config: token +- Env Var: RCLONE_DRIVE_TOKEN +- Type: string +- Default: "" + +--drive-auth-url + +Auth server URL. Leave blank to use the provider defaults. + +- Config: auth_url +- Env Var: RCLONE_DRIVE_AUTH_URL +- Type: string +- Default: "" + +--drive-token-url + +Token server url. Leave blank to use the provider defaults. + +- Config: token_url +- Env Var: RCLONE_DRIVE_TOKEN_URL +- Type: string +- Default: "" + +--drive-service-account-credentials + +Service Account Credentials JSON blob Leave blank normally. Needed only +if you want use SA instead of interactive login. + +- Config: service_account_credentials +- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS +- Type: string +- Default: "" + +--drive-team-drive + +ID of the Team Drive + +- Config: team_drive +- Env Var: RCLONE_DRIVE_TEAM_DRIVE +- Type: string +- Default: "" + +--drive-auth-owner-only + +Only consider files owned by the authenticated user. + +- Config: auth_owner_only +- Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY +- Type: bool +- Default: false + +--drive-use-trash + +Send files to the trash instead of deleting permanently. Defaults to +true, namely sending files to the trash. Use --drive-use-trash=false to +delete files permanently instead. + +- Config: use_trash +- Env Var: RCLONE_DRIVE_USE_TRASH +- Type: bool +- Default: true + +--drive-skip-gdocs + +Skip google documents in all listings. If given, gdocs practically +become invisible to rclone. + +- Config: skip_gdocs +- Env Var: RCLONE_DRIVE_SKIP_GDOCS +- Type: bool +- Default: false + +--drive-skip-checksum-gphotos + +Skip MD5 checksum on Google photos and videos only. + +Use this if you get checksum errors when transferring Google photos or +videos. + +Setting this flag will cause Google photos and videos to return a blank +MD5 checksum. + +Google photos are identified by being in the "photos" space. + +Corrupted checksums are caused by Google modifying the image/video but +not updating the checksum. + +- Config: skip_checksum_gphotos +- Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS +- Type: bool +- Default: false + +--drive-shared-with-me + +Only show files that are shared with me. + +Instructs rclone to operate on your "Shared with me" folder (where +Google Drive lets you access the files and folders others have shared +with you). + +This works both with the "list" (lsd, lsl, etc.) and the "copy" commands +(copy, sync, etc.), and with all other commands too. + +- Config: shared_with_me +- Env Var: RCLONE_DRIVE_SHARED_WITH_ME +- Type: bool +- Default: false + +--drive-trashed-only + +Only show files that are in the trash. This will show trashed files in +their original directory structure. + +- Config: trashed_only +- Env Var: RCLONE_DRIVE_TRASHED_ONLY +- Type: bool +- Default: false + +--drive-starred-only + +Only show files that are starred. + +- Config: starred_only +- Env Var: RCLONE_DRIVE_STARRED_ONLY +- Type: bool +- Default: false + +--drive-formats + +Deprecated: see export_formats + +- Config: formats +- Env Var: RCLONE_DRIVE_FORMATS +- Type: string +- Default: "" + +--drive-export-formats + +Comma separated list of preferred formats for downloading Google docs. + +- Config: export_formats +- Env Var: RCLONE_DRIVE_EXPORT_FORMATS +- Type: string +- Default: "docx,xlsx,pptx,svg" + +--drive-import-formats + +Comma separated list of preferred formats for uploading Google docs. + +- Config: import_formats +- Env Var: RCLONE_DRIVE_IMPORT_FORMATS +- Type: string +- Default: "" + +--drive-allow-import-name-change + +Allow the filetype to change when uploading Google docs (e.g. file.doc +to file.docx). This will confuse sync and reupload every time. + +- Config: allow_import_name_change +- Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE +- Type: bool +- Default: false + +--drive-use-created-date + +Use file created date instead of modified date., + +Useful when downloading data and you want the creation date used in +place of the last modified date. + +WARNING: This flag may have some unexpected consequences. + +When uploading to your drive all files will be overwritten unless they +haven't been modified since their creation. And the inverse will occur +while downloading. This side effect can be avoided by using the +"--checksum" flag. + +This feature was implemented to retain photos capture date as recorded +by google photos. You will first need to check the "Create a Google +Photos folder" option in your google drive settings. You can then copy +or move the photos locally and use the date the image was taken +(created) set as the modification date. + +- Config: use_created_date +- Env Var: RCLONE_DRIVE_USE_CREATED_DATE +- Type: bool +- Default: false + +--drive-use-shared-date + +Use date file was shared instead of modified date. + +Note that, as with "--drive-use-created-date", this flag may have +unexpected consequences when uploading/downloading files. + +If both this flag and "--drive-use-created-date" are set, the created +date is used. + +- Config: use_shared_date +- Env Var: RCLONE_DRIVE_USE_SHARED_DATE +- Type: bool +- Default: false + +--drive-list-chunk + +Size of listing chunk 100-1000. 0 to disable. + +- Config: list_chunk +- Env Var: RCLONE_DRIVE_LIST_CHUNK +- Type: int +- Default: 1000 + +--drive-impersonate + +Impersonate this user when using a service account. + +- Config: impersonate +- Env Var: RCLONE_DRIVE_IMPERSONATE +- Type: string +- Default: "" + +--drive-upload-cutoff + +Cutoff for switching to chunked upload + +- Config: upload_cutoff +- Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 8M + +--drive-chunk-size + +Upload chunk size. Must a power of 2 >= 256k. + +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. + +Reducing this will reduce memory usage but decrease performance. + +- Config: chunk_size +- Env Var: RCLONE_DRIVE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 8M + +--drive-acknowledge-abuse + +Set to allow files which return cannotDownloadAbusiveFile to be +downloaded. + +If downloading a file returns the error "This file has been identified +as malware or spam and cannot be downloaded" with the error code +"cannotDownloadAbusiveFile" then supply this flag to rclone to indicate +you acknowledge the risks of downloading the file and rclone will +download it anyway. + +- Config: acknowledge_abuse +- Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE +- Type: bool +- Default: false + +--drive-keep-revision-forever + +Keep new head revision of each file forever. + +- Config: keep_revision_forever +- Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER +- Type: bool +- Default: false + +--drive-size-as-quota + +Show sizes as storage quota usage, not actual size. + +Show the size of a file as the storage quota used. This is the current +version plus any older versions that have been set to keep forever. + +WARNING: This flag may have some unexpected consequences. + +It is not recommended to set this flag in your config - the recommended +usage is using the flag form --drive-size-as-quota when doing rclone +ls/lsl/lsf/lsjson/etc only. + +If you do use this flag for syncing (not recommended) then you will need +to use --ignore size also. + +- Config: size_as_quota +- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +- Type: bool +- Default: false + +--drive-v2-download-min-size + +If Object's are greater, use drive v2 API to download. + +- Config: v2_download_min_size +- Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE +- Type: SizeSuffix +- Default: off + +--drive-pacer-min-sleep + +Minimum time to sleep between API calls. + +- Config: pacer_min_sleep +- Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP +- Type: Duration +- Default: 100ms + +--drive-pacer-burst + +Number of API calls to allow without sleeping. + +- Config: pacer_burst +- Env Var: RCLONE_DRIVE_PACER_BURST +- Type: int +- Default: 100 + +--drive-server-side-across-configs + +Allow server-side operations (e.g. copy) to work across different drive +configs. + +This can be useful if you wish to do a server-side copy between two +different Google drives. Note that this isn't enabled by default because +it isn't easy to tell if it will work between any two configurations. + +- Config: server_side_across_configs +- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +- Type: bool +- Default: false + +--drive-disable-http2 + +Disable drive using http2 + +There is currently an unsolved issue with the google drive backend and +HTTP/2. HTTP/2 is therefore disabled by default for the drive backend +but can be re-enabled here. When the issue is solved this flag will be +removed. + +See: https://github.com/rclone/rclone/issues/3631 + +- Config: disable_http2 +- Env Var: RCLONE_DRIVE_DISABLE_HTTP2 +- Type: bool +- Default: true + +--drive-stop-on-upload-limit + +Make upload limit errors be fatal + +At the time of writing it is only possible to upload 750GB of data to +Google Drive a day (this is an undocumented limit). When this limit is +reached Google Drive produces a slightly different error message. When +this flag is set it causes these errors to be fatal. These will stop the +in-progress sync. + +Note that this detection is relying on error message strings which +Google don't document so it may break in the future. + +See: https://github.com/rclone/rclone/issues/3857 + +- Config: stop_on_upload_limit +- Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT +- Type: bool +- Default: false + +--drive-stop-on-download-limit + +Make download limit errors be fatal + +At the time of writing it is only possible to download 10TB of data from +Google Drive a day (this is an undocumented limit). When this limit is +reached Google Drive produces a slightly different error message. When +this flag is set it causes these errors to be fatal. These will stop the +in-progress sync. + +Note that this detection is relying on error message strings which +Google don't document so it may break in the future. + +- Config: stop_on_download_limit +- Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT +- Type: bool +- Default: false + +--drive-skip-shortcuts + +If set skip shortcut files + +Normally rclone dereferences shortcut files making them appear as if +they are the original file (see the shortcuts section). If this flag is +set then rclone will ignore shortcut files completely. + +- Config: skip_shortcuts +- Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS +- Type: bool +- Default: false + +--drive-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_DRIVE_ENCODING +- Type: MultiEncoder +- Default: InvalidUtf8 + +Backend commands + +Here are the commands specific to the drive backend. + +Run them with + + rclone backend COMMAND remote: + +The help below will explain what arguments each command takes. + +See the "rclone backend" command for more info on how to pass options +and arguments. + +These can be run on a running backend using the rc command +backend/command. + +get + +Get command for fetching the drive config parameters + + rclone backend get remote: [options] [+] + +This is a get command which will be used to fetch the various drive +config parameters + +Usage Examples: + + rclone backend get drive: [-o service_account_file] [-o chunk_size] + rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size] + +Options: + +- "chunk_size": show the current upload chunk size +- "service_account_file": show the current service account file + +set + +Set command for updating the drive config parameters + + rclone backend set remote: [options] [+] + +This is a set command which will be used to update the various drive +config parameters + +Usage Examples: + + rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] + rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864] + +Options: + +- "chunk_size": update the current upload chunk size +- "service_account_file": update the current service account file + +shortcut + +Create shortcuts from files or directories + + rclone backend shortcut remote: [options] [+] + +This command creates shortcuts from files or directories. + +Usage: + + rclone backend shortcut drive: source_item destination_shortcut + rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut + +In the first example this creates a shortcut from the "source_item" +which can be a file or a directory to the "destination_shortcut". The +"source_item" and the "destination_shortcut" should be relative paths +from "drive:" + +In the second example this creates a shortcut from the "source_item" +relative to "drive:" to the "destination_shortcut" relative to +"drive2:". This may fail with a permission error if the user +authenticated with "drive2:" can't read files from "drive:". + +Options: + +- "target": optional target remote for the shortcut destination + +drives + +List the shared drives available to this account + + rclone backend drives remote: [options] [+] + +This command lists the shared drives (teamdrives) available to this +account. + +Usage: + + rclone backend drives drive: + +This will return a JSON list of objects like this + + [ { - "Untrashed": 17, - "Errors": 0 + "id": "0ABCDEF-01234567890", + "kind": "drive#teamDrive", + "name": "My Drive" + }, + { + "id": "0ABCDEFabcdefghijkl", + "kind": "drive#teamDrive", + "name": "Test Drive" } + ] +untrash +Untrash files and directories + rclone backend untrash remote: [options] [+] - ### Limitations ### +This command untrashes all the files and directories in the directory +passed in recursively. - Drive has quite a lot of rate limiting. This causes rclone to be - limited to transferring about 2 files per second only. Individual - files may be transferred much faster at 100s of MBytes/s but lots of - small files can take a long time. +Usage: - Server side copies are also subject to a separate rate limit. If you - see User rate limit exceeded errors, wait at least 24 hours and retry. - You can disable server side copies with `--disable copy` to download - and upload the files if you prefer. +This takes an optional directory to trash which make this easier to use +via the API. - #### Limitations of Google Docs #### + rclone backend untrash drive:directory + rclone backend -i untrash drive:directory subdir - Google docs will appear as size -1 in `rclone ls` and as size 0 in - anything which uses the VFS layer, eg `rclone mount`, `rclone serve`. +Use the -i flag to see what would be restored before restoring it. - This is because rclone can't find out the size of the Google docs - without downloading them. +Result: - Google docs will transfer correctly with `rclone sync`, `rclone copy` - etc as rclone knows to ignore the size when doing the transfer. + { + "Untrashed": 17, + "Errors": 0 + } - However an unfortunate consequence of this is that you may not be able - to download Google docs using `rclone mount`. If it doesn't work you - will get a 0 sized file. If you try again the doc may gain its - correct size and be downloadable. Whether it will work on not depends - on the application accessing the mount and the OS you are running - - experiment to find out if it does work for you! +copyid - ### Duplicated files ### +Copy files by ID - 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. + rclone backend copyid remote: [options] [+] - Duplicated files cause problems with the syncing and you will see - messages in the log about duplicates. +This command copies files by ID - Use `rclone dedupe` to fix duplicated files. +Usage: - Note that this isn't just a problem with rclone, even Google Photos on - Android duplicates files on drive sometimes. + rclone backend copyid drive: ID path + rclone backend copyid drive: ID1 path1 ID2 path2 - ### Rclone appears to be re-copying files it shouldn't ### +It copies the drive file with ID given to the path (an rclone path which +will be passed internally to rclone copyto). The ID and path pairs can +be repeated. - 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. +The path should end with a / to indicate copy the file as named to this +directory. If it doesn't end with a / then the last path component will +be used as the file name. - 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. +If the destination is a drive backend then server-side copying will be +attempted if possible. - 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. +Use the -i flag to see what would be copied before copying. - ### Making your own client_id ### +Limitations - 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. +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. - 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. +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. - Here is how to create your own Google Drive client ID for rclone: +Limitations of Google Docs - 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) +Google docs will appear as size -1 in rclone ls and as size 0 in +anything which uses the VFS layer, e.g. rclone mount, rclone serve. - 2. Select a project or create a new project. +This is because rclone can't find out the size of the Google docs +without downloading them. - 3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the +Google docs will transfer correctly with rclone sync, rclone copy etc as +rclone knows to ignore the size when doing the transfer. + +However an unfortunate consequence of this is that you may not be able +to download Google docs using rclone mount. If it doesn't work you will +get a 0 sized file. If you try again the doc may gain its correct size +and be downloadable. Whether it will work on not depends on the +application accessing the mount and the OS you are running - experiment +to find out if it does work for you! + +Duplicated files + +Sometimes, for no reason I've been able to track down, drive will +duplicate a file that rclone uploads. Drive unlike all the other remotes +can have duplicated files. + +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. + +Use rclone dedupe to fix duplicated files. + +Note that this isn't just a problem with rclone, even Google Photos on +Android duplicates files on drive sometimes. + +Rclone appears to be re-copying files it shouldn't + +The most likely cause of this is the duplicated file issue above - run +rclone dedupe and check your logs for duplicate object or directory +messages. + +This can also be caused by a delay/caching on google drive's end when +comparing directory listings. Specifically with team drives used in +combination with --fast-list. Files that were uploaded recently may not +appear on the directory list sent to rclone when using --fast-list. + +Waiting a moderate period of time between attempts (estimated to be +approximately 1 hour) and/or not using --fast-list both seem to be +effective in preventing the problem. + +Making your own client_id + +When you use rclone with Google drive in its default configuration you +are using rclone's client_id. This is shared between all the rclone +users. There is a global rate limit on the number of queries per second +that each client_id can do set by Google. rclone already has a high +quota and I will continue to make sure it is high enough by contacting +Google. + +It is strongly recommended to use your own client ID as the default +rclone ID is heavily used. If you have multiple services running, it is +recommended to use an API key for each service. The default Google quota +is 10 transactions per second so it is recommended to stay under that +number as if you use more than that, it will cause rclone to rate limit +and make things slower. + +Here is how to create your own Google Drive client ID for rclone: + +1. Log into the Google API Console with your Google account. It doesn't + matter what Google account you use. (It need not be the same account + as the Google Drive you want to access) + +2. Select a project or create a new project. + +3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the "Google Drive API". - 4. Click "Credentials" in the left-side panel (not "Create +4. Click "Credentials" in the left-side panel (not "Create credentials", which opens the wizard), then "Create credentials" - 5. If you already configured an "Oauth Consent Screen", then skip - to the next step; if not, click on "CONFIGURE CONSENT SCREEN" button - (near the top right corner of the right panel), then select "External" - and click on "CREATE"; on the next screen, enter an "Application name" - ("rclone" is OK) then click on "Save" (all other data is optional). - Click again on "Credentials" on the left panel to go back to the - "Credentials" screen. +5. If you already configured an "Oauth Consent Screen", then skip to + the next step; if not, click on "CONFIGURE CONSENT SCREEN" button + (near the top right corner of the right panel), then select + "External" and click on "CREATE"; on the next screen, enter an + "Application name" ("rclone" is OK) then click on "Save" (all other + data is optional). Click again on "Credentials" on the left panel to + go back to the "Credentials" screen. - (PS: if you are a GSuite user, you could also select "Internal" instead - of "External" above, but this has not been tested/documented so far). +(PS: if you are a GSuite user, you could also select "Internal" instead +of "External" above, but this has not been tested/documented so far). - 6. Click on the "+ CREATE CREDENTIALS" button at the top of the screen, +6. Click on the "+ CREATE CREDENTIALS" button at the top of the screen, then select "OAuth client ID". - 7. Choose an application type of "Desktop app" if you using a Google account or "Other" if - you using a GSuite account and click "Create". (the default name is fine) +7. Choose an application type of "Desktop app" if you using a Google + account or "Other" if you using a GSuite account and click "Create". + (the default name is fine) - 8. It will show you a client ID and client secret. Use these values - in rclone config to add a new remote or edit an existing remote. +8. It will show you a client ID and client secret. Use these values in + rclone config to add a new remote or edit an existing remote. - Be aware that, due to the "enhanced security" recently introduced by - Google, you are theoretically expected to "submit your app for verification" - and then wait a few weeks(!) for their response; in practice, you can go right - ahead and use the client ID and client secret with rclone, the only issue will - be a very scary confirmation screen shown when you connect via your browser - for rclone to be able to get its token-id (but as this only happens during - the remote configuration, it's not such a big deal). +Be aware that, due to the "enhanced security" recently introduced by +Google, you are theoretically expected to "submit your app for +verification" and then wait a few weeks(!) for their response; in +practice, you can go right ahead and use the client ID and client secret +with rclone, the only issue will be a very scary confirmation screen +shown when you connect via your browser for rclone to be able to get its +token-id (but as this only happens during the remote configuration, it's +not such a big deal). - (Thanks to @balazer on github for these instructions.) +(Thanks to @balazer on github for these instructions.) - Sometimes, creation of an OAuth consent in Google API Console fails due to an error message - “The request failed because changes to one of the field of the resource is not supported”. - As a convenient workaround, the necessary Google Drive API key can be created on the - [Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page. - Just push the Enable the Drive API button to receive the Client ID and Secret. - Note that it will automatically create a new project in the API Console. +Sometimes, creation of an OAuth consent in Google API Console fails due +to an error message “The request failed because changes to one of the +field of the resource is not supported”. As a convenient workaround, the +necessary Google Drive API key can be created on the Python Quickstart +page. Just push the Enable the Drive API button to receive the Client ID +and Secret. Note that it will automatically create a new project in the +API Console. - Google Photos - ------------------------------------------------- - The rclone backend for [Google Photos](https://www.google.com/photos/about/) is - a specialized backend for transferring photos and videos to and from - Google Photos. +Google Photos - **NB** The Google Photos API which rclone uses has quite a few - limitations, so please read the [limitations section](#limitations) - carefully to make sure it is suitable for your use. +The rclone backend for Google Photos is a specialized backend for +transferring photos and videos to and from Google Photos. - ## Configuring Google Photos +NB The Google Photos API which rclone uses has quite a few limitations, +so please read the limitations section carefully to make sure it is +suitable for your use. - The initial setup for google cloud storage involves getting a token from Google Photos - which you need to do in your browser. `rclone config` walks you - through it. - Here is an example of how to make a remote called `remote`. First run: +Configuring Google Photos - rclone config +The initial setup for google cloud storage involves getting a token from +Google Photos which you need to do in your browser. rclone config walks +you through it. - This will guide you through an interactive setup process: +Here is an example of how to make a remote called remote. First run: -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default (""). -Choose a number from below, or type in your own value [snip] XX / Google -Photos  "google photos" [snip] Storage> google photos ** See help for -google photos backend at: https://rclone.org/googlephotos/ ** + rclone config -Google Application Client Id Leave blank normally. Enter a string value. -Press Enter for the default (""). client_id> Google Application Client -Secret Leave blank normally. Enter a string value. Press Enter for the -default (""). client_secret> Set to make the Google Photos backend read -only. +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / Google Photos + \ "google photos" + [snip] + Storage> google photos + ** See help for google photos backend at: https://rclone.org/googlephotos/ ** + + Google Application Client Id + Leave blank normally. + Enter a string value. Press Enter for the default (""). + client_id> + Google Application Client Secret + Leave blank normally. + Enter a string value. Press Enter for the default (""). + client_secret> + Set to make the Google Photos backend read only. + + If you choose read only then rclone will only request read only access + to your photos, otherwise rclone will request full access. + Enter a boolean value (true or false). Press Enter for the default ("false"). + read_only> + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + + *** IMPORTANT: All media items uploaded to Google Photos with rclone + *** are stored in full resolution at original quality. These uploads + *** will count towards storage in your Google Account. + + -------------------- + [remote] + type = google photos + token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this may +require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +This remote is called remote and can now be used like this + +See all the albums in your photos + + rclone lsd remote:album + +Make a new album + + rclone mkdir remote:album/newAlbum + +List the contents of an album + + rclone ls remote:album/newAlbum + +Sync /home/local/images to the Google Photos, removing any excess files +in the album. + + rclone sync -i /home/local/image remote:album/newAlbum + + +Layout + +As Google Photos is not a general purpose cloud storage system the +backend is laid out to help you navigate it. + +The directories under media show different ways of categorizing the +media. Each file will appear multiple times. So if you want to make a +backup of your google photos you might choose to backup +remote:media/by-month. (NB remote:media/by-day is rather slow at the +moment so avoid for syncing.) + +Note that all your photos and videos will appear somewhere under media, +but they may not appear under album unless you've put them into albums. + + / + - upload + - file1.jpg + - file2.jpg + - ... + - media + - all + - file1.jpg + - file2.jpg + - ... + - by-year + - 2000 + - file1.jpg + - ... + - 2001 + - file2.jpg + - ... + - ... + - by-month + - 2000 + - 2000-01 + - file1.jpg + - ... + - 2000-02 + - file2.jpg + - ... + - ... + - by-day + - 2000 + - 2000-01-01 + - file1.jpg + - ... + - 2000-01-02 + - file2.jpg + - ... + - ... + - album + - album name + - album name/sub + - shared-album + - album name + - album name/sub + - feature + - favorites + - file1.jpg + - file2.jpg + +There are two writable parts of the tree, the upload directory and sub +directories of the album directory. + +The upload directory is for uploading files you don't want to put into +albums. This will be empty to start with and will contain the files +you've uploaded for one rclone session only, becoming empty again when +you restart rclone. The use case for this would be if you have a load of +files you just want to once off dump into Google Photos. For repeated +syncing, uploading to album will work better. + +Directories within the album directory are also writeable and you may +create new directories (albums) under album. If you copy files with a +directory hierarchy in there then rclone will create albums with the / +character in them. For example if you do + + rclone copy /path/to/images remote:album/images + +and the images directory contains + + images + - file1.jpg + dir + file2.jpg + dir2 + dir3 + file3.jpg + +Then rclone will create the following albums with the following files in + +- images + - file1.jpg +- images/dir + - file2.jpg +- images/dir2/dir3 + - file3.jpg + +This means that you can use the album path pretty much like a normal +filesystem and it is a good target for repeated syncing. + +The shared-album directory shows albums shared with you or by you. This +is similar to the Sharing tab in the Google Photos web interface. + + +Limitations + +Only images and videos can be uploaded. If you attempt to upload non +videos or images or formats that Google Photos doesn't understand, +rclone will upload the file, then Google Photos will give an error when +it is put turned into a media item. + +Note that all media items uploaded to Google Photos through the API are +stored in full resolution at "original quality" and WILL count towards +your storage quota in your Google Account. The API does NOT offer a way +to upload in "high quality" mode.. + +rclone about is not supported by the Google Photos backend. Backends +without this capability cannot determine free space for an rclone mount +or use policy mfs (most free space) as a member of an rclone union +remote. + +See List of backends that do not support rclone about See rclone about + +Downloading Images + +When Images are downloaded this strips EXIF location (according to the +docs and my tests). This is a limitation of the Google Photos API and is +covered by bug #112096115. + +THE CURRENT GOOGLE API DOES NOT ALLOW PHOTOS TO BE DOWNLOADED AT +ORIGINAL RESOLUTION. THIS IS VERY IMPORTANT IF YOU ARE, FOR EXAMPLE, +RELYING ON "GOOGLE PHOTOS" AS A BACKUP OF YOUR PHOTOS. YOU WILL NOT BE +ABLE TO USE RCLONE TO REDOWNLOAD ORIGINAL IMAGES. YOU COULD USE 'GOOGLE +TAKEOUT' TO RECOVER THE ORIGINAL PHOTOS AS A LAST RESORT + +Downloading Videos + +When videos are downloaded they are downloaded in a really compressed +version of the video compared to downloading it via the Google Photos +web interface. This is covered by bug #113672044. + +Duplicates + +If a file name is duplicated in a directory then rclone will add the +file ID into its name. So two files called file.jpg would then appear as +file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer +alas!). + +If you upload the same image (with the same binary data) twice then +Google Photos will deduplicate it. However it will retain the filename +from the first upload which may confuse rclone. For example if you +uploaded an image to upload then uploaded the same image to +album/my_album the filename of the image in album/my_album will be what +it was uploaded with initially, not what you uploaded it with to album. +In practise this shouldn't cause too many problems. + +Modified time + +The date shown of media in Google Photos is the creation date as +determined by the EXIF information, or the upload date if that is not +known. + +This is not changeable by rclone and is not the modification date of the +media on local disk. This means that rclone cannot use the dates from +Google Photos for syncing purposes. + +Size + +The Google Photos API does not return the size of media. This means that +when syncing to Google Photos, rclone can only do a file existence +check. + +It is possible to read the size of the media, but this needs an extra +HTTP HEAD request per media item so is VERY SLOW and uses up a lot of +transactions. This can be enabled with the --gphotos-read-size option or +the read_size = true config parameter. + +If you want to use the backend with rclone mount you may need to enable +this flag (depending on your OS and application using the photos) +otherwise you may not be able to read media off the mount. You'll need +to experiment to see if it works for you without the flag. + +Albums + +Rclone can only upload files to albums it created. This is a limitation +of the Google Photos API. + +Rclone can remove files it uploaded from albums it created only. + +Deleting files + +Rclone can remove files from albums it created, but note that the Google +Photos API does not allow media to be deleted permanently so this media +will still remain. See bug #109759781. + +Rclone cannot delete files anywhere except under album. + +Deleting albums + +The Google Photos API does not support deleting albums - see bug +#135714733. + +Standard Options + +Here are the standard options specific to google photos (Google Photos). + +--gphotos-client-id + +OAuth Client Id Leave blank normally. + +- Config: client_id +- Env Var: RCLONE_GPHOTOS_CLIENT_ID +- Type: string +- Default: "" + +--gphotos-client-secret + +OAuth Client Secret Leave blank normally. + +- Config: client_secret +- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET +- Type: string +- Default: "" + +--gphotos-read-only + +Set to make the Google Photos backend read only. If you choose read only then rclone will only request read only access -to your photos, otherwise rclone will request full access. Enter a -boolean value (true or false). Press Enter for the default ("false"). -read_only> Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -Use auto config? * Say Y if not sure * Say N if you are working on a -remote or headless machine y) Yes n) No y/n> y If your browser doesn't -open automatically go to the following link: http://127.0.0.1:53682/auth -Log in and authorize rclone for access Waiting for code... Got code +to your photos, otherwise rclone will request full access. -*** IMPORTANT: All media items uploaded to Google Photos with rclone *** -are stored in full resolution at original quality. These uploads *** -will count towards storage in your Google Account. +- Config: read_only +- Env Var: RCLONE_GPHOTOS_READ_ONLY +- Type: bool +- Default: false - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - [remote] type = google photos token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2019-06-28T17:38:04.644930156+01:00"} - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` +Advanced Options - Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode. +Here are the advanced options specific to google photos (Google Photos). - This remote is called remote and can now be used like this +--gphotos-token - See all the albums in your photos +OAuth Access Token as a JSON blob. - rclone lsd remote:album +- Config: token +- Env Var: RCLONE_GPHOTOS_TOKEN +- Type: string +- Default: "" - Make a new album +--gphotos-auth-url - rclone mkdir remote:album/newAlbum +Auth server URL. Leave blank to use the provider defaults. - List the contents of an album +- Config: auth_url +- Env Var: RCLONE_GPHOTOS_AUTH_URL +- Type: string +- Default: "" - rclone ls remote:album/newAlbum +--gphotos-token-url - Sync /home/local/images to the Google Photos, removing any excess files in the album. +Token server url. Leave blank to use the provider defaults. - rclone sync -i /home/local/image remote:album/newAlbum +- Config: token_url +- Env Var: RCLONE_GPHOTOS_TOKEN_URL +- Type: string +- Default: "" - ## Layout +--gphotos-read-size - As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it. +Set to read the size of media items. - The directories under media show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup remote:media/by-month. (NB remote:media/by-day is rather slow at the moment so avoid for syncing.) +Normally rclone does not read the size of media items since this takes +another transaction. This isn't necessary for syncing. However rclone +mount needs to know the size of files in advance of reading them, so +setting this flag when using rclone mount is recommended if you want to +read the media. - Note that all your photos and videos will appear somewhere under media, but they may not appear under album unless you've put them into albums. +- Config: read_size +- Env Var: RCLONE_GPHOTOS_READ_SIZE +- Type: bool +- Default: false + +--gphotos-start-year - / - upload - file1.jpg - file2.jpg - ... - media - all - file1.jpg - file2.jpg - ... - by-year - 2000 - file1.jpg - ... - 2001 - file2.jpg - ... - ... - by-month - 2000 - 2000-01 - file1.jpg - ... - 2000-02 - file2.jpg - ... - ... - by-day - 2000 - 2000-01-01 - file1.jpg - ... - 2000-01-02 - file2.jpg - ... - ... - album - album name - album name/sub - shared-album - album name - album name/sub - feature - favorites - file1.jpg - file2.jpg +Year limits the photos to be downloaded to those which are uploaded +after the given year - There are two writable parts of the tree, the upload directory and sub directories of the album directory. +- Config: start_year +- Env Var: RCLONE_GPHOTOS_START_YEAR +- Type: int +- Default: 2000 - 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. +--gphotos-include-archived - 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 +Also view and download archived media. - rclone copy /path/to/images remote:album/images +By default rclone does not request archived media. Thus, when syncing, +archived media is not visible in directory listings or transferred. - and the images directory contains +Note that media in albums is always visible and synced, no matter their +archive status. - images - file1.jpg dir file2.jpg dir2 dir3 file3.jpg +With this flag, archived media are always visible in directory listings +and transferred. - Then rclone will create the following albums with the following files in +Without this flag, archived media will not be visible in directory +listings and won't be transferred. - - images - file1.jpg - images/dir - file2.jpg - images/dir2/dir3 - file3.jpg +- Config: include_archived +- Env Var: RCLONE_GPHOTOS_INCLUDE_ARCHIVED +- Type: bool +- Default: false - 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. +HDFS - ## Limitations +HDFS is a distributed file-system, part of the Apache Hadoop framework. - 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. +Paths are specified as remote: or remote:path/to/dir. - 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.. +Here is an example of how to make a remote called remote. First run: - ### Downloading Images + rclone config - 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. +This will guide you through an interactive setup process: - 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 + 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 + [skip] + XX / Hadoop distributed file system + \ "hdfs" + [skip] + Storage> hdfs + ** See help for hdfs backend at: https://rclone.org/hdfs/ ** - ### Downloading Videos + hadoop name node and port + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Connect to host namenode at port 8020 + \ "namenode:8020" + namenode> namenode.hadoop:8020 + hadoop user name + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Connect to hdfs as root + \ "root" + username> root + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> n + Remote config + -------------------- + [remote] + type = hdfs + namenode = namenode.hadoop:8020 + username = root + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y + Current remotes: - 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. + Name Type + ==== ==== + hadoop hdfs - ### Duplicates + 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 - 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!). +This remote is called remote and can now be used like this - 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. +See all the top level directories - ### Modified time + rclone lsd remote: - 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. +List the contents of a directory - 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. + rclone ls remote:directory - ### Size +Sync the remote directory to /home/local/directory, deleting any excess +files. - 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. + rclone sync -i remote:directory /home/local/directory - 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. +Setting up your own HDFS instance for testing - 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. +You may start with a manual setup or use the docker image from the +tests: - ### Albums +If you want to build the docker image - Rclone can only upload files to albums it created. This is a limitation of the Google Photos API. + git clone https://github.com/rclone/rclone.git + cd rclone/fstest/testserver/images/test-hdfs + docker build --rm -t rclone/test-hdfs . - Rclone can remove files it uploaded from albums it created only. +Or you can just use the latest one pushed - ### Deleting files + docker run --rm --name "rclone-hdfs" -p 127.0.0.1:9866:9866 -p 127.0.0.1:8020:8020 --hostname "rclone-hdfs" rclone/test-hdfs - 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. +NB it need few seconds to startup. - Rclone cannot delete files anywhere except under album. +For this docker image the remote needs to be configured like this: - ### Deleting albums + [remote] + type = hdfs + namenode = 127.0.0.1:8020 + username = root - The Google Photos API does not support deleting albums - see bug #135714733. +You can stop this image with docker kill rclone-hdfs (NB it does not use +volumes, so all data uploaded will be lost.) - ### Standard Options +Modified time - Here are the standard options specific to google photos (Google Photos). +Time accurate to 1 second is stored. - #### --gphotos-client-id +Checksum - OAuth Client Id Leave blank normally. +No checksums are implemented. - - Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Default: "" +Usage information - #### --gphotos-client-secret +You can use the rclone about remote: command which will display +filesystem size and current usage. - OAuth Client Secret Leave blank normally. +Restricted filename characters - - Config: client_secret - Env Var: RCLONE_GPHOTOS_CLIENT_SECRET - Type: string - Default: "" +In addition to the default restricted characters set the following +characters are also replaced: - #### --gphotos-read-only + Character Value Replacement + ----------- ------- ------------- + : 0x3A ： - Set to make the Google Photos backend read only. +Invalid UTF-8 bytes will also be replaced. - If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. +Limitations - - Config: read_only - Env Var: RCLONE_GPHOTOS_READ_ONLY - Type: bool - Default: false +- No server-side Move or DirMove. +- Checksums not implemented. - ### Advanced Options +Standard Options - Here are the advanced options specific to google photos (Google Photos). +Here are the standard options specific to hdfs (Hadoop distributed file +system). - #### --gphotos-token +--hdfs-namenode - OAuth Access Token as a JSON blob. +hadoop name node and port - - Config: token - Env Var: RCLONE_GPHOTOS_TOKEN - Type: string - Default: "" +- Config: namenode +- Env Var: RCLONE_HDFS_NAMENODE +- Type: string +- Default: "" +- Examples: + - "namenode:8020" + - Connect to host namenode at port 8020 - #### --gphotos-auth-url +--hdfs-username - Auth server URL. Leave blank to use the provider defaults. +hadoop user name - - Config: auth_url - Env Var: RCLONE_GPHOTOS_AUTH_URL - Type: string - Default: "" +- Config: username +- Env Var: RCLONE_HDFS_USERNAME +- Type: string +- Default: "" +- Examples: + - "root" + - Connect to hdfs as root - #### --gphotos-token-url +Advanced Options - Token server url. Leave blank to use the provider defaults. +Here are the advanced options specific to hdfs (Hadoop distributed file +system). - - Config: token_url - Env Var: RCLONE_GPHOTOS_TOKEN_URL - Type: string - Default: "" +--hdfs-service-principal-name - #### --gphotos-read-size +Kerberos service principal name for the namenode - Set to read the size of media items. +Enables KERBEROS authentication. Specifies the Service Principal Name +(/) for the namenode. - 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: service_principal_name +- Env Var: RCLONE_HDFS_SERVICE_PRINCIPAL_NAME +- Type: string +- Default: "" +- Examples: + - "hdfs/namenode.hadoop.docker" + - Namenode running as service 'hdfs' with FQDN + 'namenode.hadoop.docker'. - - Config: read_size - Env Var: RCLONE_GPHOTOS_READ_SIZE - Type: bool - Default: false +--hdfs-data-transfer-protection - #### --gphotos-start-year +Kerberos data transfer protection: authentication|integrity|privacy - Year limits the photos to be downloaded to those which are uploaded after the given year +Specifies whether or not authentication, data signature integrity +checks, and wire encryption is required when communicating the the +datanodes. Possible values are 'authentication', 'integrity' and +'privacy'. Used only with KERBEROS enabled. - - Config: start_year - Env Var: RCLONE_GPHOTOS_START_YEAR - Type: int - Default: 2000 +- Config: data_transfer_protection +- Env Var: RCLONE_HDFS_DATA_TRANSFER_PROTECTION +- Type: string +- Default: "" +- Examples: + - "privacy" + - Ensure authentication, integrity and encryption enabled. - HTTP - ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +--hdfs-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_HDFS_ENCODING +- Type: MultiEncoder +- Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot + + +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 @@ -18322,7 +21071,7 @@ CSV encoding may be used. For example to set a Cookie use 'Cookie,name=value', or '"Cookie","name=value"'. -You can set multiple headers, eg +You can set multiple headers, e.g. '"Cookie","name=value","Authorization","xxx"'. - Config: headers @@ -18374,13 +21123,21 @@ mean - Type: bool - Default: false +Limitations + +rclone about is not supported by the HTTP backend. Backends without this +capability cannot determine free space for an rclone mount or use policy +mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about + Hubic Paths are specified as remote:path Paths are specified as remote:container (or remote: for the lsd -command.) You may put subdirectories in too, eg +command.) You may put subdirectories in too, e.g. remote:container/path/to/dir. The initial setup for Hubic involves getting a token from Hubic which @@ -18543,8 +21300,8 @@ default for this is 5GB which is its maximum value. Don't chunk files during streaming upload. -When doing streaming uploads (eg using rcat or mount) setting this flag -will cause the swift backend to not upload chunked files. +When doing streaming uploads (e.g. using rcat or mount) setting this +flag will cause the swift backend to not upload chunked files. This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM. @@ -18588,7 +21345,7 @@ several whitelabel versions which should work with this backend. Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. Setup @@ -18605,9 +21362,19 @@ Legacy Setup If you are using one of the whitelabel versions (Elgiganten, Com Hem Cloud) you may not have the option to generate a CLI token. In this case -you'll have to use the legacy authentification. To to this select yes -when the setup asks for legacy authentification and enter your username -and password. The rest of the setup is identical to the default setup. +you'll have to use the legacy authentication. To to this select yes when +the setup asks for legacy authentication and enter your username and +password. The rest of the setup is identical to the default setup. + +Telia Cloud Setup + +Similar to other whitelabel versions Telia Cloud doesn't offer the +option of creating a CLI token, and additionally uses a separate +authentication flow where the username is generated internally. To setup +rclone to use Telia Cloud, choose Telia Cloud authentication in the +setup. The rest of the setup is identical to the default setup. + +Example Here is an example of how to make a remote called remote with the default setup. First run: @@ -18637,7 +21404,7 @@ This will guide you through an interactive setup process: n) No y/n> n Remote config - Use legacy authentification?. + Use legacy authentication?. This is only required for certain whitelabel versions of Jottacloud and not recommended for normal users. y) Yes n) No (default) @@ -18728,7 +21495,11 @@ Note that Jottacloud requires the MD5 hash before upload so if the source does not have an MD5 checksum then the file will be cached temporarily on disk (wherever the TMPDIR environment variable points to) before it is uploaded. Small files will be cached in memory - see the ---jottacloud-md5-memory-limit flag. +--jottacloud-md5-memory-limit flag. When uploading from local disk the +source checksum is always available, so this does not apply. Starting +with rclone version 1.52 the same is true for crypted remotes (in older +versions the crypt backend would not calculate hashes for uploads from +local disk, so the Jottacloud backend had to do it as described above). Restricted filename characters @@ -18847,7 +21618,7 @@ Koofr Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. The initial setup for Koofr involves creating an application password for rclone. You can do that by opening the Koofr web application, giving @@ -19018,7 +21789,7 @@ for rclone until it gets eventually implemented. Features highlights -- Paths may be as deep as required, eg remote:directory/subdirectory +- Paths may be as deep as required, e.g. 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 @@ -19201,8 +21972,9 @@ 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 +users. It is meaningless and ineffective if source file is unique or +encrypted. 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. @@ -19307,7 +22079,7 @@ 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 +binlist unknowndirs - Config: quirks - Env Var: RCLONE_MAILRU_QUIRKS @@ -19339,7 +22111,7 @@ features of Mega using the same client side encryption. Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. Here is an example of how to make a remote called remote. First run: @@ -19550,7 +22322,7 @@ Memory The memory backend is an in RAM backend. It does not persist its data - use the local backend for that. -The memory backend behaves like a bucket based remote (eg like s3). +The memory backend behaves like a bucket based remote (e.g. like s3). Because it has no parameters you can just use it with the :memory: remote name. @@ -19585,7 +22357,7 @@ want to: y/e/d> y Because the memory backend isn't persistent it is most useful for -testing or with an rclone server or rclone mount, eg +testing or with an rclone server or rclone mount, e.g. rclone mount :memory: /mnt/tmp rclone serve webdav :memory: @@ -19604,7 +22376,7 @@ The memory backend replaces the default restricted characters set. Microsoft Azure Blob Storage Paths are specified as remote:container (or remote: for the lsd -command.) You may put subdirectories in too, eg +command.) You may put subdirectories in too, e.g. remote:container/path/to/dir. Here is an example of making a Microsoft Azure Blob Storage @@ -19699,7 +22471,7 @@ 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. +e.g. the local disk. Authenticating with Azure Blob Storage @@ -19722,7 +22494,7 @@ SAS URL right click on a container in the Azure Blob explorer in the Azure portal. If you use a container level SAS URL, rclone operations are permitted -only on a particular container, eg +only on a particular container, e.g. rclone ls azureblob:container @@ -19740,26 +22512,6 @@ Container level SAS URLs are useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment such as a CI build server. -Multipart uploads - -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 Here are the standard options specific to azureblob (Microsoft Azure @@ -19774,6 +22526,26 @@ Storage Account Name (leave blank to use SAS URL or Emulator) - Type: string - Default: "" +--azureblob-service-principal-file + +Path to file containing credentials for use with a service principal. + +Leave blank normally. Needed only if you want to use a service principal +instead of interactive login. + + $ az sp create-for-rbac --name "" \ + --role "Storage Blob Data Owner" \ + --scopes "/subscriptions//resourceGroups//providers/Microsoft.Storage/storageAccounts//blobServices/default/containers/" \ + > azure-principal.json + +See Use Azure CLI to assign an Azure role for access to blob and queue +data for more details. + +- Config: service_principal_file +- Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE +- Type: string +- Default: "" + --azureblob-key Storage Account Key (leave blank to use SAS URL or Emulator) @@ -19793,6 +22565,26 @@ account/key or Emulator) - Type: string - Default: "" +--azureblob-use-msi + +Use a managed service identity to authenticate (only works in Azure) + +When true, use a managed service identity to authenticate to Azure +Storage instead of a SAS token or account key. + +If the VM(SS) on which this program is running has a system-assigned +identity, it will be used by default. If the resource has no +system-assigned but exactly one user-assigned identity, the +user-assigned identity will be used by default. If the resource has +multiple user-assigned identities, the identity to use must be +explicitly specified using exactly one of the msi_object_id, +msi_client_id, or msi_mi_res_id parameters. + +- Config: use_msi +- Env Var: RCLONE_AZUREBLOB_USE_MSI +- Type: bool +- Default: false + --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using @@ -19808,6 +22600,36 @@ Advanced Options Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage). +--azureblob-msi-object-id + +Object ID of the user-assigned MSI to use, if any. Leave blank if +msi_client_id or msi_mi_res_id specified. + +- Config: msi_object_id +- Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID +- Type: string +- Default: "" + +--azureblob-msi-client-id + +Object ID of the user-assigned MSI to use, if any. Leave blank if +msi_object_id or msi_mi_res_id specified. + +- Config: msi_client_id +- Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID +- Type: string +- Default: "" + +--azureblob-msi-mi-res-id + +Azure resource ID of the user-assigned MSI to use, if any. Leave blank +if msi_client_id or msi_object_id specified. + +- Config: msi_mi_res_id +- Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID +- Type: string +- Default: "" + --azureblob-endpoint Endpoint for the service Leave blank normally. @@ -19819,12 +22641,12 @@ Endpoint for the service Leave blank normally. --azureblob-upload-cutoff -Cutoff for switching to chunked upload (<= 256MB). +Cutoff for switching to chunked upload (<= 256MB). (Deprecated) - Config: upload_cutoff - Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF -- Type: SizeSuffix -- Default: 256M +- Type: string +- Default: "" --azureblob-chunk-size @@ -19873,6 +22695,27 @@ first restore by tiering blob to "Hot" or "Cool". - Type: string - Default: "" +--azureblob-archive-tier-delete + +Delete archive tier blobs before overwriting. + +Archive tier blobs cannot be updated. So without this flag, if you +attempt to update an archive tier blob, then rclone will produce the +error: + + can't update archive tier blob without --azureblob-archive-tier-delete + +With this flag set then before rclone attempts to overwrite an archive +tier blob, it will delete the existing blob before uploading its +replacement. This has the potential for data loss if the upload fails +(unlike updating a normal blob) and also may cost more since deleting +archive tier blobs early may be chargable. + +- Config: archive_tier_delete +- Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE +- Type: bool +- Default: false + --azureblob-disable-checksum Don't store MD5 checksum with object metadata. @@ -19924,6 +22767,13 @@ 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. +rclone about is not supported by the Microsoft Azure Blob storage +backend. Backends without this capability cannot determine free space +for an rclone mount or use policy mfs (most free space) as a member of +an rclone union remote. + +See List of backends that do not support rclone about See rclone about + Azure Storage Emulator Support You can test rclone with storage emulator locally, to do this make sure @@ -19937,7 +22787,7 @@ Microsoft OneDrive Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. The initial setup for OneDrive involves getting a token from Microsoft which you need to do in your browser. rclone config walks you through @@ -20058,9 +22908,9 @@ you can get your own Client ID and Key by following the steps below: and then click New registration. 2. Enter a name for your app, choose account type Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox), - 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. + select Web in Redirect URI, then type (do not copy and paste) + 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 @@ -20100,8 +22950,6 @@ characters are also replaced: ? 0x3F ？ \ 0x5C ＼ | 0x7C ｜ - # 0x23 ＃ - % 0x25 ％ File names can also not end with the following characters. These only get replaced if they are the last character in the name: @@ -20151,6 +22999,24 @@ OAuth Client Secret Leave blank normally. - Type: string - Default: "" +--onedrive-region + +Choose national cloud region for OneDrive. + +- Config: region +- Env Var: RCLONE_ONEDRIVE_REGION +- Type: string +- Default: "global" +- Examples: + - "global" + - Microsoft Cloud Global + - "us" + - Microsoft Cloud for US Government + - "de" + - Microsoft Cloud Germany + - "cn" + - Azure and Office 365 operated by 21Vianet in China + Advanced Options Here are the advanced options specific to onedrive (Microsoft OneDrive). @@ -20233,12 +23099,13 @@ set this option. --onedrive-server-side-across-configs -Allow server side operations (eg copy) to work across different onedrive -configs. +Allow server-side operations (e.g. copy) to work across different +onedrive configs. -This can be useful if you wish to do a server side copy between two -different Onedrives. Note that this isn't enabled by default because it -isn't easy to tell if it will work between any two configurations. +This will only work if you are copying between two OneDrive _Personal_ +drives AND the files to copy are already shared between them. In other +cases, rclone will fall back to normal copy (which will be slightly +slower). - Config: server_side_across_configs - Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS @@ -20265,6 +23132,52 @@ flag there. - Type: bool - Default: false +--onedrive-link-scope + +Set the scope of the links created by the link command. + +- Config: link_scope +- Env Var: RCLONE_ONEDRIVE_LINK_SCOPE +- Type: string +- Default: "anonymous" +- Examples: + - "anonymous" + - Anyone with the link has access, without needing to sign in. + This may include people outside of your organization. + Anonymous link support may be disabled by an administrator. + - "organization" + - Anyone signed into your organization (tenant) can use the + link to get access. Only available in OneDrive for Business + and SharePoint. + +--onedrive-link-type + +Set the type of the links created by the link command. + +- Config: link_type +- Env Var: RCLONE_ONEDRIVE_LINK_TYPE +- Type: string +- Default: "view" +- Examples: + - "view" + - Creates a read-only link to the item. + - "edit" + - Creates a read-write link to the item. + - "embed" + - Creates an embeddable link to the item. + +--onedrive-link-password + +Set the password for links created by the link command. + +At the time of writing this only works with OneDrive personal paid +accounts. + +- Config: link_password +- Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD +- Type: string +- Default: "" + --onedrive-encoding This sets the encoding for the backend. @@ -20275,7 +23188,7 @@ See: the encoding section in the overview for more info. - Env Var: RCLONE_ONEDRIVE_ENCODING - Type: MultiEncoder - Default: - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot Limitations @@ -20297,8 +23210,8 @@ mapped to ？ instead. File sizes -The largest allowed file size is 100GB for both OneDrive Personal and -OneDrive for Business (Updated 17 June 2020). +The largest allowed file size is 250GB for both OneDrive Personal and +OneDrive for Business (Updated 13 Jan 2021). Path length @@ -20462,7 +23375,7 @@ OpenDrive Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. Here is an example of how to make a remote called remote. First run: @@ -20613,11 +23526,17 @@ 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. +rclone about is not supported by the OpenDrive backend. Backends without +this capability cannot determine free space for an rclone mount or use +policy mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about + QingStor Paths are specified as remote:bucket (or remote: for the lsd command.) -You may put subdirectories in too, eg remote:bucket/path/to/dir. +You may put subdirectories in too, e.g. remote:bucket/path/to/dir. Here is an example of making an QingStor configuration. First run @@ -20854,7 +23773,7 @@ multipart uploads using this chunk size. Note that "--qingstor-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 +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 @@ -20869,10 +23788,10 @@ Concurrency for multipart uploads. This is the number of chunks of the same file that are uploaded concurrently. -NB if you set this to > 1 then the checksums of multpart uploads become +NB if you set this to > 1 then the checksums of multipart uploads become corrupted (the uploads themselves are not corrupted though). -If you are uploading small numbers of large file over high speed link +If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers. @@ -20892,6 +23811,14 @@ See: the encoding section in the overview for more info. - Type: MultiEncoder - Default: Slash,Ctl,InvalidUtf8 +Limitations + +rclone about is not supported by the qingstor backend. Backends without +this capability cannot determine free space for an rclone mount or use +policy mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about + Swift @@ -20905,7 +23832,7 @@ that being: - IBM Bluemix Cloud ObjectStorage Swift Paths are specified as remote:container (or remote: for the lsd -command.) You may put subdirectories in too, eg +command.) You may put subdirectories in too, e.g. remote:container/path/to/dir. Here is an example of making a swift configuration. First run @@ -21318,6 +24245,16 @@ Advanced Options Here are the advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)). +--swift-leave-parts-on-error + +If true avoid calling abort upload on a failure. It should be set to +true for resuming uploads across different sessions. + +- Config: leave_parts_on_error +- Env Var: RCLONE_SWIFT_LEAVE_PARTS_ON_ERROR +- Type: bool +- Default: false + --swift-chunk-size Above this size files will be chunked into a _segments container. @@ -21334,8 +24271,8 @@ default for this is 5GB which is its maximum value. Don't chunk files during streaming upload. -When doing streaming uploads (eg using rcat or mount) setting this flag -will cause the swift backend to not upload chunked files. +When doing streaming uploads (e.g. using rcat or mount) setting this +flag will cause the swift backend to not upload chunked files. This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM. @@ -21395,7 +24332,7 @@ So this most likely means your username / password is wrong. You can investigate further with the --dump-bodies flag. This may also be caused by specifying the region when you shouldn't have -(eg OVH). +(e.g. OVH). Rclone gives Failed to create file system: Response didn't have storage url and auth token @@ -21407,7 +24344,7 @@ pCloud Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. The initial setup for pCloud involves getting a token from pCloud which you need to do in your browser. rclone config walks you through it. @@ -21487,8 +24424,11 @@ 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. +pCloud supports MD5 and SHA1 type hashes in the US region but and SHA1 +only in the EU region, so you can use the --checksum flag. + +(Note that pCloud also support SHA256 in the EU region, but rclone does +not have support for that yet.) Restricted filename characters @@ -21625,7 +24565,7 @@ premiumize.me Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. The initial setup for premiumize.me involves getting a token from premiumize.me which you need to do in your browser. rclone config walks @@ -21762,7 +24702,7 @@ put.io Paths are specified as remote:path -put.io paths may be as deep as required, eg +put.io paths may be as deep as required, e.g. remote:directory/subdirectory. The initial setup for put.io involves getting a token from put.io which @@ -21886,7 +24826,7 @@ Root mode vs Library mode There are two distinct modes you can setup your remote: - you point your remote to the ROOT OF THE SERVER, meaning you don't specify a library during the configuration: Paths are specified as remote:library. You may -put subdirectories in too, eg remote:library/path/to/dir. - you point +put subdirectories in too, e.g. remote:library/path/to/dir. - you point your remote to a specific library during the configuration: Paths are specified as remote:path/to/dir. THIS IS THE RECOMMENDED MODE WHEN USING ENCRYPTED LIBRARIES. (_This mode is possibly slightly faster than the @@ -22274,7 +25214,7 @@ This will guide you through an interactive setup process. 1 / Connect to example.com \ "example.com" host> example.com - SSH username, leave blank for current username, ncw + SSH username, leave blank for current username, $USER user> sftpuser SSH port, leave blank to use default (22) port> @@ -22323,7 +25263,7 @@ SSH Authentication The SFTP remote supports three authentication methods: - Password -- Key file +- Key file, including certificate signed keys - ssh-agent Key files should be PEM-encoded private key files. For instance @@ -22355,11 +25295,78 @@ moment. If you set the --sftp-ask-password option, rclone will prompt for a password when needed and no password has been configured. +If you have a certificate then you can provide the path to the public +key that contains the certificate. For example: + + [remote] + type = sftp + host = example.com + user = sftpuser + key_file = ~/id_rsa + pubkey_file = ~/id_rsa-cert.pub + +If you concatenate a cert with a private key then you can specify the +merged file in both places. + +Note: the cert must come first in the file. e.g. + + cat id_rsa-cert.pub id_rsa > merged_key + +Host key validation + +By default rclone will not check the server's host key for validation. +This can allow an attacker to replace a server with their own and if you +use password authentication then this can lead to that password being +exposed. + +Host key matching, using standard known_hosts files can be turned on by +enabling the known_hosts_file option. This can point to the file +maintained by OpenSSH or can point to a unique file. + +e.g. + + [remote] + type = sftp + host = example.com + user = sftpuser + pass = + known_hosts_file = ~/.ssh/known_hosts + +There are some limitations: + +- rclone will not _manage_ this file for you. If the key is missing or + wrong then the connection will be refused. +- If the server is set up for a certificate host key then the entry in + the known_hosts file _must_ be the @cert-authority entry for the CA +- Unlike OpenSSH, the libraries used by rclone do not permit (at time + of writing) multiple host keys to be listed for a server. Only the + first entry is used. + +If the host key provided by the server does not match the one in the +file (or is missing) then the connection will be aborted and an error +returned such as + + NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key mismatch + +or + + NewFs: couldn't connect SSH: ssh: handshake failed: knownhosts: key is unknown + +If you see an error such as + + NewFs: couldn't connect SSH: ssh: handshake failed: ssh: no authorities for hostname: example.com:22 + +then it is likely the server has presented a CA signed host certificate +and you will need to add the appropriate @cert-authority entry. + +The known_hosts_file setting can be set during rclone config as an +advanced option. + ssh-agent on macOS Note that there seem to be various problems with using an ssh-agent on macOS due to recent changes in the OS. The most effective work-around -seems to be to start an ssh-agent in each session, eg +seems to be to start an ssh-agent in each session, e.g. eval `ssh-agent -s` && ssh-add -A @@ -22399,7 +25406,7 @@ SSH host to connect to --sftp-user -SSH username, leave blank for current username, ncw +SSH username, leave blank for current username, $USER - Config: user - Env Var: RCLONE_SFTP_USER @@ -22463,6 +25470,21 @@ NB Input to this must be obscured - see rclone obscure. - Type: string - Default: "" +--sftp-pubkey-file + +Optional path to public key file. + +Set this if you have a signed certificate you want to use for +authentication. + +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. + +- Config: pubkey_file +- Env Var: RCLONE_SFTP_PUBKEY_FILE +- Type: string +- Default: "" + --sftp-key-use-agent When set forces the usage of the ssh-agent. @@ -22521,6 +25543,23 @@ Advanced Options Here are the advanced options specific to sftp (SSH/SFTP Connection). +--sftp-known-hosts-file + +Optional path to known_hosts file. + +Set this value to enable server host key validation. + +Leading ~ will be expanded in the file name as will environment +variables such as ${RCLONE_CONFIG_DIR}. + +- Config: known_hosts_file +- Env Var: RCLONE_SFTP_KNOWN_HOSTS_FILE +- Type: string +- Default: "" +- Examples: + - "~/.ssh/known_hosts" + - Use OpenSSH's known_hosts file + --sftp-ask-password Allow asking for SFTP password when needed. @@ -22609,6 +25648,24 @@ The subsystem option is ignored when server_command is defined. - Type: string - Default: "" +--sftp-use-fstat + +If set use fstat instead of stat + +Some servers limit the amount of open files and calling Stat after +opening the file will throw an error from the server. Setting this flag +will call Fstat instead of Stat which is called on an already open file +handle. + +It has been found that this helps with IBM Sterling SFTP servers which +have "extractability" level set to 1 which means only 1 file can be +opened at any given time. + +- Config: use_fstat +- Env Var: RCLONE_SFTP_USE_FSTAT +- Type: bool +- Default: false + Limitations SFTP supports checksums if the same login has shell access and md5sum or @@ -22626,7 +25683,7 @@ 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 +Note that some SFTP servers (e.g. 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. @@ -22744,7 +25801,7 @@ To copy a local directory to an SugarSync folder called backup Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. NB you can't create files in the top level folder you have to create a folder, which rclone will create as a "Sync Folder" with SugarSync. @@ -22898,6 +25955,14 @@ See: the encoding section in the overview for more info. - Type: MultiEncoder - Default: Slash,Ctl,InvalidUtf8,Dot +Limitations + +rclone about is not supported by the SugarSync backend. Backends without +this capability cannot determine free space for an rclone mount or use +policy mfs (most free space) as a member of an rclone union remote. + +See List of backends that do not support rclone about See rclone about + Tardigrade @@ -22958,7 +26023,7 @@ Setup with access grant d) Delete this remote y/e/d> y -Setup with API key and passhprase +Setup with API key and passphrase No remotes found - make a new one n) New remote @@ -23018,7 +26083,7 @@ Setup with API key and passhprase Usage Paths are specified as remote:bucket (or remote: for the lsf command.) -You may put subdirectories in too, eg remote:bucket/path/to/dir. +You may put subdirectories in too, e.g. remote:bucket/path/to/dir. Once configured you can then use rclone like this. @@ -23197,13 +26262,22 @@ for uploading. - Type: string - Default: "" +Limitations + +rclone about is not supported by the rclone Tardigrade backend. Backends +without this capability cannot determine free space for an rclone mount +or use policy mfs (most free space) as a member of an rclone union +remote. + +See List of backends that do not support rclone about See rclone about + Union The union remote provides a unification similar to UnionFS using other remotes. -Paths may be as deep as required or a local path, eg +Paths may be as deep as required or a local path, e.g. remote:directory/subdirectory or /directory/subdirectory. During the initial setup with rclone config you will specify the @@ -23211,17 +26285,17 @@ upstream remotes as a space separated list. The upstream remotes can either be a local paths or other remotes. Attribute :ro and :nc can be attach to the end of path to tag the remote -as READ ONLY or NO CREATE, eg remote:directory/subdirectory:ro or +as READ ONLY or NO CREATE, e.g. remote:directory/subdirectory:ro or remote:directory/subdirectory:nc. Subfolders can be used in upstream remotes. Assume a union remote named backup with the remotes mydrive:private/backup. Invoking rclone mkdir backup:desktop is exactly the same as invoking -rclone mkdir mydrive2:/backup/desktop. +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 mydrive2:/backup/../desktop. +rclone mkdir mydrive:private/backup/../desktop. Behavior / Policies @@ -23388,7 +26462,7 @@ This will guide you through an interactive setup process: List of space separated upstreams. Can be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc. Enter a string value. Press Enter for the default (""). - upstreams> + upstreams> remote1:dir1 remote2:dir2 remote3:dir3 Policy to choose upstream on ACTION class. Enter a string value. Press Enter for the default ("epall"). action_policy> @@ -23405,7 +26479,7 @@ This will guide you through an interactive setup process: -------------------- [remote] type = union - upstreams = C:\dir1 C:\dir2 C:\dir3 + upstreams = remote1:dir1 remote2:dir2 remote3:dir3 -------------------- y) Yes this is OK e) Edit this remote @@ -23428,16 +26502,17 @@ This will guide you through an interactive setup process: Once configured you can then use rclone like this, -List directories in top level in C:\dir1, C:\dir2 and C:\dir3 +List directories in top level in remote1:dir1, remote2:dir2 and +remote3:dir3 rclone lsd remote: -List all the files in C:\dir1, C:\dir2 and C:\dir3 +List all the files in remote1:dir1, remote2:dir2 and remote3:dir3 rclone ls remote: Copy another local directory to the union directory called source, which -will be placed into C:\dir3 +will be placed into remote3:dir3 rclone copy C:\source remote:source @@ -23498,7 +26573,7 @@ WebDAV Paths are specified as remote:path -Paths may be as deep as required, eg remote:directory/subdirectory. +Paths may be as deep as required, e.g. remote:directory/subdirectory. To configure the WebDAV remote you will need to have a URL for it, and a username and password. If you know what kind of system you are @@ -23550,7 +26625,7 @@ This will guide you through an interactive setup process: password: Confirm the password: password: - Bearer token instead of user/pass (eg a Macaroon) + Bearer token instead of user/pass (e.g. a Macaroon) bearer_token> Remote config -------------------- @@ -23647,7 +26722,7 @@ NB Input to this must be obscured - see rclone obscure. --webdav-bearer-token -Bearer token instead of user/pass (eg a Macaroon) +Bearer token instead of user/pass (e.g. a Macaroon) - Config: bearer_token - Env Var: RCLONE_WEBDAV_BEARER_TOKEN @@ -23683,8 +26758,9 @@ Owncloud supports modified times using the X-OC-Mtime header. Nextcloud This is configured in an identical way to Owncloud. Note that Nextcloud -does not support streaming of files (rcat) whereas Owncloud does. This -may be fixed in the future. +initially did not support streaming of files (rcat) whereas Owncloud +did, but this seems to be fixed as of 2020-11-27 (tested with rclone +v1.53.1 and Nextcloud Server v19). Sharepoint @@ -23880,7 +26956,7 @@ in the path. rclone sync -i /home/local/directory remote:directory -Yandex paths may be as deep as required, eg +Yandex paths may be as deep as required, e.g. remote:directory/subdirectory. Modified time @@ -23987,9 +27063,164 @@ See: the encoding section in the overview for more info. - Default: Slash,Del,Ctl,InvalidUtf8,Dot +Zoho Workdrive + +Zoho WorkDrive is a cloud storage solution created by Zoho. + +Here is an example of making a zoho 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 + n/s> 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 / Zoho + \ "zoho" + [snip] + Storage> zoho + ** See help for zoho backend at: https://rclone.org/zoho/ ** + + OAuth Client Id + Leave blank normally. + Enter a string value. Press Enter for the default (""). + client_id> + OAuth Client Secret + Leave blank normally. + Enter a string value. Press Enter for the default (""). + client_secret> + Edit advanced config? (y/n) + y) Yes + n) No (default) + 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 (default) + n) No + y/n> + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ + Log in and authorize rclone for access + Waiting for code... + Got code + Choose a number from below, or type in your own value + 1 / MyTeam + \ "4u28602177065ff22426787a6745dba8954eb" + Enter a Team ID> 1 + Choose a number from below, or type in your own value + 1 / General + \ "4u2869d2aa6fca04f4f2f896b6539243b85b1" + Enter a Workspace ID> 1 + -------------------- + [remote] + type = zoho + token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"Zoho-oauthtoken","refresh_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","expiry":"2020-10-12T00:54:52.370275223+02:00"} + root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> + +See the remote setup docs for how to set it up on a machine with no +Internet browser available. + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Zoho Workdrive. 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, + +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 -i /home/local/directory remote:directory + +Zoho paths may be as deep as required, eg remote:directory/subdirectory. + +Modified time + +Modified times are currently not supported for Zoho Workdrive + +Checksums + +No checksums are supported. + +Usage information + +To view your current quota you can use the rclone about remote: command +which will display your current usage. + +Restricted filename characters + +Only control characters and invalid UTF-8 are replaced. In addition most +Unicode full-width characters are not supported at all and will be +removed from filenames during upload. + +Standard Options + +Here are the standard options specific to zoho (Zoho). + +--zoho-region + +Zoho region to connect to. You'll have to use the region you +organization is registered in. + +- Config: region +- Env Var: RCLONE_ZOHO_REGION +- Type: string +- Default: "" +- Examples: + - "com" + - United states / Global + - "eu" + - Europe + - "in" + - India + - "com.au" + - Australia + +Advanced Options + +Here are the advanced options specific to zoho (Zoho). + +--zoho-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_ZOHO_ENCODING +- Type: MultiEncoder +- Default: Del,Ctl,InvalidUtf8 + + Local Filesystem -Local paths are specified as normal filesystem paths, eg +Local paths are specified as normal filesystem paths, e.g. /path/to/wherever, so rclone sync -i /home/source /tmp/destination @@ -24012,14 +27243,14 @@ 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 +old Linux filesystem with non UTF-8 file names (e.g. latin1) then you +can use the convmv tool to convert the filesystem to UTF-8. This tool is available in most distributions' package managers. If an invalid (non-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes. The name gro\xdf will be transferred as gro‛DF. rclone will emit a debug message -in this case (use -v to see), eg +in this case (use -v to see), e.g. Local file system at .: Replacing invalid UTF-8 characters in "gro\xdf" @@ -24252,7 +27483,7 @@ 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. +it isn't supported (e.g. Windows) it will be ignored. Standard Options @@ -24303,6 +27534,25 @@ that they should be skipped. - Type: bool - Default: false +--local-zero-size-links + +Assume the Stat size of links is zero (and read them instead) + +On some virtual filesystems (such ash LucidLink), reading a link size +via a Stat call always returns 0. However, on unix it reads as the +length of the text in the link. This may cause errors like this when +syncing: + + Failed to copy: corrupted on transfer: sizes differ 0 vs 13 + +Setting this flag causes rclone to read the link and use that as the +size of the link instead of 0 which in most cases fixes the problem. + +- Config: zero_size_links +- Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS +- Type: bool +- Default: false + --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) @@ -24324,12 +27574,12 @@ Normally rclone checks the size and modification time of files as they are being uploaded and aborts with a message which starts "can't copy - source file is being updated" if the file changes during upload. -However on some file systems this modification time check may fail (eg +However on some file systems this modification time check may fail (e.g. Glusterfs #2206) so this check can be disabled with this flag. If this flag is set, rclone will use its best efforts to transfer a file which is being updated. If the file is only having things appended to it -(eg a log) then rclone will transfer the log file with the size it had +(e.g. a log) then rclone will transfer the log file with the size it had the first time rclone saw it. If the file is being modified throughout (not just appended to) then the @@ -24457,6 +27707,491 @@ Options: CHANGELOG +v1.54.0 - 2021-02-02 + +See commits + +- New backends + - Compression remote (experimental)(buengese) + - Enterprise File Fabric (Nick Craig-Wood) + - This work was sponsored by Storage Made Easy + - HDFS (Hadoop Distributed File System) (Yury Stankevich) + - Zoho workdrive (buengese) +- New Features + - Deglobalise the config (Nick Craig-Wood) + - Global config now read from the context + - Global config can be passed into the rc + - This work was sponsored by Digitalis + - Add --bwlimit for upload and download (Nick Craig-Wood) + - Obey bwlimit in http Transport for better limiting + - Enhance systemd integration (Hekmon) + - log level identification + - manual activation with flag + - automatic systemd launch detection + - Don't compile systemd log integration for non unix systems + (Benjamin Gustin) + - Add a download flag to hashsum and related commands to force + rclone to download and hash files locally (lostheli) + - build + - Raise minimum go version to go1.12 (Nick Craig-Wood) + - check + - Make the error count match up in the log message (Nick + Craig-Wood) + - cmd + - Add --progress-terminal-title to print ETA to terminal title + (LaSombra) + - Make backend env vars show in help as the defaults for + backend flags (Nick Craig-Wood) + - dedupe + - Add --by-hash to dedupe on hash not file name (Nick + Craig-Wood) + - Add --dedupe-mode list to just list dupes, changing nothing + (Nick Craig-Wood) + - Add warning if used on a remote which can't have duplicate + names (Nick Craig-Wood) + - flags: Improve error message when reading environment vars (Nick + Craig-Wood) + - fs + - Add Shutdown optional method for backends (Nick Craig-Wood) + - When using --files-from check files concurrently (zhucan) + - Accumulate stats when using --dry-run (Ingo Weiss) + - Always show stats when using --dry-run or --interactive + (Nick Craig-Wood) + - Add support for flag --no-console on windows to hide the + console window (albertony) + - genautocomplete: Add support to output to stdout (Ingo) + - ncdu + - Highlight read errors instead of aborting (Claudio + Bantaloukas) + - Add sort by average size in directory (Adam Plánský) + - Add toggle option for average size in directory - key 'a' + (Adam Plánský) + - Add empty folder flag into ncdu browser (Adam Plánský) + - Add ! (errror) and . (unreadable) file flags to go with e + (empty) (Nick Craig-Wood) + - obscure: Make rclone osbcure - ignore newline at end of line + (Nick Craig-Wood) + - operations + - Add logs when need to upload files to set mod times (Nick + Craig-Wood) + - Move and copy log name of the destination object in verbose + (Adam Plánský) + - Add size if known to skipped items and JSON log (Nick + Craig-Wood) + - rc + - Prefer actual listener address if using ":port" or "addr:0" + only (Nick Craig-Wood) + - Add listener for finished jobs (Aleksandar Jankovic) + - serve ftp: Add options to enable TLS (Deepak Sah) + - serve http/webdav: Redirect requests to the base url without the + / (Nick Craig-Wood) + - serve restic: Implement object cache (Nick Craig-Wood) + - stats: Add counter for deleted directories (Nick Craig-Wood) + - sync: Only print "There was nothing to transfer" if no errors + (Nick Craig-Wood) + - webui + - Prompt user for updating webui if an update is available + (Chaitanya Bankanhal) + - Fix plugins initialization (negative0) +- Bug Fixes + - build + - Explicitly set ARM version to fix build (Nick Craig-Wood) + - Don't explicitly set ARM version to fix ARMv5 build (Nick + Craig-Wood) + - Fix nfpm install (Nick Craig-Wood) + - Fix docker build by upgrading ilteoood/docker_buildx (Nick + Craig-Wood) + - Temporary fix for Windows build errors (Ivan Andreev) + - fs + - Fix nil pointer on copy & move operations directly to remote + (Anagh Kumar Baranwal) + - Fix parsing of .. when joining remotes (Nick Craig-Wood) + - log: Fix enabling systemd logging when using --log-file (Nick + Craig-Wood) + - move: Fix data loss when moving the same object (Nick + Craig-Wood) + - operations + - Fix --cutof-mode hard not cutting off immediately (Nick + Craig-Wood) + - Fix --immutable error message (Nick Craig-Wood) + - sync + - Fix --cutoff-mode soft & cautious so it doesn't end the + transfer early (Nick Craig-Wood) + - Fix --immutable errors retrying many times (Nick Craig-Wood) +- Docs + - Many fixes and a rewrite of the filtering docs (edwardxml) + - Many spelling and grammar problems (Josh Soref) + - Doc fixes for commands delete, purge, rmdir, rmdirs and mount + (albertony) + - And thanks to these people for many doc fixes too numerous to + list + - Ameer Dawood, Antoine GIRARD, Bob Bagwill, Christopher + Stewart + - CokeMine, David, Dov Murik, Durval Menezes, Evan Harris, + gtorelly + - Ilyess Bachiri, Janne Johansson, Kerry Su, Marcin Zelent, + - Martin Michlmayr, Milly, Sơn Trần-Nguyễn +- Mount + - Update systemd status with cache stats (Hekmon) + - Disable bazil/fuse based mount on macOS (Nick Craig-Wood) + - Make mount be cmount under macOS (Nick Craig-Wood) + - Implement mknod to make NFS file creation work (Nick Craig-Wood) + - Make sure we don't call umount more than once (Nick Craig-Wood) + - Don't call host.Umount if a signal has been received (Nick + Craig-Wood) + - More user friendly mounting as network drive on windows + (albertony) + - Cleanup OS specific option handling and documentation + (albertony) + - Detect if uid or gid are set in same option string: -o + uid=123,gid=456 (albertony) + - Don't attempt to unmount if fs has been destroyed already (Nick + Craig-Wood) +- VFS + - Fix virtual entries causing deleted files to still appear (Nick + Craig-Wood) + - Fix "file already exists" error for stale cache files (Nick + Craig-Wood) + - Fix file leaks with --vfs-cache-mode full and --buffer-size 0 + (Nick Craig-Wood) + - Fix invalid cache path on windows when using :backend: as remote + (albertony) +- Local + - Continue listing files/folders when a circular symlink is + detected (Manish Gupta) + - New flag --local-zero-size-links to fix sync on some virtual + filesystems (Riccardo Iaconelli) +- Azure Blob + - Add support for service principals (James Lim) + - Utilize streaming capabilities (Denis Neuling) + - Update SDK to v0.13.0 and fix API breakage (Nick Craig-Wood, + Mitsuo Heijo) + - Fix setting of mime types (Nick Craig-Wood) + - Fix crash when listing outside a SAS URL's root (Nick + Craig-Wood) + - Delete archive tier blobs before update if + --azureblob-archive-tier-delete (Nick Craig-Wood) + - Add support for managed identities (Brad Ackerman) + - Fix crash on startup (Nick Craig-Wood) + - Add examples for access tier (Bob Pusateri) + - Fix memory usage by upgrading the SDK and implementing a + TransferManager (Nick Craig-Wood) + - Require go1.14+ to compile due to SDK changes (Nick Craig-Wood) +- B2 + - Make NewObject use less expensive API calls (Nick Craig-Wood) + - Fixed possible crash when accessing Backblaze b2 remote + (lluuaapp) +- Box + - Fix NewObject for files that differ in case (Nick Craig-Wood) + - Fix finding directories in a case insentive way (Nick + Craig-Wood) +- Chunker + - Skip long local hashing, hash in-transit (fixes) (Ivan Andreev) + - Set Features.ReadMimeType=false as Object.MimeType not supported + (Nick Craig-Wood) + - Fix case-insensitive NewObject, test metadata detection (Ivan + Andreev) +- Drive + - Implement "rclone backend copyid" command for copying files by + ID (Nick Craig-Wood) + - Added flag --drive-stop-on-download-limit to stop transfers when + the download limit is exceeded (Anagh Kumar Baranwal) + - Implement CleanUp workaround for team drives (buengese) + - Allow shortcut resolution and creation to be retried (Nick + Craig-Wood) + - Log that emptying the trash can take some time (Nick Craig-Wood) + - Add xdg office icons to xdg desktop files (Pau + Rodriguez-Estivill) +- Dropbox + - Add support for viewing shared files and folders (buengese) + - Implement IDer (buengese) + - Set Features.ReadMimeType=false as Object.MimeType not supported + (Nick Craig-Wood) + - Tidy repeated error message (Nick Craig-Wood) + - Make malformed_path errors from too long files not retriable + (Nick Craig-Wood) + - Test file name length before upload to fix upload loop (Nick + Craig-Wood) + - Enable short lived access tokens (Nick Craig-Wood) +- Fichier + - Set Features.ReadMimeType=true as Object.MimeType is supported + (Nick Craig-Wood) +- FTP + - Add --ftp-disable-msld option to ignore MLSD for really old + servers (Nick Craig-Wood) + - Make --tpslimit apply (Nick Craig-Wood) +- Google Cloud Storage + - Storage class object header support (Laurens Janssen) + - Fix anonymous client to use rclone's HTTP client (Nick + Craig-Wood) + - Fix Entry doesn't belong in directory "" (same as directory) - + ignoring (Nick Craig-Wood) +- Googlephotos + - New flag --gphotos-include-archived (Nicolas Rueff) +- Jottacloud + - Don't erroniously report support for writing mime types + (buengese) + - Add support for Telia Cloud (#4930) (Patrik Nordlén) +- Mailru + - Fix uploads after recent changes on server (Ivan Andreev) + - Fix range requests after June 2020 changes on server (Ivan + Andreev) + - Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) + - Remove deprecated protocol quirks (Ivan Andreev) + - Accept special folders eg camera-upload (Ivan Andreev) + - Avoid prehashing of large local files (Ivan Andreev) +- Memory + - Fix setting of mime types (Nick Craig-Wood) +- Onedrive + - Add support for china region operated by 21vianet and other + regional suppliers (#4963) (NyaMisty) + - Warn on gateway timeout errors (Nick Craig-Wood) + - Fall back to normal copy if server-side copy unavailable (#4903) + (Alex Chen) + - Fix server-side copy completely disabled on OneDrive for + Business (Cnly) + - (business only) workaround to replace existing file on + server-side copy (#4904) (Alex Chen) + - Enhance link creation with expiry, scope, type and password + (Nick Craig-Wood) + - Remove % and # from the set of encoded characters (#4909) (Alex + Chen) + - Support addressing site by server-relative URL (#4761) (kice) +- Opendrive + - Fix finding directories in a case insensitive way (Nick + Craig-Wood) +- Pcloud + - Fix setting of mime types (Nick Craig-Wood) +- Premiumizeme + - Fix finding directories in a case insensitive way (Nick + Craig-Wood) +- Qingstor + - Fix error propagation in CleanUp (Nick Craig-Wood) + - Fix rclone cleanup (Nick Craig-Wood) +- S3 + - Added --s3-disable-http2 to disable http/2 (Anagh Kumar + Baranwal) + - Complete SSE-C implementation (Nick Craig-Wood) + - Fix hashes on small files with AWS:KMS and SSE-C (Nick + Craig-Wood) + - Add MD5 metadata to objects uploaded with SSE-AWS/SSE-C (Nick + Craig-Wood) + - Update docs with a Reducing Costs section (Nick Craig-Wood) + - Added error handling for error code 429 indicating too many + requests (Anagh Kumar Baranwal) + - Add requester pays option (kelv) + - Fix copy multipart with v2 auth failing with + 'SignatureDoesNotMatch' (Louis Koo) + - Add --s3-no-head parameter to minimise transactions on upload + (Nick Craig-Wood) +- SFTP + - Allow cert based auth via optional pubkey (Stephen Harris) + - Allow user to optionally check server hosts key to add security + (Stephen Harris) + - Defer asking for user passwords until the SSH connection + succeeds (Stephen Harris) + - Remember entered password in AskPass mode (Stephen Harris) + - Implement Shutdown method (Nick Craig-Wood) + - Implement keyboard interactive authentication (Nick Craig-Wood) + - Make --tpslimit apply (Nick Craig-Wood) + - Implement --sftp-use-fstat (Nick Craig-Wood) +- Sugarsync + - Fix NewObject for files that differ in case (Nick Craig-Wood) + - Fix finding directories in a case insentive way (Nick + Craig-Wood) +- Swift + - Fix deletion of parts of Static Large Object (SLO) (Nguyễn Hữu + Luân) + - Ensure partially uploaded large files are uploaded unless + --swift-leave-parts-on-error (Nguyễn Hữu Luân) +- Tardigrade + - Upgrade to uplink v1.4.1 (Caleb Case) +- WebDAV + - Updated docs to show streaming to nextcloud is working (Durval + Menezes) +- Yandex + - Set Features.WriteMimeType=false as Yandex ignores mime types + (Nick Craig-Wood) + + +v1.53.4 - 2021-01-20 + +See commits + +- Bug Fixes + - accounting: Fix data race in Transferred() (Maciej Zimnoch) + - build + - Stop tagged releases making a current beta (Nick Craig-Wood) + - Upgrade docker buildx action (Matteo Pietro Dazzi) + - Add -buildmode to cross-compile.go (Nick Craig-Wood) + - Fix docker build by upgrading ilteoood/docker_buildx (Nick + Craig-Wood) + - Revert GitHub actions brew fix since this is now fixed (Nick + Craig-Wood) + - Fix brew install --cask syntax for macOS build (Nick + Craig-Wood) + - Update nfpm syntax to fix build of .deb/.rpm packages (Nick + Craig-Wood) + - Fix for Windows build errors (Ivan Andreev) + - fs: Parseduration: fixed tests to use UTC time (Ankur Gupta) + - fshttp: Prevent overlap of HTTP headers in logs (Nathan Collins) + - rc + - Fix core/command giving 500 internal error (Nick Craig-Wood) + - Add Copy method to rc.Params (Nick Craig-Wood) + - Fix 500 error when marshalling errors from core/command + (Nick Craig-Wood) + - plugins: Create plugins files only if webui is enabled. + (negative0) + - serve http: Fix serving files of unknown length (Nick + Craig-Wood) + - serve sftp: Fix authentication on one connection blocking others + (Nick Craig-Wood) +- Mount + - Add optional brew tag to throw an error when using mount in the + binaries installed via Homebrew (Anagh Kumar Baranwal) + - Add "." and ".." to directories to match cmount and expectations + (Nick Craig-Wood) +- VFS + - Make cache dir absolute before using it to fix path too long + errors (Nick Craig-Wood) +- Chunker + - Improve detection of incompatible metadata (Ivan Andreev) +- Google Cloud Storage + - Fix server side copy of large objects (Nick Craig-Wood) +- Jottacloud + - Fix token renewer to fix long uploads (Nick Craig-Wood) + - Fix token refresh failed: is not a regular file error (Nick + Craig-Wood) +- Pcloud + - Only use SHA1 hashes in EU region (Nick Craig-Wood) +- Sharefile + - Undo Fix backend due to API swapping integers for strings (Nick + Craig-Wood) +- WebDAV + - Fix Open Range requests to fix 4shared mount (Nick Craig-Wood) + - Add "Depth: 0" to GET requests to fix bitrix (Nick Craig-Wood) + + +v1.53.3 - 2020-11-19 + +See commits + +- Bug Fixes + - random: Fix incorrect use of math/rand instead of crypto/rand + CVE-2020-28924 (Nick Craig-Wood) + - Passwords you have generated with rclone config may be + insecure + - See issue #4783 for more details and a checking tool + - random: Seed math/rand in one place with crypto strong seed + (Nick Craig-Wood) +- VFS + - Fix vfs/refresh calls with fs= parameter (Nick Craig-Wood) +- Sharefile + - Fix backend due to API swapping integers for strings (Nick + Craig-Wood) + + +v1.53.2 - 2020-10-26 + +See commits + +- Bug Fixes + - acounting + - Fix incorrect speed and transferTime in core/stats (Nick + Craig-Wood) + - Stabilize display order of transfers on Windows (Nick + Craig-Wood) + - operations + - Fix use of --suffix without --backup-dir (Nick Craig-Wood) + - Fix spurious "--checksum is in use but the source and + destination have no hashes in common" (Nick Craig-Wood) + - build + - Work around GitHub actions brew problem (Nick Craig-Wood) + - Stop using set-env and set-path in the GitHub actions (Nick + Craig-Wood) +- Mount + - mount2: Fix the swapped UID / GID values (Russell Cattelan) +- VFS + - Detect and recover from a file being removed externally from the + cache (Nick Craig-Wood) + - Fix a deadlock vulnerability in downloaders.Close (Leo Luan) + - Fix a race condition in retryFailedResets (Leo Luan) + - Fix missed concurrency control between some item operations and + reset (Leo Luan) + - Add exponential backoff during ENOSPC retries (Leo Luan) + - Add a missed update of used cache space (Leo Luan) + - Fix --no-modtime to not attempt to set modtimes (as documented) + (Nick Craig-Wood) +- Local + - Fix sizes and syncing with --links option on Windows (Nick + Craig-Wood) +- Chunker + - Disable ListR to fix missing files on GDrive (workaround) (Ivan + Andreev) + - Fix upload over crypt (Ivan Andreev) +- Fichier + - Increase maximum file size from 100GB to 300GB (gyutw) +- Jottacloud + - Remove clientSecret from config when upgrading to token based + authentication (buengese) + - Avoid double url escaping of device/mountpoint (albertony) + - Remove DirMove workaround as it's not required anymore - also + (buengese) +- Mailru + - Fix uploads after recent changes on server (Ivan Andreev) + - Fix range requests after june changes on server (Ivan Andreev) + - Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) +- Onedrive + - Fix disk usage for sharepoint (Nick Craig-Wood) +- S3 + - Add missing regions for AWS (Anagh Kumar Baranwal) +- Seafile + - Fix accessing libraries > 2GB on 32 bit systems (Muffin King) +- SFTP + - Always convert the checksum to lower case (buengese) +- Union + - Create root directories if none exist (Nick Craig-Wood) + + +v1.53.1 - 2020-09-13 + +See commits + +- Bug Fixes + - accounting: Remove new line from end of --stats-one-line display + (Nick Craig-Wood) + - check + - Add back missing --download flag (Nick Craig-Wood) + - Fix docs (Nick Craig-Wood) + - docs + - Note --log-file does append (Nick Craig-Wood) + - Add full stops for consistency in rclone --help (edwardxml) + - Add Tencent COS to s3 provider list (wjielai) + - Updated mount command to reflect that it requires Go 1.13 or + newer (Evan Harris) + - jottacloud: Mention that uploads from local disk will not + need to cache files to disk for md5 calculation (albertony) + - Fix formatting of rc docs page (Nick Craig-Wood) + - build + - Include vendor tar ball in release and fix startdev (Nick + Craig-Wood) + - Fix "Illegal instruction" error for ARMv6 builds (Nick + Craig-Wood) + - Fix architecture name in ARMv7 build (Nick Craig-Wood) +- VFS + - Fix spurious error "vfs cache: failed to _ensure cache EOF" + (Nick Craig-Wood) + - Log an ERROR if we fail to set the file to be sparse (Nick + Craig-Wood) +- Local + - Log an ERROR if we fail to set the file to be sparse (Nick + Craig-Wood) +- Drive + - Re-adds special oauth help text (Tim Gallant) +- Opendrive + - Do not retry 400 errors (Evan Harris) + + v1.53.0 - 2020-09-02 See commits @@ -24500,7 +28235,7 @@ See commits (Chaitanya Bankanhal) - Add operations/uploadfile to upload a file through rc using encoding multipart/form-data (Chaitanya Bankanhal) - - Add core/copmmand to execute rclone terminal commands. + - Add core/command to execute rclone terminal commands. (Chaitanya Bankanhal) - rclone check - Add reporting of filenames for same/missing/changed (Nick @@ -24625,7 +28360,7 @@ See commits - Don't compile on < go1.13 after dependency update (Nick Craig-Wood) - B2 - - Implement server side copy for files > 5GB (Nick Craig-Wood) + - Implement server-side copy for files > 5GB (Nick Craig-Wood) - Cancel in progress multipart uploads and copies on rclone exit (Nick Craig-Wood) - Note that b2's encoding now allows  but rclone's hasn't changed @@ -24649,7 +28384,7 @@ See commits McEntire) - Deprecate --drive-alternate-export as it is no longer needed (themylogin) - - Fix duplication of Google docs on server side copy (Nick + - Fix duplication of Google docs on server-side copy (Nick Craig-Wood) - Fix "panic: send on closed channel" when recycling dir entries (Nick Craig-Wood) @@ -24668,7 +28403,7 @@ See commits - Google Cloud Storage - Add support for anonymous access (Kai Lüke) - Jottacloud - - Bring back legacy authentification for use with whitelabel + - Bring back legacy authentication for use with whitelabel versions (buengese) - Switch to new api root - also implement a very ugly workaround for the DirMove failures (buengese) @@ -24731,7 +28466,7 @@ See commits - Bug Fixes - docs - - Disable smart typography (eg en-dash) in MANUAL.* and man + - Disable smart typography (e.g. en-dash) in MANUAL.* and man page (Nick Craig-Wood) - Update install.md to reflect minimum Go version (Evan Harris) @@ -24874,9 +28609,9 @@ See commits (Nick Craig-Wood) - Add --track-renames-strategy for configurable matching criteria for --track-renames (Bernd Schoolmann) - - Add --cutoff-mode hard,soft,catious (Shing Kit Chan & Franklyn + - Add --cutoff-mode hard,soft,cautious (Shing Kit Chan & Franklyn Tackitt) - - Filter flags (eg --files-from -) can read from stdin + - Filter flags (e.g. --files-from -) can read from stdin (fishbullet) - Add --error-on-no-transfer option (Jon Fautley) - Implement --order-by xxx,mixed for copying some small and some @@ -25281,7 +29016,7 @@ v1.51.0 - 2020-02-01 - dedupe: Add missing modes to help string (Nick Craig-Wood) - operations - Fix dedupe continuing on errors like - insufficientFilePermisson (SezalAgrawal) + insufficientFilePersimmon (SezalAgrawal) - Clear accounting before low level retry (Maciej Zimnoch) - Write debug message when hashes could not be checked (Ole Schütt) @@ -25374,7 +29109,7 @@ v1.51.0 - 2020-02-01 Craig-Wood) - Add --s3-copy-cutoff for size to switch to multipart copy (Nick Craig-Wood) - - Add new region Asia Patific (Hong Kong) (Outvi V) + - Add new region Asia Pacific (Hong Kong) (Outvi V) - Reduce memory usage streaming files by reducing max stream upload size (Nick Craig-Wood) - Add --s3-list-chunk option for bucket listing (Thomas @@ -25482,7 +29217,7 @@ v1.50.0 - 2019-10-26 - Fix --files-from without --no-traverse doing a recursive scan (Nick Craig-Wood) - operations - - Fix accounting for server side copies (Nick Craig-Wood) + - 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 @@ -25514,7 +29249,7 @@ v1.50.0 - 2019-10-26 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) + - serve sftp: Fix crash on unsupported operations (e.g. Readlink) (Nick Craig-Wood) - Mount - Allow files of unknown size to be read properly (Nick @@ -25540,7 +29275,7 @@ v1.50.0 - 2019-10-26 - Azure Blob - Disable logging to the Windows event log (Nick Craig-Wood) - B2 - - Remove unverified: prefix on sha1 to improve interop (eg with + - Remove unverified: prefix on sha1 to improve interop (e.g. with CyberDuck) (Nick Craig-Wood) - Box - Add options to get access token via JWT auth (David) @@ -25741,7 +29476,7 @@ v1.49.0 - 2019-08-26 - rcd: Fix permissions problems on cache directory with web gui download (Nick Craig-Wood) - Mount - - Default --deamon-timout to 15 minutes on macOS and FreeBSD (Nick + - Default --daemon-timout to 15 minutes on macOS and FreeBSD (Nick Craig-Wood) - Update docs to show mounting from root OK for bucket based (Nick Craig-Wood) @@ -25764,11 +29499,11 @@ v1.49.0 - 2019-08-26 - Make all operations work from the root (Nick Craig-Wood) - B2 - Implement link sharing (yparitcher) - - Enable server side copy to copy between buckets (Nick + - Enable server-side copy to copy between buckets (Nick Craig-Wood) - Make all operations work from the root (Nick Craig-Wood) - Drive - - Fix server side copy of big files (Nick Craig-Wood) + - Fix server-side copy of big files (Nick Craig-Wood) - Update API for teamdrive use (Nick Craig-Wood) - Add error for purge with --drive-trashed-only (ginvine) - Fichier @@ -25831,7 +29566,7 @@ v1.48.0 - 2019-06-15 portable use (albertony) - Allow sync of a file and a directory with the same name (forgems) - - this is common on bucket based remotes, eg s3, gcs + - this is common on bucket based remotes, e.g. s3, gcs - Add --ignore-case-sync for forced case insensitivity (garry415) - Implement --stats-one-line-date and --stats-one-line-date-format (Peter Berbec) @@ -25899,14 +29634,14 @@ v1.48.0 - 2019-06-15 Craig-Wood) - Implement Optional methods SetTier, GetTier (Nick Craig-Wood) - B2 - - Implement server side copy (Nick Craig-Wood) + - Implement server-side copy (Nick Craig-Wood) - Implement SetModTime (Nick Craig-Wood) - Drive - Fix move and copy from TeamDrive to GDrive (Fionera) - Add notes that cleanup works in the background on drive (Nick Craig-Wood) - Add --drive-server-side-across-configs to default back to old - server side copy semantics by default (Nick Craig-Wood) + server-side copy semantics by default (Nick Craig-Wood) - Add --drive-size-as-quota to show storage quota usage for file size (Garry McNulty) - FTP @@ -25957,7 +29692,7 @@ v1.47.0 - 2019-04-13 is set (Nick Craig-Wood) - this fixes --files-from with Google drive and excessive API use in general. - - Make server side copy account bytes and obey --max-transfer + - Make server-side copy account bytes and obey --max-transfer (Nick Craig-Wood) - Add --create-empty-src-dirs flag and default to not creating empty dirs (ishuah) @@ -25966,7 +29701,7 @@ v1.47.0 - 2019-04-13 - Implement --suffix-keep-extension for use with --suffix (Nick Craig-Wood) - build: - - Switch to semvar compliant version tags to be go modules + - Switch to semver compliant version tags to be go modules compliant (Nick Craig-Wood) - Update to use go1.12.x for the build (Nick Craig-Wood) - serve dlna: Add connection manager service description to @@ -26010,12 +29745,12 @@ v1.47.0 - 2019-04-13 - Drive - Add --skip-checksum-gphotos to ignore incorrect checksums on Google Photos (Nick Craig-Wood) - - Allow server side move/copy between different remotes. (Fionera) + - Allow server-side move/copy between different remotes. (Fionera) - Add docs on team drives and --fast-list eventual consistency (Nestar47) - Fix imports of text files (Nick Craig-Wood) - Fix range requests on 0 length files (Nick Craig-Wood) - - Fix creation of duplicates with server side copy (Nick + - Fix creation of duplicates with server-side copy (Nick Craig-Wood) - Dropbox - Retry blank errors to fix long listings (Nick Craig-Wood) @@ -26135,8 +29870,8 @@ v1.46 - 2019-02-09 (Garry McNulty) - Azure Blob - Allow building azureblob backend on *BSD (themylogin) - - Use the rclone HTTP client to support --dump headers, --tpslimit - etc (Nick Craig-Wood) + - Use the rclone HTTP client to support --dump headers, + --tpslimit, etc. (Nick Craig-Wood) - Use the s3 pacer for 0 delay in non error conditions (Nick Craig-Wood) - Ignore directory markers (Nick Craig-Wood) @@ -26218,7 +29953,7 @@ v1.46 - 2019-02-09 - Add option to force the usage of an ssh-agent (Fabian Möller) - Perform environment variable expansion on key-file (Fabian Möller) - - Fix rmdir on Windows based servers (eg CrushFTP) (Nick + - Fix rmdir on Windows based servers (e.g. CrushFTP) (Nick Craig-Wood) - Fix rmdir deleting directory contents on some SFTP servers (Nick Craig-Wood) @@ -26261,7 +29996,7 @@ v1.45 - 2018-11-24 --rc-no-auth flag - config/* operations to configure rclone - options/* for reading/setting command line flags - - operations/* for all low level operations, eg copy file, + - operations/* for all low level operations, e.g. copy file, list directory - sync/* for sync, copy and move - --rc-files flag to serve files on the rc http server @@ -26315,7 +30050,7 @@ v1.45 - 2018-11-24 - Fix transfer of files with + and & in (Nick Craig-Wood) - Fix retries of upload chunks (Nick Craig-Wood) - S3 - - Set ACL for server side copies to that provided by the user + - Set ACL for server-side copies to that provided by the user (Nick Craig-Wood) - Fix role_arn, credential_source, ... (Erik Swanson) - Add config info for Wasabi's US-West endpoint (Henry Ptasinski) @@ -26371,7 +30106,7 @@ v1.44 - 2018-10-15 - VFS - Fix race condition detected by serve ftp tests (Nick Craig-Wood) - Add vfs/poll-interval rc command (Fabian Möller) - - Enable rename for nearly all remotes using server side Move or + - Enable rename for nearly all remotes using server-side Move or Copy (Nick Craig-Wood) - Reduce directory cache cleared by poll-interval (Fabian Möller) - Remove EXPERIMENTAL tags (Nick Craig-Wood) @@ -26452,7 +30187,7 @@ v1.44 - 2018-10-15 - Union - Implement union backend which reads from multiple backends (Felix Brucker) - - Implement optional interfaces (Move, DirMove, Copy etc) (Nick + - Implement optional interfaces (Move, DirMove, Copy, etc.) (Nick Craig-Wood) - Fix ChangeNotify to support multiple remotes (Fabian Möller) - Fix --backup-dir on union backend (Nick Craig-Wood) @@ -26601,7 +30336,7 @@ v1.43 - 2018-09-01 - Add storage_policy (Ruben Vandamme) - Make it so just storage_url or auth_token can be overridden (Nick Craig-Wood) - - Fix server side copy bug for unusual file names (Nick + - Fix server-side copy bug for unusual file names (Nick Craig-Wood) - Remove leading / from paths (Nick Craig-Wood) - WebDAV @@ -26749,7 +30484,8 @@ v1.41 - 2018-04-28 - rc: fix setting bwlimit to unlimited - rc: take note of the --rc-addr flag too as per the docs - Mount - - Use About to return the correct disk total/used/free (eg in df) + - Use About to return the correct disk total/used/free (e.g. in + df) - Set --attr-timeout default to 1s - fixes: - rclone using too much memory - rclone not serving files to samba @@ -26975,7 +30711,7 @@ v1.40 - 2018-03-19 - Update docs to discourage use of v2 auth with CEPH and others - Don't check for bucket/container presence if listing was OK - this makes rclone do one less request per invocation - - Fix server side copy and set modtime on files with + in + - Fix server-side copy and set modtime on files with + in - SFTP - Add option to disable remote hash check command execution (Jon Fautley) @@ -27038,7 +30774,8 @@ v1.39 - 2017-12-23 oauth config - Warn the user if --include and --exclude are used together (Ernest Borowski) - - Fix duplicate files (eg on Google drive) causing spurious copies + - Fix duplicate files (e.g. on Google drive) causing spurious + copies - Allow trailing and leading whitespace for passwords (Jason Rose) - ncdu: fix crashes on empty directories - rcat: fix goroutine leak @@ -27141,7 +30878,7 @@ v1.38 - 2017-09-30 - Fix "entry doesn't belong in directory" error - Stop using deprecated API methods - Swift - - Fix server side copy to empty container with --fast-list + - Fix server-side copy to empty container with --fast-list - Google Drive - Change the default for --drive-use-trash to true - S3 @@ -27261,7 +30998,7 @@ v1.37 - 2017-07-22 - Google Cloud Storage - Add ability to specify location and storage class via config and command line - thanks gdm85 - - Create container if necessary on server side copy + - Create container if necessary on server-side copy - Increase directory listing chunk to 1000 to increase performance - Obtain a refresh token for GCS - Steven Lu - Yandex @@ -27278,7 +31015,7 @@ v1.37 - 2017-07-22 - Now supports low level retries - S3 - Work around eventual consistency in bucket creation - - Create container if necessary on server side copy + - Create container if necessary on server-side copy - Add us-east-2 (Ohio) and eu-west-2 (London) S3 regions - Zahiar Ahmed - Swift, Hubic @@ -27287,7 +31024,7 @@ v1.37 - 2017-07-22 - this caused lots of duplicate transfers - Fix paged directory listings - this caused duplicate directory errors - - Create container if necessary on server side copy + - Create container if necessary on server-side copy - Increase directory listing chunk to 1000 to increase performance - Make sensible error if the user forgets the container - SFTP @@ -27404,7 +31141,7 @@ v1.35 - 2017-01-02 - Allow repeated --include/--exclude/--filter options - Only show transfer stats on commands which transfer stuff - show stats on any command using the --stats flag - - Allow overlapping directories in move when server side dir move + - Allow overlapping directories in move when server-side dir move is supported - Add --stats-unit option - thanks Scott McGillivray - Bug Fixes @@ -27429,7 +31166,7 @@ v1.35 - 2017-01-02 - Fix failed to authenticate decrypted block errors - these will now return the underlying unexpected EOF instead - Amazon Drive - - Add support for server side move and directory move - thanks + - Add support for server-side move and directory move - thanks Stefan Breunig - Fix nil pointer deref on size attribute - B2 @@ -27540,7 +31277,7 @@ v1.33 - 2016-08-24 - New B2 API endpoint (thanks Per Cederberg) - Set maximum backoff to 5 Minutes - onedrive - - Fix URL escaping in file names - eg uploading files with + in + - Fix URL escaping in file names - e.g. uploading files with + in them. - amazon cloud drive - Fix token expiry during large uploads @@ -27594,7 +31331,7 @@ v1.31 - 2016-07-13 - Backblaze B2 - Add --b2-versions flag so old versions can be listed and retrieved. - - Treat 403 errors (eg cap exceeded) as fatal. + - Treat 403 errors (e.g. cap exceeded) as fatal. - Implement cleanup command for deleting old file versions. - Make error handling compliant with B2 integrations notes. - Fix handling of token expiry. @@ -27619,8 +31356,8 @@ v1.30 - 2016-06-18 - Log -v output to stdout by default - Display the transfer stats in more human readable form - Make 0 size files specifiable with --max-size 0b - - Add b suffix so we can specify bytes in --bwlimit, --min-size - etc + - Add b suffix so we can specify bytes in --bwlimit, --min-size, + etc. - Use "password:" instead of "password>" prompt - thanks Klaus Post and Leigh Klotz - Bug Fixes @@ -27785,7 +31522,7 @@ v1.26 - 2016-01-02 - Swift - Fix sync for chunked files - OneDrive - - Re-enable server side copy + - Re-enable server-side copy - Don't mask HTTP error codes with JSON decode error - S3 - Fix corrupting Content-Type on mod time update (thanks Joseph @@ -27801,11 +31538,11 @@ v1.25 - 2015-11-14 - This could have deleted files unexpectedly on sync - Always check first with --dry-run! - Swift - - Stop SetModTime losing metadata (eg X-Object-Manifest) + - Stop SetModTime losing metadata (e.g. X-Object-Manifest) - This could have caused data loss for files > 5GB in size - Use ContentType from Object to avoid lookups in listings - OneDrive - - disable server side copy as it seems to be broken at Microsoft + - disable server-side copy as it seems to be broken at Microsoft v1.24 - 2015-11-07 @@ -27878,7 +31615,7 @@ v1.20 - 2015-09-15 the oauth token - Implement --dump-headers and --dump-bodies debug flags - Show multiple matched commands if abbreviation too short - - Implement server side move where possible + - Implement server-side move where possible - local - Always use UNC paths internally on Windows - fixes a lot of bugs - dropbox @@ -27890,7 +31627,7 @@ v1.19 - 2015-08-28 - New features - Server side copies for s3/swift/drive/dropbox/gcs - - Move command - uses server side copies if it can + - Move command - uses server-side copies if it can - Implement --retries flag - tries 3 times by default - Build for plan9/amd64 and solaris/amd64 too - Fixes @@ -27993,8 +31730,8 @@ v1.10 - 2015-02-12 v1.09 - 2015-02-07 -- windows: Stop drive letters (eg C:) getting mixed up with remotes - (eg drive:) +- windows: Stop drive letters (e.g. C:) getting mixed up with remotes + (e.g. drive:) - local: Fix directory separators on Windows - drive: fix rate limit exceeded errors @@ -28175,8 +31912,8 @@ Frequently Asked Questions Do all cloud storage systems support all rclone commands -Yes they do. All the rclone commands (eg sync, copy etc) will work on -all the remote storage systems. +Yes they do. All the rclone commands (e.g. sync, copy, etc.) will work +on all the remote storage systems. Can I copy the config from one machine to another @@ -28205,28 +31942,29 @@ Eg Using rclone from multiple locations at the same time You can use rclone from multiple places at the same time if you choose -different subdirectory for the output, eg +different subdirectory for the output, e.g. Server A> rclone sync -i /tmp/whatever remote:ServerA Server B> rclone sync -i /tmp/whatever remote:ServerB If you sync to the same directory then you should use rclone copy -otherwise the two instances of rclone may delete each other's files, eg +otherwise the two instances of rclone may delete each other's files, +e.g. Server A> rclone copy /tmp/whatever remote:Backup Server B> rclone copy /tmp/whatever remote:Backup The file names you upload from Server A and Server B should be different -in this case, otherwise some file systems (eg Drive) may make +in this case, otherwise some file systems (e.g. Drive) may make duplicates. Why doesn't rclone support partial transfers / binary diffs like rsync? Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you upload -as expected using alternative access methods (eg using the Google Drive -web interface). There is a 1:1 mapping between files on your hard disk -and objects created in the cloud storage system. +as expected using alternative access methods (e.g. using the Google +Drive web interface). There is a 1:1 mapping between files on your hard +disk and objects created in the cloud storage system. Cloud storage systems (at least none I've come across yet) don't support partially uploading an object. You can't take an existing object, and @@ -28284,7 +32022,7 @@ Note that the ftp backend does not support ftp_proxy yet. Rclone gives x509: failed to load system roots and no roots provided error -This means that rclone can't file the SSL root certificates. Likely you +This means that rclone can't find the SSL root certificates. Likely you are running rclone on a NAS with a cut-down Linux OS, or possibly on Solaris. @@ -28580,7 +32318,7 @@ email addresses removed from here need to be addeed to bin/.ignore-emails to mak - Andres Alvarez 1671935+kir4h@users.noreply.github.com - reddi1 xreddi@gmail.com - Matt Tucker matthewtckr@gmail.com -- Sebastian Bünger buengese@gmail.com +- Sebastian Bünger buengese@gmail.com buengese@protonmail.com - Martin Polden mpolden@mpolden.no - Alex Chen Cnly@users.noreply.github.com - Denis deniskovpen@gmail.com @@ -28807,6 +32545,54 @@ email addresses removed from here need to be addeed to bin/.ignore-emails to mak - Lucas Kanashiro lucas.kanashiro@canonical.com - WarpedPixel WarpedPixel@users.noreply.github.com - Sam Edwards sam@samedwards.ca +- wjielai gouki0123@gmail.com +- Muffin King jinxz_k@live.com +- Christopher Stewart 6573710+1f47a@users.noreply.github.com +- Russell Cattelan cattelan@digitalelves.com +- gyutw 30371241+gyutw@users.noreply.github.com +- Hekmon edouardhur@gmail.com +- LaSombra lasombra@users.noreply.github.com +- Dov Murik dov.murik@gmail.com +- Ameer Dawood ameer1234567890@gmail.com +- Dan Hipschman dan.hipschman@opendoor.com +- Josh Soref jsoref@users.noreply.github.com +- David david@staron.nl +- Ingo ingo@hoffmann.cx +- Adam Plánský adamplansky@users.noreply.github.com + adamplansky@gmail.com +- Manish Gupta manishgupta.ait@gmail.com +- Deepak Sah sah.sslpu@gmail.com +- Marcin Zelent marcin@zelent.net +- zhucan zhucan.k8s@gmail.com +- James Lim james.lim@samsara.com +- Laurens Janssen BD69BM@insim.biz +- Bob Bagwill bobbagwill@gmail.com +- Nathan Collins colli372@msu.edu +- lostheli +- kelv kelvin@acks.org +- Milly milly.ca@gmail.com +- gtorelly gtorelly@gmail.com +- Brad Ackerman brad@facefault.org +- Mitsuo Heijo mitsuo.heijo@gmail.com +- Claudio Bantaloukas rockdreamer@gmail.com +- Benjamin Gustin gustin.ben@gmail.com +- Ingo Weiss ingo@redhat.com +- Kerry Su me@sshockwave.net +- Ilyess Bachiri ilyess.bachiri@sonder.com +- Yury Stankevich urykhy@gmail.com +- kice wslikerqs@gmail.com +- Denis Neuling denisneuling@gmail.com +- Janne Johansson icepic.dz@gmail.com +- Patrik Nordlén patriki@gmail.com +- CokeMine aptx4561@gmail.com +- Sơn Trần-Nguyễn github@sntran.com +- lluuaapp 266615+lluuaapp@users.noreply.github.com +- Zach Kipp kipp.zach@gmail.com +- Riccardo Iaconelli riccardo@kde.org +- Sakuragawa Misty gyc990326@gmail.com +- Nicolas Rueff nicolas@rueff.fr +- Pau Rodriguez-Estivill prodrigestivill@gmail.com +- Bob Pusateri BobPusateri@users.noreply.github.com diff --git a/docs/content/azureblob.md b/docs/content/azureblob.md index be66bd28c..8158383ff 100644 --- a/docs/content/azureblob.md +++ b/docs/content/azureblob.md @@ -160,6 +160,26 @@ Storage Account Name (leave blank to use SAS URL or Emulator) - Type: string - Default: "" +#### --azureblob-service-principal-file + +Path to file containing credentials for use with a service principal. + +Leave blank normally. Needed only if you want to use a service principal instead of interactive login. + + $ az sp create-for-rbac --name "" \ + --role "Storage Blob Data Owner" \ + --scopes "/subscriptions//resourceGroups//providers/Microsoft.Storage/storageAccounts//blobServices/default/containers/" \ + > azure-principal.json + +See [Use Azure CLI to assign an Azure role for access to blob and queue data](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) +for more details. + + +- Config: service_principal_file +- Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE +- Type: string +- Default: "" + #### --azureblob-key Storage Account Key (leave blank to use SAS URL or Emulator) @@ -179,6 +199,24 @@ SAS URL for container level access only - Type: string - Default: "" +#### --azureblob-use-msi + +Use a managed service identity to authenticate (only works in Azure) + +When true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) +to authenticate to Azure Storage instead of a SAS token or account key. + +If the VM(SS) on which this program is running has a system-assigned identity, it will +be used by default. If the resource has no system-assigned but exactly one user-assigned identity, +the user-assigned identity will be used by default. If the resource has multiple user-assigned +identities, the identity to use must be explicitly specified using exactly one of the msi_object_id, +msi_client_id, or msi_mi_res_id parameters. + +- Config: use_msi +- Env Var: RCLONE_AZUREBLOB_USE_MSI +- Type: bool +- Default: false + #### --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) @@ -192,6 +230,33 @@ Uses local storage emulator if provided as 'true' (leave blank if using real azu Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage). +#### --azureblob-msi-object-id + +Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified. + +- Config: msi_object_id +- Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID +- Type: string +- Default: "" + +#### --azureblob-msi-client-id + +Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified. + +- Config: msi_client_id +- Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID +- Type: string +- Default: "" + +#### --azureblob-msi-mi-res-id + +Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified. + +- Config: msi_mi_res_id +- Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID +- Type: string +- Default: "" + #### --azureblob-endpoint Endpoint for the service @@ -202,6 +267,15 @@ Leave blank normally. - Type: string - Default: "" +#### --azureblob-upload-cutoff + +Cutoff for switching to chunked upload (<= 256MB). (Deprecated) + +- Config: upload_cutoff +- Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF +- Type: string +- Default: "" + #### --azureblob-chunk-size Upload chunk size (<= 100MB). @@ -250,10 +324,28 @@ tiering blob to "Hot" or "Cool". - Env Var: RCLONE_AZUREBLOB_ACCESS_TIER - Type: string - Default: "" -- Examples: - - "Hot" - - "Cool" - - "Archive" + +#### --azureblob-archive-tier-delete + +Delete archive tier blobs before overwriting. + +Archive tier blobs cannot be updated. So without this flag, if you +attempt to update an archive tier blob, then rclone will produce the +error: + + can't update archive tier blob without --azureblob-archive-tier-delete + +With this flag set then before rclone attempts to overwrite an archive +tier blob, it will delete the existing blob before uploading its +replacement. This has the potential for data loss if the upload fails +(unlike updating a normal blob) and also may cost more since deleting +archive tier blobs early may be chargable. + + +- Config: archive_tier_delete +- Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE +- Type: bool +- Default: false #### --azureblob-disable-checksum diff --git a/docs/content/b2.md b/docs/content/b2.md index 3d6703f72..427935b1e 100644 --- a/docs/content/b2.md +++ b/docs/content/b2.md @@ -461,7 +461,9 @@ 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. +Rclone works with private buckets by sending an "Authorization" header. +If the custom endpoint rewrites the requests for authentication, +e.g., in Cloudflare Workers, this header needs to be handled properly. Leave blank if you want to use the endpoint provided by Backblaze. - Config: download_url diff --git a/docs/content/changelog.md b/docs/content/changelog.md index 28bd4f3bf..7ac12208b 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -5,6 +5,213 @@ description: "Rclone Changelog" # Changelog +## v1.54.0 - 2021-02-02 + +[See commits](https://github.com/rclone/rclone/compare/v1.53.0...v1.54.0) + +* New backends + * Compression remote (experimental) (buengese) + * Enterprise File Fabric (Nick Craig-Wood) + * This work was sponsored by [Storage Made Easy](https://storagemadeeasy.com/) + * HDFS (Hadoop Distributed File System) (Yury Stankevich) + * Zoho workdrive (buengese) +* New Features + * Deglobalise the config (Nick Craig-Wood) + * Global config now read from the context + * This will enable passing of global config via the rc + * This work was sponsored by [Digitalis](digitalis.io) + * Add `--bwlimit` for upload and download (Nick Craig-Wood) + * Obey bwlimit in http Transport for better limiting + * Enhance systemd integration (Hekmon) + * log level identification, manual activation with flag, automatic systemd launch detection + * Don't compile systemd log integration for non unix systems (Benjamin Gustin) + * Add a `--download` flag to md5sum/sha1sum/hashsum to force rclone to download and hash files locally (lostheli) + * Add `--progress-terminal-title` to print ETA to terminal title (LaSombra) + * Make backend env vars show in help as the defaults for backend flags (Nick Craig-Wood) + * build + * Raise minimum go version to go1.12 (Nick Craig-Wood) + * dedupe + * Add `--by-hash` to dedupe on content hash not file name (Nick Craig-Wood) + * Add `--dedupe-mode list` to just list dupes, changing nothing (Nick Craig-Wood) + * Add warning if used on a remote which can't have duplicate names (Nick Craig-Wood) + * fs + * Add Shutdown optional method for backends (Nick Craig-Wood) + * When using `--files-from` check files concurrently (zhucan) + * Accumulate stats when using `--dry-run` (Ingo Weiss) + * Always show stats when using `--dry-run` or `--interactive` (Nick Craig-Wood) + * Add support for flag `--no-console` on windows to hide the console window (albertony) + * genautocomplete: Add support to output to stdout (Ingo) + * ncdu + * Highlight read errors instead of aborting (Claudio Bantaloukas) + * Add sort by average size in directory (Adam Plánský) + * Add toggle option for average s3ize in directory - key 'a' (Adam Plánský) + * Add empty folder flag into ncdu browser (Adam Plánský) + * Add `!` (errror) and `.` (unreadable) file flags to go with `e` (empty) (Nick Craig-Wood) + * obscure: Make `rclone osbcure -` ignore newline at end of line (Nick Craig-Wood) + * operations + * Add logs when need to upload files to set mod times (Nick Craig-Wood) + * Move and copy log name of the destination object in verbose (Adam Plánský) + * Add size if known to skipped items and JSON log (Nick Craig-Wood) + * rc + * Prefer actual listener address if using ":port" or "addr:0" only (Nick Craig-Wood) + * Add listener for finished jobs (Aleksandar Jankovic) + * serve ftp: Add options to enable TLS (Deepak Sah) + * serve http/webdav: Redirect requests to the base url without the / (Nick Craig-Wood) + * serve restic: Implement object cache (Nick Craig-Wood) + * stats: Add counter for deleted directories (Nick Craig-Wood) + * sync: Only print "There was nothing to transfer" if no errors (Nick Craig-Wood) + * webui + * Prompt user for updating webui if an update is available (Chaitanya Bankanhal) + * Fix plugins initialization (negative0) +* Bug Fixes + * fs + * Fix nil pointer on copy & move operations directly to remote (Anagh Kumar Baranwal) + * Fix parsing of .. when joining remotes (Nick Craig-Wood) + * log: Fix enabling systemd logging when using `--log-file` (Nick Craig-Wood) + * check + * Make the error count match up in the log message (Nick Craig-Wood) + * move: Fix data loss when source and destination are the same object (Nick Craig-Wood) + * operations + * Fix `--cutof-mode` hard not cutting off immediately (Nick Craig-Wood) + * Fix `--immutable` error message (Nick Craig-Wood) + * sync + * Fix `--cutoff-mode` soft & cautious so it doesn't end the transfer early (Nick Craig-Wood) + * Fix `--immutable` errors retrying many times (Nick Craig-Wood) +* Docs + * Many fixes and a rewrite of the filtering docs (edwardxml) + * Many spelling and grammar fixes (Josh Soref) + * Doc fixes for commands delete, purge, rmdir, rmdirs and mount (albertony) + * And thanks to these people for many doc fixes too numerous to list + * Ameer Dawood, Antoine GIRARD, Bob Bagwill, Christopher Stewart + * CokeMine, David, Dov Murik, Durval Menezes, Evan Harris, gtorelly + * Ilyess Bachiri, Janne Johansson, Kerry Su, Marcin Zelent, + * Martin Michlmayr, Milly, Sơn Trần-Nguyễn +* Mount + * Update systemd status with cache stats (Hekmon) + * Disable bazil/fuse based mount on macOS (Nick Craig-Wood) + * Make `rclone mount` actually run `rclone cmount` under macOS (Nick Craig-Wood) + * Implement mknod to make NFS file creation work (Nick Craig-Wood) + * Make sure we don't call umount more than once (Nick Craig-Wood) + * More user friendly mounting as network drive on windows (albertony) + * Detect if uid or gid are set in same option string: -o uid=123,gid=456 (albertony) + * Don't attempt to unmount if fs has been destroyed already (Nick Craig-Wood) +* VFS + * Fix virtual entries causing deleted files to still appear (Nick Craig-Wood) + * Fix "file already exists" error for stale cache files (Nick Craig-Wood) + * Fix file leaks with `--vfs-cache-mode` full and `--buffer-size 0` (Nick Craig-Wood) + * Fix invalid cache path on windows when using :backend: as remote (albertony) +* Local + * Continue listing files/folders when a circular symlink is detected (Manish Gupta) + * New flag `--local-zero-size-links` to fix sync on some virtual filesystems (Riccardo Iaconelli) +* Azure Blob + * Add support for service principals (James Lim) + * Add support for managed identities (Brad Ackerman) + * Add examples for access tier (Bob Pusateri) + * Utilize the streaming capabilities from the SDK for multipart uploads (Denis Neuling) + * Fix setting of mime types (Nick Craig-Wood) + * Fix crash when listing outside a SAS URL's root (Nick Craig-Wood) + * Delete archive tier blobs before update if `--azureblob-archive-tier-delete` (Nick Craig-Wood) + * Fix crash on startup (Nick Craig-Wood) + * Fix memory usage by upgrading the SDK to v0.13.0 and implementing a TransferManager (Nick Craig-Wood) + * Require go1.14+ to compile due to SDK changes (Nick Craig-Wood) +* B2 + * Make NewObject use less expensive API calls (Nick Craig-Wood) + * This will improve `--files-from` and `restic serve` in particular + * Fixed crash on an empty file name (lluuaapp) +* Box + * Fix NewObject for files that differ in case (Nick Craig-Wood) + * Fix finding directories in a case insentive way (Nick Craig-Wood) +* Chunker + * Skip long local hashing, hash in-transit (fixes) (Ivan Andreev) + * Set Features ReadMimeType to false as Object.MimeType not supported (Nick Craig-Wood) + * Fix case-insensitive NewObject, test metadata detection (Ivan Andreev) +* Drive + * Implement `rclone backend copyid` command for copying files by ID (Nick Craig-Wood) + * Added flag `--drive-stop-on-download-limit` to stop transfers when the download limit is exceeded (Anagh Kumar Baranwal) + * Implement CleanUp workaround for team drives (buengese) + * Allow shortcut resolution and creation to be retried (Nick Craig-Wood) + * Log that emptying the trash can take some time (Nick Craig-Wood) + * Add xdg office icons to xdg desktop files (Pau Rodriguez-Estivill) +* Dropbox + * Add support for viewing shared files and folders (buengese) + * Enable short lived access tokens (Nick Craig-Wood) + * Implement IDer on Objects so `rclone lsf` etc can read the IDs (buengese) + * Set Features ReadMimeType to false as Object.MimeType not supported (Nick Craig-Wood) + * Make malformed_path errors from too long files not retriable (Nick Craig-Wood) + * Test file name length before upload to fix upload loop (Nick Craig-Wood) +* Fichier + * Set Features ReadMimeType to true as Object.MimeType is supported (Nick Craig-Wood) +* FTP + * Add `--ftp-disable-msld` option to ignore MLSD for really old servers (Nick Craig-Wood) + * Make `--tpslimit apply` (Nick Craig-Wood) +* Google Cloud Storage + * Storage class object header support (Laurens Janssen) + * Fix anonymous client to use rclone's HTTP client (Nick Craig-Wood) + * Fix `Entry doesn't belong in directory "" (same as directory) - ignoring` (Nick Craig-Wood) +* Googlephotos + * New flag `--gphotos-include-archived` to show archived photos as well (Nicolas Rueff) +* Jottacloud + * Don't erroneously report support for writing mime types (buengese) + * Add support for Telia Cloud (Patrik Nordlén) +* Mailru + * Accept special folders eg camera-upload (Ivan Andreev) + * Avoid prehashing of large local files (Ivan Andreev) + * Fix uploads after recent changes on server (Ivan Andreev) + * Fix range requests after June 2020 changes on server (Ivan Andreev) + * Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) + * Remove deprecated protocol quirks (Ivan Andreev) +* Memory + * Fix setting of mime types (Nick Craig-Wood) +* Onedrive + * Add support for China region operated by 21vianet and other regional suppliers (NyaMisty) + * Warn on gateway timeout errors (Nick Craig-Wood) + * Fall back to normal copy if server-side copy unavailable (Alex Chen) + * Fix server-side copy completely disabled on OneDrive for Business (Cnly) + * (business only) workaround to replace existing file on server-side copy (Alex Chen) + * Enhance link creation with expiry, scope, type and password (Nick Craig-Wood) + * Remove % and # from the set of encoded characters (Alex Chen) + * Support addressing site by server-relative URL (kice) +* Opendrive + * Fix finding directories in a case insensitive way (Nick Craig-Wood) +* Pcloud + * Fix setting of mime types (Nick Craig-Wood) +* Premiumizeme + * Fix finding directories in a case insensitive way (Nick Craig-Wood) +* Qingstor + * Fix error propagation in CleanUp (Nick Craig-Wood) + * Fix rclone cleanup (Nick Craig-Wood) +* S3 + * Added `--s3-disable-http2` to disable http/2 (Anagh Kumar Baranwal) + * Complete SSE-C implementation (Nick Craig-Wood) + * Fix hashes on small files with AWS:KMS and SSE-C (Nick Craig-Wood) + * Add MD5 metadata to objects uploaded with SSE-AWS/SSE-C (Nick Craig-Wood) + * Add `--s3-no-head parameter` to minimise transactions on upload (Nick Craig-Wood) + * Update docs with a Reducing Costs section (Nick Craig-Wood) + * Added error handling for error code 429 indicating too many requests (Anagh Kumar Baranwal) + * Add requester pays option (kelv) + * Fix copy multipart with v2 auth failing with 'SignatureDoesNotMatch' (Louis Koo) +* SFTP + * Allow cert based auth via optional pubkey (Stephen Harris) + * Allow user to optionally check server hosts key to add security (Stephen Harris) + * Defer asking for user passwords until the SSH connection succeeds (Stephen Harris) + * Remember entered password in AskPass mode (Stephen Harris) + * Implement Shutdown method (Nick Craig-Wood) + * Implement keyboard interactive authentication (Nick Craig-Wood) + * Make `--tpslimit` apply (Nick Craig-Wood) + * Implement `--sftp-use-fstat` for unusual SFTP servers (Nick Craig-Wood) +* Sugarsync + * Fix NewObject for files that differ in case (Nick Craig-Wood) + * Fix finding directories in a case insentive way (Nick Craig-Wood) +* Swift + * Fix deletion of parts of Static Large Object (SLO) (Nguyễn Hữu Luân) + * Ensure partially uploaded large files are uploaded unless `--swift-leave-parts-on-error` (Nguyễn Hữu Luân) +* Tardigrade + * Upgrade to uplink v1.4.1 (Caleb Case) +* WebDAV + * Updated docs to show streaming to nextcloud is working (Durval Menezes) +* Yandex + * Set Features WriteMimeType to false as Yandex ignores mime types (Nick Craig-Wood) + ## v1.53.4 - 2021-01-20 [See commits](https://github.com/rclone/rclone/compare/v1.53.3...v1.53.4) diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index 2025bbeb0..a59739f60 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -39,15 +39,15 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone backend](/commands/rclone_backend/) - Run a backend specific command. * [rclone cat](/commands/rclone_cat/) - Concatenates any files and sends them to stdout. * [rclone check](/commands/rclone_check/) - Checks the files in the source and destination match. -* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible +* [rclone cleanup](/commands/rclone_cleanup/) - Clean up the remote if possible. * [rclone config](/commands/rclone_config/) - Enter an interactive configuration session. -* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied -* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied +* [rclone copy](/commands/rclone_copy/) - Copy files from source to dest, skipping already copied. +* [rclone copyto](/commands/rclone_copyto/) - Copy files from source to dest, skipping already copied. * [rclone copyurl](/commands/rclone_copyurl/) - Copy url content to dest. * [rclone cryptcheck](/commands/rclone_cryptcheck/) - Cryptcheck checks the integrity of a crypted remote. * [rclone cryptdecode](/commands/rclone_cryptdecode/) - Cryptdecode returns unencrypted file names. * [rclone dedupe](/commands/rclone_dedupe/) - Interactively find duplicate filenames and delete/rename them. -* [rclone delete](/commands/rclone_delete/) - Remove the contents of path. +* [rclone delete](/commands/rclone_delete/) - Remove the files in path. * [rclone deletefile](/commands/rclone_deletefile/) - Remove a single file from remote. * [rclone genautocomplete](/commands/rclone_genautocomplete/) - Output completion script for a given shell. * [rclone gendocs](/commands/rclone_gendocs/) - Output markdown docs for rclone to the directory supplied. @@ -56,7 +56,7 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone listremotes](/commands/rclone_listremotes/) - List all the remotes in the config file. * [rclone ls](/commands/rclone_ls/) - List the objects in the path with size and path. * [rclone lsd](/commands/rclone_lsd/) - List all directories/containers/buckets in the path. -* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing +* [rclone lsf](/commands/rclone_lsf/) - List directories and objects in remote:path formatted for parsing. * [rclone lsjson](/commands/rclone_lsjson/) - List directories and objects in the path in JSON format. * [rclone lsl](/commands/rclone_lsl/) - List the objects in path with modification time, size and path. * [rclone md5sum](/commands/rclone_md5sum/) - Produces an md5sum file for all the objects in the path. @@ -65,12 +65,12 @@ See the [global flags page](/flags/) for global options not listed here. * [rclone move](/commands/rclone_move/) - Move files from source to dest. * [rclone moveto](/commands/rclone_moveto/) - Move file or directory from source to dest. * [rclone ncdu](/commands/rclone_ncdu/) - Explore a remote with a text based user interface. -* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file +* [rclone obscure](/commands/rclone_obscure/) - Obscure password for use in the rclone config file. * [rclone purge](/commands/rclone_purge/) - Remove the path and all of its contents. * [rclone rc](/commands/rclone_rc/) - Run a command against a running rclone. * [rclone rcat](/commands/rclone_rcat/) - Copies standard input to file on remote. * [rclone rcd](/commands/rclone_rcd/) - Run rclone listening to remote control commands only. -* [rclone rmdir](/commands/rclone_rmdir/) - Remove the path if empty. +* [rclone rmdir](/commands/rclone_rmdir/) - Remove the empty directory at path. * [rclone rmdirs](/commands/rclone_rmdirs/) - Remove empty directories under the path. * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol. * [rclone settier](/commands/rclone_settier/) - Changes storage class/tier of objects in remote. diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md index 6af9c129e..a0c21bfae 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -12,10 +12,10 @@ Get quota information from the remote. ## Synopsis -Get quota information from the remote, like bytes used/free/quota and bytes -used in the trash. Not supported by all remotes. +`rclone about`prints quota information about a remote to standard +output. The output is typically used, free, quota and trash contents. -This will print to stdout something like this: +E.g. Typical output from`rclone about remote:`is: Total: 17G Used: 7.444G @@ -27,16 +27,15 @@ Where the fields are: * Total: total size available. * Used: total size used - * Free: total amount this user could upload. - * Trashed: total amount in the trash - * Other: total amount in other storage (eg Gmail, Google Photos) + * Free: total space available to this user. + * Trashed: total space used by trash + * Other: total amount in other storage (e.g. Gmail, Google Photos) * Objects: total number of objects in the storage -Note that not all the backends provide all the fields - they will be -missing if they are not known for that backend. Where it is known -that the value is unlimited the value will also be omitted. +Not all backends print all fields. Information is not included if it is not +provided by a backend. Where the value is unlimited it is omitted. -Use the --full flag to see the numbers written out in full, eg +Applying a `--full` flag to the command prints the bytes in full, e.g. Total: 18253611008 Used: 7993453766 @@ -44,7 +43,7 @@ Use the --full flag to see the numbers written out in full, eg Trashed: 104857602 Other: 8849156022 -Use the --json flag for a computer readable output, eg +A `--json`flag generates conveniently computer readable output, e.g. { "total": 18253611008, @@ -54,6 +53,10 @@ Use the --json flag for a computer readable output, eg "free": 1411001220 } +Not all backends support the `rclone about` command. + +See [List of backends that do not support about](https://rclone.org/overview/#optional-features) + ``` rclone about remote: [flags] diff --git a/docs/content/commands/rclone_backend.md b/docs/content/commands/rclone_backend.md index 6ffaf30c6..a617aa908 100644 --- a/docs/content/commands/rclone_backend.md +++ b/docs/content/commands/rclone_backend.md @@ -27,7 +27,7 @@ for more info). rclone backend features remote: -Pass options to the backend command with -o. This should be key=value or key, eg: +Pass options to the backend command with -o. This should be key=value or key, e.g.: rclone backend stats remote:path stats -o format=json -o long diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index dd7913891..ee75c60f4 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -26,10 +26,10 @@ Or like this to output any .txt files in dir or its subdirectories. rclone --include "*.txt" cat remote:path/to/dir -Use the --head flag to print characters only at the start, --tail for -the end and --offset and --count to print a section in the middle. +Use the `--head` flag to print characters only at the start, `--tail` for +the end and `--offset` and `--count` to print a section in the middle. Note that if offset is negative it will count from the end, so ---offset -1 --count 1 is equivalent to --tail 1. +`--offset -1 --count 1` is equivalent to `--tail 1`. ``` diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index c91d5c196..8eb16c4b4 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -16,10 +16,10 @@ Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don't match. It doesn't alter the source or destination. -If you supply the --size-only flag, it will only compare the sizes not +If you supply the `--size-only` flag, it will only compare the sizes not the hashes as well. Use this for a quick check. -If you supply the --download flag, it will download the data from +If you supply the `--download` flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data. @@ -29,7 +29,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are @@ -55,6 +55,7 @@ rclone check source:path dest:path [flags] ``` --combined string Make a combined report of changes to this file --differ string Report all non-matching files to this file + --download Check by downloading rather than with hash. --error string Report all files with errors (hashing or reading) to this file -h, --help help for check --match string Report all matching files to this file diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index 0e8dcf58b..680b4f981 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,13 +1,13 @@ --- title: "rclone cleanup" -description: "Clean up the remote if possible" +description: "Clean up the remote if possible." slug: rclone_cleanup url: /commands/rclone_cleanup/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/cleanup/ and as part of making a release run "make commanddocs" --- # rclone cleanup -Clean up the remote if possible +Clean up the remote if possible. ## Synopsis diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md index 8f3157901..20812bbad 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -34,7 +34,7 @@ whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use -"--no-obscure". You can also set osbscured passwords using the +"--no-obscure". You can also set obscured passwords using the "rclone config password" command. So for example if you wanted to configure a Google Drive remote but diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md index df0e3dcf2..380daf80b 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -9,10 +9,6 @@ url: /commands/rclone_config_delete/ Delete an existing remote `name`. -## Synopsis - -Delete an existing remote `name`. - ``` rclone config delete `name` [flags] ``` diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md index 770e8f137..5f471c40b 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -9,10 +9,6 @@ url: /commands/rclone_config_dump/ Dump the config file as JSON. -## Synopsis - -Dump the config file as JSON. - ``` rclone config dump [flags] ``` diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md index 54fc88f73..0b289a4e5 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -9,10 +9,6 @@ url: /commands/rclone_config_file/ Show path of configuration file in use. -## Synopsis - -Show path of configuration file in use. - ``` rclone config file [flags] ``` diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md index c6c7aef59..ed89ea5fe 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -9,10 +9,6 @@ url: /commands/rclone_config_providers/ List in JSON format all the providers and options. -## Synopsis - -List in JSON format all the providers and options. - ``` rclone config providers [flags] ``` diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md index 9bcb867ec..97b818f36 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -9,10 +9,6 @@ url: /commands/rclone_config_show/ Print (decrypted) config file, or the config for a single remote. -## Synopsis - -Print (decrypted) config file, or the config for a single remote. - ``` rclone config show [] [flags] ``` diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index bdb05563c..2a01cbed4 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -30,7 +30,7 @@ whether the password is already obscured or not and put unobscured passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the "--obscure" flag, or if you are 100% certain you are already passing obscured passwords then use -"--no-obscure". You can also set osbscured passwords using the +"--no-obscure". You can also set obscured passwords using the "rclone config password" command. If the remote uses OAuth the token will be updated, if you don't diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index 16b25d04e..149e1eb23 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,13 +1,13 @@ --- title: "rclone copy" -description: "Copy files from source to dest, skipping already copied" +description: "Copy files from source to dest, skipping already copied." slug: rclone_copy url: /commands/rclone_copy/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copy/ and as part of making a release run "make commanddocs" --- # rclone copy -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis @@ -44,7 +44,7 @@ Not to destpath/sourcepath/two.txt If you are familiar with `rsync`, rclone always works as if you had -written a trailing / - meaning "copy the contents of this directory". +written a trailing `/` - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination. diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index 17567ee01..e571c8c75 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,13 +1,13 @@ --- title: "rclone copyto" -description: "Copy files from source to dest, skipping already copied" +description: "Copy files from source to dest, skipping already copied." slug: rclone_copyto url: /commands/rclone_copyto/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/copyto/ and as part of making a release run "make commanddocs" --- # rclone copyto -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. ## Synopsis diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index 47cbf716b..cf4d701ad 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -40,7 +40,7 @@ the source match the files in the destination, not the other way around. This means that extra files in the destination that are not in the source will not be detected. -The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--src-only` +The `--differ`, `--missing-on-dst`, `--missing-on-src`, `--match` and `--error` flags write paths, one per line, to the file name (or stdout if it is `-`) supplied. What they write is described in the help below. For example `--differ` will write all paths which are diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md index 13637ae05..b2e5623f0 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -23,6 +23,9 @@ use it like this rclone cryptdecode --reverse encryptedremote: filename1 filename2 +Another way to accomplish this is by using the `rclone backend encode` (or `decode`)command. +See the documentation on the `crypt` overlay for more info. + ``` rclone cryptdecode encryptedremote: encryptedfilename [flags] diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md index 139ad4682..8b201dda5 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -15,28 +15,37 @@ Interactively find duplicate filenames and delete/rename them. By default `dedupe` interactively finds files with duplicate names and offers to delete all but one or rename them to be -different. +different. This is known as deduping by name. -This is only useful with backends like Google Drive which can have -duplicate file names. It can be run on wrapping backends (eg crypt) if -they wrap a backend which supports duplicate file names. +Deduping by name is only useful with backends like Google Drive which +can have duplicate file names. It can be run on wrapping backends +(e.g. crypt) if they wrap a backend which supports duplicate file +names. -In the first pass it will merge directories with the same name. It -will do this iteratively until all the identically named directories -have been merged. +However if --by-hash is passed in then dedupe will find files with +duplicate hashes instead which will work on any backend which supports +at least one hash. This can be used to find files with duplicate +content. This is known as deduping by hash. -In the second pass, for every group of duplicate file names, it will -delete all but one identical files it finds without confirmation. -This means that for most duplicated files the `dedupe` -command will not be interactive. +If deduping by name, first rclone will merge directories with the same +name. It will do this iteratively until all the identically named +directories have been merged. + +Next, if deduping by name, for every group of duplicate file names / +hashes, it will delete all but one identical files it finds without +confirmation. This means that for most duplicated files the `dedupe` command will not be interactive. `dedupe` considers files to be identical if they have the -same hash. If the backend does not support hashes (eg crypt wrapping +same file path and the same hash. If the backend does not support hashes (e.g. crypt wrapping Google Drive) then they will never be found to be identical. If you use the `--size-only` flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes. +Next rclone will resolve the remaining duplicates. Exactly which +action is taken depends on the dedupe mode. By default rclone will +interactively query the user for each one. + **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. @@ -68,7 +77,7 @@ Now the `dedupe` session s/k/r> k Enter the number of the file to keep> 1 one.txt: Deleted 1 extra copies - two.txt: Found 3 files with duplicates names + two.txt: Found 3 files with duplicate names two.txt: 3 duplicates remain 1: 564374 bytes, 2016-03-05 16:22:52.118000000, MD5 7594e7dc9fc28f727c42ee3e0749de81 2: 6048320 bytes, 2016-03-05 16:22:46.185000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36 @@ -99,6 +108,7 @@ Dedupe can be run non interactively using the `--dedupe-mode` flag or by using a * `--dedupe-mode largest` - removes identical files then keeps the largest one. * `--dedupe-mode smallest` - removes identical files then keeps the smallest one. * `--dedupe-mode rename` - removes identical files then renames the rest to be different. + * `--dedupe-mode list` - lists duplicate dirs and files only and changes nothing. For example to rename all the identically named photos in your Google Photos directory, do @@ -116,6 +126,7 @@ rclone dedupe [mode] remote:path [flags] ## Options ``` + --by-hash Find indentical hashes rather than names --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive") -h, --help help for dedupe ``` diff --git a/docs/content/commands/rclone_delete.md b/docs/content/commands/rclone_delete.md index 04e3ca0b7..7514b4e9a 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,13 +1,13 @@ --- title: "rclone delete" -description: "Remove the contents of path." +description: "Remove the files in path." slug: rclone_delete url: /commands/rclone_delete/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/delete/ and as part of making a release run "make commanddocs" --- # rclone delete -Remove the contents of path. +Remove the files in path. ## Synopsis @@ -15,20 +15,21 @@ Remove the contents of path. Remove the files in path. Unlike `purge` it obeys include/exclude filters so can be used to selectively delete files. -`rclone delete` only deletes objects but leaves the directory structure +`rclone delete` only deletes files but leaves the directory structure alone. If you want to delete a directory and all of its contents use -`rclone purge` +the `purge` command. -If you supply the --rmdirs flag, it will remove all empty directories along with it. +If you supply the `--rmdirs` flag, it will remove all empty directories along with it. +You can also use the separate command `rmdir` or `rmdirs` to +delete empty directories only. -Eg delete all files bigger than 100MBytes - -Check what would be deleted first (use either) +For example, to delete all files bigger than 100MBytes, you may first want to check what +would be deleted (use either): rclone --min-size 100M lsl remote:path rclone --dry-run --min-size 100M delete remote:path -Then delete +Then proceed with the actual delete: rclone --min-size 100M delete remote:path diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md index 27928c680..a771b3af4 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -15,7 +15,7 @@ Output bash completion script for rclone. Generates a bash shell autocompletion script for rclone. This writes to /etc/bash_completion.d/rclone by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete bash @@ -27,7 +27,8 @@ them directly If you supply a command line argument the script will be written there. -If output_file is `-`, then the output will be written to stdout. +If output_file is "-", then the output will be written to stdout. + ``` rclone genautocomplete bash [output_file] [flags] diff --git a/docs/content/commands/rclone_genautocomplete_fish.md b/docs/content/commands/rclone_genautocomplete_fish.md index d9ba9706c..85650f6c8 100644 --- a/docs/content/commands/rclone_genautocomplete_fish.md +++ b/docs/content/commands/rclone_genautocomplete_fish.md @@ -15,7 +15,7 @@ Output fish completion script for rclone. Generates a fish autocompletion script for rclone. This writes to /etc/fish/completions/rclone.fish by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete fish @@ -27,7 +27,8 @@ them directly If you supply a command line argument the script will be written there. -If output_file is `-`, then the output will be written to stdout. +If output_file is "-", then the output will be written to stdout. + ``` rclone genautocomplete fish [output_file] [flags] diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md index e31df0726..5da7d7975 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -15,7 +15,7 @@ Output zsh completion script for rclone. Generates a zsh autocompletion script for rclone. This writes to /usr/share/zsh/vendor-completions/_rclone by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. sudo rclone genautocomplete zsh @@ -27,7 +27,8 @@ them directly If you supply a command line argument the script will be written there. -If output_file is `-`, then the output will be written to stdout. +If output_file is "-", then the output will be written to stdout. + ``` rclone genautocomplete zsh [output_file] [flags] diff --git a/docs/content/commands/rclone_ls.md b/docs/content/commands/rclone_ls.md index 0a550d0cb..1f1d47322 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -38,12 +38,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). diff --git a/docs/content/commands/rclone_lsd.md b/docs/content/commands/rclone_lsd.md index 5f8a12040..570110937 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -48,12 +48,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index 26bb1b9de..07ce3e9eb 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,13 +1,13 @@ --- title: "rclone lsf" -description: "List directories and objects in remote:path formatted for parsing" +description: "List directories and objects in remote:path formatted for parsing." slug: rclone_lsf url: /commands/rclone_lsf/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/lsf/ and as part of making a release run "make commanddocs" --- # rclone lsf -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. ## Synopsis @@ -38,7 +38,7 @@ output: o - Original ID of underlying object m - MimeType of object if known e - encrypted name - T - tier of storage if known, eg "Hot" or "Cool" + T - tier of storage if known, e.g. "Hot" or "Cool" So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last. @@ -121,12 +121,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). diff --git a/docs/content/commands/rclone_lsjson.md b/docs/content/commands/rclone_lsjson.md index 2df33f3fc..22606722b 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -41,11 +41,11 @@ may be repeated). If --hash-type is set then it implies --hash. If --no-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an extra -request (eg s3, swift). +request (e.g. s3, swift). If --no-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an extra -request (eg s3, swift). +request (e.g. s3, swift). If --encrypted is not specified the Encrypted won't be emitted. @@ -67,9 +67,9 @@ If the directory is a bucket in a bucket based backend, then The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the -nearest millisecond (eg Google Drive) then 3 digits will always be +nearest millisecond (e.g. Google Drive) then 3 digits will always be shown ("2017-05-31T16:15:57.034+01:00") whereas if the times are -accurate to the nearest second (Dropbox, Box, WebDav etc) no digits +accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits will be shown ("2017-05-31T16:15:57+01:00"). The whole output can be processed as a JSON blob, or alternatively it @@ -89,12 +89,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). diff --git a/docs/content/commands/rclone_lsl.md b/docs/content/commands/rclone_lsl.md index 628ce7383..417f8ec09 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -38,12 +38,12 @@ There are several related list commands `lsf` is designed to be human and machine readable. `lsjson` is designed to be machine readable. -Note that `ls` and `lsl` recurse by default - use "--max-depth 1" to stop the recursion. +Note that `ls` and `lsl` recurse by default - use `--max-depth 1` to stop the recursion. -The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use "-R" to make them recurse. +The other list commands `lsd`,`lsf`,`lsjson` do not recurse by default - use `-R` to make them recurse. Listing a non existent directory will produce an error except for -remotes which can't have empty directories (eg s3, swift, gcs, etc - +remotes which can't have empty directories (e.g. s3, swift, or gcs - the bucket based remotes). diff --git a/docs/content/commands/rclone_mkdir.md b/docs/content/commands/rclone_mkdir.md index f988a48dd..4d009c91e 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -9,10 +9,6 @@ url: /commands/rclone_mkdir/ Make the path if it doesn't already exist. -## Synopsis - -Make the path if it doesn't already exist. - ``` rclone mkdir remote:path [flags] ``` diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index 3410aec87..22b75695c 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -18,37 +18,51 @@ FUSE. First set up your remote using `rclone config`. Check it works with `rclone ls` etc. -You can either run mount in foreground mode or background (daemon) mode. Mount runs in -foreground mode by default, use the --daemon flag to specify background mode behaviour. -Background mode is only supported on Linux and OSX, you can only run mount in -foreground mode on Windows. +On Linux and OSX, you can either run mount in foreground mode or background (daemon) mode. +Mount runs in foreground mode by default, use the `--daemon` flag to specify background mode. +You can only run mount in foreground mode on Windows. -On Linux/macOS/FreeBSD Start the mount like this where `/path/to/local/mount` -is an **empty** **existing** directory. +On Linux/macOS/FreeBSD start the mount like this, where `/path/to/local/mount` +is an **empty** **existing** directory: rclone mount remote:path/to/files /path/to/local/mount -Or on Windows like this where `X:` is an unused drive letter -or use a path to **non-existent** directory. +On Windows you can start a mount in different ways. See [below](#mounting-modes-on-windows) +for details. The following examples will mount to an automatically assigned drive, +to specific drive letter `X:`, to path `C:\path\to\nonexistent\directory` +(which must be **non-existent** subdirectory of an **existing** parent directory or drive, +and is not supported when [mounting as a network drive](#mounting-modes-on-windows)), and +the last example will mount as network share `\\cloud\remote` and map it to an +automatically assigned drive: + rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\path\to\nonexistent\directory - -When running in background mode the user will have to stop the mount manually (specified below). + rclone mount remote:path/to/files \\cloud\remote When the program ends while in foreground mode, either via Ctrl+C or receiving -a SIGINT or SIGTERM signal, the mount is automatically stopped. +a SIGINT or SIGTERM signal, the mount should be automatically stopped. -The umount operation can fail, for example when the mountpoint is busy. -When that happens, it is the user's responsibility to stop the mount manually. - -Stopping the mount manually: +When running in background mode the user will have to stop the mount manually: # Linux fusermount -u /path/to/local/mount # OS X umount /path/to/local/mount +The umount operation can fail, for example when the mountpoint is busy. +When that happens, it is the user's responsibility to stop the mount manually. + +The size of the mounted file system will be set according to information retrieved +from the remote, the same as returned by the [rclone about](https://rclone.org/commands/rclone_about/) +command. Remotes with unlimited storage may report the used size only, +then an additional 1PB of free space is assumed. If the remote does not +[support](https://rclone.org/overview/#optional-features) the about feature +at all, then 1PB is set as both the total and the free size. + +**Note**: As of `rclone` 1.52.2, `rclone mount` now requires Go version 1.13 +or newer on some platforms depending on the underlying FUSE library in use. + ## Installing on Windows To run rclone mount on Windows, you will need to @@ -57,10 +71,110 @@ download and install [WinFsp](http://www.secfs.net/winfsp/). [WinFsp](https://github.com/billziss-gh/winfsp) is an open source Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone -uses in combination with -[cgofuse](https://github.com/billziss-gh/cgofuse). Both of these -packages are by Bill Zissimopoulos who was very helpful during the -implementation of rclone mount for Windows. +uses combination with [cgofuse](https://github.com/billziss-gh/cgofuse). +Both of these packages are by Bill Zissimopoulos who was very helpful +during the implementation of rclone mount for Windows. + +### Mounting modes on windows + +Unlike other operating systems, Microsoft Windows provides a different filesystem +type for network and fixed drives. It optimises access on the assumption fixed +disk drives are fast and reliable, while network drives have relatively high latency +and less reliability. Some settings can also be differentiated between the two types, +for example that Windows Explorer should just display icons and not create preview +thumbnails for image and video files on network drives. + +In most cases, rclone will mount the remote as a normal, fixed disk drive by default. +However, you can also choose to mount it as a remote network drive, often described +as a network share. If you mount an rclone remote using the default, fixed drive mode +and experience unexpected program errors, freezes or other issues, consider mounting +as a network drive instead. + +When mounting as a fixed disk drive you can either mount to an unused drive letter, +or to a path - which must be **non-existent** subdirectory of an **existing** parent +directory or drive. Using the special value `*` will tell rclone to +automatically assign the next available drive letter, starting with Z: and moving backward. +Examples: + + rclone mount remote:path/to/files * + rclone mount remote:path/to/files X: + rclone mount remote:path/to/files C:\path\to\nonexistent\directory + rclone mount remote:path/to/files X: + +Option `--volname` can be used to set a custom volume name for the mounted +file system. The default is to use the remote name and path. + +To mount as network drive, you can add option `--network-mode` +to your mount command. Mounting to a directory path is not supported in +this mode, it is a limitation Windows imposes on junctions, so the remote must always +be mounted to a drive letter. + + rclone mount remote:path/to/files X: --network-mode + +A volume name specified with `--volname` will be used to create the network share path. +A complete UNC path, such as `\\cloud\remote`, optionally with path +`\\cloud\remote\madeup\path`, will be used as is. Any other +string will be used as the share part, after a default prefix `\\server\`. +If no volume name is specified then `\\server\share` will be used. +You must make sure the volume name is unique when you are mounting more than one drive, +or else the mount command will fail. The share name will treated as the volume label for +the mapped drive, shown in Windows Explorer etc, while the complete +`\\server\share` will be reported as the remote UNC path by +`net use` etc, just like a normal network drive mapping. + +If you specify a full network share UNC path with `--volname`, this will implicitely +set the `--network-mode` option, so the following two examples have same result: + + rclone mount remote:path/to/files X: --network-mode + rclone mount remote:path/to/files X: --volname \\server\share + +You may also specify the network share UNC path as the mountpoint itself. Then rclone +will automatically assign a drive letter, same as with `*` and use that as +mountpoint, and instead use the UNC path specified as the volume name, as if it were +specified with the `--volname` option. This will also implicitely set +the `--network-mode` option. This means the following two examples have same result: + + rclone mount remote:path/to/files \\cloud\remote + rclone mount remote:path/to/files * --volname \\cloud\remote + +There is yet another way to enable network mode, and to set the share path, +and that is to pass the "native" libfuse/WinFsp option directly: +`--fuse-flag --VolumePrefix=\server\share`. Note that the path +must be with just a single backslash prefix in this case. + + +*Note:* In previous versions of rclone this was the only supported method. + +[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) + +See also [Limitations](#limitations) section below. + +### Windows filesystem permissions + +The FUSE emulation layer on Windows must convert between the POSIX-based +permission model used in FUSE, and the permission model used in Windows, +based on access-control lists (ACL). + +The mounted filesystem will normally get three entries in its access-control list (ACL), +representing permissions for the POSIX permission scopes: Owner, group and others. +By default, the owner and group will be taken from the current user, and the built-in +group "Everyone" will be used to represent others. The user/group can be customized +with FUSE options "UserName" and "GroupName", +e.g. `-o UserName=user123 -o GroupName="Authenticated Users"`. + +The permissions on each entry will be set according to +[options](#options) `--dir-perms` and `--file-perms`, +which takes a value in traditional [numeric notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation), +where the default corresponds to `--file-perms 0666 --dir-perms 0777`. + +Note that the mapping of permissions is not always trivial, and the result +you see in Windows Explorer may not be exactly like you expected. +For example, when setting a value that includes write access, this will be +mapped to individual permissions "write attributes", "write data" and "append data", +but not "write extended attributes" (WinFsp does not support extended attributes, +see [this](https://github.com/billziss-gh/winfsp/wiki/NTFS-Compatibility)). +Windows will then show this as basic permission "Special" instead of "Write", +because "Write" includes the "write extended attributes" permission. ### Windows caveats @@ -78,43 +192,15 @@ infrastructure](https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Archit which creates drives accessible for everyone on the system or alternatively using [the nssm service manager](https://nssm.cc/usage). -### Mount as a network drive - -By default, rclone will mount the remote as a normal drive. However, -you can also mount it as a **Network Drive** (or **Network Share**, as -mentioned in some places) - -Unlike other systems, Windows provides a different filesystem type for -network drives. Windows and other programs treat the network drives -and fixed/removable drives differently: In network drives, many I/O -operations are optimized, as the high latency and low reliability -(compared to a normal drive) of a network is expected. - -Although many people prefer network shares to be mounted as normal -system drives, this might cause some issues, such as programs not -working as expected or freezes and errors while operating with the -mounted remote in Windows Explorer. If you experience any of those, -consider mounting rclone remotes as network shares, as Windows expects -normal drives to be fast and reliable, while cloud storage is far from -that. See also [Limitations](#limitations) section below for more -info - -Add "--fuse-flag --VolumePrefix=\server\share" to your "mount" -command, **replacing "share" with any other name of your choice if you -are mounting more than one remote**. Otherwise, the mountpoints will -conflict and your mounted filesystems will overlap. - -[Read more about drive mapping](https://en.wikipedia.org/wiki/Drive_mapping) - ## Limitations -Without the use of "--vfs-cache-mode" this can only write files +Without the use of `--vfs-cache-mode` this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without -"--vfs-cache-mode writes" or "--vfs-cache-mode full". See the [File -Caching](#vfs-file-caching) section for more info. +`--vfs-cache-mode writes` or `--vfs-cache-mode full`. +See the [File Caching](#file-caching) section for more info. -The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, +The bucket based remotes (e.g. Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept of empty directories, so empty directories will have a tendency to disappear once they fall out of the directory cache. @@ -127,15 +213,15 @@ File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the -uploads. Look at the [file caching](#vfs-file-caching) +uploads. Look at the [file caching](#file-caching) for solutions to make mount more reliable. ## Attribute caching -You can use the flag --attr-timeout to set the time the kernel caches -the attributes (size, modification time etc) for directory entries. +You can use the flag `--attr-timeout` to set the time the kernel caches +the attributes (size, modification time, etc.) for directory entries. -The default is "1s" which caches files just long enough to avoid +The default is `1s` which caches files just long enough to avoid too many callbacks to rclone from the kernel. In theory 0s should be the correct value for filesystems which can @@ -146,14 +232,14 @@ few problems such as and [excessive time listing directories](https://github.com/rclone/rclone/issues/2095#issuecomment-371141147). The kernel can cache the info about a file for the time given by -"--attr-timeout". You may see corruption if the remote file changes +`--attr-timeout`. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file -or a file with garbage on the end. With "--attr-timeout 1s" this is -very unlikely but not impossible. The higher you set "--attr-timeout" +or a file with garbage on the end. With `--attr-timeout 1s` this is +very unlikely but not impossible. The higher you set `--attr-timeout` the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above. -If you set it higher ('10s' or '1m' say) then the kernel will call +If you set it higher (`10s` or `1m` say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above. @@ -164,7 +250,7 @@ This is the same as setting the attr_timeout option in mount.fuse. ## Filters -Rclone's filters can be used to select a subset of the +Note that all the rclone filters can be used to select a subset of the files to be visible in the mount. ## systemd @@ -175,28 +261,25 @@ after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode. -## chunked reading ### +## chunked reading ---vfs-read-chunk-size will enable reading the source objects in parts. +`--vfs-read-chunk-size` will enable reading the source objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests. -When --vfs-read-chunk-size-limit is also specified and greater than --vfs-read-chunk-size, -the chunk size for each open file will get doubled for each chunk read, until the -specified value is reached. A value of -1 will disable the limit and the chunk size will -grow indefinitely. +When `--vfs-read-chunk-size-limit` is also specified and greater than +`--vfs-read-chunk-size`, the chunk size for each open file will get doubled +for each chunk read, until the specified value is reached. A value of `-1` will disable +the limit and the chunk size will grow indefinitely. -With --vfs-read-chunk-size 100M and --vfs-read-chunk-size-limit 0 the following -parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. -When --vfs-read-chunk-size-limit 500M is specified, the result would be +With `--vfs-read-chunk-size 100M` and `--vfs-read-chunk-size-limit 0` +the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. +When `--vfs-read-chunk-size-limit 500M` is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on. -Chunked reading will only work with --vfs-cache-mode < full, as the file will always -be copied to the vfs cache before opening with --vfs-cache-mode full. - ## VFS - Virtual File System -Mount uses rclone's VFS layer. This adapts the cloud storage objects +This command uses the VFS layer. This adapts the cloud storage objects that rclone uses into something which looks much more like a disk filing system. @@ -290,9 +373,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -340,7 +423,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -357,6 +440,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -392,6 +480,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -405,7 +499,7 @@ 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 +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. @@ -435,30 +529,33 @@ rclone mount remote:path /path/to/mountpoint [flags] ## Options ``` - --allow-non-empty Allow mounting over a non-empty directory (not Windows). - --allow-other Allow access to other users. - --allow-root Allow access to root user. - --async-read Use asynchronous reads. (default true) + --allow-non-empty Allow mounting over a non-empty directory. Not supported on Windows. + --allow-other Allow access to other users. Not supported on Windows. + --allow-root Allow access to root user. Not supported on Windows. + --async-read Use asynchronous reads. Not supported on Windows. (default true) --attr-timeout duration Time for which file/directory attributes are cached. (default 1s) - --daemon Run mount as a daemon (background mode). - --daemon-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes). + --daemon Run mount as a daemon (background mode). Not supported on Windows. + --daemon-timeout duration Time limit for rclone to respond to kernel. Not supported on Windows. --debug-fuse Debug the FUSE internals - needs -v. - --default-permissions Makes kernel enforce access control based on the file mode. + --default-permissions Makes kernel enforce access control based on the file mode. Not supported on Windows. --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) --fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for mount - --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) + --max-read-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. Not supported on Windows. (default 128k) + --network-mode Mount as remote network drive, instead of fixed disk drive. Supported on Windows only --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. + --noappledouble Ignore Apple Double (._) and .DS_Store files. Supported on OSX only. (default true) + --noapplexattr Ignore all "com.apple.*" extended attributes. Supported on OSX only. -o, --option stringArray Option for libfuse/WinFsp. Repeat if required. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) @@ -470,8 +567,8 @@ rclone mount remote:path /path/to/mountpoint [flags] --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-back duration Time to writeback files after last use when using cache. (default 5s) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) - --volname string Set the volume name (not supported by all OSes). - --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. + --volname string Set the volume name. Supported on Windows and OSX only. + --write-back-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. Not supported on Windows. ``` See the [global flags page](/flags/) for global options not listed here. diff --git a/docs/content/commands/rclone_move.md b/docs/content/commands/rclone_move.md index 9e2cc4634..0a53c1eea 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -14,15 +14,15 @@ Move files from source to dest. Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and -the remote does not support a server side directory move operation. +the remote does not support a server-side directory move operation. -If no filters are in use and if possible this will server side move +If no filters are in use and if possible this will server-side move `source:path` into `dest:path`. After this `source:path` will no longer exist. Otherwise for each file in `source:path` selected by the filters (if -any) this will move it into `dest:path`. If possible a server side -move will be used, otherwise it will copy it (server side if possible) +any) this will move it into `dest:path`. If possible a server-side +move will be used, otherwise it will copy it (server-side if possible) into `dest:path` then delete the original (if no errors on copy) in `source:path`. diff --git a/docs/content/commands/rclone_ncdu.md b/docs/content/commands/rclone_ncdu.md index 5247b7544..c0310974d 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -30,9 +30,10 @@ Here are the keys - press '?' to toggle the help on and off ←,h to return c toggle counts g toggle graph - n,s,C sort by name,size,count + a toggle average size in directory + n,s,C,A sort by name,size,count,average size d delete file/directory - y copy current path to clipbard + y copy current path to clipboard Y display current path ^L refresh screen ? to toggle help on and off diff --git a/docs/content/commands/rclone_obscure.md b/docs/content/commands/rclone_obscure.md index bbc5f7bfc..cad5e1c19 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,13 +1,13 @@ --- title: "rclone obscure" -description: "Obscure password for use in the rclone config file" +description: "Obscure password for use in the rclone config file." slug: rclone_obscure url: /commands/rclone_obscure/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/obscure/ and as part of making a release run "make commanddocs" --- # rclone obscure -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. ## Synopsis @@ -23,7 +23,8 @@ the config file. However it is very hard to shoulder surf a 64 character hex token. This command can also accept a password through STDIN instead of an -argument by passing a hyphen as an argument. Example: +argument by passing a hyphen as an argument. This will use the first +line of STDIN as the password not including the trailing newline. echo "secretpassword" | rclone obscure - diff --git a/docs/content/commands/rclone_purge.md b/docs/content/commands/rclone_purge.md index c021ef7ae..c15c10320 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -13,8 +13,9 @@ Remove the path and all of its contents. Remove the path and all of its contents. Note that this does not obey -include/exclude filters - everything will be removed. Use `delete` if -you want to selectively delete files. +include/exclude filters - everything will be removed. Use the `delete` +command if you want to selectively delete files. To delete empty directories only, +use command `rmdir` or `rmdirs`. **Important**: Since this can cause data loss, test first with the `--dry-run` or the `--interactive`/`-i` flag. diff --git a/docs/content/commands/rclone_rc.md b/docs/content/commands/rclone_rc.md index c409daf3a..8547d3c93 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -56,7 +56,7 @@ Will place this in the "arg" value Use --loopback to connect to the rclone instance running "rclone rc". This is very useful for testing commands without having to run an -rclone rc server, eg: +rclone rc server, e.g.: rclone rc --loopback operations/about fs=/ @@ -73,7 +73,7 @@ rclone rc commands parameter [flags] -h, --help help for rc --json string Input JSON - use instead of key=value args. --loopback If set connect to this rclone instance not via HTTP. - --no-output If set don't output the JSON result. + --no-output If set, don't output the JSON result. -o, --opt stringArray Option in the form name=value or name placed in the "opt" array. --pass string Password to use to connect to rclone remote control. --url string URL to connect to rclone remote control. (default "http://localhost:5572/") diff --git a/docs/content/commands/rclone_rmdir.md b/docs/content/commands/rclone_rmdir.md index 049f34db1..f9d84cdfd 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,19 +1,24 @@ --- title: "rclone rmdir" -description: "Remove the path if empty." +description: "Remove the empty directory at path." slug: rclone_rmdir url: /commands/rclone_rmdir/ # autogenerated - DO NOT EDIT, instead edit the source code in cmd/rmdir/ and as part of making a release run "make commanddocs" --- # rclone rmdir -Remove the path if empty. +Remove the empty directory at path. ## Synopsis -Remove the path. Note that you can't remove a path with -objects in it, use purge for that. +This removes empty directory given by path. Will not remove the path if it +has any objects in it, not even empty subdirectories. Use +command `rmdirs` (or `delete` with option `--rmdirs`) +to do that. + +To delete a path and any objects in it, use `purge` command. + ``` rclone rmdir remote:path [flags] diff --git a/docs/content/commands/rclone_rmdirs.md b/docs/content/commands/rclone_rmdirs.md index 651fdabd8..1e90a055b 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -11,15 +11,21 @@ Remove empty directories under the path. ## Synopsis -This removes any empty directories (or directories that only contain -empty directories) under the path that it finds, including the path if -it has nothing in. -If you supply the --leave-root flag, it will not remove the root directory. +This recursively removes any empty directories (including directories +that only contain empty directories), that it finds under the path. +The root path itself will also be removed if it is empty, unless +you supply the `--leave-root` flag. + +Use command `rmdir` to delete just the empty directory +given by path, not recurse. This is useful for tidying up remotes that rclone has left a lot of -empty directories in. +empty directories in. For example the `delete` command will +delete files but leave the directory structure (unless used with +option `--rmdirs`). +To delete a path and any objects in it, use `purge` command. ``` diff --git a/docs/content/commands/rclone_serve.md b/docs/content/commands/rclone_serve.md index 37e6352c5..0fa84dd8e 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -12,7 +12,7 @@ Serve a remote over a protocol. ## Synopsis rclone serve is used to serve a remote over a given protocol. This -command requires the use of a subcommand to specify the protocol, eg +command requires the use of a subcommand to specify the protocol, e.g. rclone serve http remote: diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index 9f7b27932..16c6eb7c8 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -24,7 +24,7 @@ players might show files that they are not able to play back correctly. ## Server options Use `--addr` to specify which IP address and port the server should -listen on, eg `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all +listen on, e.g. `--addr 1.2.3.4:8000` or `--addr :8080` to listen to all IPs. Use `--name` to choose the friendly server name, which is by @@ -129,9 +129,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -179,7 +179,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -196,6 +196,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -231,6 +236,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -244,7 +255,7 @@ 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 +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. @@ -278,7 +289,7 @@ rclone serve dlna remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for dlna --log-trace enable trace logging of SOAP traffic --name string name of DLNA server @@ -287,8 +298,8 @@ rclone serve dlna remote:path [flags] --no-seek Don't allow seeking in files. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --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) diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index 204e7eb71..8f665c55b 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -19,7 +19,7 @@ or you can make a remote of type ftp to read and write it. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -128,9 +128,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -178,7 +178,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -195,6 +195,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -230,6 +235,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -243,7 +254,7 @@ 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 +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. @@ -270,14 +281,14 @@ otherwise. If the flag is provided without a value, then it is "true". If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple -JSON based protocl with input on STDIN and output on STDOUT. +JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored. There is an example program -[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/bin/test_proxy.py) +[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) in the rclone source code. The program's job is to take a `user` and `pass` on the input and turn @@ -356,11 +367,13 @@ rclone serve ftp remote:path [flags] ``` --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121") --auth-proxy string A program to use to create the backend from the auth. + --cert string TLS PEM key (concatenation of certificate and CA certificate) --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for ftp + --key string TLS PEM Private key --no-checksum Don't compare checksums on up/download. --no-modtime Don't read/write the modification time (can speed things up). --no-seek Don't allow seeking in files. @@ -369,8 +382,8 @@ rclone serve ftp remote:path [flags] --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --public-ip string Public IP address to advertise for passive connections. --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. (default "anonymous") --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 39ca31f90..5614405f5 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -15,7 +15,7 @@ rclone serve http implements a basic web server to serve the remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it. -You can use the filter flags (eg --include, --exclude) to control what +You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. @@ -26,7 +26,7 @@ control the stats printing. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -57,7 +57,7 @@ to be used within the template to server pages: | .Name | The full path of a file/directory. | | .Title | Directory listing of .Name | | .Sort | The current sort used. This is changeable via ?sort= parameter | -| | Sort Options: namedirfist,name,size,time (default namedirfirst) | +| | Sort Options: namedirfirst,name,size,time (default namedirfirst) | | .Order | The current ordering used. This is changeable via ?order= parameter | | | Order Options: asc,desc (default asc) | | .Query | Currently unused. | @@ -200,9 +200,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -250,7 +250,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -267,6 +267,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -302,6 +307,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -315,7 +326,7 @@ 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 +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. @@ -352,7 +363,7 @@ rclone serve http remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for http --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -367,8 +378,8 @@ rclone serve http remote:path [flags] --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md index ed0c30098..1daed58a9 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -44,6 +44,10 @@ with use of the "--addr" flag. You might wish to start this server on boot. +Adding --cache-objects=false will cause rclone to stop caching objects +returned from the List call. Caching is normally desirable as it speeds +up downloading objects, saves transactions and uses very little memory. + ## Setting up restic to use rclone ### Now you can [follow the restic @@ -92,7 +96,7 @@ with a path of `//`. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -123,7 +127,7 @@ to be used within the template to server pages: | .Name | The full path of a file/directory. | | .Title | Directory listing of .Name | | .Sort | The current sort used. This is changeable via ?sort= parameter | -| | Sort Options: namedirfist,name,size,time (default namedirfirst) | +| | Sort Options: namedirfirst,name,size,time (default namedirfirst) | | .Order | The current ordering used. This is changeable via ?order= parameter | | | Order Options: asc,desc (default asc) | | .Query | Currently unused. | @@ -181,6 +185,7 @@ rclone serve restic remote:path [flags] --addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080") --append-only disallow deletion of repository data --baseurl string Prefix for URLs - leave blank for root. + --cache-objects cache listed objects (default true) --cert string SSL PEM key (concatenation of certificate and CA certificate) --client-ca string Client certificate authority to verify clients with -h, --help help for restic diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index b4deb13f4..f55388d73 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -15,7 +15,7 @@ rclone serve sftp implements an SFTP server to serve the remote over SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it. -You can use the filter flags (eg --include, --exclude) to control what +You can use the filter flags (e.g. --include, --exclude) to control what is served. The server will log errors. Use -v to see access logs. @@ -139,9 +139,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -189,7 +189,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -206,6 +206,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -241,6 +246,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -254,7 +265,7 @@ 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 +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. @@ -281,14 +292,14 @@ otherwise. If the flag is provided without a value, then it is "true". If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple -JSON based protocl with input on STDIN and output on STDOUT. +JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be ignored. There is an example program -[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/bin/test_proxy.py) +[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) in the rclone source code. The program's job is to take a `user` and `pass` on the input and turn @@ -371,7 +382,7 @@ rclone serve sftp remote:path [flags] --dir-cache-time duration Time to cache directory entries for. (default 5m0s) --dir-perms FileMode Directory permissions (default 0777) --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for sftp --key stringArray SSH private host key file (Can be multi-valued, leave blank to auto generate) --no-auth Allow connections with no authentication if set. @@ -381,8 +392,8 @@ rclone serve sftp remote:path [flags] --pass string Password for authentication. --poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) --read-only Mount read-only. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index 0f29adcec..b898e03b8 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -34,7 +34,7 @@ Use "rclone hashsum" to see the full list. ## Server options Use --addr to specify which IP address and port the server should -listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all +listen on, e.g. --addr 1.2.3.4:8000 or --addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. @@ -65,7 +65,7 @@ to be used within the template to server pages: | .Name | The full path of a file/directory. | | .Title | Directory listing of .Name | | .Sort | The current sort used. This is changeable via ?sort= parameter | -| | Sort Options: namedirfist,name,size,time (default namedirfirst) | +| | Sort Options: namedirfirst,name,size,time (default namedirfirst) | | .Order | The current ordering used. This is changeable via ?order= parameter | | | Order Options: asc,desc (default asc) | | .Query | Currently unused. | @@ -208,9 +208,9 @@ second. If rclone is quit or dies with files that haven't been uploaded, these will be uploaded next time rclone is run with the same flags. -If using --vfs-cache-max-size note that the cache may exceed this size +If using `--vfs-cache-max-size` note that the cache may exceed this size for two reasons. Firstly because it is only checked every ---vfs-cache-poll-interval. Secondly because open files cannot be +`--vfs-cache-poll-interval`. Secondly because open files cannot be evicted from the cache. ### --vfs-cache-mode off @@ -258,7 +258,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. In this mode the files in the cache will be sparse files and rclone -will keep track of which bits of the files it has dowloaded. +will keep track of which bits of the files it has downloaded. So if an application only reads the starts of each file, then rclone will only buffer the start of the file. These files will appear to be @@ -275,6 +275,11 @@ whereas the --vfs-read-ahead is buffered on disk. When using this mode it is recommended that --buffer-size is not set too big and --vfs-read-ahead is set large if required. +**IMPORTANT** not all file systems support sparse files. In particular +FAT/exFAT do not. Rclone will perform very badly if the cache +directory is on a filesystem which doesn't support sparse files and it +will log an ERROR message if one is detected. + ## VFS Performance These flags may be used to enable/disable features of the VFS for @@ -310,6 +315,12 @@ on disk cache file. --vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms) --vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s) +When using VFS write caching (--vfs-cache-mode with value writes or full), +the global flag --transfers can be set to adjust the number of parallel uploads of +modified files from cache (the related global flag --checkers have no effect on mount). + + --transfers int Number of file transfers to run in parallel. (default 4) + ## VFS Case Sensitivity Linux file systems are case-sensitive: two files can differ only @@ -323,7 +334,7 @@ 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 +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. @@ -350,7 +361,7 @@ otherwise. If the flag is provided without a value, then it is "true". If you supply the parameter `--auth-proxy /path/to/program` then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. This uses a simple -JSON based protocl with input on STDIN and output on STDOUT. +JSON based protocol with input on STDIN and output on STDOUT. **PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used together, if `--auth-proxy` is set the authorized keys option will be @@ -444,7 +455,7 @@ rclone serve webdav remote:path [flags] --disable-dir-list Disable HTML directory list on GET request for a directory --etag-hash string Which hash to use for the ETag, or auto or blank for off --file-perms FileMode File permissions (default 0666) - --gid uint32 Override the gid field set by the filesystem. (default 1000) + --gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) -h, --help help for webdav --htpasswd string htpasswd file - if not provided no authentication is done --key string SSL PEM Private key @@ -459,8 +470,8 @@ rclone serve webdav remote:path [flags] --server-read-timeout duration Timeout for server reading data (default 1h0m0s) --server-write-timeout duration Timeout for server writing data (default 1h0m0s) --template string User Specified Template. - --uid uint32 Override the uid field set by the filesystem. (default 1000) - --umask int Override the permission bits set by the filesystem. (default 2) + --uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + --umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) --user string User name for authentication. --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s) --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off) diff --git a/docs/content/commands/rclone_size.md b/docs/content/commands/rclone_size.md index 5795393b8..a365986af 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -9,10 +9,6 @@ url: /commands/rclone_size/ Prints the total size and number of objects in remote:path. -## Synopsis - -Prints the total size and number of objects in remote:path. - ``` rclone size remote:path [flags] ``` diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md index 8708e80d3..363fdc33b 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -21,9 +21,9 @@ unless the --no-create flag is provided. If --timestamp is used then it will set the modification time to that time instead of the current time. Times may be specified as one of: -- 'YYMMDD' - eg. 17.10.30 -- 'YYYY-MM-DDTHH:MM:SS' - eg. 2006-01-02T15:04:05 -- 'YYYY-MM-DDTHH:MM:SS.SSS' - eg. 2006-01-02T15:04:05.123456789 +- 'YYMMDD' - e.g. 17.10.30 +- 'YYYY-MM-DDTHH:MM:SS' - e.g. 2006-01-02T15:04:05 +- 'YYYY-MM-DDTHH:MM:SS.SSS' - e.g. 2006-01-02T15:04:05.123456789 Note that --timestamp is in UTC if you want local time then add the --localtime flag. diff --git a/docs/content/commands/rclone_tree.md b/docs/content/commands/rclone_tree.md index 1f08bd35b..368e5787c 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -28,7 +28,7 @@ For example 1 directories, 5 files -You can use any of the filtering options with the tree command (eg +You can use any of the filtering options with the tree command (e.g. --include and --exclude). You can also use --fast-list. The tree command has many options for controlling the listing which diff --git a/docs/content/compress.md b/docs/content/compress.md index fde2f4341..e9576700c 100644 --- a/docs/content/compress.md +++ b/docs/content/compress.md @@ -130,4 +130,18 @@ GZIP compression level (-2 to 9). - Type: int - Default: -1 +#### --compress-ram-cache-limit + +Some remotes don't allow the upload of files with unknown size. + In this case the compressed file will need to be cached to determine + it's size. + + Files smaller than this limit will be cached in RAM, file larger than + this limit will be cached on disk + +- Config: ram_cache_limit +- Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT +- Type: SizeSuffix +- Default: 20M + {{< rem autogenerated options stop >}} diff --git a/docs/content/drive.md b/docs/content/drive.md index f7aefbce0..8ff1d915c 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -547,8 +547,10 @@ Here are the standard options specific to drive (Google Drive). #### --drive-client-id -OAuth Client Id -Leave blank normally. +Google Application Client Id +Setting your own is recommended. +See https://rclone.org/drive/#making-your-own-client-id for how to create your own. +If you leave this blank, it will use an internal key which is low performance. - Config: client_id - Env Var: RCLONE_DRIVE_CLIENT_ID @@ -1007,6 +1009,25 @@ See: https://github.com/rclone/rclone/issues/3857 - Type: bool - Default: false +#### --drive-stop-on-download-limit + +Make download limit errors be fatal + +At the time of writing it is only possible to download 10TB of data from +Google Drive a day (this is an undocumented limit). When this limit is +reached Google Drive produces a slightly different error message. When +this flag is set it causes these errors to be fatal. These will stop +the in-progress sync. + +Note that this detection is relying on error message strings which +Google don't document so it may break in the future. + + +- Config: stop_on_download_limit +- Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT +- Type: bool +- Default: false + #### --drive-skip-shortcuts If set skip shortcut files @@ -1171,6 +1192,33 @@ Result: } +#### copyid + +Copy files by ID + + rclone backend copyid remote: [options] [+] + +This command copies files by ID + +Usage: + + rclone backend copyid drive: ID path + rclone backend copyid drive: ID1 path1 ID2 path2 + +It copies the drive file with ID given to the path (an rclone path which +will be passed internally to rclone copyto). The ID and path pairs can be +repeated. + +The path should end with a / to indicate copy the file as named to +this directory. If it doesn't end with a / then the last path +component will be used as the file name. + +If the destination is a drive backend then server-side copying will be +attempted if possible. + +Use the -i flag to see what would be copied before copying. + + {{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/flags.md b/docs/content/flags.md index c1d6bba3d..5dafa07a5 100755 --- a/docs/content/flags.md +++ b/docs/content/flags.md @@ -69,6 +69,7 @@ These flags are available for every command. --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") + --log-systemd Activate systemd integration for the logger. --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) @@ -86,6 +87,7 @@ These flags are available for every command. --multi-thread-streams int Max number of streams to use for multi-thread downloads. (default 4) --no-check-certificate Do not verify the server SSL certificate. Insecure. --no-check-dest Don't check the destination, copy regardless. + --no-console Hide console window. Supported on Windows only. --no-gzip-encoding Don't set Accept-Encoding: gzip. --no-traverse Don't traverse destination file system on copy. --no-unicode-normalization Don't normalize unicode characters in filenames. @@ -93,6 +95,7 @@ These flags are available for every command. --order-by string Instructions on how to order the transfers, e.g. 'size,descending' --password-command SpaceSepList Command for supplying password for encrypted configuration. -P, --progress Show progress during transfer. + --progress-terminal-title Show progress on the terminal title. Requires -P/--progress. -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") @@ -147,7 +150,7 @@ These flags are available for every command. --use-json-log Use json log format. --use-mmap Use mmap allocator (see docs). --use-server-modtime Use server modified time instead of object metadata - --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.53.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.54.0") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -168,6 +171,7 @@ and may be set in the config file. --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-archive-tier-delete Delete archive tier blobs before overwriting. --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) --azureblob-disable-checksum Don't store MD5 checksum with object metadata. --azureblob-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) @@ -176,9 +180,14 @@ and may be set in the config file. --azureblob-list-chunk int Size of blob list. (default 5000) --azureblob-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) --azureblob-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. + --azureblob-msi-client-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified. + --azureblob-msi-mi-res-id string Azure resource ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified. + --azureblob-msi-object-id string Object ID of the user-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified. --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-service-principal-file string Path to file containing credentials for use with a service principal. + --azureblob-upload-cutoff string Cutoff for switching to chunked upload (<= 256MB). (Deprecated) --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) + --azureblob-use-msi Use a managed service identity to authenticate (only works in Azure) --b2-account string Account ID or Application Key ID --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) --b2-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) @@ -229,10 +238,11 @@ and may be set in the config file. --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) + --compress-level int GZIP compression level (-2 to 9). (default -1) + --compress-mode string Compression mode. (default "gzip") + --compress-ram-cache-limit SizeSuffix Some remotes don't allow the upload of files with unknown size. (default 20M) + --compress-remote string Remote to compress. -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") @@ -246,7 +256,7 @@ and may be set in the config file. --drive-auth-owner-only Only consider files owned by the authenticated user. --drive-auth-url string Auth server URL. --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) - --drive-client-id string OAuth Client Id + --drive-client-id string Google Application Client Id --drive-client-secret string OAuth Client Secret --drive-disable-http2 Disable drive using http2 (default true) --drive-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) @@ -269,6 +279,7 @@ and may be set in the config file. --drive-skip-gdocs Skip google documents in all listings. --drive-skip-shortcuts If set skip shortcut files --drive-starred-only Only show files that are starred. + --drive-stop-on-download-limit Make download limit errors be fatal --drive-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Team Drive --drive-token string OAuth Access Token as a JSON blob. @@ -285,20 +296,30 @@ and may be set in the config file. --dropbox-client-secret string OAuth Client Secret --dropbox-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) --dropbox-impersonate string Impersonate this user when using a business account. + --dropbox-shared-files Instructs rclone to work on individual shared files. + --dropbox-shared-folders Instructs rclone to work on shared folders. --dropbox-token string OAuth Access Token as a JSON blob. --dropbox-token-url string Token server url. --fichier-api-key string Your API Key, get it from https://1fichier.com/console/params.pl --fichier-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) --fichier-shared-folder string If you want to download a shared folder, add this parameter + --filefabric-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --filefabric-permanent-token string Permanent Authentication Token + --filefabric-root-folder-id string ID of the root folder + --filefabric-token string Session Token + --filefabric-token-expiry string Token expiry time + --filefabric-url string URL of the Enterprise File Fabric to connect to + --filefabric-version string Version read from the file fabric --ftp-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited --ftp-disable-epsv Disable using EPSV even if server advertises support + --ftp-disable-mlsd Disable using MLSD even if server advertises support --ftp-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) - --ftp-explicit-tls Use FTP over TLS (Explicit) + --ftp-explicit-tls Use Explicit FTPS (FTP over TLS) --ftp-host string FTP host to connect to --ftp-no-check-certificate Do not verify the TLS certificate of the server --ftp-pass string FTP password (obscured) --ftp-port string FTP port, leave blank to use default (21) - --ftp-tls Use FTPS over TLS (Implicit) + --ftp-tls Use Implicit FTPS (FTP over TLS) --ftp-user string FTP username, leave blank for current username, $USER --gcs-anonymous Access public buckets and objects without credentials --gcs-auth-url string Auth server URL. @@ -317,11 +338,17 @@ and may be set in the config file. --gphotos-auth-url string Auth server URL. --gphotos-client-id string OAuth Client Id --gphotos-client-secret string OAuth Client Secret + --gphotos-include-archived Also view and download archived media. --gphotos-read-only Set to make the Google Photos backend read only. --gphotos-read-size Set to read the size of media items. --gphotos-start-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) --gphotos-token string OAuth Access Token as a JSON blob. --gphotos-token-url string Token server url. + --hdfs-data-transfer-protection string Kerberos data transfer protection: authentication|integrity|privacy + --hdfs-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot) + --hdfs-namenode string hadoop name node and port + --hdfs-service-principal-name string Kerberos service principal name for the namenode + --hdfs-username string hadoop user name --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 / @@ -354,6 +381,7 @@ and may be set in the config file. --local-no-sparse Disable sparse files for multi-thread downloads --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) --local-nounc string Disable UNC (long path names) conversion on Windows + --local-zero-size-links Assume the Stat size of links is zero (and read them instead) --mailru-check-hash What should copy do if file checksum is mismatched or invalid (default true) --mailru-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) --mailru-pass string Password (obscured) @@ -374,9 +402,13 @@ and may be set in the config file. --onedrive-client-secret string OAuth Client Secret --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) - --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + --onedrive-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) --onedrive-expose-onenote-files Set to make OneNote files show up in directory listings. + --onedrive-link-password string Set the password for links created by the link command. + --onedrive-link-scope string Set the scope of the links created by the link command. (default "anonymous") + --onedrive-link-type string Set the type of the links created by the link command. (default "view") --onedrive-no-versions Remove all versions on modifying operations + --onedrive-region string Choose national cloud region for OneDrive. (default "global") --onedrive-server-side-across-configs Allow server-side operations (e.g. copy) to work across different onedrive configs. --onedrive-token string OAuth Access Token as a JSON blob. --onedrive-token-url string Token server url. @@ -410,6 +442,7 @@ and may be set in the config file. --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) --s3-disable-checksum Don't store MD5 checksum with object metadata + --s3-disable-http2 Disable usage of http2 for S3 backends --s3-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) --s3-endpoint string Endpoint for S3 API. --s3-env-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). @@ -421,16 +454,18 @@ and may be set in the config file. --s3-memory-pool-flush-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) --s3-memory-pool-use-mmap Whether to use mmap buffers in internal memory pool. --s3-no-check-bucket If set, don't attempt to check the bucket exists or create it + --s3-no-head If set, don't HEAD uploaded objects to check integrity --s3-profile string Profile to use in the shared credentials file --s3-provider string Choose your S3 provider. --s3-region string Region to connect to. + --s3-requester-pays Enables requester pays option when interacting with S3 bucket. --s3-secret-access-key string AWS Secret Access Key (password) --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. --s3-session-token string An AWS session token --s3-shared-credentials-file string Path to the shared credentials file --s3-sse-customer-algorithm string If using SSE-C, the server-side encryption algorithm used when storing this object in S3. --s3-sse-customer-key string If using SSE-C you must provide the secret encryption key used to encrypt/decrypt your data. - --s3-sse-customer-key-md5 string If using SSE-C you must provide the secret encryption key MD5 checksum. + --s3-sse-customer-key-md5 string If using SSE-C you may provide the secret encryption key MD5 checksum (optional). --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) @@ -452,17 +487,20 @@ and may be set in the config file. --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. (obscured) --sftp-key-pem string Raw PEM-encoded private key, If specified, will override key_file parameter. --sftp-key-use-agent When set forces the usage of the ssh-agent. + --sftp-known-hosts-file string Optional path to known_hosts file. --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. --sftp-pass string SSH password, leave blank to use ssh-agent. (obscured) --sftp-path-override string Override path used by SSH connection. --sftp-port string SSH port, leave blank to use default (22) + --sftp-pubkey-file string Optional path to public key file. --sftp-server-command string Specifies the path or command to run a sftp server on the remote host. --sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. --sftp-skip-links Set to skip any symlinks and any other non regular files. --sftp-subsystem string Specifies the SSH2 subsystem on the remote host. (default "sftp") + --sftp-use-fstat If set use fstat instead of stat --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 + --sftp-user string SSH username, leave blank for current username, $USER --sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) --sharefile-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) --sharefile-endpoint string Endpoint for API calls. @@ -492,6 +530,7 @@ and may be set in the config file. --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-leave-parts-on-error If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions. --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 @@ -523,4 +562,6 @@ and may be set in the config file. --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-token string OAuth Access Token as a JSON blob. --yandex-token-url string Token server url. + --zoho-encoding MultiEncoder This sets the encoding for the backend. (default Del,Ctl,InvalidUtf8) + --zoho-region string Zoho region to connect to. You'll have to use the region you organization is registered in. ``` diff --git a/docs/content/ftp.md b/docs/content/ftp.md index 4366499a6..263f57ae3 100644 --- a/docs/content/ftp.md +++ b/docs/content/ftp.md @@ -160,9 +160,9 @@ FTP password #### --ftp-tls -Use FTPS over TLS (Implicit) -When using implicit FTP over TLS the client will connect using TLS -right from the start, which in turn breaks the compatibility with +Use Implicit FTPS (FTP over TLS) +When using implicit FTP over TLS the client connects using TLS +right from the start which breaks compatibility with non-TLS-aware servers. This is usually served over port 990 rather than port 21. Cannot be used in combination with explicit FTP. @@ -173,8 +173,8 @@ than port 21. Cannot be used in combination with explicit FTP. #### --ftp-explicit-tls -Use FTP over TLS (Explicit) -When using explicit FTP over TLS the client explicitly request +Use Explicit FTPS (FTP over TLS) +When using explicit FTP over TLS the client explicitly requests security from the server in order to upgrade a plain text connection to an encrypted one. Cannot be used in combination with implicit FTP. @@ -214,6 +214,15 @@ Disable using EPSV even if server advertises support - Type: bool - Default: false +#### --ftp-disable-mlsd + +Disable using MLSD even if server advertises support + +- Config: disable_mlsd +- Env Var: RCLONE_FTP_DISABLE_MLSD +- Type: bool +- Default: false + #### --ftp-encoding This sets the encoding for the backend. diff --git a/docs/content/googlephotos.md b/docs/content/googlephotos.md index 5667841a1..5a6ceb9a8 100644 --- a/docs/content/googlephotos.md +++ b/docs/content/googlephotos.md @@ -403,7 +403,7 @@ you want to read the media. #### --gphotos-start-year -Year limits the photos to be downloaded to those which were uploaded after the given year +Year limits the photos to be downloaded to those which are uploaded after the given year - Config: start_year - Env Var: RCLONE_GPHOTOS_START_YEAR diff --git a/docs/content/hdfs.md b/docs/content/hdfs.md index da92311a4..b6b1c8945 100644 --- a/docs/content/hdfs.md +++ b/docs/content/hdfs.md @@ -190,7 +190,7 @@ Here are the advanced options specific to hdfs (Hadoop distributed file system). Kerberos service principal name for the namenode Enables KERBEROS authentication. Specifies the Service Principal Name -(SERVICE>/) for the namenode. +(/) for the namenode. - Config: service_principal_name - Env Var: RCLONE_HDFS_SERVICE_PRINCIPAL_NAME diff --git a/docs/content/local.md b/docs/content/local.md index 780306f32..e91c46d7f 100644 --- a/docs/content/local.md +++ b/docs/content/local.md @@ -347,6 +347,24 @@ points, as you explicitly acknowledge that they should be skipped. - Type: bool - Default: false +#### --local-zero-size-links + +Assume the Stat size of links is zero (and read them instead) + +On some virtual filesystems (such ash LucidLink), reading a link size via a Stat call always returns 0. +However, on unix it reads as the length of the text in the link. This may cause errors like this when +syncing: + + Failed to copy: corrupted on transfer: sizes differ 0 vs 13 + +Setting this flag causes rclone to read the link and use that as the size of the link +instead of 0 which in most cases fixes the problem. + +- Config: zero_size_links +- Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS +- Type: bool +- Default: false + #### --local-no-unicode-normalization Don't apply unicode normalization to paths and filenames (Deprecated) diff --git a/docs/content/mailru.md b/docs/content/mailru.md index 3e5f43a64..948cf3740 100644 --- a/docs/content/mailru.md +++ b/docs/content/mailru.md @@ -194,6 +194,7 @@ 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. +It is meaningless and ineffective if source file is unique or encrypted. 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 @@ -296,7 +297,7 @@ 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 +Supported quirks: atomicmkdir binlist unknowndirs - Config: quirks - Env Var: RCLONE_MAILRU_QUIRKS diff --git a/docs/content/onedrive.md b/docs/content/onedrive.md index 7e3c98ee3..e3cdbf336 100644 --- a/docs/content/onedrive.md +++ b/docs/content/onedrive.md @@ -215,6 +215,24 @@ Leave blank normally. - Type: string - Default: "" +#### --onedrive-region + +Choose national cloud region for OneDrive. + +- Config: region +- Env Var: RCLONE_ONEDRIVE_REGION +- Type: string +- Default: "global" +- Examples: + - "global" + - Microsoft Cloud Global + - "us" + - Microsoft Cloud for US Government + - "de" + - Microsoft Cloud Germany + - "cn" + - Azure and Office 365 operated by 21Vianet in China + ### Advanced Options Here are the advanced options specific to onedrive (Microsoft OneDrive). @@ -298,10 +316,9 @@ listing, set this option. Allow server-side operations (e.g. copy) to work across different onedrive configs. -This can be useful if you wish to do a server-side copy between two -different Onedrives. Note that this isn't enabled by default -because it isn't easy to tell if it will work between any two -configurations. +This will only work if you are copying between two OneDrive *Personal* drives AND +the files to copy are already shared between them. In other cases, rclone will +fall back to normal copy (which will be slightly slower). - Config: server_side_across_configs - Env Var: RCLONE_ONEDRIVE_SERVER_SIDE_ACROSS_CONFIGS @@ -329,6 +346,48 @@ this flag there. - Type: bool - Default: false +#### --onedrive-link-scope + +Set the scope of the links created by the link command. + +- Config: link_scope +- Env Var: RCLONE_ONEDRIVE_LINK_SCOPE +- Type: string +- Default: "anonymous" +- Examples: + - "anonymous" + - Anyone with the link has access, without needing to sign in. This may include people outside of your organization. Anonymous link support may be disabled by an administrator. + - "organization" + - Anyone signed into your organization (tenant) can use the link to get access. Only available in OneDrive for Business and SharePoint. + +#### --onedrive-link-type + +Set the type of the links created by the link command. + +- Config: link_type +- Env Var: RCLONE_ONEDRIVE_LINK_TYPE +- Type: string +- Default: "view" +- Examples: + - "view" + - Creates a read-only link to the item. + - "edit" + - Creates a read-write link to the item. + - "embed" + - Creates an embeddable link to the item. + +#### --onedrive-link-password + +Set the password for links created by the link command. + +At the time of writing this only works with OneDrive personal paid accounts. + + +- Config: link_password +- Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD +- Type: string +- Default: "" + #### --onedrive-encoding This sets the encoding for the backend. @@ -338,7 +397,7 @@ See: the [encoding section in the overview](/overview/#encoding) for more info. - Config: encoding - Env Var: RCLONE_ONEDRIVE_ENCODING - Type: MultiEncoder -- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot {{< rem autogenerated options stop >}} diff --git a/docs/content/rc.md b/docs/content/rc.md index 537e0dfd9..34de3aa05 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -477,18 +477,30 @@ See the [config update command](/commands/rclone_config_update/) command for mor ### core/bwlimit: Set the bandwidth limit. {#core-bwlimit} -This sets the bandwidth limit to that passed in. +This sets the bandwidth limit to the string passed in. This should be +a single bandwidth limit entry or a pair of upload:download bandwidth. Eg rclone rc core/bwlimit rate=off { "bytesPerSecond": -1, + "bytesPerSecondTx": -1, + "bytesPerSecondRx": -1, "rate": "off" } rclone rc core/bwlimit rate=1M { "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 1048576, + "rate": "1M" + } + rclone rc core/bwlimit rate=1M:100k + { + "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 131072, "rate": "1M" } @@ -498,6 +510,8 @@ If the rate parameter is not supplied then the bandwidth is queried rclone rc core/bwlimit { "bytesPerSecond": 1048576, + "bytesPerSecondTx": 1048576, + "bytesPerSecondRx": 1048576, "rate": "1M" } @@ -514,17 +528,22 @@ This takes the following parameters - command - a string with the command name - arg - a list of arguments for the backend command - opt - a map of string to string of options +- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") + - defaults to "COMBINED_OUTPUT" if not set + - the STREAM returnTypes will write the output to the body of the HTTP message + - the COMBINED_OUTPUT will write the output to the "result" parameter Returns - result - result from the backend command + - only set when using returnType "COMBINED_OUTPUT" - error - set if rclone exits with an error code -- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT". "STREAM_ONLY_STDERR") +- returnType - one of ("COMBINED_OUTPUT", "STREAM", "STREAM_ONLY_STDOUT", "STREAM_ONLY_STDERR") For example rclone rc core/command command=ls -a mydrive:/ -o max-depth=1 - rclone rc core/command -a ls -a mydrive:/ -o max-depth=1 + rclone rc core/command -a ls -a mydrive:/ -o max-depth=1 Returns diff --git a/docs/content/s3.md b/docs/content/s3.md index 37b4fa1fb..e634e5de6 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -570,10 +570,10 @@ Choose your S3 provider. - Scaleway Object Storage - "StackPath" - StackPath Object Storage - - "Wasabi" - - Wasabi Object Storage - "TencentCOS" - Tencent Cloud Object Storage (COS) + - "Wasabi" + - Wasabi Object Storage - "Other" - Any other S3 compatible provider @@ -628,12 +628,12 @@ Region to connect to. - "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. + - "us-west-2" + - US West (Oregon) Region + - Needs location constraint us-west-2. - "ca-central-1" - Canada (Central) Region - Needs location constraint ca-central-1. @@ -643,9 +643,15 @@ Region to connect to. - "eu-west-2" - EU (London) Region - Needs location constraint eu-west-2. + - "eu-west-3" + - EU (Paris) Region + - Needs location constraint eu-west-3. - "eu-north-1" - EU (Stockholm) Region - Needs location constraint eu-north-1. + - "eu-south-1" + - EU (Milan) Region + - Needs location constraint eu-south-1. - "eu-central-1" - EU (Frankfurt) Region - Needs location constraint eu-central-1. @@ -661,6 +667,9 @@ Region to connect to. - "ap-northeast-2" - Asia Pacific (Seoul) - Needs location constraint ap-northeast-2. + - "ap-northeast-3" + - Asia Pacific (Osaka-Local) + - Needs location constraint ap-northeast-3. - "ap-south-1" - Asia Pacific (Mumbai) - Needs location constraint ap-south-1. @@ -670,6 +679,24 @@ Region to connect to. - "sa-east-1" - South America (Sao Paulo) Region - Needs location constraint sa-east-1. + - "me-south-1" + - Middle East (Bahrain) Region + - Needs location constraint me-south-1. + - "af-south-1" + - Africa (Cape Town) Region + - Needs location constraint af-south-1. + - "cn-north-1" + - China (Beijing) Region + - Needs location constraint cn-north-1. + - "cn-northwest-1" + - China (Ningxia) Region + - Needs location constraint cn-northwest-1. + - "us-gov-east-1" + - AWS GovCloud (US-East) Region + - Needs location constraint us-gov-east-1. + - "us-gov-west-1" + - AWS GovCloud (US) Region + - Needs location constraint us-gov-west-1. #### --s3-region @@ -925,6 +952,54 @@ Endpoint for StackPath Object Storage. #### --s3-endpoint +Endpoint for Tencent COS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - "cos.ap-beijing.myqcloud.com" + - Beijing Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-shanghai.myqcloud.com" + - Shanghai Region. + - "cos.ap-guangzhou.myqcloud.com" + - Guangzhou Region. + - "cos.ap-nanjing.myqcloud.com" + - Nanjing Region. + - "cos.ap-chengdu.myqcloud.com" + - Chengdu Region. + - "cos.ap-chongqing.myqcloud.com" + - Chongqing Region. + - "cos.ap-hongkong.myqcloud.com" + - Hong Kong (China) Region. + - "cos.ap-singapore.myqcloud.com" + - Singapore Region. + - "cos.ap-mumbai.myqcloud.com" + - Mumbai Region. + - "cos.ap-seoul.myqcloud.com" + - Seoul Region. + - "cos.ap-bangkok.myqcloud.com" + - Bangkok Region. + - "cos.ap-tokyo.myqcloud.com" + - Tokyo Region. + - "cos.na-siliconvalley.myqcloud.com" + - Silicon Valley Region. + - "cos.na-ashburn.myqcloud.com" + - Virginia Region. + - "cos.na-toronto.myqcloud.com" + - Toronto Region. + - "cos.eu-frankfurt.myqcloud.com" + - Frankfurt Region. + - "cos.eu-moscow.myqcloud.com" + - Moscow Region. + - "cos.accelerate.myqcloud.com" + - Use Tencent COS Accelerate Endpoint. + +#### --s3-endpoint + Endpoint for S3 API. Required when using an S3 clone. @@ -962,18 +1037,22 @@ Used when creating buckets only. - 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. + - "us-west-2" + - US West (Oregon) Region. - "ca-central-1" - Canada (Central) Region. - "eu-west-1" - EU (Ireland) Region. - "eu-west-2" - EU (London) Region. + - "eu-west-3" + - EU (Paris) Region. - "eu-north-1" - EU (Stockholm) Region. + - "eu-south-1" + - EU (Milan) Region. - "EU" - EU Region. - "ap-southeast-1" @@ -983,13 +1062,27 @@ Used when creating buckets only. - "ap-northeast-1" - Asia Pacific (Tokyo) Region. - "ap-northeast-2" - - Asia Pacific (Seoul) + - Asia Pacific (Seoul) Region. + - "ap-northeast-3" + - Asia Pacific (Osaka-Local) Region. - "ap-south-1" - - Asia Pacific (Mumbai) + - Asia Pacific (Mumbai) Region. - "ap-east-1" - - Asia Pacific (Hong Kong) + - Asia Pacific (Hong Kong) Region. - "sa-east-1" - South America (Sao Paulo) Region. + - "me-south-1" + - Middle East (Bahrain) Region. + - "af-south-1" + - Africa (Cape Town) Region. + - "cn-north-1" + - China (Beijing) Region + - "cn-northwest-1" + - China (Ningxia) Region. + - "us-gov-east-1" + - AWS GovCloud (US-East) Region. + - "us-gov-west-1" + - AWS GovCloud (US) Region. #### --s3-location-constraint @@ -1092,6 +1185,8 @@ doesn't copy the ACL from the source but rather writes a fresh one. - Type: string - Default: "" - Examples: + - "default" + - Owner gets Full_CONTROL. No one else has access rights (default). - "private" - Owner gets FULL_CONTROL. No one else has access rights (default). - "public-read" @@ -1192,6 +1287,24 @@ The storage class to use when storing new objects in OSS. #### --s3-storage-class +The storage class to use when storing new objects in Tencent COS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - "STANDARD" + - Standard storage class + - "ARCHIVE" + - Archive storage mode. + - "STANDARD_IA" + - Infrequent access storage mode. + +#### --s3-storage-class + The storage class to use when storing new objects in S3. - Config: storage_class @@ -1208,7 +1321,7 @@ The storage class to use when storing new objects in S3. ### Advanced Options -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, Tencent COS). +Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS). #### --s3-bucket-acl @@ -1234,6 +1347,15 @@ isn't set then "acl" is used instead. - "authenticated-read" - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. +#### --s3-requester-pays + +Enables requester pays option when interacting with S3 bucket. + +- Config: requester_pays +- Env Var: RCLONE_S3_REQUESTER_PAYS +- Type: bool +- Default: false + #### --s3-sse-customer-algorithm If using SSE-C, the server-side encryption algorithm used when storing this object in S3. @@ -1262,7 +1384,10 @@ If using SSE-C you must provide the secret encryption key used to encrypt/decryp #### --s3-sse-customer-key-md5 -If using SSE-C you must provide the secret encryption key MD5 checksum. +If using SSE-C you may provide the secret encryption key MD5 checksum (optional). + +If you leave it blank, this is calculated automatically from the sse_customer_key provided. + - Config: sse_customer_key_md5 - Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 @@ -1429,7 +1554,7 @@ if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. -Some providers (e.g. AWS, Aliyun OSS or Netease COS) require this set to +Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting. @@ -1499,12 +1624,53 @@ If set, don't attempt to check the bucket exists or create it This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already. +It can also be needed if the user you are using does not have bucket +creation permissions. Before v1.52.0 this would have passed silently +due to a bug. + - Config: no_check_bucket - Env Var: RCLONE_S3_NO_CHECK_BUCKET - Type: bool - Default: false +#### --s3-no-head + +If set, don't HEAD uploaded objects to check integrity + +This can be useful when trying to minimise the number of transactions +rclone does. + +Setting it means that if rclone receives a 200 OK message after +uploading an object with PUT then it will assume that it got uploaded +properly. + +In particular it will assume: + +- the metadata, including modtime, storage class and content type was as uploaded +- the size was as uploaded + +It reads the following items from the response for a single part PUT: + +- the MD5SUM +- The uploaded date + +For multipart uploads these items aren't read. + +If an source object of unknown length is uploaded then rclone **will** do a +HEAD request. + +Setting this flag increases the chance for undetected upload failures, +in particular an incorrect size, so it isn't recommended for normal +operation. In practice the chance of an undetected upload failure is +very small even with this flag. + + +- Config: no_head +- Env Var: RCLONE_S3_NO_HEAD +- Type: bool +- Default: false + #### --s3-encoding This sets the encoding for the backend. @@ -1536,6 +1702,23 @@ Whether to use mmap buffers in internal memory pool. - Type: bool - Default: false +#### --s3-disable-http2 + +Disable usage of http2 for S3 backends + +There is currently an unsolved issue with the s3 (specifically minio) backend +and HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be +disabled here. When the issue is solved this flag will be removed. + +See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631 + + + +- Config: disable_http2 +- Env Var: RCLONE_S3_DISABLE_HTTP2 +- Type: bool +- Default: false + ### Backend commands Here are the commands specific to the s3 backend. diff --git a/docs/content/sftp.md b/docs/content/sftp.md index f3dab1dc1..172220011 100644 --- a/docs/content/sftp.md +++ b/docs/content/sftp.md @@ -478,6 +478,24 @@ The subsystem option is ignored when server_command is defined. - Type: string - Default: "" +#### --sftp-use-fstat + +If set use fstat instead of stat + +Some servers limit the amount of open files and calling Stat after opening +the file will throw an error from the server. Setting this flag will call +Fstat instead of Stat which is called on an already open file handle. + +It has been found that this helps with IBM Sterling SFTP servers which have +"extractability" level set to 1 which means only 1 file can be opened at +any given time. + + +- Config: use_fstat +- Env Var: RCLONE_SFTP_USE_FSTAT +- Type: bool +- Default: false + {{< rem autogenerated options stop >}} ### Limitations ### diff --git a/docs/content/swift.md b/docs/content/swift.md index 8544e0741..7e62f3ecd 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -430,6 +430,15 @@ provider. Here are the advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)). +#### --swift-leave-parts-on-error + +If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions. + +- Config: leave_parts_on_error +- Env Var: RCLONE_SWIFT_LEAVE_PARTS_ON_ERROR +- Type: bool +- Default: false + #### --swift-chunk-size Above this size files will be chunked into a _segments container. diff --git a/docs/content/zoho.md b/docs/content/zoho.md index 478f1ba8d..3e76285a0 100644 --- a/docs/content/zoho.md +++ b/docs/content/zoho.md @@ -127,59 +127,28 @@ from filenames during upload. Here are the standard options specific to zoho (Zoho). -#### --zoho-client-id +#### --zoho-region -OAuth Client Id -Leave blank normally. +Zoho region to connect to. You'll have to use the region you organization is registered in. -- Config: client_id -- Env Var: RCLONE_ZOHO_CLIENT_ID -- Type: string -- Default: "" - -#### --zoho-client-secret - -OAuth Client Secret -Leave blank normally. - -- Config: client_secret -- Env Var: RCLONE_ZOHO_CLIENT_SECRET +- Config: region +- Env Var: RCLONE_ZOHO_REGION - Type: string - Default: "" +- Examples: + - "com" + - United states / Global + - "eu" + - Europe + - "in" + - India + - "com.au" + - Australia ### Advanced Options Here are the advanced options specific to zoho (Zoho). -#### --zoho-token - -OAuth Access Token as a JSON blob. - -- Config: token -- Env Var: RCLONE_ZOHO_TOKEN -- Type: string -- Default: "" - -#### --zoho-auth-url - -Auth server URL. -Leave blank to use the provider defaults. - -- Config: auth_url -- Env Var: RCLONE_ZOHO_AUTH_URL -- Type: string -- Default: "" - -#### --zoho-token-url - -Token server url. -Leave blank to use the provider defaults. - -- Config: token_url -- Env Var: RCLONE_ZOHO_TOKEN_URL -- Type: string -- Default: "" - #### --zoho-encoding This sets the encoding for the backend. diff --git a/go.sum b/go.sum index ff26fa401..77c34fc14 100644 --- a/go.sum +++ b/go.sum @@ -120,8 +120,6 @@ github.com/btcsuite/goleveldb v0.0.0-20160330041536-7834afc9e8cd/go.mod h1:F+uVa github.com/btcsuite/snappy-go v0.0.0-20151229074030-0bdef8d06723/go.mod h1:8woku9dyThutzjeg+3xrA5iCpBRH8XEEg3lh6TiUghc= github.com/btcsuite/websocket v0.0.0-20150119174127-31079b680792/go.mod h1:ghJtEyQwv5/p4Mg4C0fgbePVuGr935/5ddU9Z3TmDRY= github.com/btcsuite/winsvc v1.0.0/go.mod h1:jsenWakMcC0zFBFurPLEAyrnc/teJEM1O46fmI40EZs= -github.com/buengese/sgzip v0.1.0 h1:Ti0JwfuRhcjZkFKk+RY+P+CtZ+puw9xjTqKgFgnfEsg= -github.com/buengese/sgzip v0.1.0/go.mod h1:i5ZiXGF3fhV7gL1xaRRL1nDnmpNj0X061FQzOS8VMas= github.com/buengese/sgzip v0.1.1 h1:ry+T8l1mlmiWEsDrH/YHZnCVWD2S3im1KLsyO+8ZmTU= github.com/buengese/sgzip v0.1.1/go.mod h1:i5ZiXGF3fhV7gL1xaRRL1nDnmpNj0X061FQzOS8VMas= github.com/calebcase/tmpfile v1.0.2-0.20200602150926-3af473ef8439/go.mod h1:iErLeG/iqJr8LaQ/gYRv4GXdqssi3jg4iSzvrA06/lw= diff --git a/rclone.1 b/rclone.1 index a7aae105f..6a09bdded 100644 --- a/rclone.1 +++ b/rclone.1 @@ -1,7 +1,7 @@ .\"t .\" Automatically generated by Pandoc 2.5 .\" -.TH "rclone" "1" "Sep 02, 2020" "User Manual" "" +.TH "rclone" "1" "Feb 02, 2021" "User Manual" "" .hy .SH Rclone syncs your files to cloud storage .PP @@ -44,13 +44,14 @@ Transfers over limited bandwidth; intermittent connections, or subject to quota can be restarted, from the last good file transferred. You can check (https://rclone.org/commands/rclone_check/) the integrity of your files. -Where possible, rclone employs server side transfers to minimise local +Where possible, rclone employs server\-side transfers to minimise local bandwidth use and transfers from one provider to another without using local disk. .PP Virtual backends wrap local and cloud file systems to apply encryption (https://rclone.org/crypt/), caching (https://rclone.org/cache/), +compression (https://rclone.org/compress/) chunking (https://rclone.org/chunker/) and joining (https://rclone.org/union/). .PP @@ -109,7 +110,8 @@ Timestamps are preserved on files .IP \[bu] 2 Operations can be restarted at any time .IP \[bu] 2 -Can be to and from network, eg two different cloud providers +Can be to and from network, e.g. +two different cloud providers .IP \[bu] 2 Can use multi\-threaded downloads to local disk .RE @@ -163,6 +165,8 @@ Dreamhost .IP \[bu] 2 Dropbox .IP \[bu] 2 +Enterprise File Fabric +.IP \[bu] 2 FTP .IP \[bu] 2 Google Cloud Storage @@ -171,6 +175,8 @@ Google Drive .IP \[bu] 2 Google Photos .IP \[bu] 2 +HDFS +.IP \[bu] 2 HTTP .IP \[bu] 2 Hubic @@ -231,12 +237,16 @@ SugarSync .IP \[bu] 2 Tardigrade .IP \[bu] 2 +Tencent Cloud Object Storage (COS) +.IP \[bu] 2 Wasabi .IP \[bu] 2 WebDAV .IP \[bu] 2 Yandex Disk .IP \[bu] 2 +Zoho WorkDrive +.IP \[bu] 2 The local filesystem .PP Links @@ -414,8 +424,8 @@ a minimal Alpine linux image. The \f[C]:latest\f[R] tag will always point to the latest stable release. You can use the \f[C]:beta\f[R] tag to get the latest build from master. -You can also use version tags, eg \f[C]:1.49.1\f[R], \f[C]:1.49\f[R] or -\f[C]:1\f[R]. +You can also use version tags, e.g. +\f[C]:1.49.1\f[R], \f[C]:1.49\f[R] or \f[C]:1\f[R]. .IP .nf \f[C] @@ -505,7 +515,7 @@ kill %1 .fi .SS Install from source .PP -Make sure you have at least Go (https://golang.org/) 1.11 installed. +Make sure you have at least Go (https://golang.org/) 1.12 installed. Download go (https://golang.org/dl/) if necessary. The latest release is recommended. Then @@ -544,7 +554,7 @@ These will build the binary in \f[C]$(go env GOPATH)/bin\f[R] (\f[C]\[ti]/go/bin/rclone\f[R] by default) after downloading the source to the go module cache. Note \- do \f[B]not\f[R] use the \f[C]\-u\f[R] flag here. -This causes go to try to update the depencencies that rclone uses and +This causes go to try to update the dependencies that rclone uses and sometimes these don\[aq]t work with the current version of rclone. .SS Installation with Ansible .PP @@ -603,12 +613,16 @@ files for other remotes .IP \[bu] 2 Citrix ShareFile (https://rclone.org/sharefile/) .IP \[bu] 2 +Compress (https://rclone.org/compress/) +.IP \[bu] 2 Crypt (https://rclone.org/crypt/) \- to encrypt other remotes .IP \[bu] 2 DigitalOcean Spaces (https://rclone.org/s3/#digitalocean-spaces) .IP \[bu] 2 Dropbox (https://rclone.org/dropbox/) .IP \[bu] 2 +Enterprise File Fabric (https://rclone.org/filefabric/) +.IP \[bu] 2 FTP (https://rclone.org/ftp/) .IP \[bu] 2 Google Cloud Storage (https://rclone.org/googlecloudstorage/) @@ -617,6 +631,8 @@ Google Drive (https://rclone.org/drive/) .IP \[bu] 2 Google Photos (https://rclone.org/googlephotos/) .IP \[bu] 2 +HDFS (https://rclone.org/hdfs/) +.IP \[bu] 2 HTTP (https://rclone.org/http/) .IP \[bu] 2 Hubic (https://rclone.org/hubic/) @@ -662,6 +678,8 @@ WebDAV (https://rclone.org/webdav/) .IP \[bu] 2 Yandex Disk (https://rclone.org/yandex/) .IP \[bu] 2 +Zoho WorkDrive (https://rclone.org/zoho/) +.IP \[bu] 2 The local filesystem (https://rclone.org/local/) .SS Usage .PP @@ -676,7 +694,7 @@ Syntax: [options] subcommand .fi .PP Source and destination paths are specified by the name you gave the -storage system in the config file then the sub path, eg +storage system in the config file then the sub path, e.g. \[dq]drive:myfolder\[dq] to look at \[dq]myfolder\[dq] in Google drive. .PP You can define as many storage paths as you like in the config file. @@ -766,7 +784,7 @@ userinfo (https://rclone.org/commands/rclone_config_userinfo/) \- Prints info about logged in user of remote. .SH rclone copy .PP -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. .SS Synopsis .PP Copy the source to the destination. @@ -817,8 +835,8 @@ destpath/sourcepath/two.txt .fi .PP If you are familiar with \f[C]rsync\f[R], rclone always works as if you -had written a trailing / \- meaning \[dq]copy the contents of this -directory\[dq]. +had written a trailing \f[C]/\f[R] \- meaning \[dq]copy the contents of +this directory\[dq]. This applies to all commands and whether you are talking about the source or destination. .PP @@ -926,16 +944,16 @@ Move files from source to dest. .PP Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote -does not support a server side directory move operation. +does not support a server\-side directory move operation. .PP -If no filters are in use and if possible this will server side move +If no filters are in use and if possible this will server\-side move \f[C]source:path\f[R] into \f[C]dest:path\f[R]. After this \f[C]source:path\f[R] will no longer exist. .PP Otherwise for each file in \f[C]source:path\f[R] selected by the filters (if any) this will move it into \f[C]dest:path\f[R]. -If possible a server side move will be used, otherwise it will copy it -(server side if possible) into \f[C]dest:path\f[R] then delete the +If possible a server\-side move will be used, otherwise it will copy it +(server\-side if possible) into \f[C]dest:path\f[R] then delete the original (if no errors on copy) in \f[C]source:path\f[R]. .PP If you want to delete empty source directories after move, use the @@ -976,24 +994,25 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone delete .PP -Remove the contents of path. +Remove the files in path. .SS Synopsis .PP Remove the files in path. Unlike \f[C]purge\f[R] it obeys include/exclude filters so can be used to selectively delete files. .PP -\f[C]rclone delete\f[R] only deletes objects but leaves the directory +\f[C]rclone delete\f[R] only deletes files but leaves the directory structure alone. -If you want to delete a directory and all of its contents use -\f[C]rclone purge\f[R] +If you want to delete a directory and all of its contents use the +\f[C]purge\f[R] command. .PP -If you supply the \-\-rmdirs flag, it will remove all empty directories -along with it. +If you supply the \f[C]\-\-rmdirs\f[R] flag, it will remove all empty +directories along with it. +You can also use the separate command \f[C]rmdir\f[R] or +\f[C]rmdirs\f[R] to delete empty directories only. .PP -Eg delete all files bigger than 100MBytes -.PP -Check what would be deleted first (use either) +For example, to delete all files bigger than 100MBytes, you may first +want to check what would be deleted (use either): .IP .nf \f[C] @@ -1002,7 +1021,7 @@ rclone \-\-dry\-run \-\-min\-size 100M delete remote:path \f[R] .fi .PP -Then delete +Then proceed with the actual delete: .IP .nf \f[C] @@ -1045,7 +1064,10 @@ Remove the path and all of its contents. Remove the path and all of its contents. Note that this does not obey include/exclude filters \- everything will be removed. -Use \f[C]delete\f[R] if you want to selectively delete files. +Use the \f[C]delete\f[R] command if you want to selectively delete +files. +To delete empty directories only, use command \f[C]rmdir\f[R] or +\f[C]rmdirs\f[R]. .PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]\-\-dry\-run\f[R] or the \f[C]\-\-interactive\f[R]/\f[C]\-i\f[R] @@ -1073,9 +1095,6 @@ commands, flags and backends. .SH rclone mkdir .PP Make the path if it doesn\[aq]t already exist. -.SS Synopsis -.PP -Make the path if it doesn\[aq]t already exist. .IP .nf \f[C] @@ -1098,12 +1117,16 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone rmdir .PP -Remove the path if empty. +Remove the empty directory at path. .SS Synopsis .PP -Remove the path. -Note that you can\[aq]t remove a path with objects in it, use purge for -that. +This removes empty directory given by path. +Will not remove the path if it has any objects in it, not even empty +subdirectories. +Use command \f[C]rmdirs\f[R] (or \f[C]delete\f[R] with option +\f[C]\-\-rmdirs\f[R]) to do that. +.PP +To delete a path and any objects in it, use \f[C]purge\f[R] command. .IP .nf \f[C] @@ -1134,12 +1157,12 @@ It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don\[aq]t match. It doesn\[aq]t alter the source or destination. .PP -If you supply the \-\-size\-only flag, it will only compare the sizes -not the hashes as well. +If you supply the \f[C]\-\-size\-only\f[R] flag, it will only compare +the sizes not the hashes as well. Use this for a quick check. .PP -If you supply the \-\-download flag, it will download the data from both -remotes and check them against each other on the fly. +If you supply the \f[C]\-\-download\f[R] flag, it will download the data +from both remotes and check them against each other on the fly. This can be useful for remotes that don\[aq]t support hashes or if you really want to check all the data. .PP @@ -1150,7 +1173,7 @@ This means that extra files in the destination that are not in the source will not be detected. .PP The \f[C]\-\-differ\f[R], \f[C]\-\-missing\-on\-dst\f[R], -\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-src\-only\f[R] and +\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-match\f[R] and \f[C]\-\-error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]\-\f[R]) supplied. What they write is described in the help below. @@ -1188,6 +1211,7 @@ rclone check source:path dest:path [flags] \f[C] \-\-combined string Make a combined report of changes to this file \-\-differ string Report all non\-matching files to this file + \-\-download Check by downloading rather than with hash. \-\-error string Report all files with errors (hashing or reading) to this file \-h, \-\-help help for check \-\-match string Report all matching files to this file @@ -1244,14 +1268,14 @@ readable. \f[C]lsjson\f[R] is designed to be machine readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use -\[dq]\-\-max\-depth 1\[dq] to stop the recursion. +\f[C]\-\-max\-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do -not recurse by default \- use \[dq]\-R\[dq] to make them recurse. +not recurse by default \- use \f[C]\-R\f[R] to make them recurse. .PP Listing a non existent directory will produce an error except for -remotes which can\[aq]t have empty directories (eg s3, swift, gcs, etc -\- the bucket based remotes). +remotes which can\[aq]t have empty directories (e.g. +s3, swift, or gcs \- the bucket based remotes). .IP .nf \f[C] @@ -1328,14 +1352,14 @@ readable. \f[C]lsjson\f[R] is designed to be machine readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use -\[dq]\-\-max\-depth 1\[dq] to stop the recursion. +\f[C]\-\-max\-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do -not recurse by default \- use \[dq]\-R\[dq] to make them recurse. +not recurse by default \- use \f[C]\-R\f[R] to make them recurse. .PP Listing a non existent directory will produce an error except for -remotes which can\[aq]t have empty directories (eg s3, swift, gcs, etc -\- the bucket based remotes). +remotes which can\[aq]t have empty directories (e.g. +s3, swift, or gcs \- the bucket based remotes). .IP .nf \f[C] @@ -1398,14 +1422,14 @@ readable. \f[C]lsjson\f[R] is designed to be machine readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use -\[dq]\-\-max\-depth 1\[dq] to stop the recursion. +\f[C]\-\-max\-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do -not recurse by default \- use \[dq]\-R\[dq] to make them recurse. +not recurse by default \- use \f[C]\-R\f[R] to make them recurse. .PP Listing a non existent directory will produce an error except for -remotes which can\[aq]t have empty directories (eg s3, swift, gcs, etc -\- the bucket based remotes). +remotes which can\[aq]t have empty directories (e.g. +s3, swift, or gcs \- the bucket based remotes). .IP .nf \f[C] @@ -1433,6 +1457,11 @@ Produces an md5sum file for all the objects in the path. .PP Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces. +.PP +By default, the hash is requested from the remote. +If MD5 is not supported by the remote, no hash will be returned. +With the download flag, the file will be downloaded from the remote and +hashed locally enabling MD5 for any remote. .IP .nf \f[C] @@ -1443,7 +1472,10 @@ rclone md5sum remote:path [flags] .IP .nf \f[C] - \-h, \-\-help help for md5sum + \-\-base64 Output base64 encoded hashsum + \-\-download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + \-h, \-\-help help for md5sum + \-\-output\-file string Output hashsums to a file rather than the terminal \f[R] .fi .PP @@ -1460,6 +1492,11 @@ Produces an sha1sum file for all the objects in the path. .PP Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces. +.PP +By default, the hash is requested from the remote. +If SHA\-1 is not supported by the remote, no hash will be returned. +With the download flag, the file will be downloaded from the remote and +hashed locally enabling SHA\-1 for any remote. .IP .nf \f[C] @@ -1470,7 +1507,10 @@ rclone sha1sum remote:path [flags] .IP .nf \f[C] - \-h, \-\-help help for sha1sum + \-\-base64 Output base64 encoded hashsum + \-\-download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + \-h, \-\-help help for sha1sum + \-\-output\-file string Output hashsums to a file rather than the terminal \f[R] .fi .PP @@ -1483,9 +1523,6 @@ commands, flags and backends. .SH rclone size .PP Prints the total size and number of objects in remote:path. -.SS Synopsis -.PP -Prints the total size and number of objects in remote:path. .IP .nf \f[C] @@ -1572,7 +1609,7 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone cleanup .PP -Clean up the remote if possible +Clean up the remote if possible. .SS Synopsis .PP Clean up the remote if possible. @@ -1605,30 +1642,44 @@ Interactively find duplicate filenames and delete/rename them. .PP By default \f[C]dedupe\f[R] interactively finds files with duplicate names and offers to delete all but one or rename them to be different. +This is known as deduping by name. .PP -This is only useful with backends like Google Drive which can have -duplicate file names. -It can be run on wrapping backends (eg crypt) if they wrap a backend -which supports duplicate file names. +Deduping by name is only useful with backends like Google Drive which +can have duplicate file names. +It can be run on wrapping backends (e.g. +crypt) if they wrap a backend which supports duplicate file names. .PP -In the first pass it will merge directories with the same name. +However if \-\-by\-hash is passed in then dedupe will find files with +duplicate hashes instead which will work on any backend which supports +at least one hash. +This can be used to find files with duplicate content. +This is known as deduping by hash. +.PP +If deduping by name, first rclone will merge directories with the same +name. It will do this iteratively until all the identically named directories have been merged. .PP -In the second pass, for every group of duplicate file names, it will -delete all but one identical files it finds without confirmation. +Next, if deduping by name, for every group of duplicate file names / +hashes, it will delete all but one identical files it finds without +confirmation. This means that for most duplicated files the \f[C]dedupe\f[R] command will not be interactive. .PP \f[C]dedupe\f[R] considers files to be identical if they have the same -hash. -If the backend does not support hashes (eg crypt wrapping Google Drive) -then they will never be found to be identical. +file path and the same hash. +If the backend does not support hashes (e.g. +crypt wrapping Google Drive) then they will never be found to be +identical. If you use the \f[C]\-\-size\-only\f[R] flag then files will be considered identical if they have the same size (any hash will be ignored). This can be useful on crypt backends which do not support hashes. .PP +Next rclone will resolve the remaining duplicates. +Exactly which action is taken depends on the dedupe mode. +By default rclone will interactively query the user for each one. +.PP \f[B]Important\f[R]: Since this can cause data loss, test first with the \f[C]\-\-dry\-run\f[R] or the \f[C]\-\-interactive\f[R]/\f[C]\-i\f[R] flag. @@ -1667,7 +1718,7 @@ r) Rename all to be different (by changing file.jpg to file\-1.jpg) s/k/r> k Enter the number of the file to keep> 1 one.txt: Deleted 1 extra copies -two.txt: Found 3 files with duplicates names +two.txt: Found 3 files with duplicate names two.txt: 3 duplicates remain 1: 564374 bytes, 2016\-03\-05 16:22:52.118000000, MD5 7594e7dc9fc28f727c42ee3e0749de81 2: 6048320 bytes, 2016\-03\-05 16:22:46.185000000, MD5 1eedaa9fe86fd4b8632e2ac549403b36 @@ -1719,6 +1770,9 @@ keeps the smallest one. .IP \[bu] 2 \f[C]\-\-dedupe\-mode rename\f[R] \- removes identical files then renames the rest to be different. +.IP \[bu] 2 +\f[C]\-\-dedupe\-mode list\f[R] \- lists duplicate dirs and files only +and changes nothing. .PP For example to rename all the identically named photos in your Google Photos directory, do @@ -1746,6 +1800,7 @@ rclone dedupe [mode] remote:path [flags] .IP .nf \f[C] + \-\-by\-hash Find indentical hashes rather than names \-\-dedupe\-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default \[dq]interactive\[dq]) \-h, \-\-help help for dedupe \f[R] @@ -1762,11 +1817,12 @@ commands, flags and backends. Get quota information from the remote. .SS Synopsis .PP -Get quota information from the remote, like bytes used/free/quota and -bytes used in the trash. -Not supported by all remotes. +\f[C]rclone about\f[R]prints quota information about a remote to +standard output. +The output is typically used, free, quota and trash contents. .PP -This will print to stdout something like this: +E.g. +Typical output from\f[C]rclone about remote:\f[R]is: .IP .nf \f[C] @@ -1784,20 +1840,21 @@ Total: total size available. .IP \[bu] 2 Used: total size used .IP \[bu] 2 -Free: total amount this user could upload. +Free: total space available to this user. .IP \[bu] 2 -Trashed: total amount in the trash +Trashed: total space used by trash .IP \[bu] 2 -Other: total amount in other storage (eg Gmail, Google Photos) +Other: total amount in other storage (e.g. +Gmail, Google Photos) .IP \[bu] 2 Objects: total number of objects in the storage .PP -Note that not all the backends provide all the fields \- they will be -missing if they are not known for that backend. -Where it is known that the value is unlimited the value will also be -omitted. +Not all backends print all fields. +Information is not included if it is not provided by a backend. +Where the value is unlimited it is omitted. .PP -Use the \-\-full flag to see the numbers written out in full, eg +Applying a \f[C]\-\-full\f[R] flag to the command prints the bytes in +full, e.g. .IP .nf \f[C] @@ -1809,7 +1866,8 @@ Other: 8849156022 \f[R] .fi .PP -Use the \-\-json flag for a computer readable output, eg +A \f[C]\-\-json\f[R]flag generates conveniently computer readable +output, e.g. .IP .nf \f[C] @@ -1822,6 +1880,11 @@ Use the \-\-json flag for a computer readable output, eg } \f[R] .fi +.PP +Not all backends support the \f[C]rclone about\f[R] command. +.PP +See List of backends that do not support +about (https://rclone.org/overview/#optional-features) .IP .nf \f[C] @@ -1906,7 +1969,7 @@ rclone backend features remote: .fi .PP Pass options to the backend command with \-o. -This should be key=value or key, eg: +This should be key=value or key, e.g.: .IP .nf \f[C] @@ -1977,11 +2040,12 @@ rclone \-\-include \[dq]*.txt\[dq] cat remote:path/to/dir \f[R] .fi .PP -Use the \-\-head flag to print characters only at the start, \-\-tail -for the end and \-\-offset and \-\-count to print a section in the -middle. +Use the \f[C]\-\-head\f[R] flag to print characters only at the start, +\f[C]\-\-tail\f[R] for the end and \f[C]\-\-offset\f[R] and +\f[C]\-\-count\f[R] to print a section in the middle. Note that if offset is negative it will count from the end, so -\-\-offset \-1 \-\-count 1 is equivalent to \-\-tail 1. +\f[C]\-\-offset \-1 \-\-count 1\f[R] is equivalent to +\f[C]\-\-tail 1\f[R]. .IP .nf \f[C] @@ -2040,7 +2104,7 @@ passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the \[dq]\-\-obscure\[dq] flag, or if you are 100% certain you are already passing obscured passwords then use \[dq]\-\-no\-obscure\[dq]. -You can also set osbscured passwords using the \[dq]rclone config +You can also set obscured passwords using the \[dq]rclone config password\[dq] command. .PP So for example if you wanted to configure a Google Drive remote but @@ -2076,9 +2140,6 @@ interactive configuration session. .SH rclone config delete .PP Delete an existing remote \f[C]name\f[R]. -.SS Synopsis -.PP -Delete an existing remote \f[C]name\f[R]. .IP .nf \f[C] @@ -2132,9 +2193,6 @@ interactive configuration session. .SH rclone config dump .PP Dump the config file as JSON. -.SS Synopsis -.PP -Dump the config file as JSON. .IP .nf \f[C] @@ -2186,9 +2244,6 @@ interactive configuration session. .SH rclone config file .PP Show path of configuration file in use. -.SS Synopsis -.PP -Show path of configuration file in use. .IP .nf \f[C] @@ -2250,9 +2305,6 @@ interactive configuration session. .SH rclone config providers .PP List in JSON format all the providers and options. -.SS Synopsis -.PP -List in JSON format all the providers and options. .IP .nf \f[C] @@ -2306,9 +2358,6 @@ interactive configuration session. .SH rclone config show .PP Print (decrypted) config file, or the config for a single remote. -.SS Synopsis -.PP -Print (decrypted) config file, or the config for a single remote. .IP .nf \f[C] @@ -2358,7 +2407,7 @@ passwords into the config file. If you want to be 100% certain that the passwords get obscured then use the \[dq]\-\-obscure\[dq] flag, or if you are 100% certain you are already passing obscured passwords then use \[dq]\-\-no\-obscure\[dq]. -You can also set osbscured passwords using the \[dq]rclone config +You can also set obscured passwords using the \[dq]rclone config password\[dq] command. .PP If the remote uses OAuth the token will be updated, if you don\[aq]t @@ -2421,7 +2470,7 @@ rclone config (https://rclone.org/commands/rclone_config/) \- Enter an interactive configuration session. .SH rclone copyto .PP -Copy files from source to dest, skipping already copied +Copy files from source to dest, skipping already copied. .SS Synopsis .PP If source:path is a file or directory then it copies it to a file or @@ -2562,7 +2611,7 @@ This means that extra files in the destination that are not in the source will not be detected. .PP The \f[C]\-\-differ\f[R], \f[C]\-\-missing\-on\-dst\f[R], -\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-src\-only\f[R] and +\f[C]\-\-missing\-on\-src\f[R], \f[C]\-\-match\f[R] and \f[C]\-\-error\f[R] flags write paths, one per line, to the file name (or stdout if it is \f[C]\-\f[R]) supplied. What they write is described in the help below. @@ -2635,6 +2684,10 @@ rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 rclone cryptdecode \-\-reverse encryptedremote: filename1 filename2 \f[R] .fi +.PP +Another way to accomplish this is by using the +\f[C]rclone backend encode\f[R] (or \f[C]decode\f[R])command. +See the documentation on the \f[C]crypt\f[R] overlay for more info. .IP .nf \f[C] @@ -2726,7 +2779,7 @@ Output bash completion script for rclone. Generates a bash shell autocompletion script for rclone. .PP This writes to /etc/bash_completion.d/rclone by default so will probably -need to be run with sudo or as root, eg +need to be run with sudo or as root, e.g. .IP .nf \f[C] @@ -2744,6 +2797,9 @@ directly .fi .PP If you supply a command line argument the script will be written there. +.PP +If output_file is \[dq]\-\[dq], then the output will be written to +stdout. .IP .nf \f[C] @@ -2773,7 +2829,7 @@ Output fish completion script for rclone. Generates a fish autocompletion script for rclone. .PP This writes to /etc/fish/completions/rclone.fish by default so will -probably need to be run with sudo or as root, eg +probably need to be run with sudo or as root, e.g. .IP .nf \f[C] @@ -2791,6 +2847,9 @@ directly .fi .PP If you supply a command line argument the script will be written there. +.PP +If output_file is \[dq]\-\[dq], then the output will be written to +stdout. .IP .nf \f[C] @@ -2820,7 +2879,7 @@ Output zsh completion script for rclone. Generates a zsh autocompletion script for rclone. .PP This writes to /usr/share/zsh/vendor\-completions/_rclone by default so -will probably need to be run with sudo or as root, eg +will probably need to be run with sudo or as root, e.g. .IP .nf \f[C] @@ -2838,6 +2897,9 @@ autoload \-U compinit && compinit .fi .PP If you supply a command line argument the script will be written there. +.PP +If output_file is \[dq]\-\[dq], then the output will be written to +stdout. .IP .nf \f[C] @@ -2897,7 +2959,12 @@ Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool. .PP -Run without a hash to see the list of supported hashes, eg +By default, the hash is requested from the remote. +If the hash is not supported by the remote, no hash will be returned. +With the download flag, the file will be downloaded from the remote and +hashed locally enabling any hash for any remote. +.PP +Run without a hash to see the list of all supported hashes, e.g. .IP .nf \f[C] @@ -2927,8 +2994,10 @@ rclone hashsum remote:path [flags] .IP .nf \f[C] - \-\-base64 Output base64 encoded hashsum - \-h, \-\-help help for hashsum + \-\-base64 Output base64 encoded hashsum + \-\-download Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote + \-h, \-\-help help for hashsum + \-\-output\-file string Output hashsums to a file rather than the terminal \f[R] .fi .PP @@ -3022,7 +3091,7 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone lsf .PP -List directories and objects in remote:path formatted for parsing +List directories and objects in remote:path formatted for parsing. .SS Synopsis .PP List the contents of the source path (directories and objects) to @@ -3058,7 +3127,7 @@ i \- ID of object o \- Original ID of underlying object m \- MimeType of object if known e \- encrypted name -T \- tier of storage if known, eg \[dq]Hot\[dq] or \[dq]Cool\[dq] +T \- tier of storage if known, e.g. \[dq]Hot\[dq] or \[dq]Cool\[dq] \f[R] .fi .PP @@ -3174,14 +3243,14 @@ readable. \f[C]lsjson\f[R] is designed to be machine readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use -\[dq]\-\-max\-depth 1\[dq] to stop the recursion. +\f[C]\-\-max\-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do -not recurse by default \- use \[dq]\-R\[dq] to make them recurse. +not recurse by default \- use \f[C]\-R\f[R] to make them recurse. .PP Listing a non existent directory will produce an error except for -remotes which can\[aq]t have empty directories (eg s3, swift, gcs, etc -\- the bucket based remotes). +remotes which can\[aq]t have empty directories (e.g. +s3, swift, or gcs \- the bucket based remotes). .IP .nf \f[C] @@ -3241,11 +3310,13 @@ If \-\-hash\-type is set then it implies \-\-hash. .PP If \-\-no\-modtime is specified then ModTime will be blank. This can speed things up on remotes where reading the ModTime takes an -extra request (eg s3, swift). +extra request (e.g. +s3, swift). .PP If \-\-no\-mimetype is specified then MimeType will be blank. This can speed things up on remotes where reading the MimeType takes an -extra request (eg s3, swift). +extra request (e.g. +s3, swift). .PP If \-\-encrypted is not specified the Encrypted won\[aq]t be emitted. .PP @@ -3270,10 +3341,11 @@ This key won\[aq]t be present unless it is \[dq]true\[dq]. The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision that the remote can hold the times, so if times are accurate to the -nearest millisecond (eg Google Drive) then 3 digits will always be shown +nearest millisecond (e.g. +Google Drive) then 3 digits will always be shown (\[dq]2017\-05\-31T16:15:57.034+01:00\[dq]) whereas if the times are -accurate to the nearest second (Dropbox, Box, WebDav etc) no digits will -be shown (\[dq]2017\-05\-31T16:15:57+01:00\[dq]). +accurate to the nearest second (Dropbox, Box, WebDav, etc.) no digits +will be shown (\[dq]2017\-05\-31T16:15:57+01:00\[dq]). .PP The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line. @@ -3298,14 +3370,14 @@ readable. \f[C]lsjson\f[R] is designed to be machine readable. .PP Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use -\[dq]\-\-max\-depth 1\[dq] to stop the recursion. +\f[C]\-\-max\-depth 1\f[R] to stop the recursion. .PP The other list commands \f[C]lsd\f[R],\f[C]lsf\f[R],\f[C]lsjson\f[R] do -not recurse by default \- use \[dq]\-R\[dq] to make them recurse. +not recurse by default \- use \f[C]\-R\f[R] to make them recurse. .PP Listing a non existent directory will produce an error except for -remotes which can\[aq]t have empty directories (eg s3, swift, gcs, etc -\- the bucket based remotes). +remotes which can\[aq]t have empty directories (e.g. +s3, swift, or gcs \- the bucket based remotes). .IP .nf \f[C] @@ -3346,15 +3418,15 @@ Rclone\[aq]s cloud storage systems as a file system with FUSE. First set up your remote using \f[C]rclone config\f[R]. Check it works with \f[C]rclone ls\f[R] etc. .PP -You can either run mount in foreground mode or background (daemon) mode. -Mount runs in foreground mode by default, use the \-\-daemon flag to -specify background mode mode. -Background mode is only supported on Linux and OSX, you can only run -mount in foreground mode on Windows. +On Linux and OSX, you can either run mount in foreground mode or +background (daemon) mode. +Mount runs in foreground mode by default, use the \f[C]\-\-daemon\f[R] +flag to specify background mode. +You can only run mount in foreground mode on Windows. .PP -On Linux/macOS/FreeBSD Start the mount like this where +On Linux/macOS/FreeBSD start the mount like this, where \f[C]/path/to/local/mount\f[R] is an \f[B]empty\f[R] \f[B]existing\f[R] -directory. +directory: .IP .nf \f[C] @@ -3362,28 +3434,32 @@ rclone mount remote:path/to/files /path/to/local/mount \f[R] .fi .PP -Or on Windows like this where \f[C]X:\f[R] is an unused drive letter or -use a path to \f[B]non\-existent\f[R] directory. +On Windows you can start a mount in different ways. +See below for details. +The following examples will mount to an automatically assigned drive, to +specific drive letter \f[C]X:\f[R], to path +\f[C]C:\[rs]path\[rs]to\[rs]nonexistent\[rs]directory\f[R] (which must +be \f[B]non\-existent\f[R] subdirectory of an \f[B]existing\f[R] parent +directory or drive, and is not supported when mounting as a network +drive), and the last example will mount as network share +\f[C]\[rs]\[rs]cloud\[rs]remote\f[R] and map it to an automatically +assigned drive: .IP .nf \f[C] +rclone mount remote:path/to/files * rclone mount remote:path/to/files X: rclone mount remote:path/to/files C:\[rs]path\[rs]to\[rs]nonexistent\[rs]directory +rclone mount remote:path/to/files \[rs]\[rs]cloud\[rs]remote \f[R] .fi .PP -When running in background mode the user will have to stop the mount -manually (specified below). -.PP When the program ends while in foreground mode, either via Ctrl+C or -receiving a SIGINT or SIGTERM signal, the mount is automatically +receiving a SIGINT or SIGTERM signal, the mount should be automatically stopped. .PP -The umount operation can fail, for example when the mountpoint is busy. -When that happens, it is the user\[aq]s responsibility to stop the mount -manually. -.PP -Stopping the mount manually: +When running in background mode the user will have to stop the mount +manually: .IP .nf \f[C] @@ -3393,6 +3469,23 @@ fusermount \-u /path/to/local/mount umount /path/to/local/mount \f[R] .fi +.PP +The umount operation can fail, for example when the mountpoint is busy. +When that happens, it is the user\[aq]s responsibility to stop the mount +manually. +.PP +The size of the mounted file system will be set according to information +retrieved from the remote, the same as returned by the rclone +about (https://rclone.org/commands/rclone_about/) command. +Remotes with unlimited storage may report the used size only, then an +additional 1PB of free space is assumed. +If the remote does not +support (https://rclone.org/overview/#optional-features) the about +feature at all, then 1PB is set as both the total and the free size. +.PP +\f[B]Note\f[R]: As of \f[C]rclone\f[R] 1.52.2, \f[C]rclone mount\f[R] +now requires Go version 1.13 or newer on some platforms depending on the +underlying FUSE library in use. .SS Installing on Windows .PP To run rclone mount on Windows, you will need to download and install @@ -3405,6 +3498,149 @@ It provides a FUSE emulation layer which rclone uses combination with cgofuse (https://github.com/billziss-gh/cgofuse). Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows. +.SS Mounting modes on windows +.PP +Unlike other operating systems, Microsoft Windows provides a different +filesystem type for network and fixed drives. +It optimises access on the assumption fixed disk drives are fast and +reliable, while network drives have relatively high latency and less +reliability. +Some settings can also be differentiated between the two types, for +example that Windows Explorer should just display icons and not create +preview thumbnails for image and video files on network drives. +.PP +In most cases, rclone will mount the remote as a normal, fixed disk +drive by default. +However, you can also choose to mount it as a remote network drive, +often described as a network share. +If you mount an rclone remote using the default, fixed drive mode and +experience unexpected program errors, freezes or other issues, consider +mounting as a network drive instead. +.PP +When mounting as a fixed disk drive you can either mount to an unused +drive letter, or to a path \- which must be \f[B]non\-existent\f[R] +subdirectory of an \f[B]existing\f[R] parent directory or drive. +Using the special value \f[C]*\f[R] will tell rclone to automatically +assign the next available drive letter, starting with Z: and moving +backward. +Examples: +.IP +.nf +\f[C] +rclone mount remote:path/to/files * +rclone mount remote:path/to/files X: +rclone mount remote:path/to/files C:\[rs]path\[rs]to\[rs]nonexistent\[rs]directory +rclone mount remote:path/to/files X: +\f[R] +.fi +.PP +Option \f[C]\-\-volname\f[R] can be used to set a custom volume name for +the mounted file system. +The default is to use the remote name and path. +.PP +To mount as network drive, you can add option +\f[C]\-\-network\-mode\f[R] to your mount command. +Mounting to a directory path is not supported in this mode, it is a +limitation Windows imposes on junctions, so the remote must always be +mounted to a drive letter. +.IP +.nf +\f[C] +rclone mount remote:path/to/files X: \-\-network\-mode +\f[R] +.fi +.PP +A volume name specified with \f[C]\-\-volname\f[R] will be used to +create the network share path. +A complete UNC path, such as \f[C]\[rs]\[rs]cloud\[rs]remote\f[R], +optionally with path +\f[C]\[rs]\[rs]cloud\[rs]remote\[rs]madeup\[rs]path\f[R], will be used +as is. +Any other string will be used as the share part, after a default prefix +\f[C]\[rs]\[rs]server\[rs]\f[R]. +If no volume name is specified then \f[C]\[rs]\[rs]server\[rs]share\f[R] +will be used. +You must make sure the volume name is unique when you are mounting more +than one drive, or else the mount command will fail. +The share name will treated as the volume label for the mapped drive, +shown in Windows Explorer etc, while the complete +\f[C]\[rs]\[rs]server\[rs]share\f[R] will be reported as the remote UNC +path by \f[C]net use\f[R] etc, just like a normal network drive mapping. +.PP +If you specify a full network share UNC path with \f[C]\-\-volname\f[R], +this will implicitely set the \f[C]\-\-network\-mode\f[R] option, so the +following two examples have same result: +.IP +.nf +\f[C] +rclone mount remote:path/to/files X: \-\-network\-mode +rclone mount remote:path/to/files X: \-\-volname \[rs]\[rs]server\[rs]share +\f[R] +.fi +.PP +You may also specify the network share UNC path as the mountpoint +itself. +Then rclone will automatically assign a drive letter, same as with +\f[C]*\f[R] and use that as mountpoint, and instead use the UNC path +specified as the volume name, as if it were specified with the +\f[C]\-\-volname\f[R] option. +This will also implicitely set the \f[C]\-\-network\-mode\f[R] option. +This means the following two examples have same result: +.IP +.nf +\f[C] +rclone mount remote:path/to/files \[rs]\[rs]cloud\[rs]remote +rclone mount remote:path/to/files * \-\-volname \[rs]\[rs]cloud\[rs]remote +\f[R] +.fi +.PP +There is yet another way to enable network mode, and to set the share +path, and that is to pass the \[dq]native\[dq] libfuse/WinFsp option +directly: +\f[C]\-\-fuse\-flag \-\-VolumePrefix=\[rs]server\[rs]share\f[R]. +Note that the path must be with just a single backslash prefix in this +case. +.PP +\f[I]Note:\f[R] In previous versions of rclone this was the only +supported method. +.PP +Read more about drive +mapping (https://en.wikipedia.org/wiki/Drive_mapping) +.PP +See also Limitations section below. +.SS Windows filesystem permissions +.PP +The FUSE emulation layer on Windows must convert between the +POSIX\-based permission model used in FUSE, and the permission model +used in Windows, based on access\-control lists (ACL). +.PP +The mounted filesystem will normally get three entries in its +access\-control list (ACL), representing permissions for the POSIX +permission scopes: Owner, group and others. +By default, the owner and group will be taken from the current user, and +the built\-in group \[dq]Everyone\[dq] will be used to represent others. +The user/group can be customized with FUSE options \[dq]UserName\[dq] +and \[dq]GroupName\[dq], e.g. +\f[C]\-o UserName=user123 \-o GroupName=\[dq]Authenticated Users\[dq]\f[R]. +.PP +The permissions on each entry will be set according to options +\f[C]\-\-dir\-perms\f[R] and \f[C]\-\-file\-perms\f[R], which takes a +value in traditional numeric +notation (https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation), +where the default corresponds to +\f[C]\-\-file\-perms 0666 \-\-dir\-perms 0777\f[R]. +.PP +Note that the mapping of permissions is not always trivial, and the +result you see in Windows Explorer may not be exactly like you expected. +For example, when setting a value that includes write access, this will +be mapped to individual permissions \[dq]write attributes\[dq], +\[dq]write data\[dq] and \[dq]append data\[dq], but not \[dq]write +extended attributes\[dq] (WinFsp does not support extended attributes, +see +this (https://github.com/billziss-gh/winfsp/wiki/NTFS-Compatibility)). +Windows will then show this as basic permission \[dq]Special\[dq] +instead of \[dq]Write\[dq], because \[dq]Write\[dq] includes the +\[dq]write extended attributes\[dq] permission. .SS Windows caveats .PP Note that drives created as Administrator are not visible by other @@ -3420,49 +3656,19 @@ WinFsp.Launcher infrastructure (https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture)) which creates drives accessible for everyone on the system or alternatively using the nssm service manager (https://nssm.cc/usage). -.SS Mount as a network drive -.PP -By default, rclone will mount the remote as a normal drive. -However, you can also mount it as a \f[B]Network Drive\f[R] (or -\f[B]Network Share\f[R], as mentioned in some places) -.PP -Unlike other systems, Windows provides a different filesystem type for -network drives. -Windows and other programs treat the network drives and fixed/removable -drives differently: In network drives, many I/O operations are -optimized, as the high latency and low reliability (compared to a normal -drive) of a network is expected. -.PP -Although many people prefer network shares to be mounted as normal -system drives, this might cause some issues, such as programs not -working as expected or freezes and errors while operating with the -mounted remote in Windows Explorer. -If you experience any of those, consider mounting rclone remotes as -network shares, as Windows expects normal drives to be fast and -reliable, while cloud storage is far from that. -See also Limitations section below for more info -.PP -Add \[dq]\-\-fuse\-flag \-\-VolumePrefix=\[dq] to your \[dq]mount\[dq] -command, \f[B]replacing \[dq]share\[dq] with any other name of your -choice if you are mounting more than one remote\f[R]. -Otherwise, the mountpoints will conflict and your mounted filesystems -will overlap. -.PP -Read more about drive -mapping (https://en.wikipedia.org/wiki/Drive_mapping) .SS Limitations .PP -Without the use of \[dq]\-\-vfs\-cache\-mode\[dq] this can only write +Without the use of \f[C]\-\-vfs\-cache\-mode\f[R] this can only write files sequentially, it can only seek when reading. This means that many applications won\[aq]t work with their files on an -rclone mount without \[dq]\-\-vfs\-cache\-mode writes\[dq] or -\[dq]\-\-vfs\-cache\-mode full\[dq]. +rclone mount without \f[C]\-\-vfs\-cache\-mode writes\f[R] or +\f[C]\-\-vfs\-cache\-mode full\f[R]. See the File Caching section for more info. .PP -The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, -Hubic) do not support the concept of empty directories, so empty -directories will have a tendency to disappear once they fall out of the -directory cache. +The bucket based remotes (e.g. +Swift, S3, Google Compute Storage, B2, Hubic) do not support the concept +of empty directories, so empty directories will have a tendency to +disappear once they fall out of the directory cache. .PP Only supported on Linux, FreeBSD, OS X and Windows at the moment. .SS rclone mount vs rclone sync/copy @@ -3475,10 +3681,11 @@ making local copies of the uploads. Look at the file caching for solutions to make mount more reliable. .SS Attribute caching .PP -You can use the flag \-\-attr\-timeout to set the time the kernel caches -the attributes (size, modification time etc) for directory entries. +You can use the flag \f[C]\-\-attr\-timeout\f[R] to set the time the +kernel caches the attributes (size, modification time, etc.) for +directory entries. .PP -The default is \[dq]1s\[dq] which caches files just long enough to avoid +The default is \f[C]1s\f[R] which caches files just long enough to avoid too many callbacks to rclone from the kernel. .PP In theory 0s should be the correct value for filesystems which can @@ -3491,18 +3698,18 @@ and excessive time listing directories (https://github.com/rclone/rclone/issues/2095#issuecomment-371141147). .PP The kernel can cache the info about a file for the time given by -\[dq]\-\-attr\-timeout\[dq]. +\f[C]\-\-attr\-timeout\f[R]. You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. -With \[dq]\-\-attr\-timeout 1s\[dq] this is very unlikely but not +With \f[C]\-\-attr\-timeout 1s\f[R] this is very unlikely but not impossible. -The higher you set \[dq]\-\-attr\-timeout\[dq] the more likely it is. +The higher you set \f[C]\-\-attr\-timeout\f[R] the more likely it is. The default setting of \[dq]1s\[dq] is the lowest setting which mitigates the problems above. .PP -If you set it higher (\[aq]10s\[aq] or \[aq]1m\[aq] say) then the kernel +If you set it higher (\f[C]10s\f[R] or \f[C]1m\f[R] say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above. .PP @@ -3524,28 +3731,25 @@ Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode. .SS chunked reading .PP -\-\-vfs\-read\-chunk\-size will enable reading the source objects in -parts. +\f[C]\-\-vfs\-read\-chunk\-size\f[R] will enable reading the source +objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests. .PP -When \-\-vfs\-read\-chunk\-size\-limit is also specified and greater -than \-\-vfs\-read\-chunk\-size, the chunk size for each open file will -get doubled for each chunk read, until the specified value is reached. -A value of \-1 will disable the limit and the chunk size will grow -indefinitely. +When \f[C]\-\-vfs\-read\-chunk\-size\-limit\f[R] is also specified and +greater than \f[C]\-\-vfs\-read\-chunk\-size\f[R], the chunk size for +each open file will get doubled for each chunk read, until the specified +value is reached. +A value of \f[C]\-1\f[R] will disable the limit and the chunk size will +grow indefinitely. .PP -With \-\-vfs\-read\-chunk\-size 100M and -\-\-vfs\-read\-chunk\-size\-limit 0 the following parts will be -downloaded: 0\-100M, 100M\-200M, 200M\-300M, 300M\-400M and so on. -When \-\-vfs\-read\-chunk\-size\-limit 500M is specified, the result -would be 0\-100M, 100M\-300M, 300M\-700M, 700M\-1200M, 1200M\-1700M and -so on. -.PP -Chunked reading will only work with \-\-vfs\-cache\-mode < full, as the -file will always be copied to the vfs cache before opening with -\-\-vfs\-cache\-mode full. +With \f[C]\-\-vfs\-read\-chunk\-size 100M\f[R] and +\f[C]\-\-vfs\-read\-chunk\-size\-limit 0\f[R] the following parts will +be downloaded: 0\-100M, 100M\-200M, 200M\-300M, 300M\-400M and so on. +When \f[C]\-\-vfs\-read\-chunk\-size\-limit 500M\f[R] is specified, the +result would be 0\-100M, 100M\-300M, 300M\-700M, 700M\-1200M, +1200M\-1700M and so on. .SS VFS \- Virtual File System .PP This command uses the VFS layer. @@ -3666,9 +3870,10 @@ and if they haven\[aq]t been accessed for \-\-vfs\-write\-back second. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP -If using \-\-vfs\-cache\-max\-size note that the cache may exceed this -size for two reasons. -Firstly because it is only checked every \-\-vfs\-cache\-poll\-interval. +If using \f[C]\-\-vfs\-cache\-max\-size\f[R] note that the cache may +exceed this size for two reasons. +Firstly because it is only checked every +\f[C]\-\-vfs\-cache\-poll\-interval\f[R]. Secondly because open files cannot be evicted from the cache. .SS \-\-vfs\-cache\-mode off .PP @@ -3721,7 +3926,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. .PP In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. .PP So if an application only reads the starts of each file, then rclone will only buffer the start of the file. @@ -3739,6 +3944,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -3786,6 +3997,17 @@ These flags only come into effect when not using an on disk cache file. \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) \f[R] .fi +.PP +When using VFS write caching (\-\-vfs\-cache\-mode with value writes or +full), the global flag \-\-transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +\-\-checkers have no effect on mount). +.IP +.nf +\f[C] +\-\-transfers int Number of file transfers to run in parallel. (default 4) +\f[R] +.fi .SS VFS Case Sensitivity .PP Linux file systems are case\-sensitive: two files can differ only by @@ -3802,7 +4024,7 @@ Usually file systems on macOS are case\-insensitive. It is possible to make macOS file systems case\-sensitive but that is not the default .PP -The \[dq]\-\-vfs\-case\-insensitive\[dq] mount flag controls how rclone +The \f[C]\-\-vfs\-case\-insensitive\f[R] mount flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the mounted file system as\-is. @@ -3840,30 +4062,33 @@ rclone mount remote:path /path/to/mountpoint [flags] .IP .nf \f[C] - \-\-allow\-non\-empty Allow mounting over a non\-empty directory (not Windows). - \-\-allow\-other Allow access to other users. - \-\-allow\-root Allow access to root user. - \-\-async\-read Use asynchronous reads. (default true) + \-\-allow\-non\-empty Allow mounting over a non\-empty directory. Not supported on Windows. + \-\-allow\-other Allow access to other users. Not supported on Windows. + \-\-allow\-root Allow access to root user. Not supported on Windows. + \-\-async\-read Use asynchronous reads. Not supported on Windows. (default true) \-\-attr\-timeout duration Time for which file/directory attributes are cached. (default 1s) - \-\-daemon Run mount as a daemon (background mode). - \-\-daemon\-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes). + \-\-daemon Run mount as a daemon (background mode). Not supported on Windows. + \-\-daemon\-timeout duration Time limit for rclone to respond to kernel. Not supported on Windows. \-\-debug\-fuse Debug the FUSE internals \- needs \-v. - \-\-default\-permissions Makes kernel enforce access control based on the file mode. + \-\-default\-permissions Makes kernel enforce access control based on the file mode. Not supported on Windows. \-\-dir\-cache\-time duration Time to cache directory entries for. (default 5m0s) \-\-dir\-perms FileMode Directory permissions (default 0777) \-\-file\-perms FileMode File permissions (default 0666) \-\-fuse\-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required. - \-\-gid uint32 Override the gid field set by the filesystem. (default 1000) + \-\-gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) \-h, \-\-help help for mount - \-\-max\-read\-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) + \-\-max\-read\-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. Not supported on Windows. (default 128k) + \-\-network\-mode Mount as remote network drive, instead of fixed disk drive. Supported on Windows only \-\-no\-checksum Don\[aq]t compare checksums on up/download. \-\-no\-modtime Don\[aq]t read/write the modification time (can speed things up). \-\-no\-seek Don\[aq]t allow seeking in files. + \-\-noappledouble Ignore Apple Double (._) and .DS_Store files. Supported on OSX only. (default true) + \-\-noapplexattr Ignore all \[dq]com.apple.*\[dq] extended attributes. Supported on OSX only. \-o, \-\-option stringArray Option for libfuse/WinFsp. Repeat if required. \-\-poll\-interval duration Time to wait between polling for changes. Must be smaller than dir\-cache\-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) \-\-read\-only Mount read\-only. - \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) - \-\-umask int Override the permission bits set by the filesystem. + \-\-uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. Not supported on Windows. \-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) \-\-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) @@ -3875,8 +4100,8 @@ rclone mount remote:path /path/to/mountpoint [flags] \-\-vfs\-read\-wait duration Time to wait for in\-sequence read before seeking. (default 20ms) \-\-vfs\-write\-back duration Time to writeback files after last use when using cache. (default 5s) \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) - \-\-volname string Set the volume name (not supported by all OSes). - \-\-write\-back\-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. + \-\-volname string Set the volume name. Supported on Windows and OSX only. + \-\-write\-back\-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. Not supported on Windows. \f[R] .fi .PP @@ -3975,9 +4200,10 @@ Here are the keys \- press \[aq]?\[aq] to toggle the help on and off \[<-],h to return c toggle counts g toggle graph - n,s,C sort by name,size,count + a toggle average size in directory + n,s,C,A sort by name,size,count,average size d delete file/directory - y copy current path to clipbard + y copy current path to clipboard Y display current path \[ha]L refresh screen ? to toggle help on and off @@ -4014,7 +4240,7 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SH rclone obscure .PP -Obscure password for use in the rclone config file +Obscure password for use in the rclone config file. .SS Synopsis .PP In the rclone config file, human readable passwords are obscured. @@ -4030,7 +4256,8 @@ However it is very hard to shoulder surf a 64 character hex token. .PP This command can also accept a password through STDIN instead of an argument by passing a hyphen as an argument. -Example: +This will use the first line of STDIN as the password not including the +trailing newline. .PP echo \[dq]secretpassword\[dq] | rclone obscure \- .PP @@ -4127,7 +4354,7 @@ Will place this in the \[dq]arg\[dq] value Use \-\-loopback to connect to the rclone instance running \[dq]rclone rc\[dq]. This is very useful for testing commands without having to run an rclone -rc server, eg: +rc server, e.g.: .IP .nf \f[C] @@ -4150,7 +4377,7 @@ rclone rc commands parameter [flags] \-h, \-\-help help for rc \-\-json string Input JSON \- use instead of key=value args. \-\-loopback If set connect to this rclone instance not via HTTP. - \-\-no\-output If set don\[aq]t output the JSON result. + \-\-no\-output If set, don\[aq]t output the JSON result. \-o, \-\-opt stringArray Option in the form name=value or name placed in the \[dq]opt\[dq] array. \-\-pass string Password to use to connect to rclone remote control. \-\-url string URL to connect to rclone remote control. (default \[dq]http://localhost:5572/\[dq]) @@ -4259,15 +4486,20 @@ commands, flags and backends. Remove empty directories under the path. .SS Synopsis .PP -This removes any empty directories (or directories that only contain -empty directories) under the path that it finds, including the path if -it has nothing in. +This recursively removes any empty directories (including directories +that only contain empty directories), that it finds under the path. +The root path itself will also be removed if it is empty, unless you +supply the \f[C]\-\-leave\-root\f[R] flag. .PP -If you supply the \-\-leave\-root flag, it will not remove the root -directory. +Use command \f[C]rmdir\f[R] to delete just the empty directory given by +path, not recurse. .PP This is useful for tidying up remotes that rclone has left a lot of empty directories in. +For example the \f[C]delete\f[R] command will delete files but leave the +directory structure (unless used with option \f[C]\-\-rmdirs\f[R]). +.PP +To delete a path and any objects in it, use \f[C]purge\f[R] command. .IP .nf \f[C] @@ -4296,7 +4528,7 @@ Serve a remote over a protocol. .PP rclone serve is used to serve a remote over a given protocol. This command requires the use of a subcommand to specify the protocol, -eg +e.g. .IP .nf \f[C] @@ -4364,8 +4596,9 @@ play back correctly. .SS Server options .PP Use \f[C]\-\-addr\f[R] to specify which IP address and port the server -should listen on, eg \f[C]\-\-addr 1.2.3.4:8000\f[R] or -\f[C]\-\-addr :8080\f[R] to listen to all IPs. +should listen on, e.g. +\f[C]\-\-addr 1.2.3.4:8000\f[R] or \f[C]\-\-addr :8080\f[R] to listen to +all IPs. .PP Use \f[C]\-\-name\f[R] to choose the friendly server name, which is by default \[dq]rclone (hostname)\[dq]. @@ -4492,9 +4725,10 @@ and if they haven\[aq]t been accessed for \-\-vfs\-write\-back second. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP -If using \-\-vfs\-cache\-max\-size note that the cache may exceed this -size for two reasons. -Firstly because it is only checked every \-\-vfs\-cache\-poll\-interval. +If using \f[C]\-\-vfs\-cache\-max\-size\f[R] note that the cache may +exceed this size for two reasons. +Firstly because it is only checked every +\f[C]\-\-vfs\-cache\-poll\-interval\f[R]. Secondly because open files cannot be evicted from the cache. .SS \-\-vfs\-cache\-mode off .PP @@ -4547,7 +4781,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. .PP In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. .PP So if an application only reads the starts of each file, then rclone will only buffer the start of the file. @@ -4565,6 +4799,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -4612,6 +4852,17 @@ These flags only come into effect when not using an on disk cache file. \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) \f[R] .fi +.PP +When using VFS write caching (\-\-vfs\-cache\-mode with value writes or +full), the global flag \-\-transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +\-\-checkers have no effect on mount). +.IP +.nf +\f[C] +\-\-transfers int Number of file transfers to run in parallel. (default 4) +\f[R] +.fi .SS VFS Case Sensitivity .PP Linux file systems are case\-sensitive: two files can differ only by @@ -4628,7 +4879,7 @@ Usually file systems on macOS are case\-insensitive. It is possible to make macOS file systems case\-sensitive but that is not the default .PP -The \[dq]\-\-vfs\-case\-insensitive\[dq] mount flag controls how rclone +The \f[C]\-\-vfs\-case\-insensitive\f[R] mount flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the mounted file system as\-is. @@ -4670,7 +4921,7 @@ rclone serve dlna remote:path [flags] \-\-dir\-cache\-time duration Time to cache directory entries for. (default 5m0s) \-\-dir\-perms FileMode Directory permissions (default 0777) \-\-file\-perms FileMode File permissions (default 0666) - \-\-gid uint32 Override the gid field set by the filesystem. (default 1000) + \-\-gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) \-h, \-\-help help for dlna \-\-log\-trace enable trace logging of SOAP traffic \-\-name string name of DLNA server @@ -4679,8 +4930,8 @@ rclone serve dlna remote:path [flags] \-\-no\-seek Don\[aq]t allow seeking in files. \-\-poll\-interval duration Time to wait between polling for changes. Must be smaller than dir\-cache\-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) \-\-read\-only Mount read\-only. - \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) - \-\-umask int Override the permission bits set by the filesystem. (default 2) + \-\-uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) \-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) \-\-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) @@ -4713,8 +4964,8 @@ ftp to read and write it. .SS Server options .PP Use \-\-addr to specify which IP address and port the server should -listen on, eg \-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all -IPs. +listen on, e.g. +\-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. .PP @@ -4846,9 +5097,10 @@ and if they haven\[aq]t been accessed for \-\-vfs\-write\-back second. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP -If using \-\-vfs\-cache\-max\-size note that the cache may exceed this -size for two reasons. -Firstly because it is only checked every \-\-vfs\-cache\-poll\-interval. +If using \f[C]\-\-vfs\-cache\-max\-size\f[R] note that the cache may +exceed this size for two reasons. +Firstly because it is only checked every +\f[C]\-\-vfs\-cache\-poll\-interval\f[R]. Secondly because open files cannot be evicted from the cache. .SS \-\-vfs\-cache\-mode off .PP @@ -4901,7 +5153,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. .PP In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. .PP So if an application only reads the starts of each file, then rclone will only buffer the start of the file. @@ -4919,6 +5171,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -4966,6 +5224,17 @@ These flags only come into effect when not using an on disk cache file. \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) \f[R] .fi +.PP +When using VFS write caching (\-\-vfs\-cache\-mode with value writes or +full), the global flag \-\-transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +\-\-checkers have no effect on mount). +.IP +.nf +\f[C] +\-\-transfers int Number of file transfers to run in parallel. (default 4) +\f[R] +.fi .SS VFS Case Sensitivity .PP Linux file systems are case\-sensitive: two files can differ only by @@ -4982,7 +5251,7 @@ Usually file systems on macOS are case\-insensitive. It is possible to make macOS file systems case\-sensitive but that is not the default .PP -The \[dq]\-\-vfs\-case\-insensitive\[dq] mount flag controls how rclone +The \f[C]\-\-vfs\-case\-insensitive\f[R] mount flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the mounted file system as\-is. @@ -5015,7 +5284,7 @@ If the flag is provided without a value, then it is \[dq]true\[dq]. If you supply the parameter \f[C]\-\-auth\-proxy /path/to/program\f[R] then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. -This uses a simple JSON based protocl with input on STDIN and output on +This uses a simple JSON based protocol with input on STDIN and output on STDOUT. .PP \f[B]PLEASE NOTE:\f[R] \f[C]\-\-auth\-proxy\f[R] and @@ -5115,11 +5384,13 @@ rclone serve ftp remote:path [flags] \f[C] \-\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:2121\[dq]) \-\-auth\-proxy string A program to use to create the backend from the auth. + \-\-cert string TLS PEM key (concatenation of certificate and CA certificate) \-\-dir\-cache\-time duration Time to cache directory entries for. (default 5m0s) \-\-dir\-perms FileMode Directory permissions (default 0777) \-\-file\-perms FileMode File permissions (default 0666) - \-\-gid uint32 Override the gid field set by the filesystem. (default 1000) + \-\-gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) \-h, \-\-help help for ftp + \-\-key string TLS PEM Private key \-\-no\-checksum Don\[aq]t compare checksums on up/download. \-\-no\-modtime Don\[aq]t read/write the modification time (can speed things up). \-\-no\-seek Don\[aq]t allow seeking in files. @@ -5128,8 +5399,8 @@ rclone serve ftp remote:path [flags] \-\-poll\-interval duration Time to wait between polling for changes. Must be smaller than dir\-cache\-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) \-\-public\-ip string Public IP address to advertise for passive connections. \-\-read\-only Mount read\-only. - \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) - \-\-umask int Override the permission bits set by the filesystem. (default 2) + \-\-uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) \-\-user string User name for authentication. (default \[dq]anonymous\[dq]) \-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) \-\-vfs\-cache\-max\-size SizeSuffix Max total size of objects in the cache. (default off) @@ -5161,8 +5432,8 @@ HTTP. This can be viewed in a web browser or you can make a remote of type http read from it. .PP -You can use the filter flags (eg \-\-include, \-\-exclude) to control -what is served. +You can use the filter flags (e.g. +\-\-include, \-\-exclude) to control what is served. .PP The server will log errors. Use \-v to see access logs. @@ -5172,8 +5443,8 @@ Use \-\-stats to control the stats printing. .SS Server options .PP Use \-\-addr to specify which IP address and port the server should -listen on, eg \-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all -IPs. +listen on, e.g. +\-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. .PP @@ -5229,7 +5500,7 @@ This is changeable via ?sort= parameter T} T{ T}@T{ -Sort Options: namedirfist,name,size,time (default namedirfirst) +Sort Options: namedirfirst,name,size,time (default namedirfirst) T} T{ \&.Order @@ -5450,9 +5721,10 @@ and if they haven\[aq]t been accessed for \-\-vfs\-write\-back second. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP -If using \-\-vfs\-cache\-max\-size note that the cache may exceed this -size for two reasons. -Firstly because it is only checked every \-\-vfs\-cache\-poll\-interval. +If using \f[C]\-\-vfs\-cache\-max\-size\f[R] note that the cache may +exceed this size for two reasons. +Firstly because it is only checked every +\f[C]\-\-vfs\-cache\-poll\-interval\f[R]. Secondly because open files cannot be evicted from the cache. .SS \-\-vfs\-cache\-mode off .PP @@ -5505,7 +5777,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. .PP In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. .PP So if an application only reads the starts of each file, then rclone will only buffer the start of the file. @@ -5523,6 +5795,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -5570,6 +5848,17 @@ These flags only come into effect when not using an on disk cache file. \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) \f[R] .fi +.PP +When using VFS write caching (\-\-vfs\-cache\-mode with value writes or +full), the global flag \-\-transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +\-\-checkers have no effect on mount). +.IP +.nf +\f[C] +\-\-transfers int Number of file transfers to run in parallel. (default 4) +\f[R] +.fi .SS VFS Case Sensitivity .PP Linux file systems are case\-sensitive: two files can differ only by @@ -5586,7 +5875,7 @@ Usually file systems on macOS are case\-insensitive. It is possible to make macOS file systems case\-sensitive but that is not the default .PP -The \[dq]\-\-vfs\-case\-insensitive\[dq] mount flag controls how rclone +The \f[C]\-\-vfs\-case\-insensitive\f[R] mount flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the mounted file system as\-is. @@ -5631,7 +5920,7 @@ rclone serve http remote:path [flags] \-\-dir\-cache\-time duration Time to cache directory entries for. (default 5m0s) \-\-dir\-perms FileMode Directory permissions (default 0777) \-\-file\-perms FileMode File permissions (default 0666) - \-\-gid uint32 Override the gid field set by the filesystem. (default 1000) + \-\-gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) \-h, \-\-help help for http \-\-htpasswd string htpasswd file \- if not provided no authentication is done \-\-key string SSL PEM Private key @@ -5646,8 +5935,8 @@ rclone serve http remote:path [flags] \-\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) \-\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) \-\-template string User Specified Template. - \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) - \-\-umask int Override the permission bits set by the filesystem. (default 2) + \-\-uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) \-\-user string User name for authentication. \-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) \-\-vfs\-cache\-max\-size SizeSuffix Max total size of objects in the cache. (default off) @@ -5711,6 +6000,11 @@ By default this will serve on \[dq]localhost:8080\[dq] you can change this with use of the \[dq]\-\-addr\[dq] flag. .PP You might wish to start this server on boot. +.PP +Adding \-\-cache\-objects=false will cause rclone to stop caching +objects returned from the List call. +Caching is normally desirable as it speeds up downloading objects, saves +transactions and uses very little memory. .SS Setting up restic to use rclone .PP Now you can follow the restic @@ -5765,8 +6059,8 @@ repositories starting with a path of \f[C]//\f[R]. .SS Server options .PP Use \-\-addr to specify which IP address and port the server should -listen on, eg \-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all -IPs. +listen on, e.g. +\-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. .PP @@ -5822,7 +6116,7 @@ This is changeable via ?sort= parameter T} T{ T}@T{ -Sort Options: namedirfist,name,size,time (default namedirfirst) +Sort Options: namedirfirst,name,size,time (default namedirfirst) T} T{ \&.Order @@ -5936,6 +6230,7 @@ rclone serve restic remote:path [flags] \-\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:8080\[dq]) \-\-append\-only disallow deletion of repository data \-\-baseurl string Prefix for URLs \- leave blank for root. + \-\-cache\-objects cache listed objects (default true) \-\-cert string SSL PEM key (concatenation of certificate and CA certificate) \-\-client\-ca string Client certificate authority to verify clients with \-h, \-\-help help for restic @@ -5969,8 +6264,8 @@ SFTP. This can be used with an SFTP client or you can make a remote of type sftp to use with it. .PP -You can use the filter flags (eg \-\-include, \-\-exclude) to control -what is served. +You can use the filter flags (e.g. +\-\-include, \-\-exclude) to control what is served. .PP The server will log errors. Use \-v to see access logs. @@ -6118,9 +6413,10 @@ and if they haven\[aq]t been accessed for \-\-vfs\-write\-back second. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP -If using \-\-vfs\-cache\-max\-size note that the cache may exceed this -size for two reasons. -Firstly because it is only checked every \-\-vfs\-cache\-poll\-interval. +If using \f[C]\-\-vfs\-cache\-max\-size\f[R] note that the cache may +exceed this size for two reasons. +Firstly because it is only checked every +\f[C]\-\-vfs\-cache\-poll\-interval\f[R]. Secondly because open files cannot be evicted from the cache. .SS \-\-vfs\-cache\-mode off .PP @@ -6173,7 +6469,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. .PP In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. .PP So if an application only reads the starts of each file, then rclone will only buffer the start of the file. @@ -6191,6 +6487,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -6238,6 +6540,17 @@ These flags only come into effect when not using an on disk cache file. \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) \f[R] .fi +.PP +When using VFS write caching (\-\-vfs\-cache\-mode with value writes or +full), the global flag \-\-transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +\-\-checkers have no effect on mount). +.IP +.nf +\f[C] +\-\-transfers int Number of file transfers to run in parallel. (default 4) +\f[R] +.fi .SS VFS Case Sensitivity .PP Linux file systems are case\-sensitive: two files can differ only by @@ -6254,7 +6567,7 @@ Usually file systems on macOS are case\-insensitive. It is possible to make macOS file systems case\-sensitive but that is not the default .PP -The \[dq]\-\-vfs\-case\-insensitive\[dq] mount flag controls how rclone +The \f[C]\-\-vfs\-case\-insensitive\f[R] mount flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the mounted file system as\-is. @@ -6287,7 +6600,7 @@ If the flag is provided without a value, then it is \[dq]true\[dq]. If you supply the parameter \f[C]\-\-auth\-proxy /path/to/program\f[R] then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. -This uses a simple JSON based protocl with input on STDIN and output on +This uses a simple JSON based protocol with input on STDIN and output on STDOUT. .PP \f[B]PLEASE NOTE:\f[R] \f[C]\-\-auth\-proxy\f[R] and @@ -6391,7 +6704,7 @@ rclone serve sftp remote:path [flags] \-\-dir\-cache\-time duration Time to cache directory entries for. (default 5m0s) \-\-dir\-perms FileMode Directory permissions (default 0777) \-\-file\-perms FileMode File permissions (default 0666) - \-\-gid uint32 Override the gid field set by the filesystem. (default 1000) + \-\-gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) \-h, \-\-help help for sftp \-\-key stringArray SSH private host key file (Can be multi\-valued, leave blank to auto generate) \-\-no\-auth Allow connections with no authentication if set. @@ -6401,8 +6714,8 @@ rclone serve sftp remote:path [flags] \-\-pass string Password for authentication. \-\-poll\-interval duration Time to wait between polling for changes. Must be smaller than dir\-cache\-time. Only on supported remotes. Set to 0 to disable. (default 1m0s) \-\-read\-only Mount read\-only. - \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) - \-\-umask int Override the permission bits set by the filesystem. (default 2) + \-\-uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) \-\-user string User name for authentication. \-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) \-\-vfs\-cache\-max\-size SizeSuffix Max total size of objects in the cache. (default off) @@ -6448,8 +6761,8 @@ Use \[dq]rclone hashsum\[dq] to see the full list. .SS Server options .PP Use \-\-addr to specify which IP address and port the server should -listen on, eg \-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all -IPs. +listen on, e.g. +\-\-addr 1.2.3.4:8000 or \-\-addr :8080 to listen to all IPs. By default it only listens on localhost. You can use port :0 to let the OS choose an available port. .PP @@ -6505,7 +6818,7 @@ This is changeable via ?sort= parameter T} T{ T}@T{ -Sort Options: namedirfist,name,size,time (default namedirfirst) +Sort Options: namedirfirst,name,size,time (default namedirfirst) T} T{ \&.Order @@ -6726,9 +7039,10 @@ and if they haven\[aq]t been accessed for \-\-vfs\-write\-back second. If rclone is quit or dies with files that haven\[aq]t been uploaded, these will be uploaded next time rclone is run with the same flags. .PP -If using \-\-vfs\-cache\-max\-size note that the cache may exceed this -size for two reasons. -Firstly because it is only checked every \-\-vfs\-cache\-poll\-interval. +If using \f[C]\-\-vfs\-cache\-max\-size\f[R] note that the cache may +exceed this size for two reasons. +Firstly because it is only checked every +\f[C]\-\-vfs\-cache\-poll\-interval\f[R]. Secondly because open files cannot be evicted from the cache. .SS \-\-vfs\-cache\-mode off .PP @@ -6781,7 +7095,7 @@ In this mode all reads and writes are buffered to and from disk. When data is read from the remote this is buffered to disk as well. .PP In this mode the files in the cache will be sparse files and rclone will -keep track of which bits of the files it has dowloaded. +keep track of which bits of the files it has downloaded. .PP So if an application only reads the starts of each file, then rclone will only buffer the start of the file. @@ -6799,6 +7113,12 @@ The \-\-buffer\-size is buffered in memory whereas the .PP When using this mode it is recommended that \-\-buffer\-size is not set too big and \-\-vfs\-read\-ahead is set large if required. +.PP +\f[B]IMPORTANT\f[R] not all file systems support sparse files. +In particular FAT/exFAT do not. +Rclone will perform very badly if the cache directory is on a filesystem +which doesn\[aq]t support sparse files and it will log an ERROR message +if one is detected. .SS VFS Performance .PP These flags may be used to enable/disable features of the VFS for @@ -6846,6 +7166,17 @@ These flags only come into effect when not using an on disk cache file. \-\-vfs\-write\-wait duration Time to wait for in\-sequence write before giving error. (default 1s) \f[R] .fi +.PP +When using VFS write caching (\-\-vfs\-cache\-mode with value writes or +full), the global flag \-\-transfers can be set to adjust the number of +parallel uploads of modified files from cache (the related global flag +\-\-checkers have no effect on mount). +.IP +.nf +\f[C] +\-\-transfers int Number of file transfers to run in parallel. (default 4) +\f[R] +.fi .SS VFS Case Sensitivity .PP Linux file systems are case\-sensitive: two files can differ only by @@ -6862,7 +7193,7 @@ Usually file systems on macOS are case\-insensitive. It is possible to make macOS file systems case\-sensitive but that is not the default .PP -The \[dq]\-\-vfs\-case\-insensitive\[dq] mount flag controls how rclone +The \f[C]\-\-vfs\-case\-insensitive\f[R] mount flag controls how rclone handles these two cases. If its value is \[dq]false\[dq], rclone passes file names to the mounted file system as\-is. @@ -6895,7 +7226,7 @@ If the flag is provided without a value, then it is \[dq]true\[dq]. If you supply the parameter \f[C]\-\-auth\-proxy /path/to/program\f[R] then rclone will use that program to generate backends on the fly which then are used to authenticate incoming requests. -This uses a simple JSON based protocl with input on STDIN and output on +This uses a simple JSON based protocol with input on STDIN and output on STDOUT. .PP \f[B]PLEASE NOTE:\f[R] \f[C]\-\-auth\-proxy\f[R] and @@ -7003,7 +7334,7 @@ rclone serve webdav remote:path [flags] \-\-disable\-dir\-list Disable HTML directory list on GET request for a directory \-\-etag\-hash string Which hash to use for the ETag, or auto or blank for off \-\-file\-perms FileMode File permissions (default 0666) - \-\-gid uint32 Override the gid field set by the filesystem. (default 1000) + \-\-gid uint32 Override the gid field set by the filesystem. Not supported on Windows. (default 1000) \-h, \-\-help help for webdav \-\-htpasswd string htpasswd file \- if not provided no authentication is done \-\-key string SSL PEM Private key @@ -7018,8 +7349,8 @@ rclone serve webdav remote:path [flags] \-\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) \-\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) \-\-template string User Specified Template. - \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) - \-\-umask int Override the permission bits set by the filesystem. (default 2) + \-\-uid uint32 Override the uid field set by the filesystem. Not supported on Windows. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. Not supported on Windows. (default 2) \-\-user string User name for authentication. \-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) \-\-vfs\-cache\-max\-size SizeSuffix Max total size of objects in the cache. (default off) @@ -7117,13 +7448,13 @@ If \-\-timestamp is used then it will set the modification time to that time instead of the current time. Times may be specified as one of: .IP \[bu] 2 -\[aq]YYMMDD\[aq] \- eg. +\[aq]YYMMDD\[aq] \- e.g. 17.10.30 .IP \[bu] 2 -\[aq]YYYY\-MM\-DDTHH:MM:SS\[aq] \- eg. +\[aq]YYYY\-MM\-DDTHH:MM:SS\[aq] \- e.g. 2006\-01\-02T15:04:05 .IP \[bu] 2 -\[aq]YYYY\-MM\-DDTHH:MM:SS.SSS\[aq] \- eg. +\[aq]YYYY\-MM\-DDTHH:MM:SS.SSS\[aq] \- e.g. 2006\-01\-02T15:04:05.123456789 .PP Note that \-\-timestamp is in UTC if you want local time then add the @@ -7176,7 +7507,7 @@ $ rclone tree remote:path \f[R] .fi .PP -You can use any of the filtering options with the tree command (eg +You can use any of the filtering options with the tree command (e.g. \-\-include and \-\-exclude). You can also use \-\-fast\-list. .PP @@ -7351,9 +7682,9 @@ Here are some gotchas which may help users unfamiliar with the shell rules .SS Linux / OSX .PP -If your names have spaces or shell metacharacters (eg \f[C]*\f[R], -\f[C]?\f[R], \f[C]$\f[R], \f[C]\[aq]\f[R], \f[C]\[dq]\f[R] etc) then you -must quote them. +If your names have spaces or shell metacharacters (e.g. +\f[C]*\f[R], \f[C]?\f[R], \f[C]$\f[R], \f[C]\[aq]\f[R], \f[C]\[dq]\f[R], +etc.) then you must quote them. Use single quotes \f[C]\[aq]\f[R] by default. .IP .nf @@ -7363,7 +7694,7 @@ rclone copy \[aq]Important files?\[aq] remote:backup .fi .PP If you want to send a \f[C]\[aq]\f[R] you will need to use -\f[C]\[dq]\f[R], eg +\f[C]\[dq]\f[R], e.g. .IP .nf \f[C] @@ -7375,7 +7706,8 @@ The rules for quoting metacharacters are complicated and if you want the full details you\[aq]ll have to consult the manual page for your shell. .SS Windows .PP -If your names have spaces in you need to put them in \f[C]\[dq]\f[R], eg +If your names have spaces in you need to put them in \f[C]\[dq]\f[R], +e.g. .IP .nf \f[C] @@ -7384,7 +7716,7 @@ rclone copy \[dq]E:\[rs]folder name\[rs]folder name\[rs]folder name\[dq] remote: .fi .PP If you are using the root directory on its own then don\[aq]t quote it -(see #464 (https://github.com/rclone/rclone/issues/464) for why), eg +(see #464 (https://github.com/rclone/rclone/issues/464) for why), e.g. .IP .nf \f[C] @@ -7420,7 +7752,7 @@ rclone sync \-i /full/path/to/sync:me remote:path .PP Most remotes (but not all \- see the overview (https://rclone.org/overview/#optional-features)) support -server side copy. +server\-side copy. .PP This means if you want to copy one folder to another then rclone won\[aq]t download all the files and re\-upload them; it will instruct @@ -7437,20 +7769,20 @@ rclone copy s3:oldbucket s3:newbucket Will copy the contents of \f[C]oldbucket\f[R] to \f[C]newbucket\f[R] without downloading and re\-uploading. .PP -Remotes which don\[aq]t support server side copy \f[B]will\f[R] download -and re\-upload in this case. +Remotes which don\[aq]t support server\-side copy \f[B]will\f[R] +download and re\-upload in this case. .PP Server side copies are used with \f[C]sync\f[R] and \f[C]copy\f[R] and will be identified in the log when using the \f[C]\-v\f[R] flag. The \f[C]move\f[R] command may also use them if remote doesn\[aq]t -support server side move directly. -This is done by issuing a server side copy then a delete which is much +support server\-side move directly. +This is done by issuing a server\-side copy then a delete which is much quicker than a download and re\-upload. .PP Server side copies will only be attempted if the remote names are the same. .PP -This can be used when scripting to make aged backups efficiently, eg +This can be used when scripting to make aged backups efficiently, e.g. .IP .nf \f[C] @@ -7484,7 +7816,8 @@ Options which use SIZE use kByte by default. However, a suffix of \f[C]b\f[R] for bytes, \f[C]k\f[R] for kBytes, \f[C]M\f[R] for MBytes, \f[C]G\f[R] for GBytes, \f[C]T\f[R] for TBytes and \f[C]P\f[R] for PBytes may be used. -These are the binary units, eg 1, 2**10, 2**20, 2**30 respectively. +These are the binary units, e.g. +1, 2**10, 2**20, 2**30 respectively. .SS \-\-backup\-dir=DIR .PP When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] any files @@ -7496,8 +7829,8 @@ suffix added to them. If there is a file with the same path (after the suffix has been added) in DIR, then it will be overwritten. .PP -The remote in use must support server side move or copy and you must use -the same remote as the destination of the sync. +The remote in use must support server\-side move or copy and you must +use the same remote as the destination of the sync. The backup directory must not overlap the destination directory. .PP For example @@ -7528,33 +7861,70 @@ address it will give an error. .SS \-\-bwlimit=BANDWIDTH_SPEC .PP This option controls the bandwidth limit. -Limits can be specified in two ways: As a single limit, or as a -timetable. +For example +.IP +.nf +\f[C] +\-\-bwlimit 10M +\f[R] +.fi .PP -Single limits last for the duration of the session. +would mean limit the upload and download bandwidth to 10 Mbyte/s. +\f[B]NB\f[R] this is \f[B]bytes\f[R] per second not \f[B]bits\f[R] per +second. To use a single limit, specify the desired bandwidth in kBytes/s, or use a suffix b|k|M|G. The default is \f[C]0\f[R] which means to not limit bandwidth. .PP -For example, to limit bandwidth usage to 10 MBytes/s use -\f[C]\-\-bwlimit 10M\f[R] +The upload and download bandwidth can be specified seperately, as +\f[C]\-\-bwlimit UP:DOWN\f[R], so +.IP +.nf +\f[C] +\-\-bwlimit 10M:100k +\f[R] +.fi +.PP +would mean limit the upload bandwidth to 10 Mbyte/s and the download +bandwidth to 100 kByte/s. +Either limit can be \[dq]off\[dq] meaning no limit, so to just limit the +upload bandwidth you would use +.IP +.nf +\f[C] +\-\-bwlimit 10M:off +\f[R] +.fi +.PP +this would limit the upload bandwidth to 10MByte/s but the download +bandwidth would be unlimited. +.PP +When specified as above the bandwidth limits last for the duration of +run of the rclone binary. .PP It is also possible to specify a \[dq]timetable\[dq] of limits, which will cause certain limits to be applied at certain times. To specify a timetable, format your entries as \f[C]WEEKDAY\-HH:MM,BANDWIDTH WEEKDAY\-HH:MM,BANDWIDTH...\f[R] where: \f[C]WEEKDAY\f[R] is optional element. -It could be written as whole world or only using 3 first characters. +.IP \[bu] 2 +\f[C]BANDWIDTH\f[R] can be a single number, e.g.\f[C]100k\f[R] or a pair +of numbers for upload:download, e.g.\f[C]10M:1M\f[R]. +.IP \[bu] 2 +\f[C]WEEKDAY\f[R] can be written as the whole word or only using the +first 3 characters. +It is optional. +.IP \[bu] 2 \f[C]HH:MM\f[R] is an hour from 00:00 to 23:59. .PP An example of a typical timetable to avoid link saturation during daytime working hours could be: .PP -\f[C]\-\-bwlimit \[dq]08:00,512 12:00,10M 13:00,512 18:00,30M 23:00,off\[dq]\f[R] +\f[C]\-\-bwlimit \[dq]08:00,512k 12:00,10M 13:00,512k 18:00,30M 23:00,off\[dq]\f[R] .PP -In this example, the transfer bandwidth will be every day set to -512kBytes/sec at 8am. -At noon, it will raise to 10Mbytes/s, and drop back to 512kBytes/sec at +In this example, the transfer bandwidth will be set to 512kBytes/sec at +8am every day. +At noon, it will rise to 10Mbytes/s, and drop back to 512kBytes/sec at 1pm. At 6pm, the bandwidth limit will be set to 30MBytes/s, and at 11pm it will be completely disabled (full speed). @@ -7564,25 +7934,27 @@ An example of timetable with \f[C]WEEKDAY\f[R] could be: .PP \f[C]\-\-bwlimit \[dq]Mon\-00:00,512 Fri\-23:59,10M Sat\-10:00,1M Sun\-20:00,off\[dq]\f[R] .PP -It mean that, the transfer bandwidth will be set to 512kBytes/sec on +It means that, the transfer bandwidth will be set to 512kBytes/sec on Monday. -It will raise to 10Mbytes/s before the end of Friday. -At 10:00 on Sunday it will be set to 1Mbyte/s. -From 20:00 at Sunday will be unlimited. +It will rise to 10Mbytes/s before the end of Friday. +At 10:00 on Saturday it will be set to 1Mbyte/s. +From 20:00 on Sunday it will be unlimited. .PP -Timeslots without weekday are extended to whole week. -So this one example: +Timeslots without \f[C]WEEKDAY\f[R] are extended to the whole week. +So this example: .PP \f[C]\-\-bwlimit \[dq]Mon\-00:00,512 12:00,1M Sun\-20:00,off\[dq]\f[R] .PP -Is equal to this: +Is equivalent to this: .PP \f[C]\-\-bwlimit \[dq]Mon\-00:00,512Mon\-12:00,1M Tue\-12:00,1M Wed\-12:00,1M Thu\-12:00,1M Fri\-12:00,1M Sat\-12:00,1M Sun\-12:00,1M Sun\-20:00,off\[dq]\f[R] .PP -Bandwidth limits only apply to the data transfer. -They don\[aq]t apply to the bandwidth of the directory listings etc. +Bandwidth limit apply to the data transfer for all backends. +For most backends the directory listing bandwidth is also included +(exceptions being the non HTTP backends, \f[C]ftp\f[R], \f[C]sftp\f[R] +and \f[C]tardigrade\f[R]). .PP -Note that the units are Bytes/s, not Bits/s. +Note that the units are \f[B]Bytes/s\f[R], not \f[B]Bits/s\f[R]. Typically connections are measured in Bits/s \- to convert divide by 8. For example, let\[aq]s say you have a 10 Mbit/s connection and you wish rclone to use half of it \- 5 Mbit/s. @@ -7653,6 +8025,9 @@ Normally rclone would start running transfers as soon as possible. This flag can be useful on IO limited systems where transfers interfere with checking. .PP +It can also be useful to ensure perfect ordering when using +\f[C]\-\-order\-by\f[R]. +.PP Using this flag can use more memory as it effectively sets \f[C]\-\-max\-backlog\f[R] to infinite. This means that all the info on the objects to transfer is held in @@ -7661,8 +8036,9 @@ memory before the transfers start. .PP The number of checkers to run in parallel. Checkers do the equality checking of files during a sync. -For some storage systems (eg S3, Swift, Dropbox) this can take a -significant amount of time so they are run in parallel. +For some storage systems (e.g. +S3, Swift, Dropbox) this can take a significant amount of time so they +are run in parallel. .PP The default is to run 8 checkers in parallel. .SS \-c, \-\-checksum @@ -7676,7 +8052,8 @@ This is useful when the remote doesn\[aq]t support setting modified time and a more accurate sync is desired than just checking the file size. .PP This is very useful when transferring between remotes which store the -same hash type on the object, eg Drive and Swift. +same hash type on the object, e.g. +Drive and Swift. For details of which remotes support which hash type see the table in the overview section (https://rclone.org/overview/). .PP @@ -7716,7 +8093,7 @@ be created automatically. If you run \f[C]rclone config file\f[R] you will see where the default location is for you. .PP -Use this flag to override the config location, eg +Use this flag to override the config location, e.g. \f[C]rclone \-\-config=\[dq].myconfig\[dq] .config\f[R]. .SS \-\-contimeout=TIME .PP @@ -7731,11 +8108,11 @@ It is \f[C]1m\f[R] by default. .PP When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] DIR is checked in addition to the destination for files. -If a file identical to the source is found that file is server side +If a file identical to the source is found that file is server\-side copied from DIR to the destination. This is useful for incremental backup. .PP -The remote in use must support server side copy and you must use the +The remote in use must support server\-side copy and you must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. .PP @@ -7751,7 +8128,7 @@ mean. .SS \-\-disable FEATURE,FEATURE,... .PP This disables a comma separated list of optional features. -For example to disable server side move and server side copy use: +For example to disable server\-side move and server\-side copy use: .IP .nf \f[C] @@ -7774,7 +8151,8 @@ optional features (https://rclone.org/overview/#optional-features) to get an idea of which feature does what. .PP This flag can be useful for debugging and in exceptional circumstances -(eg Google Drive limiting the total volume of Server Side Copies to +(e.g. +Google Drive limiting the total volume of Server Side Copies to 100GB/day). .SS \-n, \-\-dry\-run .PP @@ -7980,6 +8358,8 @@ This can be useful for tracking down problems with syncs in combination with the \f[C]\-v\f[R] flag. See the Logging section for more info. .PP +If FILE exists then rclone will append to it. +.PP Note that if you are using the \f[C]logrotate\f[R] program to manage rclone\[aq]s logs, then you should use the \f[C]copytruncate\f[R] option as rclone doesn\[aq]t have a signal to rotate logs. @@ -8188,7 +8568,8 @@ the destination is not listed minimising the API calls .IP \[bu] 2 files are always transferred .IP \[bu] 2 -this can cause duplicates on remotes which allow it (eg Google Drive) +this can cause duplicates on remotes which allow it (e.g. +Google Drive) .IP \[bu] 2 \f[C]\-\-retries 1\f[R] is recommended otherwise you\[aq]ll transfer everything again on a retry @@ -8249,7 +8630,8 @@ When using this flag, rclone won\[aq]t update modification times of remote files if they are incorrect as it would normally. .PP This can be used if the remote is being synced with another tool also -(eg the Google Drive client). +(e.g. +the Google Drive client). .SS \-\-order\-by string .PP The \f[C]\-\-order\-by\f[R] flag controls the order in which files in @@ -8277,9 +8659,9 @@ newest) is processed first some threads and the largest for others .PP If the modifier is \f[C]mixed\f[R] then it can have an optional -percentage (which defaults to \f[C]50\f[R]), eg \f[C]size,mixed,25\f[R] -which means that 25% of the threads should be taking the smallest items -and 75% the largest. +percentage (which defaults to \f[C]50\f[R]), e.g. +\f[C]size,mixed,25\f[R] which means that 25% of the threads should be +taking the smallest items and 75% the largest. The threads which take the smallest first will always take the smallest first and likewise the largest first threads. The \f[C]mixed\f[R] mode can be useful to minimise the transfer time @@ -8318,6 +8700,10 @@ Rclone will do its best to transfer the best file it has so in practice this should not cause a problem. Think of \f[C]\-\-order\-by\f[R] as being more of a best efforts flag rather than a perfect ordering. +.PP +If you want perfect ordering then you will need to specify +\-\-check\-first which will find all the files which need transferring +first before transferring any. .SS \-\-password\-command SpaceSepList .PP This flag supplies a program which should supply the config password @@ -8366,6 +8752,10 @@ Note: On Windows until this bug (https://github.com/Azure/go-ansiterm/issues/26) is fixed all non\-ASCII characters will be replaced with \f[C].\f[R] when \f[C]\-\-progress\f[R] is in use. +.SS \-\-progress\-terminal\-title +.PP +This flag, when used with \f[C]\-P/\-\-progress\f[R], will print the +string \f[C]ETA: %s\f[R] to the terminal title. .SS \-q, \-\-quiet .PP This flag will limit rclone\[aq]s output to error messages only. @@ -8379,7 +8769,8 @@ This is useful if you uploaded files with the incorrect timestamps and you now wish to correct them. .PP This flag is \f[B]only\f[R] useful for destinations which don\[aq]t -support hashes (eg \f[C]crypt\f[R]). +support hashes (e.g. +\f[C]crypt\f[R]). .PP This can be used any of the sync commands \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R]. @@ -8395,8 +8786,8 @@ If this file matches the source with size (and checksum if available) but has a differing timestamp then instead of re\-uploading it, rclone will update the timestamp on the destination file. If the checksum does not match rclone will upload the new file. -If the checksum is absent (eg on a \f[C]crypt\f[R] backend) then rclone -will update the timestamp. +If the checksum is absent (e.g. +on a \f[C]crypt\f[R] backend) then rclone will update the timestamp. .PP Note that some remotes can\[aq]t set the modification time without re\-uploading the file so this flag is less useful on them. @@ -8508,8 +8899,8 @@ to them. If there is a file with the same path (after the suffix has been added), then it will be overwritten. .PP -The remote in use must support server side move or copy and you must use -the same remote as the destination of the sync. +The remote in use must support server\-side move or copy and you must +use the same remote as the destination of the sync. .PP This is for use with files to add the suffix in the current directory or with \f[C]\-\-backup\-dir\f[R]. @@ -8519,12 +8910,23 @@ For example .IP .nf \f[C] -rclone sync \-i /path/to/local/file remote:current \-\-suffix .bak +rclone copy \-i /path/to/local/file remote:current \-\-suffix .bak \f[R] .fi .PP -will sync \f[C]/path/to/local\f[R] to \f[C]remote:current\f[R], but for +will copy \f[C]/path/to/local\f[R] to \f[C]remote:current\f[R], but for any files which would have been updated or deleted have .bak added. +.PP +If using \f[C]rclone sync\f[R] with \f[C]\-\-suffix\f[R] and without +\f[C]\-\-backup\-dir\f[R] then it is recommended to put a filter rule in +excluding the suffix otherwise the \f[C]sync\f[R] will delete the backup +files. +.IP +.nf +\f[C] +rclone sync \-i /path/to/local/file remote:current \-\-suffix .bak \-\-exclude \[dq]*.bak\[dq] +\f[R] +.fi .SS \-\-suffix\-keep\-extension .PP When using \f[C]\-\-suffix\f[R], setting this causes rclone put the @@ -8544,26 +8946,35 @@ This can be useful for running rclone in a script or \f[C]rclone mount\f[R]. .SS \-\-syslog\-facility string .PP -If using \f[C]\-\-syslog\f[R] this sets the syslog facility (eg +If using \f[C]\-\-syslog\f[R] this sets the syslog facility (e.g. \f[C]KERN\f[R], \f[C]USER\f[R]). See \f[C]man syslog\f[R] for a list of possible facilities. The default facility is \f[C]DAEMON\f[R]. .SS \-\-tpslimit float .PP -Limit HTTP transactions per second to this. +Limit transactions per second to this number. Default is 0 which is used to mean unlimited transactions per second. .PP -For example to limit rclone to 10 HTTP transactions per second use +A transaction is roughly defined as an API call; its exact meaning will +depend on the backend. +For HTTP based backends it is an HTTP PUT/GET/POST/etc and its response. +For FTP/SFTP it is a round trip transaction over TCP. +.PP +For example to limit rclone to 10 transactions per second use \f[C]\-\-tpslimit 10\f[R], or to 1 transaction every 2 seconds use \f[C]\-\-tpslimit 0.5\f[R]. .PP Use this when the number of transactions per second from rclone is -causing a problem with the cloud storage provider (eg getting you banned -or rate limited). +causing a problem with the cloud storage provider (e.g. +getting you banned or rate limited). .PP This can be very useful for \f[C]rclone mount\f[R] to control the behaviour of applications using it. .PP +This limit applies to all HTTP based backends and to the FTP and SFTP +backends. +It does not apply to the local backend or the Tardigrade backend. +.PP See also \f[C]\-\-tpslimit\-burst\f[R]. .SS \-\-tpslimit\-burst int .PP @@ -8589,10 +9000,10 @@ By default, rclone doesn\[aq]t keep track of renamed files, so if you rename a file locally then sync it to a remote, rclone will delete the old file on the remote and upload a new copy. .PP -If you use this flag, and the remote supports server side copy or server -side move, and the source and destination have a compatible hash, then -this will track renames during \f[C]sync\f[R] operations and perform -renaming server\-side. +If you use this flag, and the remote supports server\-side copy or +server\-side move, and the source and destination have a compatible +hash, then this will track renames during \f[C]sync\f[R] operations and +perform renaming server\-side. .PP Files will be matched by size and hash \- if both match then a rename will be considered. @@ -8671,7 +9082,7 @@ If there have been errors before the deletions start then you will get the message \f[C]not deleting files as there were IO errors\f[R]. .SS \-\-fast\-list .PP -When doing anything which involves a directory listing (eg +When doing anything which involves a directory listing (e.g. \f[C]sync\f[R], \f[C]copy\f[R], \f[C]ls\f[R] \- in fact nearly every command), rclone normally lists a directory and processes it before using more directory lists to process any subdirectories. @@ -8680,8 +9091,8 @@ of memory. .PP However, some remotes have a way of listing all files beneath a directory in one (or a small number) of transactions. -These tend to be the bucket based remotes (eg S3, B2, GCS, Swift, -Hubic). +These tend to be the bucket based remotes (e.g. +S3, B2, GCS, Swift, Hubic). .PP If you use the \f[C]\-\-fast\-list\f[R] flag then rclone will use this method for listing directories. @@ -8968,8 +9379,9 @@ This will make rclone fail instead of asking for a password if These options are useful when developing or debugging rclone. There are also some more remote specific options which aren\[aq]t documented here which are used for testing. -These start with remote name eg \f[C]\-\-drive\-test\-option\f[R] \- see -the docs for the remote in question. +These start with remote name e.g. +\f[C]\-\-drive\-test\-option\f[R] \- see the docs for the remote in +question. .SS \-\-cpuprofile=FILE .PP Write CPU profile to file. @@ -9088,7 +9500,8 @@ rclone has 4 levels of logging, \f[C]ERROR\f[R], \f[C]NOTICE\f[R], .PP By default, rclone logs to standard error. This means you can redirect standard error and still see the normal -output of rclone commands (eg \f[C]rclone ls\f[R]). +output of rclone commands (e.g. +\f[C]rclone ls\f[R]). .PP By default, rclone will produce \f[C]Error\f[R] and \f[C]Notice\f[R] level messages. @@ -9112,8 +9525,8 @@ standard error to FILE. If you use the \f[C]\-\-syslog\f[R] flag then rclone will log to syslog and the \f[C]\-\-syslog\-facility\f[R] control which facility it uses. .PP -Rclone prefixes all log messages with their level in capitals, eg INFO -which makes it easy to grep the log file for different kinds of +Rclone prefixes all log messages with their level in capitals, e.g. +INFO which makes it easy to grep the log file for different kinds of information. .SS Exit Code .PP @@ -9220,17 +9633,20 @@ must create the \f[C]..._TYPE\f[R] variable as above. The various different methods of backend configuration are read in this order and the first one with a value is used. .IP \[bu] 2 -Flag values as supplied on the command line, eg +Flag values as supplied on the command line, e.g. \f[C]\-\-drive\-use\-trash\f[R]. .IP \[bu] 2 -Remote specific environment vars, eg +Remote specific environment vars, e.g. \f[C]RCLONE_CONFIG_MYREMOTE_USE_TRASH\f[R] (see above). .IP \[bu] 2 -Backend specific environment vars, eg \f[C]RCLONE_DRIVE_USE_TRASH\f[R]. +Backend specific environment vars, e.g. +\f[C]RCLONE_DRIVE_USE_TRASH\f[R]. .IP \[bu] 2 -Config file, eg \f[C]use_trash = false\f[R]. +Config file, e.g. +\f[C]use_trash = false\f[R]. .IP \[bu] 2 -Default values, eg \f[C]true\f[R] \- these can\[aq]t be changed. +Default values, e.g. +\f[C]true\f[R] \- these can\[aq]t be changed. .PP So if both \f[C]\-\-drive\-use\-trash\f[R] is supplied on the config line and an environment variable \f[C]RCLONE_DRIVE_USE_TRASH\f[R] is @@ -9238,11 +9654,14 @@ set, the command line flag will take preference. .PP For non backend configuration the order is as follows: .IP \[bu] 2 -Flag values as supplied on the command line, eg \f[C]\-\-stats 5s\f[R]. +Flag values as supplied on the command line, e.g. +\f[C]\-\-stats 5s\f[R]. .IP \[bu] 2 -Environment vars, eg \f[C]RCLONE_STATS=5s\f[R]. +Environment vars, e.g. +\f[C]RCLONE_STATS=5s\f[R]. .IP \[bu] 2 -Default values, eg \f[C]1m\f[R] \- these can\[aq]t be changed. +Default values, e.g. +\f[C]1m\f[R] \- these can\[aq]t be changed. .SS Other environment variables .IP \[bu] 2 \f[C]RCLONE_CONFIG_PASS\f[R] set to contain your config file password @@ -9269,8 +9688,9 @@ Some of the configurations (those involving oauth2) require an Internet connected web browser. .PP If you are trying to set rclone up on a remote or headless box with no -browser available on it (eg a NAS or a server in a datacenter) then you -will need to use an alternative means of configuration. +browser available on it (e.g. +a NAS or a server in a datacenter) then you will need to use an +alternative means of configuration. There are two ways of doing it, described below. .SS Configuring using rclone authorize .PP @@ -9360,128 +9780,115 @@ Configuration file is stored at: \f[R] .fi .PP -Now transfer it to the remote box (scp, cut paste, ftp, sftp etc) and +Now transfer it to the remote box (scp, cut paste, ftp, sftp, etc.) and place it in the correct place (use \f[C]rclone config file\f[R] on the remote box to find out where). .SH Filtering, includes and excludes .PP -Rclone has a sophisticated set of include and exclude rules. -Some of these are based on patterns and some on other things like file -size. -.PP -The filters are applied for the \f[C]copy\f[R], \f[C]sync\f[R], +Filter flags determine which files rclone \f[C]sync\f[R], \f[C]move\f[R], \f[C]ls\f[R], \f[C]lsl\f[R], \f[C]md5sum\f[R], -\f[C]sha1sum\f[R], \f[C]size\f[R], \f[C]delete\f[R] and \f[C]check\f[R] -operations. -Note that \f[C]purge\f[R] does not obey the filters. +\f[C]sha1sum\f[R], \f[C]size\f[R], \f[C]delete\f[R], \f[C]check\f[R] and +similar commands apply to. .PP -Each path as it passes through rclone is matched against the include and -exclude rules like \f[C]\-\-include\f[R], \f[C]\-\-exclude\f[R], -\f[C]\-\-include\-from\f[R], \f[C]\-\-exclude\-from\f[R], -\f[C]\-\-filter\f[R], or \f[C]\-\-filter\-from\f[R]. -The simplest way to try them out is using the \f[C]ls\f[R] command, or -\f[C]\-\-dry\-run\f[R] together with \f[C]\-v\f[R]. -\f[C]\-\-filter\-from\f[R], \f[C]\-\-exclude\-from\f[R], -\f[C]\-\-include\-from\f[R], \f[C]\-\-files\-from\f[R], -\f[C]\-\-files\-from\-raw\f[R] understand \f[C]\-\f[R] as a file name to -mean read from standard input. -.SS Patterns +They are specified in terms of path/file name patterns; path/file lists; +file age and size, or presence of a file in a directory. +Bucket based remotes without the concept of directory apply filters to +object key, age and size in an analogous way. .PP -The patterns used to match files for inclusion or exclusion are based on -\[dq]file globs\[dq] as used by the unix shell. +Rclone \f[C]purge\f[R] does not obey filters. .PP -If the pattern starts with a \f[C]/\f[R] then it only matches at the top -level of the directory tree, \f[B]relative to the root of the -remote\f[R] (not necessarily the root of the local drive). -If it doesn\[aq]t start with \f[C]/\f[R] then it is matched starting at -the \f[B]end of the path\f[R], but it will only match a complete path -element: +To test filters without risk of damage to data, apply them to +\f[C]rclone ls\f[R], or with the \f[C]\-\-dry\-run\f[R] and +\f[C]\-vv\f[R] flags. +.PP +Rclone filter patterns can only be used in filter command line options, +not in the specification of a remote. +.PP +E.g. +\f[C]rclone copy \[dq]remote:dir*.jpg\[dq] /path/to/dir\f[R] does not +have a filter effect. +\f[C]rclone copy remote:dir /path/to/dir \-\-include \[dq]*.jpg\[dq]\f[R] +does. +.PP +\f[B]Important\f[R] Avoid mixing any two of \f[C]\-\-include...\f[R], +\f[C]\-\-exclude...\f[R] or \f[C]\-\-filter...\f[R] flags in an rclone +command. +The results may not be what you expect. +Instead use a \f[C]\-\-filter...\f[R] flag. +.SS Patterns for matching path/file names +.SS Pattern syntax +.PP +Rclone matching rules follow a glob style: .IP .nf \f[C] -file.jpg \- matches \[dq]file.jpg\[dq] - \- matches \[dq]directory/file.jpg\[dq] - \- doesn\[aq]t match \[dq]afile.jpg\[dq] - \- doesn\[aq]t match \[dq]directory/afile.jpg\[dq] -/file.jpg \- matches \[dq]file.jpg\[dq] in the root directory of the remote - \- doesn\[aq]t match \[dq]afile.jpg\[dq] - \- doesn\[aq]t match \[dq]directory/file.jpg\[dq] +\[ga]*\[ga] matches any sequence of non\-separator (\[ga]/\[ga]) characters +\[ga]**\[ga] matches any sequence of characters including \[ga]/\[ga] separators +\[ga]?\[ga] matches any single non\-separator (\[ga]/\[ga]) character +\[ga][\[ga] [ \[ga]!\[ga] ] { character\-range } \[ga]]\[ga] + character class (must be non\-empty) +\[ga]{\[ga] pattern\-list \[ga]}\[ga] + pattern alternatives +c matches character c (c != \[ga]*\[ga], \[ga]**\[ga], \[ga]?\[ga], \[ga]\[rs]\[ga], \[ga][\[ga], \[ga]{\[ga], \[ga]}\[ga]) +\[ga]\[rs]\[ga] c matches character c \f[R] .fi .PP -\f[B]Important\f[R] Note that you must use \f[C]/\f[R] in patterns and -not \f[C]\[rs]\f[R] even if running on Windows. -.PP -A \f[C]*\f[R] matches anything but not a \f[C]/\f[R]. +character\-range: .IP .nf \f[C] -*.jpg \- matches \[dq]file.jpg\[dq] - \- matches \[dq]directory/file.jpg\[dq] - \- doesn\[aq]t match \[dq]file.jpg/something\[dq] +c matches character c (c != \[ga]\[rs]\[rs]\[ga], \[ga]\-\[ga], \[ga]]\[ga]) +\[ga]\[rs]\[ga] c matches character c +lo \[ga]\-\[ga] hi matches character c for lo <= c <= hi \f[R] .fi .PP -Use \f[C]**\f[R] to match anything, including slashes (\f[C]/\f[R]). +pattern\-list: .IP .nf \f[C] -dir/** \- matches \[dq]dir/file.jpg\[dq] - \- matches \[dq]dir/dir1/dir2/file.jpg\[dq] - \- doesn\[aq]t match \[dq]directory/file.jpg\[dq] - \- doesn\[aq]t match \[dq]adir/file.jpg\[dq] +pattern { \[ga],\[ga] pattern } + comma\-separated (without spaces) patterns \f[R] .fi .PP -A \f[C]?\f[R] matches any character except a slash \f[C]/\f[R]. +character classes (see Go regular expression +reference (https://golang.org/pkg/regexp/syntax/)) include: .IP .nf \f[C] -l?ss \- matches \[dq]less\[dq] - \- matches \[dq]lass\[dq] - \- doesn\[aq]t match \[dq]floss\[dq] +Named character classes (e.g. [\[rs]d], [\[ha]\[rs]d], [\[rs]D], [\[ha]\[rs]D]) +Perl character classes (e.g. \[rs]s, \[rs]S, \[rs]w, \[rs]W) +ASCII character classes (e.g. [[:alnum:]], [[:alpha:]], [[:punct:]], [[:xdigit:]]) \f[R] .fi .PP -A \f[C][\f[R] and \f[C]]\f[R] together make a character class, such as -\f[C][a\-z]\f[R] or \f[C][aeiou]\f[R] or \f[C][[:alpha:]]\f[R]. -See the go regexp docs (https://golang.org/pkg/regexp/syntax/) for more -info on these. +If the filter pattern starts with a \f[C]/\f[R] then it only matches at +the top level of the directory tree, \f[B]relative to the root of the +remote\f[R] (not necessarily the root of the drive). +If it does not start with \f[C]/\f[R] then it is matched starting at the +\f[B]end of the path/file name\f[R] but it only matches a complete path +element \- it must match from a \f[C]/\f[R] separator or the beginning +of the path/file. .IP .nf \f[C] -h[ae]llo \- matches \[dq]hello\[dq] - \- matches \[dq]hallo\[dq] - \- doesn\[aq]t match \[dq]hullo\[dq] +file.jpg \- matches \[dq]file.jpg\[dq] + \- matches \[dq]directory/file.jpg\[dq] + \- doesn\[aq]t match \[dq]afile.jpg\[dq] + \- doesn\[aq]t match \[dq]directory/afile.jpg\[dq] +/file.jpg \- matches \[dq]file.jpg\[dq] in the root directory of the remote + \- doesn\[aq]t match \[dq]afile.jpg\[dq] + \- doesn\[aq]t match \[dq]directory/file.jpg\[dq] \f[R] .fi .PP -A \f[C]{\f[R] and \f[C]}\f[R] define a choice between elements. -It should contain a comma separated list of patterns, any of which might -match. -These patterns can contain wildcards. -.IP -.nf -\f[C] -{one,two}_potato \- matches \[dq]one_potato\[dq] - \- matches \[dq]two_potato\[dq] - \- doesn\[aq]t match \[dq]three_potato\[dq] - \- doesn\[aq]t match \[dq]_potato\[dq] -\f[R] -.fi +\f[B]Important\f[R] Use \f[C]/\f[R] in path/file name patterns and not +\f[C]\[rs]\f[R] even if running on Microsoft Windows. .PP -Special characters can be escaped with a \f[C]\[rs]\f[R] before them. -.IP -.nf -\f[C] -\[rs]*.jpg \- matches \[dq]*.jpg\[dq] -\[rs]\[rs].jpg \- matches \[dq]\[rs].jpg\[dq] -\[rs][one\[rs]].jpg \- matches \[dq][one].jpg\[dq] -\f[R] -.fi -.PP -Patterns are case sensitive unless the \f[C]\-\-ignore\-case\f[R] flag -is used. +Simple patterns are case sensitive unless the \f[C]\-\-ignore\-case\f[R] +flag is used. .PP Without \f[C]\-\-ignore\-case\f[R] (default) .IP @@ -9500,97 +9907,10 @@ potato \- matches \[dq]potato\[dq] \- matches \[dq]POTATO\[dq] \f[R] .fi +.SS How filter rules are applied to files .PP -Note also that rclone filter globs can only be used in one of the filter -command line flags, not in the specification of the remote, so -\f[C]rclone copy \[dq]remote:dir*.jpg\[dq] /path/to/dir\f[R] won\[aq]t -work \- what is required is -\f[C]rclone \-\-include \[dq]*.jpg\[dq] copy remote:dir /path/to/dir\f[R] -.SS Directories -.PP -Rclone keeps track of directories that could match any file patterns. -.PP -Eg if you add the include rule -.IP -.nf -\f[C] -/a/*.jpg -\f[R] -.fi -.PP -Rclone will synthesize the directory include rule -.IP -.nf -\f[C] -/a/ -\f[R] -.fi -.PP -If you put any rules which end in \f[C]/\f[R] then it will only match -directories. -.PP -Directory matches are \f[B]only\f[R] used to optimise directory access -patterns \- you must still match the files that you want to match. -Directory matches won\[aq]t optimise anything on bucket based remotes -(eg s3, swift, google compute storage, b2) which don\[aq]t have a -concept of directory. -.SS Differences between rsync and rclone patterns -.PP -Rclone implements bash style \f[C]{a,b,c}\f[R] glob matching which rsync -doesn\[aq]t. -.PP -Rclone always does a wildcard match so \f[C]\[rs]\f[R] must always -escape a \f[C]\[rs]\f[R]. -.SS How the rules are used -.PP -Rclone maintains a combined list of include rules and exclude rules. -.PP -Each file is matched in order, starting from the top, against the rule -in the list until it finds a match. -The file is then included or excluded according to the rule type. -.PP -If the matcher fails to find a match after testing against all the -entries in the list then the path is included. -.PP -For example given the following rules, \f[C]+\f[R] being include, -\f[C]\-\f[R] being exclude, -.IP -.nf -\f[C] -\- secret*.jpg -+ *.jpg -+ *.png -+ file2.avi -\- * -\f[R] -.fi -.PP -This would include -.IP \[bu] 2 -\f[C]file1.jpg\f[R] -.IP \[bu] 2 -\f[C]file3.png\f[R] -.IP \[bu] 2 -\f[C]file2.avi\f[R] -.PP -This would exclude -.IP \[bu] 2 -\f[C]secret17.jpg\f[R] -.IP \[bu] 2 -non \f[C]*.jpg\f[R] and \f[C]*.png\f[R] -.PP -A similar process is done on directory entries before recursing into -them. -This only works on remotes which have a concept of directory (Eg local, -google drive, onedrive, amazon drive) and not on bucket based remotes -(eg s3, swift, google compute storage, b2). -.SS Adding filtering rules -.PP -Filtering rules are added with the following command line flags. -.SS Repeating options -.PP -You can repeat the following options to add more than one rule of that -type. +Rclone path / file name filters are made up of one or more of the +following flags: .IP \[bu] 2 \f[C]\-\-include\f[R] .IP \[bu] 2 @@ -9603,40 +9923,193 @@ type. \f[C]\-\-filter\f[R] .IP \[bu] 2 \f[C]\-\-filter\-from\f[R] +.PP +There can be more than one instance of individual flags. +.PP +Rclone internally uses a combined list of all the include and exclude +rules. +The order in which rules are processed can influence the result of the +filter. +.PP +All flags of the same type are processed together in the order above, +regardless of what order the different types of flags are included on +the command line. +.PP +Multiple instances of the same flag are processed from left to right +according to their position in the command line. +.PP +To mix up the order of processing includes and excludes use +\f[C]\-\-filter...\f[R] flags. +.PP +Within \f[C]\-\-include\-from\f[R], \f[C]\-\-exclude\-from\f[R] and +\f[C]\-\-filter\-from\f[R] flags rules are processed from top to bottom +of the referenced file.. +.PP +If there is an \f[C]\-\-include\f[R] or \f[C]\-\-include\-from\f[R] flag +specified, rclone implies a \f[C]\- **\f[R] rule which it adds to the +bottom of the internal rule list. +Specifying a \f[C]+\f[R] rule with a \f[C]\-\-filter...\f[R] flag does +not imply that rule. +.PP +Each path/file name passed through rclone is matched against the +combined filter list. +At first match to a rule the path/file name is included or excluded and +no further filter rules are processed for that path/file. +.PP +If rclone does not find a match, after testing against all rules +(including the implied rule if appropriate), the path/file name is +included. +.PP +Any path/file included at that stage is processed by the rclone command. +.PP +\f[C]\-\-files\-from\f[R] and \f[C]\-\-files\-from\-raw\f[R] flags +over\-ride and cannot be combined with other filter options. +.PP +To see the internal combined rule list, in regular expression form, for +a command add the \f[C]\-\-dump filters\f[R] flag. +Running an rclone command with \f[C]\-\-dump filters\f[R] and +\f[C]\-vv\f[R] flags lists the internal filter elements and shows how +they are applied to each source path/file. +There is not currently a means provided to pass regular expression +filter options into rclone directly though character class filter rules +contain character classes. +Go regular expression reference (https://golang.org/pkg/regexp/syntax/) +.SS How filter rules are applied to directories +.PP +Rclone commands filter, and are applied to, path/file names not +directories. +The entire contents of a directory can be matched to a filter by the +pattern \f[C]directory/*\f[R] or recursively by \f[C]directory/**\f[R]. +.PP +Directory filter rules are defined with a closing \f[C]/\f[R] separator. +.PP +E.g. +\f[C]/directory/subdirectory/\f[R] is an rclone directory filter rule. +.PP +Rclone commands can use directory filter rules to determine whether they +recurse into subdirectories. +This potentially optimises access to a remote by avoiding listing +unnecessary directories. +Whether optimisation is desirable depends on the specific filter rules +and source remote content. +.PP +Optimisation occurs if either: .IP \[bu] 2 -\f[C]\-\-filter\-from\-raw\f[R] +A source remote does not support the rclone \f[C]ListR\f[R] primitive. +\f[C]local\f[R], \f[C]sftp\f[R], \f[C]Microsoft OneDrive\f[R] and +\f[C]WebDav\f[R] do not support \f[C]ListR\f[R]. +Google Drive and most bucket type storage do. +Full list (https://rclone.org/overview/#optional-features) +.IP \[bu] 2 +On other remotes, if the rclone command is not naturally recursive, +provided it is not run with the \f[C]\-\-fast\-list\f[R] flag. +\f[C]ls\f[R], \f[C]lsf \-R\f[R] and \f[C]size\f[R] are recursive but +\f[C]sync\f[R], \f[C]copy\f[R] and \f[C]move\f[R] are not. +.IP \[bu] 2 +Whenever the \f[C]\-\-disable ListR\f[R] flag is applied to an rclone +command. .PP -\f[B]Important\f[R] You should not use \f[C]\-\-include*\f[R] together -with \f[C]\-\-exclude*\f[R]. -It may produce different results than you expected. -In that case try to use: \f[C]\-\-filter*\f[R]. +Rclone commands imply directory filter rules from path/file filter +rules. +To view the directory filter rules rclone has implied for a command +specify the \f[C]\-\-dump filters\f[R] flag. .PP -Note that all the options of the same type are processed together in the -order above, regardless of what order they were placed on the command -line. +E.g. +for an include rule +.IP +.nf +\f[C] +/a/*.jpg +\f[R] +.fi .PP -So all \f[C]\-\-include\f[R] options are processed first in the order -they appeared on the command line, then all \f[C]\-\-include\-from\f[R] -options etc. +Rclone implies the directory include rule +.IP +.nf +\f[C] +/a/ +\f[R] +.fi .PP -To mix up the order includes and excludes, the \f[C]\-\-filter\f[R] flag -can be used. +Directory filter rules specified in an rclone command can limit the +scope of an rclone command but path/file filters still have to be +specified. +.PP +E.g. +\f[C]rclone ls remote: \-\-include /directory/\f[R] will not match any +files. +Because it is an \f[C]\-\-include\f[R] option the +\f[C]\-\-exclude **\f[R] rule is implied, and the +\f[C]\[rs]directory\[rs]\f[R] pattern serves only to optimise access to +the remote by ignoring everything outside of that directory. +.PP +E.g. +\f[C]rclone ls remote: \-\-filter\-from filter\-list.txt\f[R] with a +file \f[C]filter\-list.txt\f[R]: +.IP +.nf +\f[C] +\- /dir1/ +\- /dir2/ ++ *.pdf +\- ** +\f[R] +.fi +.PP +All files in directories \f[C]dir1\f[R] or \f[C]dir2\f[R] or their +subdirectories are completely excluded from the listing. +Only files of suffix \f[C]\[aq]pdf\f[R] in the root of \f[C]remote:\f[R] +or its subdirectories are listed. +The \f[C]\- **\f[R] rule prevents listing of any path/files not +previously matched by the rules above. +.PP +Option \f[C]exclude\-if\-present\f[R] creates a directory exclude rule +based on the presence of a file in a directory and takes precedence over +other rclone directory filter rules. .SS \f[C]\-\-exclude\f[R] \- Exclude files matching pattern .PP -Add a single exclude rule with \f[C]\-\-exclude\f[R]. +Excludes path/file names from an rclone command based on a single +exclude rule. .PP This flag can be repeated. -See above for the order the flags are processed in. +See above for the order filter flags are processed in. .PP -Eg \f[C]\-\-exclude *.bak\f[R] to exclude all bak files from the sync. +\f[C]\-\-exclude\f[R] should not be used with \f[C]\-\-include\f[R], +\f[C]\-\-include\-from\f[R], \f[C]\-\-filter\f[R] or +\f[C]\-\-filter\-from\f[R] flags. +.PP +\f[C]\-\-exclude\f[R] has no effect when combined with +\f[C]\-\-files\-from\f[R] or \f[C]\-\-files\-from\-raw\f[R] flags. +.PP +E.g. +\f[C]rclone ls remote: \-\-exclude *.bak\f[R] excludes all .bak files +from listing. +.PP +E.g. +\f[C]rclone size remote: \[dq]\-\-exclude /dir/**\[dq]\f[R] returns the +total size of all files on \f[C]remote:\f[R] excluding those in root +directory \f[C]dir\f[R] and sub directories. +.PP +E.g. +on Microsoft Windows +\f[C]rclone ls remote: \-\-exclude \[dq]*\[rs][{JP,KR,HK}\[rs]]*\[dq]\f[R] +lists the files in \f[C]remote:\f[R] with \f[C][JP]\f[R] or +\f[C][KR]\f[R] or \f[C][HK]\f[R] in their name. +The single quotes prevent the shell from interpreting the +\f[C]\[rs]\f[R] characters. +The \f[C]\[rs]\f[R] characters escape the \f[C][\f[R] and \f[C]]\f[R] so +ran clone filter treats them literally rather than as a +character\-range. +The \f[C]{\f[R] and \f[C]}\f[R] define an rclone pattern list. +For other operating systems single quotes are required ie +\f[C]rclone ls remote: \-\-exclude \[aq]*\[rs][{JP,KR,HK}\[rs]]*\[aq]\f[R] .SS \f[C]\-\-exclude\-from\f[R] \- Read exclude patterns from file .PP -Add exclude rules from a file. +Excludes path/file names from an rclone command based on rules in a +named file. +The file contains a list of remarks and pattern rules. .PP -This flag can be repeated. -See above for the order the flags are processed in. -.PP -Prepare a file like this \f[C]exclude\-file.txt\f[R] +For an example \f[C]exclude\-file.txt\f[R]: .IP .nf \f[C] @@ -9646,82 +10119,162 @@ file2.jpg \f[R] .fi .PP -Then use as \f[C]\-\-exclude\-from exclude\-file.txt\f[R]. -This will sync all files except those ending in \f[C]bak\f[R] and -\f[C]file2.jpg\f[R]. +\f[C]rclone ls remote: \-\-exclude\-from exclude\-file.txt\f[R] lists +the files on \f[C]remote:\f[R] except those named \f[C]file2.jpg\f[R] or +with a suffix \f[C].bak\f[R]. +That is equivalent to +\f[C]rclone ls remote: \-\-exclude file2.jpg \-\-exclude \[dq]*.bak\[dq]\f[R]. .PP -This is useful if you have a lot of rules. +This flag can be repeated. +See above for the order filter flags are processed in. +.PP +The \f[C]\-\-exclude\-from\f[R] flag is useful where multiple exclude +filter rules are applied to an rclone command. +.PP +\f[C]\-\-exclude\-from\f[R] should not be used with +\f[C]\-\-include\f[R], \f[C]\-\-include\-from\f[R], \f[C]\-\-filter\f[R] +or \f[C]\-\-filter\-from\f[R] flags. +.PP +\f[C]\-\-exclude\-from\f[R] has no effect when combined with +\f[C]\-\-files\-from\f[R] or \f[C]\-\-files\-from\-raw\f[R] flags. +.PP +\f[C]\-\-exclude\-from\f[R] followed by \f[C]\-\f[R] reads filter rules +from standard input. .SS \f[C]\-\-include\f[R] \- Include files matching pattern .PP -Add a single include rule with \f[C]\-\-include\f[R]. +Adds a single include rule based on path/file names to an rclone +command. .PP This flag can be repeated. -See above for the order the flags are processed in. +See above for the order filter flags are processed in. .PP -Eg \f[C]\-\-include *.{png,jpg}\f[R] to include all \f[C]png\f[R] and -\f[C]jpg\f[R] files in the backup and no others. +\f[C]\-\-include\f[R] has no effect when combined with +\f[C]\-\-files\-from\f[R] or \f[C]\-\-files\-from\-raw\f[R] flags. .PP -This adds an implicit \f[C]\-\-exclude *\f[R] at the very end of the -filter list. -This means you can mix \f[C]\-\-include\f[R] and -\f[C]\-\-include\-from\f[R] with the other filters (eg -\f[C]\-\-exclude\f[R]) but you must include all the files you want in -the include statement. -If this doesn\[aq]t provide enough flexibility then you must use -\f[C]\-\-filter\-from\f[R]. +\f[C]\-\-include\f[R] implies \f[C]\-\-exclude **\f[R] at the end of an +rclone internal filter list. +Therefore if you mix \f[C]\-\-include\f[R] and +\f[C]\-\-include\-from\f[R] flags with \f[C]\-\-exclude\f[R], +\f[C]\-\-exclude\-from\f[R], \f[C]\-\-filter\f[R] or +\f[C]\-\-filter\-from\f[R], you must use include rules for all the files +you want in the include statement. +For more flexibility use the \f[C]\-\-filter\-from\f[R] flag. +.PP +E.g. +\f[C]rclone ls remote: \-\-include \[dq]*.{png,jpg}\[dq]\f[R] lists the +files on \f[C]remote:\f[R] with suffix \f[C].png\f[R] and +\f[C].jpg\f[R]. +All other files are excluded. +.PP +E.g. +multiple rclone copy commands can be combined with \f[C]\-\-include\f[R] +and a pattern\-list. +.IP +.nf +\f[C] +rclone copy /vol1/A remote:A +rclone copy /vol1/B remote:B +\f[R] +.fi +.PP +is equivalent to: +.IP +.nf +\f[C] +rclone copy /vol1 remote: \-\-include \[dq]{A,B}/**\[dq] +\f[R] +.fi +.PP +E.g. +\f[C]rclone ls remote:/wheat \-\-include \[dq]??[\[ha][:punct:]]*\[dq]\f[R] +lists the files \f[C]remote:\f[R] directory \f[C]wheat\f[R] (and +subdirectories) whose third character is not punctuation. +This example uses an ASCII character +class (https://golang.org/pkg/regexp/syntax/). .SS \f[C]\-\-include\-from\f[R] \- Read include patterns from file .PP -Add include rules from a file. +Adds path/file names to an rclone command based on rules in a named +file. +The file contains a list of remarks and pattern rules. .PP -This flag can be repeated. -See above for the order the flags are processed in. -.PP -Prepare a file like this \f[C]include\-file.txt\f[R] +For an example \f[C]include\-file.txt\f[R]: .IP .nf \f[C] # a sample include rule file *.jpg -*.png file2.avi \f[R] .fi .PP -Then use as \f[C]\-\-include\-from include\-file.txt\f[R]. -This will sync all \f[C]jpg\f[R], \f[C]png\f[R] files and -\f[C]file2.avi\f[R]. +\f[C]rclone ls remote: \-\-include\-from include\-file.txt\f[R] lists +the files on \f[C]remote:\f[R] with name \f[C]file2.avi\f[R] or suffix +\f[C].jpg\f[R]. +That is equivalent to +\f[C]rclone ls remote: \-\-include file2.avi \-\-include \[dq]*.jpg\[dq]\f[R]. .PP -This is useful if you have a lot of rules. +This flag can be repeated. +See above for the order filter flags are processed in. .PP -This adds an implicit \f[C]\-\-exclude *\f[R] at the very end of the -filter list. -This means you can mix \f[C]\-\-include\f[R] and -\f[C]\-\-include\-from\f[R] with the other filters (eg -\f[C]\-\-exclude\f[R]) but you must include all the files you want in -the include statement. -If this doesn\[aq]t provide enough flexibility then you must use -\f[C]\-\-filter\-from\f[R]. +The \f[C]\-\-include\-from\f[R] flag is useful where multiple include +filter rules are applied to an rclone command. +.PP +\f[C]\-\-include\-from\f[R] implies \f[C]\-\-exclude **\f[R] at the end +of an rclone internal filter list. +Therefore if you mix \f[C]\-\-include\f[R] and +\f[C]\-\-include\-from\f[R] flags with \f[C]\-\-exclude\f[R], +\f[C]\-\-exclude\-from\f[R], \f[C]\-\-filter\f[R] or +\f[C]\-\-filter\-from\f[R], you must use include rules for all the files +you want in the include statement. +For more flexibility use the \f[C]\-\-filter\-from\f[R] flag. +.PP +\f[C]\-\-exclude\-from\f[R] has no effect when combined with +\f[C]\-\-files\-from\f[R] or \f[C]\-\-files\-from\-raw\f[R] flags. +.PP +\f[C]\-\-exclude\-from\f[R] followed by \f[C]\-\f[R] reads filter rules +from standard input. .SS \f[C]\-\-filter\f[R] \- Add a file\-filtering rule .PP -This can be used to add a single include or exclude rule. -Include rules start with \f[C]+\f[R] and exclude rules start with -\f[C]\-\f[R]. -A special rule called \f[C]!\f[R] can be used to clear the existing -rules. +Specifies path/file names to an rclone command, based on a single +include or exclude rule, in \f[C]+\f[R] or \f[C]\-\f[R] format. .PP This flag can be repeated. -See above for the order the flags are processed in. +See above for the order filter flags are processed in. .PP -Eg \f[C]\-\-filter \[dq]\- *.bak\[dq]\f[R] to exclude all bak files from -the sync. +\f[C]\-\-filter +\f[R] differs from \f[C]\-\-include\f[R]. +In the case of \f[C]\-\-include\f[R] rclone implies an +\f[C]\-\-exclude *\f[R] rule which it adds to the bottom of the internal +rule list. +\f[C]\-\-filter...+\f[R] does not imply that rule. +.PP +\f[C]\-\-filter\f[R] has no effect when combined with +\f[C]\-\-files\-from\f[R] or \f[C]\-\-files\-from\-raw\f[R] flags. +.PP +\f[C]\-\-filter\f[R] should not be used with \f[C]\-\-include\f[R], +\f[C]\-\-include\-from\f[R], \f[C]\-\-exclude\f[R] or +\f[C]\-\-exclude\-from\f[R] flags. +.PP +E.g. +\f[C]rclone ls remote: \-\-filter \[dq]\- *.bak\[dq]\f[R] excludes all +\f[C].bak\f[R] files from a list of \f[C]remote:\f[R]. .SS \f[C]\-\-filter\-from\f[R] \- Read filtering patterns from a file .PP -Add include/exclude rules from a file. +Adds path/file names to an rclone command based on rules in a named +file. +The file contains a list of remarks and pattern rules. +Include rules start with \f[C]+\f[R] and exclude rules with +\f[C]\-\f[R]. +\f[C]!\f[R] clears existing rules. +Rules are processed in the order they are defined. .PP This flag can be repeated. -See above for the order the flags are processed in. +See above for the order filter flags are processed in. .PP -Prepare a file like this \f[C]filter\-file.txt\f[R] +Arrange the order of filter rules with the most restrictive first and +work down. +.PP +E.g. +For \f[C]filter\-file.txt\f[R]: .IP .nf \f[C] @@ -9737,48 +10290,88 @@ Prepare a file like this \f[C]filter\-file.txt\f[R] \f[R] .fi .PP -Then use as \f[C]\-\-filter\-from filter\-file.txt\f[R]. -The rules are processed in the order that they are defined. +\f[C]rclone ls remote: \-\-filter\-from filter\-file.txt\f[R] lists the +path/files on \f[C]remote:\f[R] including all \f[C]jpg\f[R] and +\f[C]png\f[R] files, excluding any matching \f[C]secret*.jpg\f[R] and +including \f[C]file2.avi\f[R]. +It also includes everything in the directory \f[C]dir\f[R] at the root +of \f[C]remote\f[R], except \f[C]remote:dir/Trash\f[R] which it +excludes. +Everything else is excluded. .PP -This example will include all \f[C]jpg\f[R] and \f[C]png\f[R] files, -exclude any files matching \f[C]secret*.jpg\f[R] and include -\f[C]file2.avi\f[R]. -It will also include everything in the directory \f[C]dir\f[R] at the -root of the sync, except \f[C]dir/Trash\f[R] which it will exclude. -Everything else will be excluded from the sync. +E.g. +for an alternative \f[C]filter\-file.txt\f[R]: +.IP +.nf +\f[C] +\- secret*.jpg ++ *.jpg ++ *.png ++ file2.avi +\- * +\f[R] +.fi +.PP +Files \f[C]file1.jpg\f[R], \f[C]file3.png\f[R] and \f[C]file2.avi\f[R] +are listed whilst \f[C]secret17.jpg\f[R] and files without the suffix +\&.jpg\f[C]or\f[R].png\[ga] are excluded. +.PP +E.g. +for an alternative \f[C]filter\-file.txt\f[R]: +.IP +.nf +\f[C] ++ *.jpg ++ *.gif +! ++ 42.doc +\- * +\f[R] +.fi +.PP +Only file 42.doc is listed. +Prior rules are cleared by the \f[C]!\f[R]. .SS \f[C]\-\-files\-from\f[R] \- Read list of source\-file names .PP -This reads a list of file names from the file passed in and -\f[B]only\f[R] these files are transferred. -The \f[B]filtering rules are ignored\f[R] completely if you use this -option. +Adds path/files to an rclone command from a list in a named file. +Rclone processes the path/file names in the order of the list, and no +others. +.PP +Other filter flags (\f[C]\-\-include\f[R], \f[C]\-\-include\-from\f[R], +\f[C]\-\-exclude\f[R], \f[C]\-\-exclude\-from\f[R], \f[C]\-\-filter\f[R] +and \f[C]\-\-filter\-from\f[R]) are ignored when +\f[C]\-\-files\-from\f[R] is used. .PP \f[C]\-\-files\-from\f[R] expects a list of files as its input. -Leading / trailing whitespace is stripped from the input lines and lines -starting with \f[C]#\f[R] and \f[C];\f[R] are ignored. +Leading or trailing whitespace is stripped from the input lines. +Lines starting with \f[C]#\f[R] or \f[C];\f[R] are ignored. .PP -Rclone will traverse the file system if you use -\f[C]\-\-files\-from\f[R], effectively using the files in -\f[C]\-\-files\-from\f[R] as a set of filters. -Rclone will not error if any of the files are missing. +Rclone commands with a \f[C]\-\-files\-from\f[R] flag traverse the +remote, treating the names in \f[C]\-\-files\-from\f[R] as a set of +filters. .PP -If you use \f[C]\-\-no\-traverse\f[R] as well as -\f[C]\-\-files\-from\f[R] then rclone will not traverse the destination -file system, it will find each file individually using approximately 1 -API call. -This can be more efficient for small lists of files. +If the \f[C]\-\-no\-traverse\f[R] and \f[C]\-\-files\-from\f[R] flags +are used together an rclone command does not traverse the remote. +Instead it addresses each path/file named in the file individually. +For each path/file name, that requires typically 1 API call. +This can be efficient for a short \f[C]\-\-files\-from\f[R] list and a +remote containing many files. .PP -This option can be repeated to read from more than one file. -These are read in the order that they are placed on the command line. +Rclone commands do not error if any names in the +\f[C]\-\-files\-from\f[R] file are missing from the source remote. .PP -Paths within the \f[C]\-\-files\-from\f[R] file will be interpreted as -starting with the root specified in the command. -Leading \f[C]/\f[R] characters are ignored. +The \f[C]\-\-files\-from\f[R] flag can be repeated in a single rclone +command to read path/file names from more than one file. +The files are read from left to right along the command line. +.PP +Paths within the \f[C]\-\-files\-from\f[R] file are interpreted as +starting with the root specified in the rclone command. +Leading \f[C]/\f[R] separators are ignored. See \-\-files\-from\-raw if you need the input to be processed in a raw manner. .PP -For example, suppose you had \f[C]files\-from.txt\f[R] with this -content: +E.g. +for a file \f[C]files\-from.txt\f[R]: .IP .nf \f[C] @@ -9788,15 +10381,8 @@ subdir/file2.jpg \f[R] .fi .PP -You could then use it like this: -.IP -.nf -\f[C] -rclone copy \-\-files\-from files\-from.txt /home/me/pics remote:pics -\f[R] -.fi -.PP -This will transfer these files only (if they exist) +\f[C]rclone copy \-\-files\-from files\-from.txt /home/me/pics remote:pics\f[R] +copies the following, if they exist, and only those files. .IP .nf \f[C] @@ -9805,30 +10391,30 @@ This will transfer these files only (if they exist) \f[R] .fi .PP -To take a more complicated example, let\[aq]s say you had a few files -you want to back up regularly with these absolute paths: +E.g. +to copy the following files referenced by their absolute paths: .IP .nf \f[C] -/home/user1/important -/home/user1/dir/file -/home/user2/stuff +/home/user1/42 +/home/user1/dir/ford +/home/user2/prefect \f[R] .fi .PP -To copy these you\[aq]d find a common subdirectory \- in this case -\f[C]/home\f[R] and put the remaining files in \f[C]files\-from.txt\f[R] -with or without leading \f[C]/\f[R], eg +First find a common subdirectory \- in this case \f[C]/home\f[R] and put +the remaining files in \f[C]files\-from.txt\f[R] with or without leading +\f[C]/\f[R], e.g. .IP .nf \f[C] -user1/important -user1/dir/file -user2/stuff +user1/42 +user1/dir/ford +user2/prefect \f[R] .fi .PP -You could then copy these to a remote like this +Then copy these to a remote: .IP .nf \f[C] @@ -9836,29 +10422,28 @@ rclone copy \-\-files\-from files\-from.txt /home remote:backup \f[R] .fi .PP -The 3 files will arrive in \f[C]remote:backup\f[R] with the paths as in -the \f[C]files\-from.txt\f[R] like this: +The three files are transferred as follows: .IP .nf \f[C] -/home/user1/important \[->] remote:backup/user1/important -/home/user1/dir/file \[->] remote:backup/user1/dir/file -/home/user2/stuff \[->] remote:backup/user2/stuff +/home/user1/42 \[->] remote:backup/user1/important +/home/user1/dir/ford \[->] remote:backup/user1/dir/file +/home/user2/prefect \[->] remote:backup/user2/stuff \f[R] .fi .PP -You could of course choose \f[C]/\f[R] as the root too in which case -your \f[C]files\-from.txt\f[R] might look like this. +Alternatively if \f[C]/\f[R] is chosen as root \f[C]files\-from.txt\f[R] +would be: .IP .nf \f[C] -/home/user1/important -/home/user1/dir/file -/home/user2/stuff +/home/user1/42 +/home/user1/dir/ford +/home/user2/prefect \f[R] .fi .PP -And you would transfer it like this +The copy command would be: .IP .nf \f[C] @@ -9866,46 +10451,79 @@ rclone copy \-\-files\-from files\-from.txt / remote:backup \f[R] .fi .PP -In this case there will be an extra \f[C]home\f[R] directory on the -remote: +Then there will be an extra \f[C]home\f[R] directory on the remote: .IP .nf \f[C] -/home/user1/important \[->] remote:backup/home/user1/important -/home/user1/dir/file \[->] remote:backup/home/user1/dir/file -/home/user2/stuff \[->] remote:backup/home/user2/stuff +/home/user1/42 \[->] remote:backup/home/user1/42 +/home/user1/dir/ford \[->] remote:backup/home/user1/dir/ford +/home/user2/prefect \[->] remote:backup/home/user2/prefect \f[R] .fi .SS \f[C]\-\-files\-from\-raw\f[R] \- Read list of source\-file names without any processing .PP -This option is same as \f[C]\-\-files\-from\f[R] with the only -difference being that the input is read in a raw manner. -This means that lines with leading/trailing whitespace and lines -starting with \f[C];\f[R] or \f[C]#\f[R] are read without any -processing. +This flag is the same as \f[C]\-\-files\-from\f[R] except that input is +read in a raw manner. +Lines with leading / trailing whitespace, and lines starting with +\f[C];\f[R] or \f[C]#\f[R] are read without any processing. rclone lsf (https://rclone.org/commands/rclone_lsf/) has a compatible -format that can be used to export file lists from remotes, which can -then be used as an input to \f[C]\-\-files\-from\-raw\f[R]. +format that can be used to export file lists from remotes for input to +\f[C]\-\-files\-from\-raw\f[R]. +.SS \f[C]\-\-ignore\-case\f[R] \- make searches case insensitive +.PP +By default rclone filter patterns are case sensitive. +The \f[C]\-\-ignore\-case\f[R] flag makes all of the filters patterns on +the command line case insensitive. +.PP +E.g. +\f[C]\-\-include \[dq]zaphod.txt\[dq]\f[R] does not match a file +\f[C]Zaphod.txt\f[R]. +With \f[C]\-\-ignore\-case\f[R] a match is made. +.SS Quoting shell metacharacters +.PP +Rclone commands with filter patterns containing shell metacharacters may +not as work as expected in your shell and may require quoting. +.PP +E.g. +linux, OSX (\f[C]*\f[R] metacharacter) +.IP \[bu] 2 +\f[C]\-\-include \[rs]*.jpg\f[R] +.IP \[bu] 2 +\f[C]\-\-include \[aq]*.jpg\[aq]\f[R] +.IP \[bu] 2 +\f[C]\-\-include=\[aq]*.jpg\[aq]\f[R] +.PP +Microsoft Windows expansion is done by the command, not shell, so +\f[C]\-\-include *.jpg\f[R] does not require quoting. +.PP +If the rclone error +\f[C]Command .... needs .... arguments maximum: you provided .... non flag arguments:\f[R] +is encountered, the cause is commonly spaces within the name of a remote +or flag value. +The fix then is to quote values containing spaces. +.SS Other filters .SS \f[C]\-\-min\-size\f[R] \- Don\[aq]t transfer any file smaller than this .PP -This option controls the minimum size file which will be transferred. -This defaults to \f[C]kBytes\f[R] but a suffix of \f[C]k\f[R], -\f[C]M\f[R], or \f[C]G\f[R] can be used. +Controls the minimum size file within the scope of an rclone command. +Default units are \f[C]kBytes\f[R] but abbreviations \f[C]k\f[R], +\f[C]M\f[R], or \f[C]G\f[R] are valid. .PP -For example \f[C]\-\-min\-size 50k\f[R] means no files smaller than -50kByte will be transferred. +E.g. +\f[C]rclone ls remote: \-\-min\-size 50k\f[R] lists files on +\f[C]remote:\f[R] of 50kByte size or larger. .SS \f[C]\-\-max\-size\f[R] \- Don\[aq]t transfer any file larger than this .PP -This option controls the maximum size file which will be transferred. -This defaults to \f[C]kBytes\f[R] but a suffix of \f[C]k\f[R], -\f[C]M\f[R], or \f[C]G\f[R] can be used. +Controls the maximum size file within the scope of an rclone command. +Default units are \f[C]kBytes\f[R] but abbreviations \f[C]k\f[R], +\f[C]M\f[R], or \f[C]G\f[R] are valid. .PP -For example \f[C]\-\-max\-size 1G\f[R] means no files larger than 1GByte -will be transferred. +E.g. +\f[C]rclone ls remote: \-\-max\-size 1G\f[R] lists files on +\f[C]remote:\f[R] of 1GByte size or smaller. .SS \f[C]\-\-max\-age\f[R] \- Don\[aq]t transfer any file older than this .PP -This option controls the maximum age of files to transfer. -Give in seconds or with a suffix of: +Controls the maximum age of files within the scope of an rclone command. +Default units are seconds or the following abbreviations are valid: .IP \[bu] 2 \f[C]ms\f[R] \- Milliseconds .IP \[bu] 2 @@ -9923,44 +10541,45 @@ Give in seconds or with a suffix of: .IP \[bu] 2 \f[C]y\f[R] \- Years .PP -For example \f[C]\-\-max\-age 2d\f[R] means no files older than 2 days -will be transferred. -.PP -This can also be an absolute time in one of these formats +\f[C]\-\-max\-age\f[R] can also be specified as an absolute time in the +following formats: .IP \[bu] 2 -RFC3339 \- eg \[dq]2006\-01\-02T15:04:05Z07:00\[dq] +RFC3339 \- e.g. +\[dq]2006\-01\-02T15:04:05Z07:00\[dq] .IP \[bu] 2 ISO8601 Date and time, local timezone \- \[dq]2006\-01\-02T15:04:05\[dq] .IP \[bu] 2 ISO8601 Date and time, local timezone \- \[dq]2006\-01\-02 15:04:05\[dq] .IP \[bu] 2 ISO8601 Date \- \[dq]2006\-01\-02\[dq] (YYYY\-MM\-DD) +.PP +\f[C]\-\-max\-age\f[R] applies only to files and not to directories. +.PP +E.g. +\f[C]rclone ls remote: \-\-max\-age 2d\f[R] lists files on +\f[C]remote:\f[R] of 2 days old or less. .SS \f[C]\-\-min\-age\f[R] \- Don\[aq]t transfer any file younger than this .PP -This option controls the minimum age of files to transfer. -Give in seconds or with a suffix (see \f[C]\-\-max\-age\f[R] for list of -suffixes) +Controls the minimum age of files within the scope of an rclone command. +(see \f[C]\-\-max\-age\f[R] for valid formats) .PP -For example \f[C]\-\-min\-age 2d\f[R] means no files younger than 2 days -will be transferred. +\f[C]\-\-min\-age\f[R] applies only to files and not to directories. +.PP +E.g. +\f[C]rclone ls remote: \-\-min\-age 2d\f[R] lists files on +\f[C]remote:\f[R] of 2 days old or more. +.SS Other flags .SS \f[C]\-\-delete\-excluded\f[R] \- Delete files on dest excluded from sync .PP -\f[B]Important\f[R] this flag is dangerous \- use with +\f[B]Important\f[R] this flag is dangerous to your data \- use with \f[C]\-\-dry\-run\f[R] and \f[C]\-v\f[R] first. .PP -When doing \f[C]rclone sync\f[R] this will delete any files which are -excluded from the sync on the destination. +In conjunction with \f[C]rclone sync\f[R] the \[ga]\-\-delete\-excluded +deletes any files on the destination which are excluded from the +command. .PP -If for example you did a sync from \f[C]A\f[R] to \f[C]B\f[R] without -the \f[C]\-\-min\-size 50k\f[R] flag -.IP -.nf -\f[C] -rclone sync \-i A: B: -\f[R] -.fi -.PP -Then you repeated it like this with the \f[C]\-\-delete\-excluded\f[R] +E.g. +the scope of \f[C]rclone sync \-i A: B:\f[R] can be restricted: .IP .nf \f[C] @@ -9968,52 +10587,24 @@ rclone \-\-min\-size 50k \-\-delete\-excluded sync A: B: \f[R] .fi .PP -This would delete all files on \f[C]B\f[R] which are less than 50 kBytes -as these are now excluded from the sync. -.PP -Always test first with \f[C]\-\-dry\-run\f[R] and \f[C]\-v\f[R] before -using this flag. +All files on \f[C]B:\f[R] which are less than 50 kBytes are deleted +because they are excluded from the rclone sync command. .SS \f[C]\-\-dump filters\f[R] \- dump the filters to the output .PP -This dumps the defined filters to the output as regular expressions. +Dumps the defined filters to standard output in regular expression +format. .PP Useful for debugging. -.SS \f[C]\-\-ignore\-case\f[R] \- make searches case insensitive -.PP -Normally filter patterns are case sensitive. -If this flag is supplied then filter patterns become case insensitive. -.PP -Normally a \f[C]\-\-include \[dq]file.txt\[dq]\f[R] will not match a -file called \f[C]FILE.txt\f[R]. -However if you use the \f[C]\-\-ignore\-case\f[R] flag then -\f[C]\-\-include \[dq]file.txt\[dq]\f[R] this will match a file called -\f[C]FILE.txt\f[R]. -.SS Quoting shell metacharacters -.PP -The examples above may not work verbatim in your shell as they have -shell metacharacters in them (eg \f[C]*\f[R]), and may require quoting. -.PP -Eg linux, OSX -.IP \[bu] 2 -\f[C]\-\-include \[rs]*.jpg\f[R] -.IP \[bu] 2 -\f[C]\-\-include \[aq]*.jpg\[aq]\f[R] -.IP \[bu] 2 -\f[C]\-\-include=\[aq]*.jpg\[aq]\f[R] -.PP -In Windows the expansion is done by the command not the shell so this -should work fine -.IP \[bu] 2 -\f[C]\-\-include *.jpg\f[R] .SS Exclude directory based on a file .PP -It is possible to exclude a directory based on a file, which is present -in this directory. -Filename should be specified using the -\f[C]\-\-exclude\-if\-present\f[R] flag. -This flag has a priority over the other filtering flags. +The \f[C]\-\-exclude\-if\-present\f[R] flag controls whether a directory +is within the scope of an rclone command based on the presence of a +named file within it. .PP -Imagine, you have the following directory structure: +This flag has a priority over other filter flags. +.PP +E.g. +for the following directory structure: .IP .nf \f[C] @@ -10024,17 +10615,21 @@ dir1/dir2/dir3/.ignore \f[R] .fi .PP -You can exclude \f[C]dir3\f[R] from sync by running the following -command: -.IP -.nf -\f[C] -rclone sync \-i \-\-exclude\-if\-present .ignore dir1 remote:backup -\f[R] -.fi +The command \f[C]rclone ls \-\-exclude\-if\-present .ignore dir1\f[R] +does not list \f[C]dir3\f[R], \f[C]file3\f[R] or \f[C].ignore\f[R]. .PP -Currently only one filename is supported, i.e. -\f[C]\-\-exclude\-if\-present\f[R] should not be used multiple times. +\f[C]\-\-exclude\-if\-present\f[R] can only be used once in an rclone +command. +.SS Common pitfalls +.PP +The most frequent filter support issues on the rclone +forum (https://https://forum.rclone.org/) are: +.IP \[bu] 2 +Not using paths relative to the root of the remote +.IP \[bu] 2 +Not using \f[C]/\f[R] to match from the root of a remote +.IP \[bu] 2 +Not using \f[C]**\f[R] to match the contents of a directory .SH GUI (Experimental) .PP Rclone can serve a web based GUI (graphical user interface). @@ -10173,9 +10768,12 @@ If you have questions then please ask them on the rclone forum (https://forum.rclone.org/). .SH Remote controlling rclone with its API .PP -If rclone is run with the \f[C]\-\-rc\f[R] flag then it starts an http +If rclone is run with the \f[C]\-\-rc\f[R] flag then it starts an HTTP server which can be used to remote control rclone using its API. .PP +You can either use the rclone rc command to access the API or use HTTP +directly. +.PP If you just want to run a remote control then see the rcd command (https://rclone.org/commands/rclone_rcd/). .SS Supported parameters @@ -10378,7 +10976,7 @@ The \f[C]job/status\f[R] call can be used to get information of the background job. The job can be queried for up to 1 minute after it has finished. .PP -It is recommended that potentially long running jobs, eg +It is recommended that potentially long running jobs, e.g. \f[C]sync/sync\f[R], \f[C]sync/copy\f[R], \f[C]sync/move\f[R], \f[C]operations/purge\f[R] are run with the \f[C]_async\f[R] flag to avoid any potential problems with the HTTP request and response timing @@ -10469,7 +11067,8 @@ This takes the following parameters .IP \[bu] 2 command \- a string with the command name .IP \[bu] 2 -fs \- a remote name string eg \[dq]drive:\[dq] +fs \- a remote name string e.g. +\[dq]drive:\[dq] .IP \[bu] 2 arg \- a list of arguments for the backend command .IP \[bu] 2 @@ -10558,7 +11157,7 @@ chunks \[dq]0,\-2\[dq] \-> the first and the second last chunk \[dq]0:10\[dq] \-> the first ten chunks .PP Any parameter with a key that starts with \[dq]file\[dq] can be used to -specify files to fetch, eg +specify files to fetch, e.g. .IP .nf \f[C] @@ -10673,7 +11272,9 @@ more information on the above. \f[B]Authentication is required for this call.\f[R] .SS core/bwlimit: Set the bandwidth limit. .PP -This sets the bandwidth limit to that passed in. +This sets the bandwidth limit to the string passed in. +This should be a single bandwidth limit entry or a pair of +upload:download bandwidth. .PP Eg .IP @@ -10682,11 +11283,22 @@ Eg rclone rc core/bwlimit rate=off { \[dq]bytesPerSecond\[dq]: \-1, + \[dq]bytesPerSecondTx\[dq]: \-1, + \[dq]bytesPerSecondRx\[dq]: \-1, \[dq]rate\[dq]: \[dq]off\[dq] } rclone rc core/bwlimit rate=1M { \[dq]bytesPerSecond\[dq]: 1048576, + \[dq]bytesPerSecondTx\[dq]: 1048576, + \[dq]bytesPerSecondRx\[dq]: 1048576, + \[dq]rate\[dq]: \[dq]1M\[dq] +} +rclone rc core/bwlimit rate=1M:100k +{ + \[dq]bytesPerSecond\[dq]: 1048576, + \[dq]bytesPerSecondTx\[dq]: 1048576, + \[dq]bytesPerSecondRx\[dq]: 131072, \[dq]rate\[dq]: \[dq]1M\[dq] } \f[R] @@ -10699,6 +11311,8 @@ If the rate parameter is not supplied then the bandwidth is queried rclone rc core/bwlimit { \[dq]bytesPerSecond\[dq]: 1048576, + \[dq]bytesPerSecondTx\[dq]: 1048576, + \[dq]bytesPerSecondRx\[dq]: 1048576, \[dq]rate\[dq]: \[dq]1M\[dq] } \f[R] @@ -10718,16 +11332,32 @@ command \- a string with the command name arg \- a list of arguments for the backend command .IP \[bu] 2 opt \- a map of string to string of options +.IP \[bu] 2 +returnType \- one of (\[dq]COMBINED_OUTPUT\[dq], \[dq]STREAM\[dq], +\[dq]STREAM_ONLY_STDOUT\[dq], \[dq]STREAM_ONLY_STDERR\[dq]) +.RS 2 +.IP \[bu] 2 +defaults to \[dq]COMBINED_OUTPUT\[dq] if not set +.IP \[bu] 2 +the STREAM returnTypes will write the output to the body of the HTTP +message +.IP \[bu] 2 +the COMBINED_OUTPUT will write the output to the \[dq]result\[dq] +parameter +.RE .PP Returns .IP \[bu] 2 result \- result from the backend command +.RS 2 +.IP \[bu] 2 +only set when using returnType \[dq]COMBINED_OUTPUT\[dq] +.RE .IP \[bu] 2 error \- set if rclone exits with an error code .IP \[bu] 2 returnType \- one of (\[dq]COMBINED_OUTPUT\[dq], \[dq]STREAM\[dq], -\[dq]STREAM_ONLY_STDOUT\[dq]. -\[dq]STREAM_ONLY_STDERR\[dq]) +\[dq]STREAM_ONLY_STDOUT\[dq], \[dq]STREAM_ONLY_STDERR\[dq]) .PP For example .IP @@ -10752,4382 +11382,8732 @@ OR \[dq]error\[dq]: true, \[dq]result\[dq]: \[dq]\[dq] } - -**Authentication is required for this call.** - -### core/gc: Runs a garbage collection. {#core\-gc} - -This tells the go runtime to do a garbage collection run. It isn\[aq]t -necessary to call this normally, but it can be useful for debugging -memory problems. - -### core/group\-list: Returns list of stats. {#core\-group\-list} - -This returns list of stats groups currently in memory. - -Returns the following values: \f[R] .fi .PP -{ \[dq]groups\[dq]: an array of group names: [ \[dq]group1\[dq], -\[dq]group2\[dq], ... -] } +\f[B]Authentication is required for this call.\f[R] +.SS core/gc: Runs a garbage collection. +.PP +This tells the go runtime to do a garbage collection run. +It isn\[aq]t necessary to call this normally, but it can be useful for +debugging memory problems. +.SS core/group\-list: Returns list of stats. +.PP +This returns list of stats groups currently in memory. +.PP +Returns the following values: .IP .nf \f[C] - -### core/memstats: Returns the memory statistics {#core\-memstats} - -This returns the memory statistics of the running program. What the values mean -are explained in the go docs: https://golang.org/pkg/runtime/#MemStats - +{ + \[dq]groups\[dq]: an array of group names: + [ + \[dq]group1\[dq], + \[dq]group2\[dq], + ... + ] +} +\f[R] +.fi +.SS core/memstats: Returns the memory statistics +.PP +This returns the memory statistics of the running program. +What the values mean are explained in the go docs: +https://golang.org/pkg/runtime/#MemStats +.PP The most interesting values for most people are: - -* HeapAlloc: This is the amount of memory rclone is actually using -* HeapSys: This is the amount of memory rclone has obtained from the OS -* Sys: this is the total amount of memory requested from the OS - * It is virtual memory so may include unused memory - -### core/obscure: Obscures a string passed in. {#core\-obscure} - -Pass a clear string and rclone will obscure it for the config file: -\- clear \- string - -Returns -\- obscured \- string - -### core/pid: Return PID of current process {#core\-pid} - +.IP \[bu] 2 +HeapAlloc: This is the amount of memory rclone is actually using +.IP \[bu] 2 +HeapSys: This is the amount of memory rclone has obtained from the OS +.IP \[bu] 2 +Sys: this is the total amount of memory requested from the OS +.RS 2 +.IP \[bu] 2 +It is virtual memory so may include unused memory +.RE +.SS core/obscure: Obscures a string passed in. +.PP +Pass a clear string and rclone will obscure it for the config file: \- +clear \- string +.PP +Returns \- obscured \- string +.SS core/pid: Return PID of current process +.PP This returns PID of current process. Useful for stopping rclone process. - -### core/quit: Terminates the app. {#core\-quit} - -(optional) Pass an exit code to be used for terminating the app: -\- exitCode \- int - -### core/stats: Returns stats about current transfers. {#core\-stats} - +.SS core/quit: Terminates the app. +.PP +(optional) Pass an exit code to be used for terminating the app: \- +exitCode \- int +.SS core/stats: Returns stats about current transfers. +.PP This returns all available stats: - - rclone rc core/stats - +.IP +.nf +\f[C] +rclone rc core/stats +\f[R] +.fi +.PP If group is not provided then summed up stats for all groups will be returned. - -Parameters - -\- group \- name of the stats group (string) - -Returns the following values: -\f[R] -.fi .PP -{ \[dq]speed\[dq]: average speed in bytes/sec since start of the -process, \[dq]bytes\[dq]: total transferred bytes since the start of the -process, \[dq]errors\[dq]: number of errors, \[dq]fatalError\[dq]: -whether there has been at least one FatalError, \[dq]retryError\[dq]: -whether there has been at least one non\-NoRetryError, \[dq]checks\[dq]: -number of checked files, \[dq]transfers\[dq]: number of transferred -files, \[dq]deletes\[dq] : number of deleted files, \[dq]renames\[dq] : -number of renamed files, \[dq]transferTime\[dq] : total time spent on -running jobs, \[dq]elapsedTime\[dq]: time in seconds since the start of -the process, \[dq]lastError\[dq]: last occurred error, -\[dq]transferring\[dq]: an array of currently active file transfers: [ { -\[dq]bytes\[dq]: total transferred bytes for this file, \[dq]eta\[dq]: -estimated time in seconds until file transfer completion \[dq]name\[dq]: -name of the file, \[dq]percentage\[dq]: progress of the file transfer in -percent, \[dq]speed\[dq]: average speed over the whole transfer in -bytes/sec, \[dq]speedAvg\[dq]: current speed in bytes/sec as an -exponentially weighted moving average, \[dq]size\[dq]: size of the file -in bytes } ], \[dq]checking\[dq]: an array of names of currently active -file checks [] } +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) +.PP +Returns the following values: .IP .nf \f[C] -Values for \[dq]transferring\[dq], \[dq]checking\[dq] and \[dq]lastError\[dq] are only assigned if data is available. +{ + \[dq]speed\[dq]: average speed in bytes/sec since start of the process, + \[dq]bytes\[dq]: total transferred bytes since the start of the process, + \[dq]errors\[dq]: number of errors, + \[dq]fatalError\[dq]: whether there has been at least one FatalError, + \[dq]retryError\[dq]: whether there has been at least one non\-NoRetryError, + \[dq]checks\[dq]: number of checked files, + \[dq]transfers\[dq]: number of transferred files, + \[dq]deletes\[dq] : number of deleted files, + \[dq]renames\[dq] : number of renamed files, + \[dq]transferTime\[dq] : total time spent on running jobs, + \[dq]elapsedTime\[dq]: time in seconds since the start of the process, + \[dq]lastError\[dq]: last occurred error, + \[dq]transferring\[dq]: an array of currently active file transfers: + [ + { + \[dq]bytes\[dq]: total transferred bytes for this file, + \[dq]eta\[dq]: estimated time in seconds until file transfer completion + \[dq]name\[dq]: name of the file, + \[dq]percentage\[dq]: progress of the file transfer in percent, + \[dq]speed\[dq]: average speed over the whole transfer in bytes/sec, + \[dq]speedAvg\[dq]: current speed in bytes/sec as an exponentially weighted moving average, + \[dq]size\[dq]: size of the file in bytes + } + ], + \[dq]checking\[dq]: an array of names of currently active file checks + [] +} +\f[R] +.fi +.PP +Values for \[dq]transferring\[dq], \[dq]checking\[dq] and +\[dq]lastError\[dq] are only assigned if data is available. The value for \[dq]eta\[dq] is null if an eta cannot be determined. - -### core/stats\-delete: Delete stats group. {#core\-stats\-delete} - +.SS core/stats\-delete: Delete stats group. +.PP This deletes entire stats group - +.PP Parameters - -\- group \- name of the stats group (string) - -### core/stats\-reset: Reset stats. {#core\-stats\-reset} - -This clears counters, errors and finished transfers for all stats or specific -stats group if group is provided. - +.IP \[bu] 2 +group \- name of the stats group (string) +.SS core/stats\-reset: Reset stats. +.PP +This clears counters, errors and finished transfers for all stats or +specific stats group if group is provided. +.PP Parameters - -\- group \- name of the stats group (string) - -### core/transferred: Returns stats about completed transfers. {#core\-transferred} - +.IP \[bu] 2 +group \- name of the stats group (string) +.SS core/transferred: Returns stats about completed transfers. +.PP This returns stats about completed transfers: - - rclone rc core/transferred - +.IP +.nf +\f[C] +rclone rc core/transferred +\f[R] +.fi +.PP If group is not provided then completed transfers for all groups will be returned. - -Note only the last 100 completed transfers are returned. - -Parameters - -\- group \- name of the stats group (string) - -Returns the following values: -\f[R] -.fi .PP -{ \[dq]transferred\[dq]: an array of completed transfers (including -failed ones): [ { \[dq]name\[dq]: name of the file, \[dq]size\[dq]: size -of the file in bytes, \[dq]bytes\[dq]: total transferred bytes for this -file, \[dq]checked\[dq]: if the transfer is only checked (skipped, -deleted), \[dq]timestamp\[dq]: integer representing millisecond unix -epoch, \[dq]error\[dq]: string description of the error (empty if -successful), \[dq]jobid\[dq]: id of the job that this transfer belongs -to } ] } +Note only the last 100 completed transfers are returned. +.PP +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) +.PP +Returns the following values: .IP .nf \f[C] - -### core/version: Shows the current version of rclone and the go runtime. {#core\-version} - +{ + \[dq]transferred\[dq]: an array of completed transfers (including failed ones): + [ + { + \[dq]name\[dq]: name of the file, + \[dq]size\[dq]: size of the file in bytes, + \[dq]bytes\[dq]: total transferred bytes for this file, + \[dq]checked\[dq]: if the transfer is only checked (skipped, deleted), + \[dq]timestamp\[dq]: integer representing millisecond unix epoch, + \[dq]error\[dq]: string description of the error (empty if successful), + \[dq]jobid\[dq]: id of the job that this transfer belongs to + } + ] +} +\f[R] +.fi +.SS core/version: Shows the current version of rclone and the go runtime. +.PP This shows the current version of go and the go runtime - -\- version \- rclone version, eg \[dq]v1.53.0\[dq] -\- decomposed \- version number as [major, minor, patch] -\- isGit \- boolean \- true if this was compiled from the git version -\- isBeta \- boolean \- true if this is a beta version -\- os \- OS in use as according to Go -\- arch \- cpu architecture in use according to Go -\- goVersion \- version of Go runtime in use - -### debug/set\-block\-profile\-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug\-set\-block\-profile\-rate} - +.IP \[bu] 2 +version \- rclone version, e.g. +\[dq]v1.53.0\[dq] +.IP \[bu] 2 +decomposed \- version number as [major, minor, patch] +.IP \[bu] 2 +isGit \- boolean \- true if this was compiled from the git version +.IP \[bu] 2 +isBeta \- boolean \- true if this is a beta version +.IP \[bu] 2 +os \- OS in use as according to Go +.IP \[bu] 2 +arch \- cpu architecture in use according to Go +.IP \[bu] 2 +goVersion \- version of Go runtime in use +.SS debug/set\-block\-profile\-rate: Set runtime.SetBlockProfileRate for blocking profiling. +.PP SetBlockProfileRate controls the fraction of goroutine blocking events -that are reported in the blocking profile. The profiler aims to sample -an average of one blocking event per rate nanoseconds spent blocked. - -To include every blocking event in the profile, pass rate = 1. To turn -off profiling entirely, pass rate <= 0. - +that are reported in the blocking profile. +The profiler aims to sample an average of one blocking event per rate +nanoseconds spent blocked. +.PP +To include every blocking event in the profile, pass rate = 1. +To turn off profiling entirely, pass rate <= 0. +.PP After calling this you can use this to see the blocking profile: - - go tool pprof http://localhost:5572/debug/pprof/block - +.IP +.nf +\f[C] +go tool pprof http://localhost:5572/debug/pprof/block +\f[R] +.fi +.PP Parameters - -\- rate \- int - -### debug/set\-mutex\-profile\-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug\-set\-mutex\-profile\-fraction} - -SetMutexProfileFraction controls the fraction of mutex contention -events that are reported in the mutex profile. On average 1/rate -events are reported. The previous rate is returned. - -To turn off profiling entirely, pass rate 0. To just read the current -rate, pass rate < 0. (For n>1 the details of sampling may change.) - +.IP \[bu] 2 +rate \- int +.SS debug/set\-mutex\-profile\-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. +.PP +SetMutexProfileFraction controls the fraction of mutex contention events +that are reported in the mutex profile. +On average 1/rate events are reported. +The previous rate is returned. +.PP +To turn off profiling entirely, pass rate 0. +To just read the current rate, pass rate < 0. +(For n>1 the details of sampling may change.) +.PP Once this is set you can look use this to profile the mutex contention: - - go tool pprof http://localhost:5572/debug/pprof/mutex - +.IP +.nf +\f[C] +go tool pprof http://localhost:5572/debug/pprof/mutex +\f[R] +.fi +.PP Parameters - -\- rate \- int - +.IP \[bu] 2 +rate \- int +.PP Results - -\- previousRate \- int - -### job/list: Lists the IDs of the running jobs {#job\-list} - +.IP \[bu] 2 +previousRate \- int +.SS job/list: Lists the IDs of the running jobs +.PP Parameters \- None - +.PP Results - -\- jobids \- array of integer job ids - -### job/status: Reads the status of the job ID {#job\-status} - +.IP \[bu] 2 +jobids \- array of integer job ids +.SS job/status: Reads the status of the job ID +.PP Parameters - -\- jobid \- id of the job (integer) - +.IP \[bu] 2 +jobid \- id of the job (integer) +.PP Results - -\- finished \- boolean -\- duration \- time in seconds that the job ran for -\- endTime \- time the job finished (eg \[dq]2018\-10\-26T18:50:20.528746884+01:00\[dq]) -\- error \- error from the job or empty string for no error -\- finished \- boolean whether the job has finished or not -\- id \- as passed in above -\- startTime \- time the job started (eg \[dq]2018\-10\-26T18:50:20.528336039+01:00\[dq]) -\- success \- boolean \- true for success false otherwise -\- output \- output of the job as would have been returned if called synchronously -\- progress \- output of the progress related to the underlying job - -### job/stop: Stop the running job {#job\-stop} - +.IP \[bu] 2 +finished \- boolean +.IP \[bu] 2 +duration \- time in seconds that the job ran for +.IP \[bu] 2 +endTime \- time the job finished (e.g. +\[dq]2018\-10\-26T18:50:20.528746884+01:00\[dq]) +.IP \[bu] 2 +error \- error from the job or empty string for no error +.IP \[bu] 2 +finished \- boolean whether the job has finished or not +.IP \[bu] 2 +id \- as passed in above +.IP \[bu] 2 +startTime \- time the job started (e.g. +\[dq]2018\-10\-26T18:50:20.528336039+01:00\[dq]) +.IP \[bu] 2 +success \- boolean \- true for success false otherwise +.IP \[bu] 2 +output \- output of the job as would have been returned if called +synchronously +.IP \[bu] 2 +progress \- output of the progress related to the underlying job +.SS job/stop: Stop the running job +.PP Parameters - -\- jobid \- id of the job (integer) - -### mount/listmounts: Show current mount points {#mount\-listmounts} - -This shows currently mounted points, which can be used for performing an unmount - +.IP \[bu] 2 +jobid \- id of the job (integer) +.SS mount/listmounts: Show current mount points +.PP +This shows currently mounted points, which can be used for performing an +unmount +.PP This takes no parameters and returns - -\- mountPoints: list of current mount points - +.IP \[bu] 2 +mountPoints: list of current mount points +.PP Eg - - rclone rc mount/listmounts - -**Authentication is required for this call.** - -### mount/mount: Create a new mount point {#mount\-mount} - +.IP +.nf +\f[C] +rclone rc mount/listmounts +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/mount: Create a new mount point +.PP rclone allows Linux, FreeBSD, macOS and Windows to mount any of Rclone\[aq]s cloud storage systems as a file system with FUSE. - -If no mountType is provided, the priority is given as follows: 1. mount 2.cmount 3.mount2 - -This takes the following parameters - -\- fs \- a remote path to be mounted (required) -\- mountPoint: valid path on the local machine (required) -\- mountType: One of the values (mount, cmount, mount2) specifies the mount implementation to use -\- mountOpt: a JSON object with Mount options in. -\- vfsOpt: a JSON object with VFS options in. - -Eg - - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint - rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount - rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=\[aq]{\[dq]CacheMode\[dq]: 2}\[aq] mountOpt=\[aq]{\[dq]AllowOther\[dq]: true}\[aq] - -The vfsOpt are as described in options/get and can be seen in the the -\[dq]vfs\[dq] section when running and the mountOpt can be seen in the \[dq]mount\[dq] section. - - rclone rc options/get - -**Authentication is required for this call.** - -### mount/types: Show all possible mount types {#mount\-types} - -This shows all possible mount types and returns them as a list. - -This takes no parameters and returns - -\- mountTypes: list of mount types - -The mount types are strings like \[dq]mount\[dq], \[dq]mount2\[dq], \[dq]cmount\[dq] and can -be passed to mount/mount as the mountType parameter. - -Eg - - rclone rc mount/types - -**Authentication is required for this call.** - -### mount/unmount: Unmount selected active mount {#mount\-unmount} - -rclone allows Linux, FreeBSD, macOS and Windows to -mount any of Rclone\[aq]s cloud storage systems as a file system with -FUSE. - -This takes the following parameters - -\- mountPoint: valid path on the local machine where the mount was created (required) - -Eg - - rclone rc mount/unmount mountPoint=/home//mountPoint - -**Authentication is required for this call.** - -### mount/unmountall: Show current mount points {#mount\-unmountall} - -This shows currently mounted points, which can be used for performing an unmount - -This takes no parameters and returns error if unmount does not succeed. - -Eg - - rclone rc mount/unmountall - -**Authentication is required for this call.** - -### operations/about: Return the space used on the remote {#operations\-about} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -The result is as returned from rclone about \-\-json - -See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/cleanup: Remove trashed files in the remote or path {#operations\-cleanup} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/copyfile: Copy a file from source remote to destination remote {#operations\-copyfile} - -This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:\[dq] for the source -\- srcRemote \- a path within that remote eg \[dq]file.txt\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive2:\[dq] for the destination -\- dstRemote \- a path within that remote eg \[dq]file2.txt\[dq] for the destination - -**Authentication is required for this call.** - -### operations/copyurl: Copy the URL to the object {#operations\-copyurl} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- url \- string, URL to read from - \- autoFilename \- boolean, set to true to retrieve destination file name from url -See the [copyurl command](https://rclone.org/commands/rclone_copyurl/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/delete: Remove files in the path {#operations\-delete} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -See the [delete command](https://rclone.org/commands/rclone_delete/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/deletefile: Remove the single file pointed to {#operations\-deletefile} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [deletefile command](https://rclone.org/commands/rclone_deletefile/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/fsinfo: Return information about the remote {#operations\-fsinfo} - -This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] - -This returns info about the remote passed in; -\f[R] -.fi .PP -{ // optional features and whether they are available or not -\[dq]Features\[dq]: { \[dq]About\[dq]: true, \[dq]BucketBased\[dq]: -false, \[dq]CanHaveEmptyDirectories\[dq]: true, -\[dq]CaseInsensitive\[dq]: false, \[dq]ChangeNotify\[dq]: false, -\[dq]CleanUp\[dq]: false, \[dq]Copy\[dq]: false, -\[dq]DirCacheFlush\[dq]: false, \[dq]DirMove\[dq]: true, -\[dq]DuplicateFiles\[dq]: false, \[dq]GetTier\[dq]: false, -\[dq]ListR\[dq]: false, \[dq]MergeDirs\[dq]: false, \[dq]Move\[dq]: -true, \[dq]OpenWriterAt\[dq]: true, \[dq]PublicLink\[dq]: false, -\[dq]Purge\[dq]: true, \[dq]PutStream\[dq]: true, -\[dq]PutUnchecked\[dq]: false, \[dq]ReadMimeType\[dq]: false, -\[dq]ServerSideAcrossConfigs\[dq]: false, \[dq]SetTier\[dq]: false, -\[dq]SetWrapper\[dq]: false, \[dq]UnWrap\[dq]: false, \[dq]WrapFs\[dq]: -false, \[dq]WriteMimeType\[dq]: false }, // Names of hashes available -\[dq]Hashes\[dq]: [ \[dq]MD5\[dq], \[dq]SHA\-1\[dq], -\[dq]DropboxHash\[dq], \[dq]QuickXorHash\[dq] ], \[dq]Name\[dq]: -\[dq]local\[dq], // Name as created \[dq]Precision\[dq]: 1, // Precision -of timestamps in ns \[dq]Root\[dq]: \[dq]/\[dq], // Path as created -\[dq]String\[dq]: \[dq]Local file system at /\[dq] // how the remote -will appear in logs } +If no mountType is provided, the priority is given as follows: 1. +mount 2.cmount 3.mount2 +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote path to be mounted (required) +.IP \[bu] 2 +mountPoint: valid path on the local machine (required) +.IP \[bu] 2 +mountType: One of the values (mount, cmount, mount2) specifies the mount +implementation to use +.IP \[bu] 2 +mountOpt: a JSON object with Mount options in. +.IP \[bu] 2 +vfsOpt: a JSON object with VFS options in. +.PP +Eg .IP .nf \f[C] - -This command does not have a command line equivalent so use this instead: - - rclone rc \-\-loopback operations/fsinfo fs=remote: - -### operations/list: List the given remote and path in JSON format {#operations\-list} - +rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint +rclone rc mount/mount fs=mydrive: mountPoint=/home//mountPoint mountType=mount +rclone rc mount/mount fs=TestDrive: mountPoint=/mnt/tmp vfsOpt=\[aq]{\[dq]CacheMode\[dq]: 2}\[aq] mountOpt=\[aq]{\[dq]AllowOther\[dq]: true}\[aq] +\f[R] +.fi +.PP +The vfsOpt are as described in options/get and can be seen in the the +\[dq]vfs\[dq] section when running and the mountOpt can be seen in the +\[dq]mount\[dq] section. +.IP +.nf +\f[C] +rclone rc options/get +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/types: Show all possible mount types +.PP +This shows all possible mount types and returns them as a list. +.PP +This takes no parameters and returns +.IP \[bu] 2 +mountTypes: list of mount types +.PP +The mount types are strings like \[dq]mount\[dq], \[dq]mount2\[dq], +\[dq]cmount\[dq] and can be passed to mount/mount as the mountType +parameter. +.PP +Eg +.IP +.nf +\f[C] +rclone rc mount/types +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/unmount: Unmount selected active mount +.PP +rclone allows Linux, FreeBSD, macOS and Windows to mount any of +Rclone\[aq]s cloud storage systems as a file system with FUSE. +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- opt \- a dictionary of options to control the listing (optional) - \- recurse \- If set recurse directories - \- noModTime \- If set return modification time - \- showEncrypted \- If set show decrypted names - \- showOrigIDs \- If set show the IDs for each item if known - \- showHash \- If set return a dictionary of hashes - +.IP \[bu] 2 +mountPoint: valid path on the local machine where the mount was created +(required) +.PP +Eg +.IP +.nf +\f[C] +rclone rc mount/unmount mountPoint=/home//mountPoint +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS mount/unmountall: Show current mount points +.PP +This shows currently mounted points, which can be used for performing an +unmount +.PP +This takes no parameters and returns error if unmount does not succeed. +.PP +Eg +.IP +.nf +\f[C] +rclone rc mount/unmountall +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/about: Return the space used on the remote +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.PP +The result is as returned from rclone about \-\-json +.PP +See the about command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/cleanup: Remove trashed files in the remote or path +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.PP +See the cleanup command (https://rclone.org/commands/rclone_cleanup/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/copyfile: Copy a file from source remote to destination remote +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string e.g. +\[dq]drive:\[dq] for the source +.IP \[bu] 2 +srcRemote \- a path within that remote e.g. +\[dq]file.txt\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string e.g. +\[dq]drive2:\[dq] for the destination +.IP \[bu] 2 +dstRemote \- a path within that remote e.g. +\[dq]file2.txt\[dq] for the destination +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/copyurl: Copy the URL to the object +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.IP \[bu] 2 +url \- string, URL to read from +.IP \[bu] 2 +autoFilename \- boolean, set to true to retrieve destination file name +from url See the copyurl +command (https://rclone.org/commands/rclone_copyurl/) command for more +information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/delete: Remove files in the path +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.PP +See the delete command (https://rclone.org/commands/rclone_delete/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/deletefile: Remove the single file pointed to +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.PP +See the deletefile +command (https://rclone.org/commands/rclone_deletefile/) command for +more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/fsinfo: Return information about the remote +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.PP +This returns info about the remote passed in; +.IP +.nf +\f[C] +{ + // optional features and whether they are available or not + \[dq]Features\[dq]: { + \[dq]About\[dq]: true, + \[dq]BucketBased\[dq]: false, + \[dq]CanHaveEmptyDirectories\[dq]: true, + \[dq]CaseInsensitive\[dq]: false, + \[dq]ChangeNotify\[dq]: false, + \[dq]CleanUp\[dq]: false, + \[dq]Copy\[dq]: false, + \[dq]DirCacheFlush\[dq]: false, + \[dq]DirMove\[dq]: true, + \[dq]DuplicateFiles\[dq]: false, + \[dq]GetTier\[dq]: false, + \[dq]ListR\[dq]: false, + \[dq]MergeDirs\[dq]: false, + \[dq]Move\[dq]: true, + \[dq]OpenWriterAt\[dq]: true, + \[dq]PublicLink\[dq]: false, + \[dq]Purge\[dq]: true, + \[dq]PutStream\[dq]: true, + \[dq]PutUnchecked\[dq]: false, + \[dq]ReadMimeType\[dq]: false, + \[dq]ServerSideAcrossConfigs\[dq]: false, + \[dq]SetTier\[dq]: false, + \[dq]SetWrapper\[dq]: false, + \[dq]UnWrap\[dq]: false, + \[dq]WrapFs\[dq]: false, + \[dq]WriteMimeType\[dq]: false + }, + // Names of hashes available + \[dq]Hashes\[dq]: [ + \[dq]MD5\[dq], + \[dq]SHA\-1\[dq], + \[dq]DropboxHash\[dq], + \[dq]QuickXorHash\[dq] + ], + \[dq]Name\[dq]: \[dq]local\[dq], // Name as created + \[dq]Precision\[dq]: 1, // Precision of timestamps in ns + \[dq]Root\[dq]: \[dq]/\[dq], // Path as created + \[dq]String\[dq]: \[dq]Local file system at /\[dq] // how the remote will appear in logs +} +\f[R] +.fi +.PP +This command does not have a command line equivalent so use this +instead: +.IP +.nf +\f[C] +rclone rc \-\-loopback operations/fsinfo fs=remote: +\f[R] +.fi +.SS operations/list: List the given remote and path in JSON format +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.IP \[bu] 2 +opt \- a dictionary of options to control the listing (optional) +.RS 2 +.IP \[bu] 2 +recurse \- If set recurse directories +.IP \[bu] 2 +noModTime \- If set return modification time +.IP \[bu] 2 +showEncrypted \- If set show decrypted names +.IP \[bu] 2 +showOrigIDs \- If set show the IDs for each item if known +.IP \[bu] 2 +showHash \- If set return a dictionary of hashes +.RE +.PP The result is - -\- list - \- This is an array of objects as described in the lsjson command - -See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. - -**Authentication is required for this call.** - -### operations/mkdir: Make a destination directory or container {#operations\-mkdir} - +.IP \[bu] 2 +list +.RS 2 +.IP \[bu] 2 +This is an array of objects as described in the lsjson command +.RE +.PP +See the lsjson command (https://rclone.org/commands/rclone_lsjson/) for +more information on the above and examples. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/mkdir: Make a destination directory or container +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/movefile: Move a file from source remote to destination remote {#operations\-movefile} - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.PP +See the mkdir command (https://rclone.org/commands/rclone_mkdir/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/movefile: Move a file from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:\[dq] for the source -\- srcRemote \- a path within that remote eg \[dq]file.txt\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive2:\[dq] for the destination -\- dstRemote \- a path within that remote eg \[dq]file2.txt\[dq] for the destination - -**Authentication is required for this call.** - -### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations\-publiclink} - +.IP \[bu] 2 +srcFs \- a remote name string e.g. +\[dq]drive:\[dq] for the source +.IP \[bu] 2 +srcRemote \- a path within that remote e.g. +\[dq]file.txt\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string e.g. +\[dq]drive2:\[dq] for the destination +.IP \[bu] 2 +dstRemote \- a path within that remote e.g. +\[dq]file2.txt\[dq] for the destination +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/publiclink: Create or retrieve a public link to the given file or folder. +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- unlink \- boolean \- if set removes the link rather than adding it (optional) -\- expire \- string \- the expiry time of the link eg \[dq]1d\[dq] (optional) - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.IP \[bu] 2 +unlink \- boolean \- if set removes the link rather than adding it +(optional) +.IP \[bu] 2 +expire \- string \- the expiry time of the link e.g. +\[dq]1d\[dq] (optional) +.PP Returns - -\- url \- URL of the resource - -See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/purge: Remove a directory or container and all of its contents {#operations\-purge} - +.IP \[bu] 2 +url \- URL of the resource +.PP +See the link command (https://rclone.org/commands/rclone_link/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/purge: Remove a directory or container and all of its contents +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/rmdir: Remove an empty directory or container {#operations\-rmdir} - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.PP +See the purge command (https://rclone.org/commands/rclone_purge/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/rmdir: Remove an empty directory or container +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] - -See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/rmdirs: Remove all the empty directories in the path {#operations\-rmdirs} - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.PP +See the rmdir command (https://rclone.org/commands/rclone_rmdir/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/rmdirs: Remove all the empty directories in the path +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- leaveRoot \- boolean, set to true not to delete the root - -See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/size: Count the number of bytes and files in remote {#operations\-size} - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.IP \[bu] 2 +leaveRoot \- boolean, set to true not to delete the root +.PP +See the rmdirs command (https://rclone.org/commands/rclone_rmdirs/) +command for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/size: Count the number of bytes and files in remote +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:path/to/dir\[dq] - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:path/to/dir\[dq] +.PP Returns - -\- count \- number of files -\- bytes \- number of bytes in those files - -See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above. - -**Authentication is required for this call.** - -### operations/uploadfile: Upload file using multiform/form\-data {#operations\-uploadfile} - +.IP \[bu] 2 +count \- number of files +.IP \[bu] 2 +bytes \- number of bytes in those files +.PP +See the size command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS operations/uploadfile: Upload file using multiform/form\-data +.PP This takes the following parameters - -\- fs \- a remote name string eg \[dq]drive:\[dq] -\- remote \- a path within that remote eg \[dq]dir\[dq] -\- each part in body represents a file to be uploaded -See the [uploadfile command](https://rclone.org/commands/rclone_uploadfile/) command for more information on the above. - -**Authentication is required for this call.** - -### options/blocks: List all the option blocks {#options\-blocks} - -Returns -\- options \- a list of the options block names - -### options/get: Get all the options {#options\-get} - +.IP \[bu] 2 +fs \- a remote name string e.g. +\[dq]drive:\[dq] +.IP \[bu] 2 +remote \- a path within that remote e.g. +\[dq]dir\[dq] +.IP \[bu] 2 +each part in body represents a file to be uploaded See the uploadfile +command (https://rclone.org/commands/rclone_uploadfile/) command for +more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS options/blocks: List all the option blocks +.PP +Returns \- options \- a list of the options block names +.SS options/get: Get all the options +.PP Returns an object where keys are option block names and values are an object with the current option values in. - +.PP This shows the internal names of the option within rclone which should map to the external options very easily with a few exceptions. - -### options/set: Set an option {#options\-set} - +.SS options/set: Set an option +.PP Parameters - -\- option block name containing an object with - \- key: value - +.IP \[bu] 2 +option block name containing an object with +.RS 2 +.IP \[bu] 2 +key: value +.RE +.PP Repeated as often as required. - -Only supply the options you wish to change. If an option is unknown -it will be silently ignored. Not all options will have an effect when -changed like this. - +.PP +Only supply the options you wish to change. +If an option is unknown it will be silently ignored. +Not all options will have an effect when changed like this. +.PP For example: - +.PP This sets DEBUG level logs (\-vv) - - rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 8}}\[aq] - +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 8}}\[aq] +\f[R] +.fi +.PP And this sets INFO level logs (\-v) - - rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 7}}\[aq] - +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 7}}\[aq] +\f[R] +.fi +.PP And this sets NOTICE level logs (normal without \-v) - - rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 6}}\[aq] - -### pluginsctl/addPlugin: Add a plugin using url {#pluginsctl\-addPlugin} - +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 6}}\[aq] +\f[R] +.fi +.SS pluginsctl/addPlugin: Add a plugin using url +.PP used for adding a plugin to the webgui - +.PP This takes the following parameters - -\- url: http url of the github repo where the plugin is hosted (http://github.com/rclone/rclone\-webui\-react) - +.IP \[bu] 2 +url: http url of the github repo where the plugin is hosted +(http://github.com/rclone/rclone\-webui\-react) +.PP Eg - - rclone rc pluginsctl/addPlugin - -**Authentication is required for this call.** - -### pluginsctl/getPluginsForType: Get plugins with type criteria {#pluginsctl\-getPluginsForType} - +.PP +rclone rc pluginsctl/addPlugin +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/getPluginsForType: Get plugins with type criteria +.PP This shows all possible plugins by a mime type - +.PP This takes the following parameters - -\- type: supported mime type by a loaded plugin eg (video/mp4, audio/mp3) -\- pluginType: filter plugins based on their type eg (DASHBOARD, FILE_HANDLER, TERMINAL) - +.IP \[bu] 2 +type: supported mime type by a loaded plugin e.g. +(video/mp4, audio/mp3) +.IP \[bu] 2 +pluginType: filter plugins based on their type e.g. +(DASHBOARD, FILE_HANDLER, TERMINAL) +.PP and returns - -\- loadedPlugins: list of current production plugins -\- testPlugins: list of temporarily loaded development plugins, usually running on a different server. - +.IP \[bu] 2 +loadedPlugins: list of current production plugins +.IP \[bu] 2 +testPlugins: list of temporarily loaded development plugins, usually +running on a different server. +.PP Eg - - rclone rc pluginsctl/getPluginsForType type=video/mp4 - -**Authentication is required for this call.** - -### pluginsctl/listPlugins: Get the list of currently loaded plugins {#pluginsctl\-listPlugins} - +.PP +rclone rc pluginsctl/getPluginsForType type=video/mp4 +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/listPlugins: Get the list of currently loaded plugins +.PP This allows you to get the currently enabled plugins and their details. - +.PP This takes no parameters and returns - -\- loadedPlugins: list of current production plugins -\- testPlugins: list of temporarily loaded development plugins, usually running on a different server. - +.IP \[bu] 2 +loadedPlugins: list of current production plugins +.IP \[bu] 2 +testPlugins: list of temporarily loaded development plugins, usually +running on a different server. +.PP Eg - - rclone rc pluginsctl/listPlugins - -**Authentication is required for this call.** - -### pluginsctl/listTestPlugins: Show currently loaded test plugins {#pluginsctl\-listTestPlugins} - -allows listing of test plugins with the rclone.test set to true in package.json of the plugin - +.PP +rclone rc pluginsctl/listPlugins +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/listTestPlugins: Show currently loaded test plugins +.PP +allows listing of test plugins with the rclone.test set to true in +package.json of the plugin +.PP This takes no parameters and returns - -\- loadedTestPlugins: list of currently available test plugins - +.IP \[bu] 2 +loadedTestPlugins: list of currently available test plugins +.PP Eg - - rclone rc pluginsctl/listTestPlugins - -**Authentication is required for this call.** - -### pluginsctl/removePlugin: Remove a loaded plugin {#pluginsctl\-removePlugin} - +.IP +.nf +\f[C] +rclone rc pluginsctl/listTestPlugins +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/removePlugin: Remove a loaded plugin +.PP This allows you to remove a plugin using it\[aq]s name - +.PP This takes parameters - -\- name: name of the plugin in the format / - +.IP \[bu] 2 +name: name of the plugin in the format +\f[C]author\f[R]/\f[C]plugin_name\f[R] +.PP Eg - - rclone rc pluginsctl/removePlugin name=rclone/video\-plugin - -**Authentication is required for this call.** - -### pluginsctl/removeTestPlugin: Remove a test plugin {#pluginsctl\-removeTestPlugin} - +.PP +rclone rc pluginsctl/removePlugin name=rclone/video\-plugin +.PP +\f[B]Authentication is required for this call.\f[R] +.SS pluginsctl/removeTestPlugin: Remove a test plugin +.PP This allows you to remove a plugin using it\[aq]s name - +.PP This takes the following parameters - -\- name: name of the plugin in the format / - +.IP \[bu] 2 +name: name of the plugin in the format +\f[C]author\f[R]/\f[C]plugin_name\f[R] +.PP Eg - - rclone rc pluginsctl/removeTestPlugin name=rclone/rclone\-webui\-react - -**Authentication is required for this call.** - -### rc/error: This returns an error {#rc\-error} - +.IP +.nf +\f[C] +rclone rc pluginsctl/removeTestPlugin name=rclone/rclone\-webui\-react +\f[R] +.fi +.PP +\f[B]Authentication is required for this call.\f[R] +.SS rc/error: This returns an error +.PP This returns an error with the input as part of its error string. Useful for testing error handling. - -### rc/list: List all the registered remote control commands {#rc\-list} - +.SS rc/list: List all the registered remote control commands +.PP This lists all the registered remote control commands as a JSON map in the commands response. - -### rc/noop: Echo the input to the output parameters {#rc\-noop} - +.SS rc/noop: Echo the input to the output parameters +.PP This echoes the input parameters to the output parameters for testing -purposes. It can be used to check that rclone is still alive and to -check that parameter passing is working properly. - -### rc/noopauth: Echo the input to the output parameters requiring auth {#rc\-noopauth} - +purposes. +It can be used to check that rclone is still alive and to check that +parameter passing is working properly. +.SS rc/noopauth: Echo the input to the output parameters requiring auth +.PP This echoes the input parameters to the output parameters for testing -purposes. It can be used to check that rclone is still alive and to -check that parameter passing is working properly. - -**Authentication is required for this call.** - -### sync/copy: copy a directory from source remote to destination remote {#sync\-copy} - +purposes. +It can be used to check that rclone is still alive and to check that +parameter passing is working properly. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS sync/copy: copy a directory from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination - - -See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above. - -**Authentication is required for this call.** - -### sync/move: move a directory from source remote to destination remote {#sync\-move} - +.IP \[bu] 2 +srcFs \- a remote name string e.g. +\[dq]drive:src\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string e.g. +\[dq]drive:dst\[dq] for the destination +.PP +See the copy command (https://rclone.org/commands/rclone_copy/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS sync/move: move a directory from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination -\- deleteEmptySrcDirs \- delete empty src directories if set - - -See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above. - -**Authentication is required for this call.** - -### sync/sync: sync a directory from source remote to destination remote {#sync\-sync} - +.IP \[bu] 2 +srcFs \- a remote name string e.g. +\[dq]drive:src\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string e.g. +\[dq]drive:dst\[dq] for the destination +.IP \[bu] 2 +deleteEmptySrcDirs \- delete empty src directories if set +.PP +See the move command (https://rclone.org/commands/rclone_move/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS sync/sync: sync a directory from source remote to destination remote +.PP This takes the following parameters - -\- srcFs \- a remote name string eg \[dq]drive:src\[dq] for the source -\- dstFs \- a remote name string eg \[dq]drive:dst\[dq] for the destination - - -See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. - -**Authentication is required for this call.** - -### vfs/forget: Forget files or directories in the directory cache. {#vfs\-forget} - +.IP \[bu] 2 +srcFs \- a remote name string e.g. +\[dq]drive:src\[dq] for the source +.IP \[bu] 2 +dstFs \- a remote name string e.g. +\[dq]drive:dst\[dq] for the destination +.PP +See the sync command (https://rclone.org/commands/rclone_sync/) command +for more information on the above. +.PP +\f[B]Authentication is required for this call.\f[R] +.SS vfs/forget: Forget files or directories in the directory cache. +.PP This forgets the paths in the directory cache causing them to be re\-read from the remote when needed. - +.PP If no paths are passed in then it will forget all the paths in the directory cache. - - rclone rc vfs/forget - -Otherwise pass files or dirs in as file=path or dir=path. Any -parameter key starting with file will forget that file and any -starting with dir will forget that dir, eg - - rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - -This command takes an \[dq]fs\[dq] parameter. If this parameter is not -supplied and if there is only one VFS in use then that VFS will be -used. If there is more than one VFS in use then the \[dq]fs\[dq] parameter +.IP +.nf +\f[C] +rclone rc vfs/forget +\f[R] +.fi +.PP +Otherwise pass files or dirs in as file=path or dir=path. +Any parameter key starting with file will forget that file and any +starting with dir will forget that dir, e.g. +.IP +.nf +\f[C] +rclone rc vfs/forget file=hello file2=goodbye dir=home/junk +\f[R] +.fi +.PP +This command takes an \[dq]fs\[dq] parameter. +If this parameter is not supplied and if there is only one VFS in use +then that VFS will be used. +If there is more than one VFS in use then the \[dq]fs\[dq] parameter must be supplied. - -### vfs/list: List active VFSes. {#vfs\-list} - +.SS vfs/list: List active VFSes. +.PP This lists the active VFSes. - -It returns a list under the key \[dq]vfses\[dq] where the values are the VFS -names that could be passed to the other VFS commands in the \[dq]fs\[dq] -parameter. - -### vfs/poll\-interval: Get the status or update the value of the poll\-interval option. {#vfs\-poll\-interval} - +.PP +It returns a list under the key \[dq]vfses\[dq] where the values are the +VFS names that could be passed to the other VFS commands in the +\[dq]fs\[dq] parameter. +.SS vfs/poll\-interval: Get the status or update the value of the poll\-interval option. +.PP Without any parameter given this returns the current status of the poll\-interval setting. - -When the interval=duration parameter is set, the poll\-interval value -is updated and the polling function is notified. +.PP +When the interval=duration parameter is set, the poll\-interval value is +updated and the polling function is notified. Setting interval=0 disables poll\-interval. - - rclone rc vfs/poll\-interval interval=5m - -The timeout=duration parameter can be used to specify a time to wait -for the current poll function to apply the new value. +.IP +.nf +\f[C] +rclone rc vfs/poll\-interval interval=5m +\f[R] +.fi +.PP +The timeout=duration parameter can be used to specify a time to wait for +the current poll function to apply the new value. If timeout is less or equal 0, which is the default, wait indefinitely. - -The new poll\-interval value will only be active when the timeout is -not reached. - -If poll\-interval is updated or disabled temporarily, some changes -might not get picked up by the polling function, depending on the -used remote. - -This command takes an \[dq]fs\[dq] parameter. If this parameter is not -supplied and if there is only one VFS in use then that VFS will be -used. If there is more than one VFS in use then the \[dq]fs\[dq] parameter +.PP +The new poll\-interval value will only be active when the timeout is not +reached. +.PP +If poll\-interval is updated or disabled temporarily, some changes might +not get picked up by the polling function, depending on the used remote. +.PP +This command takes an \[dq]fs\[dq] parameter. +If this parameter is not supplied and if there is only one VFS in use +then that VFS will be used. +If there is more than one VFS in use then the \[dq]fs\[dq] parameter must be supplied. - -### vfs/refresh: Refresh the directory cache. {#vfs\-refresh} - +.SS vfs/refresh: Refresh the directory cache. +.PP This reads the directories for the specified paths and freshens the directory cache. - +.PP If no paths are passed in then it will refresh the root directory. - - rclone rc vfs/refresh - -Otherwise pass directories in as dir=path. Any parameter key -starting with dir will refresh that directory, eg - - rclone rc vfs/refresh dir=home/junk dir2=data/misc - -If the parameter recursive=true is given the whole directory tree -will get refreshed. This refresh will use \-\-fast\-list if enabled. - -This command takes an \[dq]fs\[dq] parameter. If this parameter is not -supplied and if there is only one VFS in use then that VFS will be -used. If there is more than one VFS in use then the \[dq]fs\[dq] parameter +.IP +.nf +\f[C] +rclone rc vfs/refresh +\f[R] +.fi +.PP +Otherwise pass directories in as dir=path. +Any parameter key starting with dir will refresh that directory, e.g. +.IP +.nf +\f[C] +rclone rc vfs/refresh dir=home/junk dir2=data/misc +\f[R] +.fi +.PP +If the parameter recursive=true is given the whole directory tree will +get refreshed. +This refresh will use \-\-fast\-list if enabled. +.PP +This command takes an \[dq]fs\[dq] parameter. +If this parameter is not supplied and if there is only one VFS in use +then that VFS will be used. +If there is more than one VFS in use then the \[dq]fs\[dq] parameter must be supplied. - - - -## Accessing the remote control via HTTP - +.SS Accessing the remote control via HTTP +.PP Rclone implements a simple HTTP based protocol. - +.PP Each endpoint takes an JSON object and returns a JSON object or an -error. The JSON objects are essentially a map of string names to -values. - +error. +The JSON objects are essentially a map of string names to values. +.PP All calls must made using POST. - -The input objects can be supplied using URL parameters, POST -parameters or by supplying \[dq]Content\-Type: application/json\[dq] and a JSON -blob in the body. There are examples of these below using \[ga]curl\[ga]. - -The response will be a JSON blob in the body of the response. This is -formatted to be reasonably human readable. - -### Error returns - -If an error occurs then there will be an HTTP error status (eg 500) -and the body of the response will contain a JSON encoded error object, -eg -\f[R] -.fi .PP -{ \[dq]error\[dq]: \[dq]Expecting string value for key \[dq]remote\[dq] -(was float64)\[dq], \[dq]input\[dq]: { \[dq]fs\[dq]: \[dq]/tmp\[dq], -\[dq]remote\[dq]: 3 }, \[dq]status\[dq]: 400 \[dq]path\[dq]: -\[dq]operations/rmdir\[dq], } +The input objects can be supplied using URL parameters, POST parameters +or by supplying \[dq]Content\-Type: application/json\[dq] and a JSON +blob in the body. +There are examples of these below using \f[C]curl\f[R]. +.PP +The response will be a JSON blob in the body of the response. +This is formatted to be reasonably human readable. +.SS Error returns +.PP +If an error occurs then there will be an HTTP error status (e.g. +500) and the body of the response will contain a JSON encoded error +object, e.g. .IP .nf \f[C] - -The keys in the error response are -\- error \- error string -\- input \- the input parameters to the call -\- status \- the HTTP status code -\- path \- the path of the call - -### CORS - +{ + \[dq]error\[dq]: \[dq]Expecting string value for key \[rs]\[dq]remote\[rs]\[dq] (was float64)\[dq], + \[dq]input\[dq]: { + \[dq]fs\[dq]: \[dq]/tmp\[dq], + \[dq]remote\[dq]: 3 + }, + \[dq]status\[dq]: 400 + \[dq]path\[dq]: \[dq]operations/rmdir\[dq], +} +\f[R] +.fi +.PP +The keys in the error response are \- error \- error string \- input \- +the input parameters to the call \- status \- the HTTP status code \- +path \- the path of the call +.SS CORS +.PP The sever implements basic CORS support and allows all origins for that. -The response to a preflight OPTIONS request will echo the requested \[dq]Access\-Control\-Request\-Headers\[dq] back. - -### Using POST with URL parameters only -\f[R] -.fi -.PP +The response to a preflight OPTIONS request will echo the requested +\[dq]Access\-Control\-Request\-Headers\[dq] back. +.SS Using POST with URL parameters only +.IP +.nf +\f[C] curl \-X POST \[aq]http://localhost:5572/rc/noop?potato=1&sausage=2\[aq] -.IP -.nf -\f[C] - -Response \f[R] .fi .PP -{ \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } +Response .IP .nf \f[C] - +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] +} +\f[R] +.fi +.PP Here is what an error response looks like: -\f[R] -.fi -.PP -curl \-X POST -\[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] .IP .nf \f[C] +curl \-X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] \f[R] .fi -.PP -{ \[dq]error\[dq]: \[dq]arbitrary error on input map[potato:1 -sausage:2]\[dq], \[dq]input\[dq]: { \[dq]potato\[dq]: \[dq]1\[dq], -\[dq]sausage\[dq]: \[dq]2\[dq] } } .IP .nf \f[C] - -Note that curl doesn\[aq]t return errors to the shell unless you use the \[ga]\-f\[ga] option +{ + \[dq]error\[dq]: \[dq]arbitrary error on input map[potato:1 sausage:2]\[dq], + \[dq]input\[dq]: { + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] + } +} \f[R] .fi .PP -$ curl \-f \-X POST -\[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] curl: (22) -The requested URL returned error: 400 Bad Request $ echo $? +Note that curl doesn\[aq]t return errors to the shell unless you use the +\f[C]\-f\f[R] option +.IP +.nf +\f[C] +$ curl \-f \-X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] +curl: (22) The requested URL returned error: 400 Bad Request +$ echo $? 22 +\f[R] +.fi +.SS Using POST with a form .IP .nf \f[C] - -### Using POST with a form +curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] http://localhost:5572/rc/noop \f[R] .fi .PP -curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] -http://localhost:5572/rc/noop -.IP -.nf -\f[C] - Response -\f[R] -.fi -.PP -{ \[dq]potato\[dq]: \[dq]1\[dq], \[dq]sausage\[dq]: \[dq]2\[dq] } .IP .nf \f[C] - +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] +} +\f[R] +.fi +.PP Note that you can combine these with URL parameters too with the POST parameters taking precedence. -\f[R] -.fi -.PP -curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] -\[dq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[dq] .IP .nf \f[C] - +curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] \[dq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[dq] +\f[R] +.fi +.PP Response -\f[R] -.fi -.PP -{ \[dq]potato\[dq]: \[dq]1\[dq], \[dq]rutabaga\[dq]: \[dq]3\[dq], -\[dq]sausage\[dq]: \[dq]4\[dq] } .IP .nf \f[C] - -### Using POST with a JSON blob +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]rutabaga\[dq]: \[dq]3\[dq], + \[dq]sausage\[dq]: \[dq]4\[dq] +} \f[R] .fi -.PP -curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d -\[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] -http://localhost:5572/rc/noop +.SS Using POST with a JSON blob .IP .nf \f[C] - +curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d \[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] http://localhost:5572/rc/noop +\f[R] +.fi +.PP response -\f[R] -.fi -.PP -{ \[dq]password\[dq]: \[dq]xyz\[dq], \[dq]username\[dq]: \[dq]xyz\[dq] } .IP .nf \f[C] - -This can be combined with URL parameters too if required. The JSON -blob takes precedence. +{ + \[dq]password\[dq]: \[dq]xyz\[dq], + \[dq]username\[dq]: \[dq]xyz\[dq] +} \f[R] .fi .PP -curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d -\[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] -\[aq]http://localhost:5572/rc/noop?rutabaga=3&potato=4\[aq] +This can be combined with URL parameters too if required. +The JSON blob takes precedence. .IP .nf \f[C] +curl \-H \[dq]Content\-Type: application/json\[dq] \-X POST \-d \[aq]{\[dq]potato\[dq]:2,\[dq]sausage\[dq]:1}\[aq] \[aq]http://localhost:5572/rc/noop?rutabaga=3&potato=4\[aq] \f[R] .fi -.PP -{ \[dq]potato\[dq]: 2, \[dq]rutabaga\[dq]: \[dq]3\[dq], -\[dq]sausage\[dq]: 1 } .IP .nf \f[C] - -## Debugging rclone with pprof ## - -If you use the \[ga]\-\-rc\[ga] flag this will also enable the use of the go -profiling tools on the same port. - -To use these, first [install go](https://golang.org/doc/install). - -### Debugging memory use - +{ + \[dq]potato\[dq]: 2, + \[dq]rutabaga\[dq]: \[dq]3\[dq], + \[dq]sausage\[dq]: 1 +} +\f[R] +.fi +.SS Debugging rclone with pprof +.PP +If you use the \f[C]\-\-rc\f[R] flag this will also enable the use of +the go profiling tools on the same port. +.PP +To use these, first install go (https://golang.org/doc/install). +.SS Debugging memory use +.PP To profile rclone\[aq]s memory use you can run: - - go tool pprof \-web http://localhost:5572/debug/pprof/heap - +.IP +.nf +\f[C] +go tool pprof \-web http://localhost:5572/debug/pprof/heap +\f[R] +.fi +.PP This should open a page in your browser showing what is using what memory. - -You can also use the \[ga]\-text\[ga] flag to produce a textual summary -\f[R] -.fi .PP -$ go tool pprof \-text http://localhost:5572/debug/pprof/heap Showing -nodes accounting for 1537.03kB, 100% of 1537.03kB total flat flat% sum% -cum cum% 1024.03kB 66.62% 66.62% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode -513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init 0 0% 100% -1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2.init 0 0% 100% -1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init 0 0% -100% 1024.03kB 66.62% -github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 0 0% -100% 1024.03kB 66.62% main.init 0 0% 100% 513kB 33.38% -net/http.(\f[I]conn).readRequest 0 0% 100% 513kB 33.38% -net/http.(\f[R]conn).serve 0 0% 100% 1024.03kB 66.62% runtime.main +You can also use the \f[C]\-text\f[R] flag to produce a textual summary .IP .nf \f[C] - -### Debugging go routine leaks - +$ go tool pprof \-text http://localhost:5572/debug/pprof/heap +Showing nodes accounting for 1537.03kB, 100% of 1537.03kB total + flat flat% sum% cum cum% + 1024.03kB 66.62% 66.62% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.addDecoderNode + 513kB 33.38% 100% 513kB 33.38% net/http.newBufioWriterSize + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/all.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/cmd/serve/restic.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init + 0 0% 100% 1024.03kB 66.62% github.com/rclone/rclone/vendor/golang.org/x/net/http2/hpack.init.0 + 0 0% 100% 1024.03kB 66.62% main.init + 0 0% 100% 513kB 33.38% net/http.(*conn).readRequest + 0 0% 100% 513kB 33.38% net/http.(*conn).serve + 0 0% 100% 1024.03kB 66.62% runtime.main +\f[R] +.fi +.SS Debugging go routine leaks +.PP Memory leaks are most often caused by go routine leaks keeping memory alive which should have been garbage collected. - +.PP See all active go routines using - - curl http://localhost:5572/debug/pprof/goroutine?debug=1 - -Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. - -### Other profiles to look at - -You can see a summary of profiles available at http://localhost:5572/debug/pprof/ - +.IP +.nf +\f[C] +curl http://localhost:5572/debug/pprof/goroutine?debug=1 +\f[R] +.fi +.PP +Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your +browser. +.SS Other profiles to look at +.PP +You can see a summary of profiles available at +http://localhost:5572/debug/pprof/ +.PP Here is how to use some of them: - -\- Memory: \[ga]go tool pprof http://localhost:5572/debug/pprof/heap\[ga] -\- Go routines: \[ga]curl http://localhost:5572/debug/pprof/goroutine?debug=1\[ga] -\- 30\-second CPU profile: \[ga]go tool pprof http://localhost:5572/debug/pprof/profile\[ga] -\- 5\-second execution trace: \[ga]wget http://localhost:5572/debug/pprof/trace?seconds=5\[ga] -\- Goroutine blocking profile - \- Enable first with: \[ga]rclone rc debug/set\-block\-profile\-rate rate=1\[ga] ([docs](#debug/set\-block\-profile\-rate)) - \- \[ga]go tool pprof http://localhost:5572/debug/pprof/block\[ga] -\- Contended mutexes: - \- Enable first with: \[ga]rclone rc debug/set\-mutex\-profile\-fraction rate=1\[ga] ([docs](#debug/set\-mutex\-profile\-fraction)) - \- \[ga]go tool pprof http://localhost:5572/debug/pprof/mutex\[ga] - -See the [net/http/pprof docs](https://golang.org/pkg/net/http/pprof/) -for more info on how to use the profiling and for a general overview -see [the Go team\[aq]s blog post on profiling go programs](https://blog.golang.org/profiling\-go\-programs). - -The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). - -# Overview of cloud storage systems # - -Each cloud storage system is slightly different. Rclone attempts to -provide a unified interface to them, but some underlying differences -show through. - -## Features ## - +.IP \[bu] 2 +Memory: \f[C]go tool pprof http://localhost:5572/debug/pprof/heap\f[R] +.IP \[bu] 2 +Go routines: +\f[C]curl http://localhost:5572/debug/pprof/goroutine?debug=1\f[R] +.IP \[bu] 2 +30\-second CPU profile: +\f[C]go tool pprof http://localhost:5572/debug/pprof/profile\f[R] +.IP \[bu] 2 +5\-second execution trace: +\f[C]wget http://localhost:5572/debug/pprof/trace?seconds=5\f[R] +.IP \[bu] 2 +Goroutine blocking profile +.RS 2 +.IP \[bu] 2 +Enable first with: +\f[C]rclone rc debug/set\-block\-profile\-rate rate=1\f[R] (docs) +.IP \[bu] 2 +\f[C]go tool pprof http://localhost:5572/debug/pprof/block\f[R] +.RE +.IP \[bu] 2 +Contended mutexes: +.RS 2 +.IP \[bu] 2 +Enable first with: +\f[C]rclone rc debug/set\-mutex\-profile\-fraction rate=1\f[R] (docs) +.IP \[bu] 2 +\f[C]go tool pprof http://localhost:5572/debug/pprof/mutex\f[R] +.RE +.PP +See the net/http/pprof docs (https://golang.org/pkg/net/http/pprof/) for +more info on how to use the profiling and for a general overview see the +Go team\[aq]s blog post on profiling go +programs (https://blog.golang.org/profiling-go-programs). +.PP +The profiling hook is zero overhead unless it is +used (https://stackoverflow.com/q/26545159/164234). +.SH Overview of cloud storage systems +.PP +Each cloud storage system is slightly different. +Rclone attempts to provide a unified interface to them, but some +underlying differences show through. +.SS Features +.PP Here is an overview of the major features of each cloud storage system. - -| Name | Hash | ModTime | Case Insensitive | Duplicate Files | MIME Type | -| \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-:| -| 1Fichier | Whirlpool | No | No | Yes | R | -| Amazon Drive | MD5 | No | Yes | No | R | -| Amazon S3 | MD5 | Yes | No | No | R/W | -| Backblaze B2 | SHA1 | Yes | No | No | R/W | -| Box | SHA1 | Yes | Yes | No | \- | -| Citrix ShareFile | MD5 | Yes | Yes | No | \- | -| Dropbox | DBHASH \[dg] | Yes | Yes | No | \- | -| FTP | \- | No | No | No | \- | -| Google Cloud Storage | MD5 | Yes | No | No | R/W | -| Google Drive | MD5 | Yes | No | Yes | R/W | -| Google Photos | \- | No | No | Yes | R | -| HTTP | \- | No | No | No | R | -| Hubic | MD5 | Yes | No | No | R/W | -| Jottacloud | MD5 | Yes | Yes | No | R/W | -| Koofr | MD5 | No | Yes | No | \- | -| Mail.ru Cloud | Mailru \[dd]\[dd]\[dd] | Yes | Yes | No | \- | -| Mega | \- | No | No | Yes | \- | -| Memory | MD5 | Yes | No | No | \- | -| Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | -| Microsoft OneDrive | SHA1 \[dd]\[dd] | Yes | Yes | No | R | -| OpenDrive | MD5 | Yes | Yes | Partial \[rs]* | \- | -| OpenStack Swift | MD5 | Yes | No | No | R/W | -| pCloud | MD5, SHA1 | Yes | No | No | W | -| premiumize.me | \- | No | Yes | No | R | -| put.io | CRC\-32 | Yes | No | Yes | R | -| QingStor | MD5 | No | No | No | R/W | -| Seafile | \- | No | No | No | \- | -| SFTP | MD5, SHA1 \[dd] | Yes | Depends | No | \- | -| SugarSync | \- | No | No | No | \- | -| Tardigrade | \- | Yes | No | No | \- | -| WebDAV | MD5, SHA1 \[dg]\[dg]| Yes \[dg]\[dg]\[dg] | Depends | No | \- | -| Yandex Disk | MD5 | Yes | No | No | R/W | -| The local filesystem | All | Yes | Depends | No | \- | - -### Hash ### - +.PP +.TS +tab(@); +l c c c c c. +T{ +Name +T}@T{ +Hash +T}@T{ +ModTime +T}@T{ +Case Insensitive +T}@T{ +Duplicate Files +T}@T{ +MIME Type +T} +_ +T{ +1Fichier +T}@T{ +Whirlpool +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +Amazon Drive +T}@T{ +MD5 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +Amazon S3 +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Backblaze B2 +T}@T{ +SHA1 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Box +T}@T{ +SHA1 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Citrix ShareFile +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Dropbox +T}@T{ +DBHASH \[S1] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Enterprise File Fabric +T}@T{ +\- +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +R/W +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{ +HDFS +T}@T{ +\- +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +\- +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 +T} +T{ +Koofr +T}@T{ +MD5 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Mail.ru Cloud +T}@T{ +Mailru \[u2076] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Mega +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +\- +T} +T{ +Memory +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Microsoft Azure Blob Storage +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Microsoft OneDrive +T}@T{ +SHA1 \[u2075] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +OpenDrive +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Partial \[u2078] +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 \[u2077] +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +W +T} +T{ +premiumize.me +T}@T{ +\- +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +put.io +T}@T{ +CRC\-32 +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +QingStor +T}@T{ +MD5 +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Seafile +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +SFTP +T}@T{ +MD5, SHA1 \[S2] +T}@T{ +Yes +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +T{ +SugarSync +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Tardigrade +T}@T{ +\- +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +WebDAV +T}@T{ +MD5, SHA1 \[S3] +T}@T{ +Yes \[u2074] +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 +T} +T{ +Zoho WorkDrive +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +The local filesystem +T}@T{ +All +T}@T{ +Yes +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +.TE +.SS Notes +.PP +\[S1] 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 +\[S2] SFTP supports checksums if the same login has shell access and +\f[C]md5sum\f[R] or \f[C]sha1sum\f[R] as well as \f[C]echo\f[R] are in +the remote\[aq]s PATH. +.PP +\[S3] WebDAV supports hashes when used with Owncloud and Nextcloud only. +.PP +\[u2074] WebDAV supports modtimes when used with Owncloud and Nextcloud +only. +.PP +\[u2075] Microsoft OneDrive Personal supports SHA1 hashes, whereas +OneDrive for business and SharePoint server support Microsoft\[aq]s own +QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). +.PP +\[u2076] Mail.ru uses its own modified SHA1 hash +.PP +\[u2077] pCloud only supports SHA1 (not MD5) in its EU region +.PP +\[u2078] Opendrive does not support creation of duplicate files using +their web client interface or other stock clients, but the underlying +storage platform has been determined to allow duplicate files, and it is +possible to create them with \f[C]rclone\f[R]. +It may be that this is a mistake or an unsupported feature. +.SS Hash +.PP The cloud storage system supports various hash types of the objects. -The hashes are used when transferring data as an integrity check and -can be specifically used with the \[ga]\-\-checksum\[ga] flag in syncs and in -the \[ga]check\[ga] command. - +The hashes are used when transferring data as an integrity check and can +be specifically used with the \f[C]\-\-checksum\f[R] flag in syncs and +in the \f[C]check\f[R] command. +.PP To use the verify checksums when transferring between cloud storage systems they must support a common hash type. - -\[dg] Note that Dropbox supports [its own custom -hash](https://www.dropbox.com/developers/reference/content\-hash). -This is an SHA256 sum of all the 4MB block SHA256s. - -\[dd] SFTP supports checksums if the same login has shell access and \[ga]md5sum\[ga] -or \[ga]sha1sum\[ga] as well as \[ga]echo\[ga] are in the remote\[aq]s PATH. - -\[dg]\[dg] WebDAV supports hashes when used with Owncloud and Nextcloud only. - -\[dg]\[dg]\[dg] WebDAV supports modtimes when used with Owncloud and Nextcloud only. - -\[dd]\[dd] Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive -for business and SharePoint server support Microsoft\[aq]s own -[QuickXorHash](https://docs.microsoft.com/en\-us/onedrive/developer/code\-snippets/quickxorhash). - -\[dd]\[dd]\[dd] Mail.ru uses its own modified SHA1 hash - -### ModTime ### - -The cloud storage system supports setting modification times on -objects. If it does then this enables a using the modification times -as part of the sync. If not then only the size will be checked by -default, though the MD5SUM can be checked with the \[ga]\-\-checksum\[ga] flag. - +.SS ModTime +.PP +The cloud storage system supports setting modification times on objects. +If it does then this enables a using the modification times as part of +the sync. +If not then only the size will be checked by default, though the MD5SUM +can be checked with the \f[C]\-\-checksum\f[R] flag. +.PP All cloud storage systems support some kind of date on the object and these will be set when transferring from the cloud storage system. - -### Case Insensitive ### - -If a cloud storage systems is case sensitive then it is possible to -have two files which differ only in case, eg \[ga]file.txt\[ga] and -\[ga]FILE.txt\[ga]. If a cloud storage system is case insensitive then that -isn\[aq]t possible. - -This can cause problems when syncing between a case insensitive -system and a case sensitive system. The symptom of this is that no -matter how many times you run the sync it never completes fully. - -The local filesystem and SFTP may or may not be case sensitive -depending on OS. - - * Windows \- usually case insensitive, though case is preserved - * OSX \- usually case insensitive, though it is possible to format case sensitive - * Linux \- usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys) - +.SS Case Insensitive +.PP +If a cloud storage systems is case sensitive then it is possible to have +two files which differ only in case, e.g. +\f[C]file.txt\f[R] and \f[C]FILE.txt\f[R]. +If a cloud storage system is case insensitive then that isn\[aq]t +possible. +.PP +This can cause problems when syncing between a case insensitive system +and a case sensitive system. +The symptom of this is that no matter how many times you run the sync it +never completes fully. +.PP +The local filesystem and SFTP may or may not be case sensitive depending +on OS. +.IP \[bu] 2 +Windows \- usually case insensitive, though case is preserved +.IP \[bu] 2 +OSX \- usually case insensitive, though it is possible to format case +sensitive +.IP \[bu] 2 +Linux \- usually case sensitive, but there are case insensitive file +systems (e.g. +FAT formatted USB keys) +.PP Most of the time this doesn\[aq]t cause any problems as people tend to avoid files whose name differs only by case even on case sensitive systems. - -### Duplicate files ### - +.SS Duplicate files +.PP If a cloud storage system allows duplicate files then it can have two objects with the same name. - -This confuses rclone greatly when syncing \- use the \[ga]rclone dedupe\[ga] -command to rename or remove duplicates. - -\[rs]* Opendrive does not support creation of duplicate files using -their web client interface or other stock clients, but the underlying -storage platform has been determined to allow duplicate files, and it -is possible to create them with \[ga]rclone\[ga]. It may be that this is a -mistake or an unsupported feature. - -### Restricted filenames ### - +.PP +This confuses rclone greatly when syncing \- use the +\f[C]rclone dedupe\f[R] command to rename or remove duplicates. +.SS Restricted filenames +.PP Some cloud storage systems might have restrictions on the characters that are usable in file or directory names. -When \[ga]rclone\[ga] detects such a name during a file upload, it will +When \f[C]rclone\f[R] detects such a name during a file upload, it will transparently replace the restricted characters with similar looking Unicode characters. - +.PP This process is designed to avoid ambiguous file names as much as possible and allow to move files between many cloud storage systems transparently. - -The name shown by \[ga]rclone\[ga] to the user or during log output will only -contain a minimal set of [replaced characters](#restricted\-characters) -to ensure correct formatting and not necessarily the actual name used -on the cloud storage. - +.PP +The name shown by \f[C]rclone\f[R] to the user or during log output will +only contain a minimal set of replaced characters to ensure correct +formatting and not necessarily the actual name used on the cloud +storage. +.PP This transformation is reversed when downloading a file or parsing -\[ga]rclone\[ga] arguments. -For example, when uploading a file named \[ga]my file?.txt\[ga] to Onedrive -will be displayed as \[ga]my file?.txt\[ga] on the console, but stored as -\[ga]my file\[uFF1F].txt\[ga] (the \[ga]?\[ga] gets replaced by the similar looking \[ga]\[uFF1F]\[ga] -character) to Onedrive. -The reverse transformation allows to read a file\[ga]unusual/name.txt\[ga] -from Google Drive, by passing the name \[ga]unusual\[uFF0F]name.txt\[ga] (the \[ga]/\[ga] needs -to be replaced by the similar looking \[ga]\[uFF0F]\[ga] character) on the command line. - -#### Default restricted characters {#restricted\-characters} - +\f[C]rclone\f[R] arguments. +For example, when uploading a file named \f[C]my file?.txt\f[R] to +Onedrive will be displayed as \f[C]my file?.txt\f[R] on the console, but +stored as \f[C]my file\[uFF1F].txt\f[R] (the \f[C]?\f[R] gets replaced +by the similar looking \f[C]\[uFF1F]\f[R] character) to Onedrive. +The reverse transformation allows to read a +file\f[C]unusual/name.txt\f[R] from Google Drive, by passing the name +\f[C]unusual\[uFF0F]name.txt\f[R] (the \f[C]/\f[R] needs to be replaced +by the similar looking \f[C]\[uFF0F]\f[R] character) on the command +line. +.SS Default restricted characters +.PP The table below shows the characters that are replaced by default. - -When a replacement character is found in a filename, this character -will be escaped with the \[ga]\[u201B]\[ga] character to avoid ambiguous file names. -(e.g. a file named \[ga]\[u2400].txt\[ga] would shown as \[ga]\[u201B]\[u2400].txt\[ga]) - -Each cloud storage backend can use a different set of characters, -which will be specified in the documentation for each backend. - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| SOH | 0x01 | \[u2401] | -| STX | 0x02 | \[u2402] | -| ETX | 0x03 | \[u2403] | -| EOT | 0x04 | \[u2404] | -| ENQ | 0x05 | \[u2405] | -| ACK | 0x06 | \[u2406] | -| BEL | 0x07 | \[u2407] | -| BS | 0x08 | \[u2408] | -| HT | 0x09 | \[u2409] | -| LF | 0x0A | \[u240A] | -| VT | 0x0B | \[u240B] | -| FF | 0x0C | \[u240C] | -| CR | 0x0D | \[u240D] | -| SO | 0x0E | \[u240E] | -| SI | 0x0F | \[u240F] | -| DLE | 0x10 | \[u2410] | -| DC1 | 0x11 | \[u2411] | -| DC2 | 0x12 | \[u2412] | -| DC3 | 0x13 | \[u2413] | -| DC4 | 0x14 | \[u2414] | -| NAK | 0x15 | \[u2415] | -| SYN | 0x16 | \[u2416] | -| ETB | 0x17 | \[u2417] | -| CAN | 0x18 | \[u2418] | -| EM | 0x19 | \[u2419] | -| SUB | 0x1A | \[u241A] | -| ESC | 0x1B | \[u241B] | -| FS | 0x1C | \[u241C] | -| GS | 0x1D | \[u241D] | -| RS | 0x1E | \[u241E] | -| US | 0x1F | \[u241F] | -| / | 0x2F | \[uFF0F] | -| DEL | 0x7F | \[u2421] | - +.PP +When a replacement character is found in a filename, this character will +be escaped with the \f[C]\[u201B]\f[R] character to avoid ambiguous file +names. +(e.g. +a file named \f[C]\[u2400].txt\f[R] would shown as +\f[C]\[u201B]\[u2400].txt\f[R]) +.PP +Each cloud storage backend can use a different set of characters, which +will be specified in the documentation for each backend. +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +SOH +T}@T{ +0x01 +T}@T{ +\[u2401] +T} +T{ +STX +T}@T{ +0x02 +T}@T{ +\[u2402] +T} +T{ +ETX +T}@T{ +0x03 +T}@T{ +\[u2403] +T} +T{ +EOT +T}@T{ +0x04 +T}@T{ +\[u2404] +T} +T{ +ENQ +T}@T{ +0x05 +T}@T{ +\[u2405] +T} +T{ +ACK +T}@T{ +0x06 +T}@T{ +\[u2406] +T} +T{ +BEL +T}@T{ +0x07 +T}@T{ +\[u2407] +T} +T{ +BS +T}@T{ +0x08 +T}@T{ +\[u2408] +T} +T{ +HT +T}@T{ +0x09 +T}@T{ +\[u2409] +T} +T{ +LF +T}@T{ +0x0A +T}@T{ +\[u240A] +T} +T{ +VT +T}@T{ +0x0B +T}@T{ +\[u240B] +T} +T{ +FF +T}@T{ +0x0C +T}@T{ +\[u240C] +T} +T{ +CR +T}@T{ +0x0D +T}@T{ +\[u240D] +T} +T{ +SO +T}@T{ +0x0E +T}@T{ +\[u240E] +T} +T{ +SI +T}@T{ +0x0F +T}@T{ +\[u240F] +T} +T{ +DLE +T}@T{ +0x10 +T}@T{ +\[u2410] +T} +T{ +DC1 +T}@T{ +0x11 +T}@T{ +\[u2411] +T} +T{ +DC2 +T}@T{ +0x12 +T}@T{ +\[u2412] +T} +T{ +DC3 +T}@T{ +0x13 +T}@T{ +\[u2413] +T} +T{ +DC4 +T}@T{ +0x14 +T}@T{ +\[u2414] +T} +T{ +NAK +T}@T{ +0x15 +T}@T{ +\[u2415] +T} +T{ +SYN +T}@T{ +0x16 +T}@T{ +\[u2416] +T} +T{ +ETB +T}@T{ +0x17 +T}@T{ +\[u2417] +T} +T{ +CAN +T}@T{ +0x18 +T}@T{ +\[u2418] +T} +T{ +EM +T}@T{ +0x19 +T}@T{ +\[u2419] +T} +T{ +SUB +T}@T{ +0x1A +T}@T{ +\[u241A] +T} +T{ +ESC +T}@T{ +0x1B +T}@T{ +\[u241B] +T} +T{ +FS +T}@T{ +0x1C +T}@T{ +\[u241C] +T} +T{ +GS +T}@T{ +0x1D +T}@T{ +\[u241D] +T} +T{ +RS +T}@T{ +0x1E +T}@T{ +\[u241E] +T} +T{ +US +T}@T{ +0x1F +T}@T{ +\[u241F] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +T{ +DEL +T}@T{ +0x7F +T}@T{ +\[u2421] +T} +.TE +.PP The default encoding will also encode these file names as they are problematic with many cloud storage systems. - -| File name | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-:| -| . | \[uFF0E] | -| .. | \[uFF0E]\[uFF0E] | - -#### Invalid UTF\-8 bytes {#invalid\-utf8} - -Some backends only support a sequence of well formed UTF\-8 bytes -as file or directory names. - +.PP +.TS +tab(@); +l c. +T{ +File name +T}@T{ +Replacement +T} +_ +T{ +\&. +T}@T{ +\[uFF0E] +T} +T{ +\&.. +T}@T{ +\[uFF0E]\[uFF0E] +T} +.TE +.SS Invalid UTF\-8 bytes +.PP +Some backends only support a sequence of well formed UTF\-8 bytes as +file or directory names. +.PP In this case all invalid UTF\-8 bytes will be replaced with a quoted representation of the byte value to allow uploading a file to such a -backend. For example, the invalid byte \[ga]0xFE\[ga] will be encoded as \[ga]\[u201B]FE\[ga]. - -A common source of invalid UTF\-8 bytes are local filesystems, that store -names in a different encoding than UTF\-8 or UTF\-16, like latin1. See the -[local filenames](https://rclone.org/local/#filenames) section for details. - -#### Encoding option {#encoding} - +backend. +For example, the invalid byte \f[C]0xFE\f[R] will be encoded as +\f[C]\[u201B]FE\f[R]. +.PP +A common source of invalid UTF\-8 bytes are local filesystems, that +store names in a different encoding than UTF\-8 or UTF\-16, like latin1. +See the local filenames (https://rclone.org/local/#filenames) section +for details. +.SS Encoding option +.PP Most backends have an encoding options, specified as a flag -\[ga]\-\-backend\-encoding\[ga] where \[ga]backend\[ga] is the name of the backend, or as -a config parameter \[ga]encoding\[ga] (you\[aq]ll need to select the Advanced -config in \[ga]rclone config\[ga] to see it). - +\f[C]\-\-backend\-encoding\f[R] where \f[C]backend\f[R] is the name of +the backend, or as a config parameter \f[C]encoding\f[R] (you\[aq]ll +need to select the Advanced config in \f[C]rclone config\f[R] to see +it). +.PP This will have default value which encodes and decodes characters in -such a way as to preserve the maximum number of characters (see -above). - -However this can be incorrect in some scenarios, for example if you -have a Windows file system with characters such as \[ga]\[uFF0A]\[ga] and \[ga]\[uFF1F]\[ga] that -you want to remain as those characters on the remote rather than being -translated to \[ga]*\[ga] and \[ga]?\[ga]. - -The \[ga]\-\-backend\-encoding\[ga] flags allow you to change that. You can -disable the encoding completely with \[ga]\-\-backend\-encoding None\[ga] or set -\[ga]encoding = None\[ga] in the config file. - -Encoding takes a comma separated list of encodings. You can see the -list of all available characters by passing an invalid value to this -flag, eg \[ga]\-\-local\-encoding \[dq]help\[dq]\[ga] and \[ga]rclone help flags encoding\[ga] -will show you the defaults for the backends. - -| Encoding | Characters | -| \-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\- | -| Asterisk | \[ga]*\[ga] | -| BackQuote | \[ga]\[ga] \[ga] \[ga]\[ga] | -| BackSlash | \[ga]\[rs]\[ga] | -| Colon | \[ga]:\[ga] | -| CrLf | CR 0x0D, LF 0x0A | -| Ctl | All control characters 0x00\-0x1F | -| Del | DEL 0x7F | -| Dollar | \[ga]$\[ga] | -| Dot | \[ga].\[ga] | -| DoubleQuote | \[ga]\[dq]\[ga] | -| Hash | \[ga]#\[ga] | -| InvalidUtf8 | An invalid UTF\-8 character (eg latin1) | -| LeftCrLfHtVt | CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string | -| LeftPeriod | \[ga].\[ga] on the left of a string | -| LeftSpace | SPACE on the left of a string | -| LeftTilde | \[ga]\[ti]\[ga] on the left of a string | -| LtGt | \[ga]<\[ga], \[ga]>\[ga] | -| None | No characters are encoded | -| Percent | \[ga]%\[ga] | -| Pipe | \[rs]| | -| Question | \[ga]?\[ga] | -| RightCrLfHtVt | CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string | -| RightPeriod | \[ga].\[ga] on the right of a string | -| RightSpace | SPACE on the right of a string | -| SingleQuote | \[ga]\[aq]\[ga] | -| Slash | \[ga]/\[ga] | - +such a way as to preserve the maximum number of characters (see above). +.PP +However this can be incorrect in some scenarios, for example if you have +a Windows file system with characters such as \f[C]\[uFF0A]\f[R] and +\f[C]\[uFF1F]\f[R] that you want to remain as those characters on the +remote rather than being translated to \f[C]*\f[R] and \f[C]?\f[R]. +.PP +The \f[C]\-\-backend\-encoding\f[R] flags allow you to change that. +You can disable the encoding completely with +\f[C]\-\-backend\-encoding None\f[R] or set \f[C]encoding = None\f[R] in +the config file. +.PP +Encoding takes a comma separated list of encodings. +You can see the list of all available characters by passing an invalid +value to this flag, e.g. +\f[C]\-\-local\-encoding \[dq]help\[dq]\f[R] and +\f[C]rclone help flags encoding\f[R] will show you the defaults for the +backends. +.PP +.TS +tab(@); +l l. +T{ +Encoding +T}@T{ +Characters +T} +_ +T{ +Asterisk +T}@T{ +\f[C]*\f[R] +T} +T{ +BackQuote +T}@T{ +\f[C]\[ga]\f[R] +T} +T{ +BackSlash +T}@T{ +\f[C]\[rs]\f[R] +T} +T{ +Colon +T}@T{ +\f[C]:\f[R] +T} +T{ +CrLf +T}@T{ +CR 0x0D, LF 0x0A +T} +T{ +Ctl +T}@T{ +All control characters 0x00\-0x1F +T} +T{ +Del +T}@T{ +DEL 0x7F +T} +T{ +Dollar +T}@T{ +\f[C]$\f[R] +T} +T{ +Dot +T}@T{ +\f[C].\f[R] +T} +T{ +DoubleQuote +T}@T{ +\f[C]\[dq]\f[R] +T} +T{ +Hash +T}@T{ +\f[C]#\f[R] +T} +T{ +InvalidUtf8 +T}@T{ +An invalid UTF\-8 character (e.g. +latin1) +T} +T{ +LeftCrLfHtVt +T}@T{ +CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string +T} +T{ +LeftPeriod +T}@T{ +\f[C].\f[R] on the left of a string +T} +T{ +LeftSpace +T}@T{ +SPACE on the left of a string +T} +T{ +LeftTilde +T}@T{ +\f[C]\[ti]\f[R] on the left of a string +T} +T{ +LtGt +T}@T{ +\f[C]<\f[R], \f[C]>\f[R] +T} +T{ +None +T}@T{ +No characters are encoded +T} +T{ +Percent +T}@T{ +\f[C]%\f[R] +T} +T{ +Pipe +T}@T{ +| +T} +T{ +Question +T}@T{ +\f[C]?\f[R] +T} +T{ +RightCrLfHtVt +T}@T{ +CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string +T} +T{ +RightPeriod +T}@T{ +\f[C].\f[R] on the right of a string +T} +T{ +RightSpace +T}@T{ +SPACE on the right of a string +T} +T{ +SingleQuote +T}@T{ +\f[C]\[aq]\f[R] +T} +T{ +Slash +T}@T{ +\f[C]/\f[R] +T} +.TE +.PP To take a specific example, the FTP backend\[aq]s default encoding is - - \-\-ftp\-encoding \[dq]Slash,Del,Ctl,RightSpace,Dot\[dq] - -However, let\[aq]s say the FTP server is running on Windows and can\[aq]t have -any of the invalid Windows characters in file names. You are backing -up Linux servers to this FTP server which do have those characters in -file names. So you would add the Windows set which are - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - +.IP +.nf +\f[C] +\-\-ftp\-encoding \[dq]Slash,Del,Ctl,RightSpace,Dot\[dq] +\f[R] +.fi +.PP +However, let\[aq]s say the FTP server is running on Windows and +can\[aq]t have any of the invalid Windows characters in file names. +You are backing up Linux servers to this FTP server which do have those +characters in file names. +So you would add the Windows set which are +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot +\f[R] +.fi +.PP to the existing ones, giving: - - Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace - -This can be specified using the \[ga]\-\-ftp\-encoding\[ga] flag or using an \[ga]encoding\[ga] parameter in the config file. - -Or let\[aq]s say you have a Windows server but you want to preserve \[ga]\[uFF0A]\[ga] -and \[ga]\[uFF1F]\[ga], you would then have this as the encoding (the Windows -encoding minus \[ga]Asterisk\[ga] and \[ga]Question\[ga]). - - Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot - -This can be specified using the \[ga]\-\-local\-encoding\[ga] flag or using an -\[ga]encoding\[ga] parameter in the config file. - -### MIME Type ### - -MIME types (also known as media types) classify types of documents -using a simple text classification, eg \[ga]text/html\[ga] or -\[ga]application/pdf\[ga]. - -Some cloud storage systems support reading (\[ga]R\[ga]) the MIME type of -objects and some support writing (\[ga]W\[ga]) the MIME type of objects. - -The MIME type can be important if you are serving files directly to -HTTP from the storage system. - -If you are copying from a remote which supports reading (\[ga]R\[ga]) to a -remote which supports writing (\[ga]W\[ga]) then rclone will preserve the MIME -types. Otherwise they will be guessed from the extension, or the -remote itself may assign the MIME type. - -## Optional Features ## - -All the remotes support a basic set of features, but there are some -optional features supported by some remotes used to make some -operations more efficient. - -| Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir | -| \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-:|:\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-:| :\-\-\-\-\-\-: | -| 1Fichier | No | No | No | No | No | No | No | No | No | Yes | -| Amazon Drive | Yes | No | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | -| Amazon S3 | No | Yes | No | No | Yes | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | Yes | No | No | -| Box | Yes | Yes | Yes | Yes | Yes \[dd]\[dd] | No | Yes | Yes | No | Yes | -| Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | Yes | No | No | Yes | -| Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | Yes | Yes | -| FTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | -| Google Cloud Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Google Drive | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | -| Google Photos | No | No | No | No | No | No | No | No | No | No | -| HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | -| Hubic | Yes \[dg] | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | -| Jottacloud | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | -| Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| Memory | No | Yes | No | No | No | Yes | Yes | No | No | No | -| Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Microsoft OneDrive | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | -| OpenStack Swift | Yes \[dg] | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | -| pCloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | -| premiumize.me | Yes | No | Yes | Yes | No | No | No | Yes | Yes | Yes | -| put.io | Yes | No | Yes | Yes | Yes | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| QingStor | No | Yes | No | No | Yes | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | -| Seafile | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | -| SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | -| Tardigrade | Yes \[dg] | No | No | No | No | Yes | Yes | No | No | No | -| WebDAV | Yes | Yes | Yes | Yes | No | No | Yes \[dd] | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | -| Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | -| The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | - -### Purge ### - -This deletes a directory quicker than just deleting all the files in -the directory. - -\[dg] Note Swift, Hubic, and Tardigrade implement this in order to delete -directory markers but they don\[aq]t actually have a quicker way of deleting -files other than deleting them individually. - +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace +\f[R] +.fi +.PP +This can be specified using the \f[C]\-\-ftp\-encoding\f[R] flag or +using an \f[C]encoding\f[R] parameter in the config file. +.PP +Or let\[aq]s say you have a Windows server but you want to preserve +\f[C]\[uFF0A]\f[R] and \f[C]\[uFF1F]\f[R], you would then have this as +the encoding (the Windows encoding minus \f[C]Asterisk\f[R] and +\f[C]Question\f[R]). +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot +\f[R] +.fi +.PP +This can be specified using the \f[C]\-\-local\-encoding\f[R] flag or +using an \f[C]encoding\f[R] parameter in the config file. +.SS MIME Type +.PP +MIME types (also known as media types) classify types of documents using +a simple text classification, e.g. +\f[C]text/html\f[R] or \f[C]application/pdf\f[R]. +.PP +Some cloud storage systems support reading (\f[C]R\f[R]) the MIME type +of objects and some support writing (\f[C]W\f[R]) the MIME type of +objects. +.PP +The MIME type can be important if you are serving files directly to HTTP +from the storage system. +.PP +If you are copying from a remote which supports reading (\f[C]R\f[R]) to +a remote which supports writing (\f[C]W\f[R]) then rclone will preserve +the MIME types. +Otherwise they will be guessed from the extension, or the remote itself +may assign the MIME type. +.SS Optional Features +.PP +All rclone remotes support a base command set. +Other features depend upon backend specific capabilities. +.PP +.TS +tab(@); +l c c c c c c c c c c. +T{ +Name +T}@T{ +Purge +T}@T{ +Copy +T}@T{ +Move +T}@T{ +DirMove +T}@T{ +CleanUp +T}@T{ +ListR +T}@T{ +StreamUpload +T}@T{ +LinkSharing +T}@T{ +About +T}@T{ +EmptyDir +T} +_ +T{ +1Fichier +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Amazon Drive +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Amazon S3 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Backblaze B2 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T} +T{ +Box +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes \[dd]\[dd] +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T} +T{ +Citrix ShareFile +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Dropbox +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Enterprise File Fabric +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{ +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{ +HDFS +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +HTTP +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Hubic +T}@T{ +Yes \[dg] +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +No +T} +T{ +Jottacloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Mail.ru Cloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Mega +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Memory +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T} +T{ +Microsoft Azure Blob Storage +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Microsoft OneDrive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +OpenDrive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +OpenStack Swift +T}@T{ +Yes \[dg] +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +No +T} +T{ +pCloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +premiumize.me +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +put.io +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +QingStor +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Seafile +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +SFTP +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +SugarSync +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T} +T{ +Tardigrade +T}@T{ +Yes \[dg] +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T} +T{ +WebDAV +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes \[dd] +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Yandex Disk +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Zoho WorkDrive +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{ +Yes +T}@T{ +Yes +T} +T{ +The local filesystem +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T} +.TE +.SS Purge +.PP +This deletes a directory quicker than just deleting all the files in the +directory. +.PP +\[dg] Note Swift, Hubic, and Tardigrade implement this in order to +delete directory markers but they don\[aq]t actually have a quicker way +of deleting files other than deleting them individually. +.PP \[dd] StreamUpload is not supported with Nextcloud - -### Copy ### - -Used when copying an object to and from the same remote. This known -as a server side copy so you can copy a file without downloading it -and uploading it again. It is used if you use \[ga]rclone copy\[ga] or -\[ga]rclone move\[ga] if the remote doesn\[aq]t support \[ga]Move\[ga] directly. - -If the server doesn\[aq]t support \[ga]Copy\[ga] directly then for copy operations -the file is downloaded then re\-uploaded. - -### Move ### - -Used when moving/renaming an object on the same remote. This is known -as a server side move of a file. This is used in \[ga]rclone move\[ga] if the -server doesn\[aq]t support \[ga]DirMove\[ga]. - -If the server isn\[aq]t capable of \[ga]Move\[ga] then rclone simulates it with -\[ga]Copy\[ga] then delete. If the server doesn\[aq]t support \[ga]Copy\[ga] then rclone -will download the file and re\-upload it. - -### DirMove ### - -This is used to implement \[ga]rclone move\[ga] to move a directory if -possible. If it isn\[aq]t then it will use \[ga]Move\[ga] on each file (which -falls back to \[ga]Copy\[ga] then download and upload \- see \[ga]Move\[ga] section). - -### CleanUp ### - -This is used for emptying the trash for a remote by \[ga]rclone cleanup\[ga]. - -If the server can\[aq]t do \[ga]CleanUp\[ga] then \[ga]rclone cleanup\[ga] will return an -error. - -\[dd]\[dd] Note that while Box implements this it has to delete every file -idividually so it will be slower than emptying the trash via the WebUI - -### ListR ### - -The remote supports a recursive list to list all the contents beneath -a directory quickly. This enables the \[ga]\-\-fast\-list\[ga] flag to work. -See the [rclone docs](https://rclone.org/docs/#fast\-list) for more details. - -### StreamUpload ### - -Some remotes allow files to be uploaded without knowing the file size -in advance. This allows certain operations to work without spooling the -file to local disk first, e.g. \[ga]rclone rcat\[ga]. - -### LinkSharing ### - +.SS Copy +.PP +Used when copying an object to and from the same remote. +This known as a server\-side copy so you can copy a file without +downloading it and uploading it again. +It is used if you use \f[C]rclone copy\f[R] or \f[C]rclone move\f[R] if +the remote doesn\[aq]t support \f[C]Move\f[R] directly. +.PP +If the server doesn\[aq]t support \f[C]Copy\f[R] directly then for copy +operations the file is downloaded then re\-uploaded. +.SS Move +.PP +Used when moving/renaming an object on the same remote. +This is known as a server\-side move of a file. +This is used in \f[C]rclone move\f[R] if the server doesn\[aq]t support +\f[C]DirMove\f[R]. +.PP +If the server isn\[aq]t capable of \f[C]Move\f[R] then rclone simulates +it with \f[C]Copy\f[R] then delete. +If the server doesn\[aq]t support \f[C]Copy\f[R] then rclone will +download the file and re\-upload it. +.SS DirMove +.PP +This is used to implement \f[C]rclone move\f[R] to move a directory if +possible. +If it isn\[aq]t then it will use \f[C]Move\f[R] on each file (which +falls back to \f[C]Copy\f[R] then download and upload \- see +\f[C]Move\f[R] section). +.SS CleanUp +.PP +This is used for emptying the trash for a remote by +\f[C]rclone cleanup\f[R]. +.PP +If the server can\[aq]t do \f[C]CleanUp\f[R] then +\f[C]rclone cleanup\f[R] will return an error. +.PP +\[dd]\[dd] Note that while Box implements this it has to delete every +file individually so it will be slower than emptying the trash via the +WebUI +.SS ListR +.PP +The remote supports a recursive list to list all the contents beneath a +directory quickly. +This enables the \f[C]\-\-fast\-list\f[R] flag to work. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS StreamUpload +.PP +Some remotes allow files to be uploaded without knowing the file size in +advance. +This allows certain operations to work without spooling the file to +local disk first, e.g. +\f[C]rclone rcat\f[R]. +.SS LinkSharing +.PP Sets the necessary permissions on a file or folder and prints a link -that allows others to access them, even if they don\[aq]t have an account -on the particular cloud provider. - -### About ### - -This is used to fetch quota information from the remote, like bytes -used/free/quota and bytes used in the trash. - -This is also used to return the space used, available for \[ga]rclone mount\[ga]. - -If the server can\[aq]t do \[ga]About\[ga] then \[ga]rclone about\[ga] will return an -error. - -### EmptyDir ### - -The remote supports empty directories. See [Limitations](https://rclone.org/bugs/#limitations) - for details. Most Object/Bucket based remotes do not support this. - -# Global Flags - -This describes the global flags available to every rclone command -split into two groups, non backend and backend flags. - -## Non Backend Flags - +that allows others to access them, even if they don\[aq]t have an +account on the particular cloud provider. +.SS About +.PP +Rclone \f[C]about\f[R] prints quota information for a remote. +Typical output includes bytes used, free, quota and in trash. +.PP +If a remote lacks about capability \f[C]rclone about remote:\f[R]returns +an error. +.PP +Backends without about capability cannot determine free space for an +rclone mount, or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See rclone about command (https://rclone.org/commands/rclone_about/) +.SS EmptyDir +.PP +The remote supports empty directories. +See Limitations (https://rclone.org/bugs/#limitations) for details. +Most Object/Bucket based remotes do not support this. +.SH Global Flags +.PP +This describes the global flags available to every rclone command split +into two groups, non backend and backend flags. +.SS Non Backend Flags +.PP These flags are available for every command. -\f[R] -.fi .IP .nf \f[C] - \-\-ask\-password Allow prompt for password for encrypted configuration. (default true) - \-\-auto\-confirm If enabled, do not request console confirmation. - \-\-backup\-dir string Make backups into hierarchy based in DIR. - \-\-bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. - \-\-buffer\-size SizeSuffix In memory buffer size when reading files for each \-\-transfer. (default 16M) - \-\-bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. - \-\-bwlimit\-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. - \-\-ca\-cert string CA certificate used to verify servers - \-\-cache\-dir string Directory rclone will use for caching. (default \[dq]$HOME/.cache/rclone\[dq]) - \-\-check\-first Do all the checks before starting transfers. - \-\-checkers int Number of checkers to run in parallel. (default 8) + \-\-ask\-password Allow prompt for password for encrypted configuration. (default true) + \-\-auto\-confirm If enabled, do not request console confirmation. + \-\-backup\-dir string Make backups into hierarchy based in DIR. + \-\-bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + \-\-buffer\-size SizeSuffix In memory buffer size when reading files for each \-\-transfer. (default 16M) + \-\-bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + \-\-bwlimit\-file BwTimetable Bandwidth limit per file in kBytes/s, or use suffix b|k|M|G or a full timetable. + \-\-ca\-cert string CA certificate used to verify servers + \-\-cache\-dir string Directory rclone will use for caching. (default \[dq]$HOME/.cache/rclone\[dq]) + \-\-check\-first Do all the checks before starting transfers. + \-\-checkers int Number of checkers to run in parallel. (default 8) + \-c, \-\-checksum Skip based on checksum (if available) & size, not mod\-time & size + \-\-client\-cert string Client SSL certificate (PEM) for mutual TLS auth + \-\-client\-key string Client SSL private key (PEM) for mutual TLS auth + \-\-compare\-dest string Include additional server\-side path during comparison. + \-\-config string Config file. (default \[dq]$HOME/.config/rclone/rclone.conf\[dq]) + \-\-contimeout duration Connect timeout (default 1m0s) + \-\-copy\-dest string Implies \-\-compare\-dest but also copies files from path into destination. + \-\-cpuprofile string Write cpu profile to file + \-\-cutoff\-mode string Mode to stop transfers when reaching the max transfer limit HARD|SOFT|CAUTIOUS (default \[dq]HARD\[dq]) + \-\-delete\-after When synchronizing, delete files on destination after transferring (default) + \-\-delete\-before When synchronizing, delete files on destination before transferring + \-\-delete\-during When synchronizing, delete files during transfer + \-\-delete\-excluded Delete files on dest excluded from sync + \-\-disable string Disable a comma separated list of features. Use help to see a list. + \-n, \-\-dry\-run Do a trial run with no permanent changes + \-\-dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + \-\-dump\-bodies Dump HTTP headers and bodies \- may contain sensitive info + \-\-dump\-headers Dump HTTP headers \- may contain sensitive info + \-\-error\-on\-no\-transfer Sets exit code 9 if no files are transferred, useful in scripts + \-\-exclude stringArray Exclude files matching pattern + \-\-exclude\-from stringArray Read exclude patterns from file (use \- to read from stdin) + \-\-exclude\-if\-present string Exclude directories if filename is present + \-\-expect\-continue\-timeout duration Timeout when using expect / 100\-continue in HTTP (default 1s) + \-\-fast\-list Use recursive list if available. Uses more memory but fewer transactions. + \-\-files\-from stringArray Read list of source\-file names from file (use \- to read from stdin) + \-\-files\-from\-raw stringArray Read list of source\-file names from file without any processing of lines (use \- to read from stdin) + \-f, \-\-filter stringArray Add a file\-filtering rule + \-\-filter\-from stringArray Read filtering patterns from a file (use \- to read from stdin) + \-\-header stringArray Set HTTP header for all transactions + \-\-header\-download stringArray Set HTTP header for download transactions + \-\-header\-upload stringArray Set HTTP header for upload transactions + \-\-ignore\-case Ignore case in filters (case insensitive) + \-\-ignore\-case\-sync Ignore case when synchronizing + \-\-ignore\-checksum Skip post copy check of checksums. + \-\-ignore\-errors delete even if there are I/O errors + \-\-ignore\-existing Skip all files that exist on destination + \-\-ignore\-size Ignore size when skipping use mod\-time or checksum. + \-I, \-\-ignore\-times Don\[aq]t skip files that match size and time \- transfer all files + \-\-immutable Do not modify files. Fail if existing files have been modified. + \-\-include stringArray Include files matching pattern + \-\-include\-from stringArray Read include patterns from file (use \- to read from stdin) + \-i, \-\-interactive Enable interactive mode + \-\-log\-file string Log everything to this file + \-\-log\-format string Comma separated list of log format options (default \[dq]date,time\[dq]) + \-\-log\-level string Log level DEBUG|INFO|NOTICE|ERROR (default \[dq]NOTICE\[dq]) + \-\-log\-systemd Activate systemd integration for the logger. + \-\-low\-level\-retries int Number of low level retries to do. (default 10) + \-\-max\-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) + \-\-max\-backlog int Maximum number of objects in sync or check backlog. (default 10000) + \-\-max\-delete int When synchronizing, limit the number of deletes (default \-1) + \-\-max\-depth int If set limits the recursion depth to this. (default \-1) + \-\-max\-duration duration Maximum duration rclone will transfer data for. + \-\-max\-size SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G (default off) + \-\-max\-stats\-groups int Maximum number of stats groups to keep in memory. On max oldest is discarded. (default 1000) + \-\-max\-transfer SizeSuffix Maximum size of data to transfer. (default off) + \-\-memprofile string Write memory profile to file + \-\-min\-age Duration Only transfer files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) + \-\-min\-size SizeSuffix Only transfer files bigger than this in k or suffix b|k|M|G (default off) + \-\-modify\-window duration Max time diff to be considered the same (default 1ns) + \-\-multi\-thread\-cutoff SizeSuffix Use multi\-thread downloads for files above this size. (default 250M) + \-\-multi\-thread\-streams int Max number of streams to use for multi\-thread downloads. (default 4) + \-\-no\-check\-certificate Do not verify the server SSL certificate. Insecure. + \-\-no\-check\-dest Don\[aq]t check the destination, copy regardless. + \-\-no\-console Hide console window. Supported on Windows only. + \-\-no\-gzip\-encoding Don\[aq]t set Accept\-Encoding: gzip. + \-\-no\-traverse Don\[aq]t traverse destination file system on copy. + \-\-no\-unicode\-normalization Don\[aq]t normalize unicode characters in filenames. + \-\-no\-update\-modtime Don\[aq]t update destination mod\-time if files identical. + \-\-order\-by string Instructions on how to order the transfers, e.g. \[aq]size,descending\[aq] + \-\-password\-command SpaceSepList Command for supplying password for encrypted configuration. + \-P, \-\-progress Show progress during transfer. + \-\-progress\-terminal\-title Show progress on the terminal title. Requires \-P/\-\-progress. + \-q, \-\-quiet Print as little stuff as possible + \-\-rc Enable the remote control server. + \-\-rc\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:5572\[dq]) + \-\-rc\-allow\-origin string Set the allowed origin for CORS. + \-\-rc\-baseurl string Prefix for URLs \- leave blank for root. + \-\-rc\-cert string SSL PEM key (concatenation of certificate and CA certificate) + \-\-rc\-client\-ca string Client certificate authority to verify clients with + \-\-rc\-enable\-metrics Enable prometheus metrics on /metrics + \-\-rc\-files string Path to local files to serve on the HTTP server. + \-\-rc\-htpasswd string htpasswd file \- if not provided no authentication is done + \-\-rc\-job\-expire\-duration duration expire finished async jobs older than this value (default 1m0s) + \-\-rc\-job\-expire\-interval duration interval to check for expired async jobs (default 10s) + \-\-rc\-key string SSL PEM Private key + \-\-rc\-max\-header\-bytes int Maximum size of request header (default 4096) + \-\-rc\-no\-auth Don\[aq]t require auth for certain methods. + \-\-rc\-pass string Password for authentication. + \-\-rc\-realm string realm for authentication (default \[dq]rclone\[dq]) + \-\-rc\-serve Enable the serving of remote objects. + \-\-rc\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) + \-\-rc\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) + \-\-rc\-template string User Specified Template. + \-\-rc\-user string User name for authentication. + \-\-rc\-web\-fetch\-url string URL to fetch the releases for webgui. (default \[dq]https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest\[dq]) + \-\-rc\-web\-gui Launch WebGUI on localhost + \-\-rc\-web\-gui\-force\-update Force update to latest version of web gui + \-\-rc\-web\-gui\-no\-open\-browser Don\[aq]t open the browser automatically + \-\-rc\-web\-gui\-update Check and update to latest version of web gui + \-\-refresh\-times Refresh the modtime of remote files. + \-\-retries int Retry operations this many times if they fail (default 3) + \-\-retries\-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) + \-\-size\-only Skip based on size only, not mod\-time or checksum + \-\-stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) + \-\-stats\-file\-name\-length int Max file name length in stats. 0 for no limit (default 45) + \-\-stats\-log\-level string Log level to show \-\-stats output DEBUG|INFO|NOTICE|ERROR (default \[dq]INFO\[dq]) + \-\-stats\-one\-line Make the stats fit on one line. + \-\-stats\-one\-line\-date Enables \-\-stats\-one\-line and add current date/time prefix. + \-\-stats\-one\-line\-date\-format string Enables \-\-stats\-one\-line\-date and uses custom formatted date. Enclose date string in double quotes (\[dq]). See https://golang.org/pkg/time/#Time.Format + \-\-stats\-unit string Show data rate in stats as either \[aq]bits\[aq] or \[aq]bytes\[aq]/s (default \[dq]bytes\[dq]) + \-\-streaming\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) + \-\-suffix string Suffix to add to changed files. + \-\-suffix\-keep\-extension Preserve the extension when using \-\-suffix. + \-\-syslog Use Syslog for logging + \-\-syslog\-facility string Facility for syslog, e.g. KERN,USER,... (default \[dq]DAEMON\[dq]) + \-\-timeout duration IO idle timeout (default 5m0s) + \-\-tpslimit float Limit HTTP transactions per second to this. + \-\-tpslimit\-burst int Max burst of transactions for \-\-tpslimit. (default 1) + \-\-track\-renames When synchronizing, track file renames and do a server\-side move if possible + \-\-track\-renames\-strategy string Strategies to use when synchronizing using track\-renames hash|modtime|leaf (default \[dq]hash\[dq]) + \-\-transfers int Number of file transfers to run in parallel. (default 4) + \-u, \-\-update Skip files that are newer on the destination. + \-\-use\-cookies Enable session cookiejar. + \-\-use\-json\-log Use json log format. + \-\-use\-mmap Use mmap allocator (see docs). + \-\-use\-server\-modtime Use server modified time instead of object metadata + \-\-user\-agent string Set the user\-agent to a specified string. The default is rclone/ version (default \[dq]rclone/v1.54.0\[dq]) + \-v, \-\-verbose count Print lots more stuff (repeat for more) +\f[R] +.fi +.SS Backend Flags +.PP +These flags are available for every command. +They control the backends and may be set in the config file. +.IP +.nf +\f[C] + \-\-acd\-auth\-url string Auth server URL. + \-\-acd\-client\-id string OAuth Client Id + \-\-acd\-client\-secret string OAuth Client Secret + \-\-acd\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + \-\-acd\-templink\-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) + \-\-acd\-token string OAuth Access Token as a JSON blob. + \-\-acd\-token\-url string Token server url. + \-\-acd\-upload\-wait\-per\-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) + \-\-alias\-remote string Remote or path to alias. + \-\-azureblob\-access\-tier string Access tier of blob: hot, cool or archive. + \-\-azureblob\-account string Storage Account Name (leave blank to use SAS URL or Emulator) + \-\-azureblob\-archive\-tier\-delete Delete archive tier blobs before overwriting. + \-\-azureblob\-chunk\-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) + \-\-azureblob\-disable\-checksum Don\[aq]t store MD5 checksum with object metadata. + \-\-azureblob\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) + \-\-azureblob\-endpoint string Endpoint for the service + \-\-azureblob\-key string Storage Account Key (leave blank to use SAS URL or Emulator) + \-\-azureblob\-list\-chunk int Size of blob list. (default 5000) + \-\-azureblob\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + \-\-azureblob\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. + \-\-azureblob\-msi\-client\-id string Object ID of the user\-assigned MSI to use, if any. Leave blank if msi_object_id or msi_mi_res_id specified. + \-\-azureblob\-msi\-mi\-res\-id string Azure resource ID of the user\-assigned MSI to use, if any. Leave blank if msi_client_id or msi_object_id specified. + \-\-azureblob\-msi\-object\-id string Object ID of the user\-assigned MSI to use, if any. Leave blank if msi_client_id or msi_mi_res_id specified. + \-\-azureblob\-sas\-url string SAS URL for container level access only + \-\-azureblob\-service\-principal\-file string Path to file containing credentials for use with a service principal. + \-\-azureblob\-upload\-cutoff string Cutoff for switching to chunked upload (<= 256MB). (Deprecated) + \-\-azureblob\-use\-emulator Uses local storage emulator if provided as \[aq]true\[aq] (leave blank if using real azure storage endpoint) + \-\-azureblob\-use\-msi Use a managed service identity to authenticate (only works in Azure) + \-\-b2\-account string Account ID or Application Key ID + \-\-b2\-chunk\-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + \-\-b2\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) + \-\-b2\-disable\-checksum Disable checksums for large (> upload cutoff) files + \-\-b2\-download\-auth\-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + \-\-b2\-download\-url string Custom endpoint for downloads. + \-\-b2\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-b2\-endpoint string Endpoint for the service. + \-\-b2\-hard\-delete Permanently delete files on remote removal, otherwise hide files. + \-\-b2\-key string Application Key + \-\-b2\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + \-\-b2\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. + \-\-b2\-test\-mode string A flag string for X\-Bz\-Test\-Mode header for debugging. + \-\-b2\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + \-\-b2\-versions Include old versions in directory listings. + \-\-box\-access\-token string Box App Primary Access Token + \-\-box\-auth\-url string Auth server URL. + \-\-box\-box\-config\-file string Box App config.json location + \-\-box\-box\-sub\-type string (default \[dq]user\[dq]) + \-\-box\-client\-id string OAuth Client Id + \-\-box\-client\-secret string OAuth Client Secret + \-\-box\-commit\-retries int Max number of times to try committing a multipart file. (default 100) + \-\-box\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + \-\-box\-root\-folder\-id string Fill in for rclone to use a non root folder as its starting point. + \-\-box\-token string OAuth Access Token as a JSON blob. + \-\-box\-token\-url string Token server url. + \-\-box\-upload\-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + \-\-cache\-chunk\-clean\-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + \-\-cache\-chunk\-no\-memory Disable the in\-memory cache for storing chunks during streaming. + \-\-cache\-chunk\-path string Directory to cache chunk files. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) + \-\-cache\-chunk\-size SizeSuffix The size of a chunk (partial file data). (default 5M) + \-\-cache\-chunk\-total\-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + \-\-cache\-db\-path string Directory to store file structure metadata DB. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) + \-\-cache\-db\-purge Clear all the cached data for this remote on start. + \-\-cache\-db\-wait\-time Duration How long to wait for the DB to be available \- 0 is unlimited (default 1s) + \-\-cache\-info\-age Duration How long to cache file structure information (directory listings, file size, times, etc.). (default 6h0m0s) + \-\-cache\-plex\-insecure string Skip all certificate verification when connecting to the Plex server + \-\-cache\-plex\-password string The password of the Plex user (obscured) + \-\-cache\-plex\-url string The URL of the Plex server + \-\-cache\-plex\-username string The username of the Plex user + \-\-cache\-read\-retries int How many times to retry a read from a cache storage. (default 10) + \-\-cache\-remote string Remote to cache. + \-\-cache\-rps int Limits the number of requests per second to the source FS (\-1 to disable) (default \-1) + \-\-cache\-tmp\-upload\-path string Directory to keep temporary files until they are uploaded. + \-\-cache\-tmp\-wait\-time Duration How long should files be stored in local cache before being uploaded (default 15s) + \-\-cache\-workers int How many workers should run in parallel to download chunks. (default 4) + \-\-cache\-writes Cache file data on writes through the FS + \-\-chunker\-chunk\-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + \-\-chunker\-fail\-hard Choose how chunker should handle files with missing or invalid chunks. + \-\-chunker\-hash\-type string Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. (default \[dq]md5\[dq]) + \-\-chunker\-remote string Remote to chunk/unchunk. + \-\-compress\-level int GZIP compression level (\-2 to 9). (default \-1) + \-\-compress\-mode string Compression mode. (default \[dq]gzip\[dq]) + \-\-compress\-ram\-cache\-limit SizeSuffix Some remotes don\[aq]t allow the upload of files with unknown size. (default 20M) + \-\-compress\-remote string Remote to compress. + \-L, \-\-copy\-links Follow symlinks and copy the pointed to item. + \-\-crypt\-directory\-name\-encryption Option to either encrypt directory names or leave them intact. (default true) + \-\-crypt\-filename\-encryption string How to encrypt the filenames. (default \[dq]standard\[dq]) + \-\-crypt\-password string Password or pass phrase for encryption. (obscured) + \-\-crypt\-password2 string Password or pass phrase for salt. Optional but recommended. (obscured) + \-\-crypt\-remote string Remote to encrypt/decrypt. + \-\-crypt\-server\-side\-across\-configs Allow server\-side operations (e.g. copy) to work across different crypt configs. + \-\-crypt\-show\-mapping For all files listed show how the names encrypt. + \-\-drive\-acknowledge\-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + \-\-drive\-allow\-import\-name\-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + \-\-drive\-auth\-owner\-only Only consider files owned by the authenticated user. + \-\-drive\-auth\-url string Auth server URL. + \-\-drive\-chunk\-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + \-\-drive\-client\-id string Google Application Client Id + \-\-drive\-client\-secret string OAuth Client Secret + \-\-drive\-disable\-http2 Disable drive using http2 (default true) + \-\-drive\-encoding MultiEncoder This sets the encoding for the backend. (default InvalidUtf8) + \-\-drive\-export\-formats string Comma separated list of preferred formats for downloading Google docs. (default \[dq]docx,xlsx,pptx,svg\[dq]) + \-\-drive\-formats string Deprecated: see export_formats + \-\-drive\-impersonate string Impersonate this user when using a service account. + \-\-drive\-import\-formats string Comma separated list of preferred formats for uploading Google docs. + \-\-drive\-keep\-revision\-forever Keep new head revision of each file forever. + \-\-drive\-list\-chunk int Size of listing chunk 100\-1000. 0 to disable. (default 1000) + \-\-drive\-pacer\-burst int Number of API calls to allow without sleeping. (default 100) + \-\-drive\-pacer\-min\-sleep Duration Minimum time to sleep between API calls. (default 100ms) + \-\-drive\-root\-folder\-id string ID of the root folder + \-\-drive\-scope string Scope that rclone should use when requesting access from drive. + \-\-drive\-server\-side\-across\-configs Allow server\-side operations (e.g. copy) to work across different drive configs. + \-\-drive\-service\-account\-credentials string Service Account Credentials JSON blob + \-\-drive\-service\-account\-file string Service Account Credentials JSON file path + \-\-drive\-shared\-with\-me Only show files that are shared with me. + \-\-drive\-size\-as\-quota Show sizes as storage quota usage, not actual size. + \-\-drive\-skip\-checksum\-gphotos Skip MD5 checksum on Google photos and videos only. + \-\-drive\-skip\-gdocs Skip google documents in all listings. + \-\-drive\-skip\-shortcuts If set skip shortcut files + \-\-drive\-starred\-only Only show files that are starred. + \-\-drive\-stop\-on\-download\-limit Make download limit errors be fatal + \-\-drive\-stop\-on\-upload\-limit Make upload limit errors be fatal + \-\-drive\-team\-drive string ID of the Team Drive + \-\-drive\-token string OAuth Access Token as a JSON blob. + \-\-drive\-token\-url string Token server url. + \-\-drive\-trashed\-only Only show files that are in the trash. + \-\-drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + \-\-drive\-use\-created\-date Use file created date instead of modified date., + \-\-drive\-use\-shared\-date Use date file was shared instead of modified date. + \-\-drive\-use\-trash Send files to the trash instead of deleting permanently. (default true) + \-\-drive\-v2\-download\-min\-size SizeSuffix If Object\[aq]s are greater, use drive v2 API to download. (default off) + \-\-dropbox\-auth\-url string Auth server URL. + \-\-dropbox\-chunk\-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + \-\-dropbox\-client\-id string OAuth Client Id + \-\-dropbox\-client\-secret string OAuth Client Secret + \-\-dropbox\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) + \-\-dropbox\-impersonate string Impersonate this user when using a business account. + \-\-dropbox\-shared\-files Instructs rclone to work on individual shared files. + \-\-dropbox\-shared\-folders Instructs rclone to work on shared folders. + \-\-dropbox\-token string OAuth Access Token as a JSON blob. + \-\-dropbox\-token\-url string Token server url. + \-\-fichier\-api\-key string Your API Key, get it from https://1fichier.com/console/params.pl + \-\-fichier\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) + \-\-fichier\-shared\-folder string If you want to download a shared folder, add this parameter + \-\-filefabric\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + \-\-filefabric\-permanent\-token string Permanent Authentication Token + \-\-filefabric\-root\-folder\-id string ID of the root folder + \-\-filefabric\-token string Session Token + \-\-filefabric\-token\-expiry string Token expiry time + \-\-filefabric\-url string URL of the Enterprise File Fabric to connect to + \-\-filefabric\-version string Version read from the file fabric + \-\-ftp\-concurrency int Maximum number of FTP simultaneous connections, 0 for unlimited + \-\-ftp\-disable\-epsv Disable using EPSV even if server advertises support + \-\-ftp\-disable\-mlsd Disable using MLSD even if server advertises support + \-\-ftp\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,RightSpace,Dot) + \-\-ftp\-explicit\-tls Use Explicit FTPS (FTP over TLS) + \-\-ftp\-host string FTP host to connect to + \-\-ftp\-no\-check\-certificate Do not verify the TLS certificate of the server + \-\-ftp\-pass string FTP password (obscured) + \-\-ftp\-port string FTP port, leave blank to use default (21) + \-\-ftp\-tls Use Implicit FTPS (FTP over TLS) + \-\-ftp\-user string FTP username, leave blank for current username, $USER + \-\-gcs\-anonymous Access public buckets and objects without credentials + \-\-gcs\-auth\-url string Auth server URL. + \-\-gcs\-bucket\-acl string Access Control List for new buckets. + \-\-gcs\-bucket\-policy\-only Access checks should use bucket\-level IAM policies. + \-\-gcs\-client\-id string OAuth Client Id + \-\-gcs\-client\-secret string OAuth Client Secret + \-\-gcs\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,CrLf,InvalidUtf8,Dot) + \-\-gcs\-location string Location for the newly created buckets. + \-\-gcs\-object\-acl string Access Control List for new objects. + \-\-gcs\-project\-number string Project number. + \-\-gcs\-service\-account\-file string Service Account Credentials JSON file path + \-\-gcs\-storage\-class string The storage class to use when storing objects in Google Cloud Storage. + \-\-gcs\-token string OAuth Access Token as a JSON blob. + \-\-gcs\-token\-url string Token server url. + \-\-gphotos\-auth\-url string Auth server URL. + \-\-gphotos\-client\-id string OAuth Client Id + \-\-gphotos\-client\-secret string OAuth Client Secret + \-\-gphotos\-include\-archived Also view and download archived media. + \-\-gphotos\-read\-only Set to make the Google Photos backend read only. + \-\-gphotos\-read\-size Set to read the size of media items. + \-\-gphotos\-start\-year int Year limits the photos to be downloaded to those which are uploaded after the given year (default 2000) + \-\-gphotos\-token string OAuth Access Token as a JSON blob. + \-\-gphotos\-token\-url string Token server url. + \-\-hdfs\-data\-transfer\-protection string Kerberos data transfer protection: authentication|integrity|privacy + \-\-hdfs\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Colon,Del,Ctl,InvalidUtf8,Dot) + \-\-hdfs\-namenode string hadoop name node and port + \-\-hdfs\-service\-principal\-name string Kerberos service principal name for the namenode + \-\-hdfs\-username string hadoop user name + \-\-http\-headers CommaSepList Set HTTP headers for all transactions + \-\-http\-no\-head Don\[aq]t use HEAD requests to find file sizes in dir listing + \-\-http\-no\-slash Set this if the site doesn\[aq]t end directories with / + \-\-http\-url string URL of http host to connect to + \-\-hubic\-auth\-url string Auth server URL. + \-\-hubic\-chunk\-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + \-\-hubic\-client\-id string OAuth Client Id + \-\-hubic\-client\-secret string OAuth Client Secret + \-\-hubic\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + \-\-hubic\-no\-chunk Don\[aq]t chunk files during streaming upload. + \-\-hubic\-token string OAuth Access Token as a JSON blob. + \-\-hubic\-token\-url string Token server url. + \-\-jottacloud\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) + \-\-jottacloud\-hard\-delete Delete files permanently rather than putting them into the trash. + \-\-jottacloud\-md5\-memory\-limit SizeSuffix Files bigger than this will be cached on disk to calculate the MD5 if required. (default 10M) + \-\-jottacloud\-trashed\-only Only show files that are in the trash. + \-\-jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this can be resumed if the upload fail\[aq]s. (default 10M) + \-\-koofr\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-koofr\-endpoint string The Koofr API endpoint to use (default \[dq]https://app.koofr.net\[dq]) + \-\-koofr\-mountid string Mount ID of the mount to use. If omitted, the primary mount is used. + \-\-koofr\-password string Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) (obscured) + \-\-koofr\-setmtime Does the backend support setting modification time. Set this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend. (default true) + \-\-koofr\-user string Your Koofr user name + \-l, \-\-links Translate symlinks to/from regular files with a \[aq].rclonelink\[aq] extension + \-\-local\-case\-insensitive Force the filesystem to report itself as case insensitive + \-\-local\-case\-sensitive Force the filesystem to report itself as case sensitive. + \-\-local\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Dot) + \-\-local\-no\-check\-updated Don\[aq]t check to see if the files change during upload + \-\-local\-no\-set\-modtime Disable setting modtime + \-\-local\-no\-sparse Disable sparse files for multi\-thread downloads + \-\-local\-no\-unicode\-normalization Don\[aq]t apply unicode normalization to paths and filenames (Deprecated) + \-\-local\-nounc string Disable UNC (long path names) conversion on Windows + \-\-local\-zero\-size\-links Assume the Stat size of links is zero (and read them instead) + \-\-mailru\-check\-hash What should copy do if file checksum is mismatched or invalid (default true) + \-\-mailru\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-mailru\-pass string Password (obscured) + \-\-mailru\-speedup\-enable Skip full upload if there is another file with same data hash. (default true) + \-\-mailru\-speedup\-file\-patterns string Comma separated list of file name patterns eligible for speedup (put by hash). (default \[dq]*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf\[dq]) + \-\-mailru\-speedup\-max\-disk SizeSuffix This option allows you to disable speedup (put by hash) for large files (default 3G) + \-\-mailru\-speedup\-max\-memory SizeSuffix Files larger than the size given below will always be hashed on disk. (default 32M) + \-\-mailru\-user string User name (usually email) + \-\-mega\-debug Output more debug from Mega. + \-\-mega\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + \-\-mega\-hard\-delete Delete files permanently rather than putting them into the trash. + \-\-mega\-pass string Password. (obscured) + \-\-mega\-user string User name + \-x, \-\-one\-file\-system Don\[aq]t cross filesystem boundaries (unix/macOS only). + \-\-onedrive\-auth\-url string Auth server URL. + \-\-onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- must be multiple of 320k (327,680 bytes). (default 10M) + \-\-onedrive\-client\-id string OAuth Client Id + \-\-onedrive\-client\-secret string OAuth Client Secret + \-\-onedrive\-drive\-id string The ID of the drive to use + \-\-onedrive\-drive\-type string The type of the drive ( personal | business | documentLibrary ) + \-\-onedrive\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) + \-\-onedrive\-expose\-onenote\-files Set to make OneNote files show up in directory listings. + \-\-onedrive\-link\-password string Set the password for links created by the link command. + \-\-onedrive\-link\-scope string Set the scope of the links created by the link command. (default \[dq]anonymous\[dq]) + \-\-onedrive\-link\-type string Set the type of the links created by the link command. (default \[dq]view\[dq]) + \-\-onedrive\-no\-versions Remove all versions on modifying operations + \-\-onedrive\-region string Choose national cloud region for OneDrive. (default \[dq]global\[dq]) + \-\-onedrive\-server\-side\-across\-configs Allow server\-side operations (e.g. copy) to work across different onedrive configs. + \-\-onedrive\-token string OAuth Access Token as a JSON blob. + \-\-onedrive\-token\-url string Token server url. + \-\-opendrive\-chunk\-size SizeSuffix Files will be uploaded in chunks this size. (default 10M) + \-\-opendrive\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) + \-\-opendrive\-password string Password. (obscured) + \-\-opendrive\-username string Username + \-\-pcloud\-auth\-url string Auth server URL. + \-\-pcloud\-client\-id string OAuth Client Id + \-\-pcloud\-client\-secret string OAuth Client Secret + \-\-pcloud\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-pcloud\-hostname string Hostname to connect to. (default \[dq]api.pcloud.com\[dq]) + \-\-pcloud\-root\-folder\-id string Fill in for rclone to use a non root folder as its starting point. (default \[dq]d0\[dq]) + \-\-pcloud\-token string OAuth Access Token as a JSON blob. + \-\-pcloud\-token\-url string Token server url. + \-\-premiumizeme\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-putio\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-qingstor\-access\-key\-id string QingStor Access Key ID + \-\-qingstor\-chunk\-size SizeSuffix Chunk size to use for uploading. (default 4M) + \-\-qingstor\-connection\-retries int Number of connection retries. (default 3) + \-\-qingstor\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8) + \-\-qingstor\-endpoint string Enter an endpoint URL to connection QingStor API. + \-\-qingstor\-env\-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + \-\-qingstor\-secret\-access\-key string QingStor Secret Access Key (password) + \-\-qingstor\-upload\-concurrency int Concurrency for multipart uploads. (default 1) + \-\-qingstor\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + \-\-qingstor\-zone string Zone to connect to. + \-\-s3\-access\-key\-id string AWS Access Key ID. + \-\-s3\-acl string Canned ACL used when creating buckets and storing or copying objects. + \-\-s3\-bucket\-acl string Canned ACL used when creating buckets. + \-\-s3\-chunk\-size SizeSuffix Chunk size to use for uploading. (default 5M) + \-\-s3\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4.656G) + \-\-s3\-disable\-checksum Don\[aq]t store MD5 checksum with object metadata + \-\-s3\-disable\-http2 Disable usage of http2 for S3 backends + \-\-s3\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) + \-\-s3\-endpoint string Endpoint for S3 API. + \-\-s3\-env\-auth Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). + \-\-s3\-force\-path\-style If true use path style access if false use virtual hosted style. (default true) + \-\-s3\-leave\-parts\-on\-error If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. + \-\-s3\-list\-chunk int Size of listing chunk (response list for each ListObject S3 request). (default 1000) + \-\-s3\-location\-constraint string Location constraint \- must be set to match the Region. + \-\-s3\-max\-upload\-parts int Maximum number of parts in a multipart upload. (default 10000) + \-\-s3\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) + \-\-s3\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. + \-\-s3\-no\-check\-bucket If set, don\[aq]t attempt to check the bucket exists or create it + \-\-s3\-no\-head If set, don\[aq]t HEAD uploaded objects to check integrity + \-\-s3\-profile string Profile to use in the shared credentials file + \-\-s3\-provider string Choose your S3 provider. + \-\-s3\-region string Region to connect to. + \-\-s3\-requester\-pays Enables requester pays option when interacting with S3 bucket. + \-\-s3\-secret\-access\-key string AWS Secret Access Key (password) + \-\-s3\-server\-side\-encryption string The server\-side encryption algorithm used when storing this object in S3. + \-\-s3\-session\-token string An AWS session token + \-\-s3\-shared\-credentials\-file string Path to the shared credentials file + \-\-s3\-sse\-customer\-algorithm string If using SSE\-C, the server\-side encryption algorithm used when storing this object in S3. + \-\-s3\-sse\-customer\-key string If using SSE\-C you must provide the secret encryption key used to encrypt/decrypt your data. + \-\-s3\-sse\-customer\-key\-md5 string If using SSE\-C you may provide the secret encryption key MD5 checksum (optional). + \-\-s3\-sse\-kms\-key\-id string If using KMS ID you must provide the ARN of Key. + \-\-s3\-storage\-class string The storage class to use when storing new objects in S3. + \-\-s3\-upload\-concurrency int Concurrency for multipart uploads. (default 4) + \-\-s3\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + \-\-s3\-use\-accelerate\-endpoint If true use the AWS S3 accelerated endpoint. + \-\-s3\-v2\-auth If true use v2 authentication. + \-\-seafile\-2fa Two\-factor authentication (\[aq]true\[aq] if the account has 2FA enabled) + \-\-seafile\-create\-library Should rclone create a library if it doesn\[aq]t exist + \-\-seafile\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) + \-\-seafile\-library string Name of the library. Leave blank to access all non\-encrypted libraries. + \-\-seafile\-library\-key string Library password (for encrypted libraries only). Leave blank if you pass it through the command line. (obscured) + \-\-seafile\-pass string Password (obscured) + \-\-seafile\-url string URL of seafile host to connect to + \-\-seafile\-user string User name (usually email address) + \-\-sftp\-ask\-password Allow asking for SFTP password when needed. + \-\-sftp\-disable\-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + \-\-sftp\-host string SSH host to connect to + \-\-sftp\-key\-file string Path to PEM\-encoded private key file, leave blank or set key\-use\-agent to use ssh\-agent. + \-\-sftp\-key\-file\-pass string The passphrase to decrypt the PEM\-encoded private key file. (obscured) + \-\-sftp\-key\-pem string Raw PEM\-encoded private key, If specified, will override key_file parameter. + \-\-sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. + \-\-sftp\-known\-hosts\-file string Optional path to known_hosts file. + \-\-sftp\-md5sum\-command string The command used to read md5 hashes. Leave blank for autodetect. + \-\-sftp\-pass string SSH password, leave blank to use ssh\-agent. (obscured) + \-\-sftp\-path\-override string Override path used by SSH connection. + \-\-sftp\-port string SSH port, leave blank to use default (22) + \-\-sftp\-pubkey\-file string Optional path to public key file. + \-\-sftp\-server\-command string Specifies the path or command to run a sftp server on the remote host. + \-\-sftp\-set\-modtime Set the modified time on the remote if set. (default true) + \-\-sftp\-sha1sum\-command string The command used to read sha1 hashes. Leave blank for autodetect. + \-\-sftp\-skip\-links Set to skip any symlinks and any other non regular files. + \-\-sftp\-subsystem string Specifies the SSH2 subsystem on the remote host. (default \[dq]sftp\[dq]) + \-\-sftp\-use\-fstat If set use fstat instead of stat + \-\-sftp\-use\-insecure\-cipher Enable the use of insecure ciphers and key exchange methods. + \-\-sftp\-user string SSH username, leave blank for current username, $USER + \-\-sharefile\-chunk\-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 64M) + \-\-sharefile\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) + \-\-sharefile\-endpoint string Endpoint for API calls. + \-\-sharefile\-root\-folder\-id string ID of the root folder + \-\-sharefile\-upload\-cutoff SizeSuffix Cutoff for switching to multipart upload. (default 128M) + \-\-skip\-links Don\[aq]t warn about skipped symlinks. + \-\-sugarsync\-access\-key\-id string Sugarsync Access Key ID. + \-\-sugarsync\-app\-id string Sugarsync App ID. + \-\-sugarsync\-authorization string Sugarsync authorization + \-\-sugarsync\-authorization\-expiry string Sugarsync authorization expiry + \-\-sugarsync\-deleted\-id string Sugarsync deleted folder id + \-\-sugarsync\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Ctl,InvalidUtf8,Dot) + \-\-sugarsync\-hard\-delete Permanently delete files if true + \-\-sugarsync\-private\-access\-key string Sugarsync Private Access Key + \-\-sugarsync\-refresh\-token string Sugarsync refresh token + \-\-sugarsync\-root\-id string Sugarsync root id + \-\-sugarsync\-user string Sugarsync user + \-\-swift\-application\-credential\-id string Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) + \-\-swift\-application\-credential\-name string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) + \-\-swift\-application\-credential\-secret string Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) + \-\-swift\-auth string Authentication URL for server (OS_AUTH_URL). + \-\-swift\-auth\-token string Auth Token from alternate authentication \- optional (OS_AUTH_TOKEN) + \-\-swift\-auth\-version int AuthVersion \- optional \- set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) + \-\-swift\-chunk\-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + \-\-swift\-domain string User domain \- optional (v3 auth) (OS_USER_DOMAIN_NAME) + \-\-swift\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + \-\-swift\-endpoint\-type string Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default \[dq]public\[dq]) + \-\-swift\-env\-auth Get swift credentials from environment variables in standard OpenStack form. + \-\-swift\-key string API key or password (OS_PASSWORD). + \-\-swift\-leave\-parts\-on\-error If true avoid calling abort upload on a failure. It should be set to true for resuming uploads across different sessions. + \-\-swift\-no\-chunk Don\[aq]t chunk files during streaming upload. + \-\-swift\-region string Region name \- optional (OS_REGION_NAME) + \-\-swift\-storage\-policy string The storage policy to use when creating a new container + \-\-swift\-storage\-url string Storage URL \- optional (OS_STORAGE_URL) + \-\-swift\-tenant string Tenant name \- optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) + \-\-swift\-tenant\-domain string Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) + \-\-swift\-tenant\-id string Tenant ID \- optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) + \-\-swift\-user string User name to log in (OS_USERNAME). + \-\-swift\-user\-id string User ID to log in \- optional \- most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). + \-\-tardigrade\-access\-grant string Access Grant. + \-\-tardigrade\-api\-key string API Key. + \-\-tardigrade\-passphrase string Encryption Passphrase. To access existing objects enter passphrase used for uploading. + \-\-tardigrade\-provider string Choose an authentication method. (default \[dq]existing\[dq]) + \-\-tardigrade\-satellite\-address \[at]
    : Satellite Address. Custom satellite address should match the format: \[at]
    :. (default \[dq]us\-central\-1.tardigrade.io\[dq]) + \-\-union\-action\-policy string Policy to choose upstream on ACTION category. (default \[dq]epall\[dq]) + \-\-union\-cache\-time int Cache time of usage and free space (in seconds). This option is only useful when a path preserving policy is used. (default 120) + \-\-union\-create\-policy string Policy to choose upstream on CREATE category. (default \[dq]epmfs\[dq]) + \-\-union\-search\-policy string Policy to choose upstream on SEARCH category. (default \[dq]ff\[dq]) + \-\-union\-upstreams string List of space separated upstreams. + \-\-webdav\-bearer\-token string Bearer token instead of user/pass (e.g. a Macaroon) + \-\-webdav\-bearer\-token\-command string Command to run to get a bearer token + \-\-webdav\-pass string Password. (obscured) + \-\-webdav\-url string URL of http host to connect to + \-\-webdav\-user string User name + \-\-webdav\-vendor string Name of the Webdav site/service/software you are using + \-\-yandex\-auth\-url string Auth server URL. + \-\-yandex\-client\-id string OAuth Client Id + \-\-yandex\-client\-secret string OAuth Client Secret + \-\-yandex\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + \-\-yandex\-token string OAuth Access Token as a JSON blob. + \-\-yandex\-token\-url string Token server url. + \-\-zoho\-encoding MultiEncoder This sets the encoding for the backend. (default Del,Ctl,InvalidUtf8) + \-\-zoho\-region string Zoho region to connect to. You\[aq]ll have to use the region you organization is registered in. +\f[R] +.fi +.SS 1Fichier +.PP +This is a backend for the 1fichier (https://1fichier.com) cloud storage +service. +Note that a Premium subscription is required to use the API. +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, e.g. +\f[C]remote:directory/subdirectory\f[R]. +.PP +The initial setup for 1Fichier involves getting the API key from the +website which you need to do in your browser. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config \f[R] .fi .PP -\-c, \-\-checksum Skip based on checksum (if available) & size, not -mod\-time & size \-\-client\-cert string Client SSL certificate (PEM) -for mutual TLS auth \-\-client\-key string Client SSL private key (PEM) -for mutual TLS auth \-\-compare\-dest string Include additional -server\-side path during comparison. -\-\-config string Config file. -(default \[dq]$HOME/.config/rclone/rclone.conf\[dq]) \-\-contimeout -duration Connect timeout (default 1m0s) \-\-copy\-dest string Implies -\-\-compare\-dest but also copies files from path into destination. -\-\-cpuprofile string Write cpu profile to file \-\-cutoff\-mode string -Mode to stop transfers when reaching the max transfer limit -HARD|SOFT|CAUTIOUS (default \[dq]HARD\[dq]) \-\-delete\-after When -synchronizing, delete files on destination after transferring (default) -\-\-delete\-before When synchronizing, delete files on destination -before transferring \-\-delete\-during When synchronizing, delete files -during transfer \-\-delete\-excluded Delete files on dest excluded from -sync \-\-disable string Disable a comma separated list of features. -Use help to see a list. -\-n, \-\-dry\-run Do a trial run with no permanent changes \-\-dump -DumpFlags List of items to dump from: -headers,bodies,requests,responses,auth,filters,goroutines,openfiles -\-\-dump\-bodies Dump HTTP headers and bodies \- may contain sensitive -info \-\-dump\-headers Dump HTTP headers \- may contain sensitive info -\-\-error\-on\-no\-transfer Sets exit code 9 if no files are -transferred, useful in scripts \-\-exclude stringArray Exclude files -matching pattern \-\-exclude\-from stringArray Read exclude patterns -from file (use \- to read from stdin) \-\-exclude\-if\-present string -Exclude directories if filename is present \-\-expect\-continue\-timeout -duration Timeout when using expect / 100\-continue in HTTP (default 1s) -\-\-fast\-list Use recursive list if available. -Uses more memory but fewer transactions. -\-\-files\-from stringArray Read list of source\-file names from file -(use \- to read from stdin) \-\-files\-from\-raw stringArray Read list -of source\-file names from file without any processing of lines (use \- -to read from stdin) \-f, \-\-filter stringArray Add a file\-filtering -rule \-\-filter\-from stringArray Read filtering patterns from a file -(use \- to read from stdin) \-\-header stringArray Set HTTP header for -all transactions \-\-header\-download stringArray Set HTTP header for -download transactions \-\-header\-upload stringArray Set HTTP header for -upload transactions \-\-ignore\-case Ignore case in filters (case -insensitive) \-\-ignore\-case\-sync Ignore case when synchronizing -\-\-ignore\-checksum Skip post copy check of checksums. -\-\-ignore\-errors delete even if there are I/O errors -\-\-ignore\-existing Skip all files that exist on destination -\-\-ignore\-size Ignore size when skipping use mod\-time or checksum. -\-I, \-\-ignore\-times Don\[aq]t skip files that match size and time \- -transfer all files \-\-immutable Do not modify files. -Fail if existing files have been modified. -\-\-include stringArray Include files matching pattern \-\-include\-from -stringArray Read include patterns from file (use \- to read from stdin) -\-i, \-\-interactive Enable interactive mode \-\-log\-file string Log -everything to this file \-\-log\-format string Comma separated list of -log format options (default \[dq]date,time\[dq]) \-\-log\-level string -Log level DEBUG|INFO|NOTICE|ERROR (default \[dq]NOTICE\[dq]) -\-\-low\-level\-retries int Number of low level retries to do. -(default 10) \-\-max\-age Duration Only transfer files younger than this -in s or suffix ms|s|m|h|d|w|M|y (default off) \-\-max\-backlog int -Maximum number of objects in sync or check backlog. -(default 10000) \-\-max\-delete int When synchronizing, limit the number -of deletes (default \-1) \-\-max\-depth int If set limits the recursion -depth to this. -(default \-1) \-\-max\-duration duration Maximum duration rclone will -transfer data for. -\-\-max\-size SizeSuffix Only transfer files smaller than this in k or -suffix b|k|M|G (default off) \-\-max\-stats\-groups int Maximum number -of stats groups to keep in memory. -On max oldest is discarded. -(default 1000) \-\-max\-transfer SizeSuffix Maximum size of data to -transfer. -(default off) \-\-memprofile string Write memory profile to file -\-\-min\-age Duration Only transfer files older than this in s or suffix -ms|s|m|h|d|w|M|y (default off) \-\-min\-size SizeSuffix Only transfer -files bigger than this in k or suffix b|k|M|G (default off) -\-\-modify\-window duration Max time diff to be considered the same -(default 1ns) \-\-multi\-thread\-cutoff SizeSuffix Use multi\-thread -downloads for files above this size. -(default 250M) \-\-multi\-thread\-streams int Max number of streams to -use for multi\-thread downloads. -(default 4) \-\-no\-check\-certificate Do not verify the server SSL -certificate. -Insecure. -\-\-no\-check\-dest Don\[aq]t check the destination, copy regardless. -\-\-no\-gzip\-encoding Don\[aq]t set Accept\-Encoding: gzip. -\-\-no\-traverse Don\[aq]t traverse destination file system on copy. -\-\-no\-unicode\-normalization Don\[aq]t normalize unicode characters in -filenames. -\-\-no\-update\-modtime Don\[aq]t update destination mod\-time if files -identical. -\-\-order\-by string Instructions on how to order the transfers, eg -\[aq]size,descending\[aq] \-\-password\-command SpaceSepList Command for -supplying password for encrypted configuration. -\-P, \-\-progress Show progress during transfer. -\-q, \-\-quiet Print as little stuff as possible \-\-rc Enable the -remote control server. -\-\-rc\-addr string IPaddress:Port or :Port to bind server to. -(default \[dq]localhost:5572\[dq]) \-\-rc\-allow\-origin string Set the -allowed origin for CORS. -\-\-rc\-baseurl string Prefix for URLs \- leave blank for root. -\-\-rc\-cert string SSL PEM key (concatenation of certificate and CA -certificate) \-\-rc\-client\-ca string Client certificate authority to -verify clients with \-\-rc\-enable\-metrics Enable prometheus metrics on -/metrics \-\-rc\-files string Path to local files to serve on the HTTP -server. -\-\-rc\-htpasswd string htpasswd file \- if not provided no -authentication is done \-\-rc\-job\-expire\-duration duration expire -finished async jobs older than this value (default 1m0s) -\-\-rc\-job\-expire\-interval duration interval to check for expired -async jobs (default 10s) \-\-rc\-key string SSL PEM Private key -\-\-rc\-max\-header\-bytes int Maximum size of request header (default -4096) \-\-rc\-no\-auth Don\[aq]t require auth for certain methods. -\-\-rc\-pass string Password for authentication. -\-\-rc\-realm string realm for authentication (default \[dq]rclone\[dq]) -\-\-rc\-serve Enable the serving of remote objects. -\-\-rc\-server\-read\-timeout duration Timeout for server reading data -(default 1h0m0s) \-\-rc\-server\-write\-timeout duration Timeout for -server writing data (default 1h0m0s) \-\-rc\-template string User -Specified Template. -\-\-rc\-user string User name for authentication. -\-\-rc\-web\-fetch\-url string URL to fetch the releases for webgui. -(default -\[dq]https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest\[dq]) -\-\-rc\-web\-gui Launch WebGUI on localhost -\-\-rc\-web\-gui\-force\-update Force update to latest version of web -gui \-\-rc\-web\-gui\-no\-open\-browser Don\[aq]t open the browser -automatically \-\-rc\-web\-gui\-update Check and update to latest -version of web gui \-\-refresh\-times Refresh the modtime of remote -files. -\-\-retries int Retry operations this many times if they fail (default -3) \-\-retries\-sleep duration Interval between retrying operations if -they fail, e.g 500ms, 60s, 5m. -(0 to disable) \-\-size\-only Skip based on size only, not mod\-time or -checksum \-\-stats duration Interval between printing stats, e.g 500ms, -60s, 5m. -(0 to disable) (default 1m0s) \-\-stats\-file\-name\-length int Max file -name length in stats. -0 for no limit (default 45) \-\-stats\-log\-level string Log level to -show \-\-stats output DEBUG|INFO|NOTICE|ERROR (default \[dq]INFO\[dq]) -\-\-stats\-one\-line Make the stats fit on one line. -\-\-stats\-one\-line\-date Enables \-\-stats\-one\-line and add current -date/time prefix. -\-\-stats\-one\-line\-date\-format string Enables -\-\-stats\-one\-line\-date and uses custom formatted date. -Enclose date string in double quotes (\[dq]). -See https://golang.org/pkg/time/#Time.Format \-\-stats\-unit string Show -data rate in stats as either \[aq]bits\[aq] or \[aq]bytes\[aq]/s -(default \[dq]bytes\[dq]) \-\-streaming\-upload\-cutoff SizeSuffix -Cutoff for switching to chunked upload if file size is unknown. -Upload starts after reaching cutoff or when file ends. -(default 100k) \-\-suffix string Suffix to add to changed files. -\-\-suffix\-keep\-extension Preserve the extension when using -\-\-suffix. -\-\-syslog Use Syslog for logging \-\-syslog\-facility string Facility -for syslog, eg KERN,USER,... -(default \[dq]DAEMON\[dq]) \-\-timeout duration IO idle timeout (default -5m0s) \-\-tpslimit float Limit HTTP transactions per second to this. -\-\-tpslimit\-burst int Max burst of transactions for \-\-tpslimit. -(default 1) \-\-track\-renames When synchronizing, track file renames -and do a server side move if possible \-\-track\-renames\-strategy -string Strategies to use when synchronizing using track\-renames -hash|modtime|leaf (default \[dq]hash\[dq]) \-\-transfers int Number of -file transfers to run in parallel. -(default 4) \-u, \-\-update Skip files that are newer on the -destination. -\-\-use\-cookies Enable session cookiejar. -\-\-use\-json\-log Use json log format. -\-\-use\-mmap Use mmap allocator (see docs). -\-\-use\-server\-modtime Use server modified time instead of object -metadata \-\-user\-agent string Set the user\-agent to a specified -string. -The default is rclone/ version (default \[dq]rclone/v1.53.0\[dq]) \-v, -\-\-verbose count Print lots more stuff (repeat for more) -.IP -.nf -\f[C] - -## Backend Flags - -These flags are available for every command. They control the backends -and may be set in the config file. -\f[R] -.fi -.IP -.nf -\f[C] - \-\-acd\-auth\-url string Auth server URL. - \-\-acd\-client\-id string OAuth Client Id - \-\-acd\-client\-secret string OAuth Client Secret - \-\-acd\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8,Dot) - \-\-acd\-templink\-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - \-\-acd\-token string OAuth Access Token as a JSON blob. - \-\-acd\-token\-url string Token server url. - \-\-acd\-upload\-wait\-per\-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) - \-\-alias\-remote string Remote or path to alias. - \-\-azureblob\-access\-tier string Access tier of blob: hot, cool or archive. - \-\-azureblob\-account string Storage Account Name (leave blank to use SAS URL or Emulator) - \-\-azureblob\-chunk\-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) - \-\-azureblob\-disable\-checksum Don\[aq]t store MD5 checksum with object metadata. - \-\-azureblob\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8) - \-\-azureblob\-endpoint string Endpoint for the service - \-\-azureblob\-key string Storage Account Key (leave blank to use SAS URL or Emulator) - \-\-azureblob\-list\-chunk int Size of blob list. (default 5000) - \-\-azureblob\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - \-\-azureblob\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. - \-\-azureblob\-sas\-url string SAS URL for container level access only - \-\-azureblob\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) - \-\-azureblob\-use\-emulator Uses local storage emulator if provided as \[aq]true\[aq] (leave blank if using real azure storage endpoint) - \-\-b2\-account string Account ID or Application Key ID - \-\-b2\-chunk\-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) - \-\-b2\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 4G) - \-\-b2\-disable\-checksum Disable checksums for large (> upload cutoff) files - \-\-b2\-download\-auth\-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) - \-\-b2\-download\-url string Custom endpoint for downloads. - \-\-b2\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) - \-\-b2\-endpoint string Endpoint for the service. - \-\-b2\-hard\-delete Permanently delete files on remote removal, otherwise hide files. - \-\-b2\-key string Application Key - \-\-b2\-memory\-pool\-flush\-time Duration How often internal memory buffer pools will be flushed. (default 1m0s) - \-\-b2\-memory\-pool\-use\-mmap Whether to use mmap buffers in internal memory pool. - \-\-b2\-test\-mode string A flag string for X\-Bz\-Test\-Mode header for debugging. - \-\-b2\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) - \-\-b2\-versions Include old versions in directory listings. - \-\-box\-access\-token string Box App Primary Access Token - \-\-box\-auth\-url string Auth server URL. - \-\-box\-box\-config\-file string Box App config.json location - \-\-box\-box\-sub\-type string (default \[dq]user\[dq]) - \-\-box\-client\-id string OAuth Client Id - \-\-box\-client\-secret string OAuth Client Secret - \-\-box\-commit\-retries int Max number of times to try committing a multipart file. (default 100) - \-\-box\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) - \-\-box\-root\-folder\-id string Fill in for rclone to use a non root folder as its starting point. - \-\-box\-token string OAuth Access Token as a JSON blob. - \-\-box\-token\-url string Token server url. - \-\-box\-upload\-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) - \-\-cache\-chunk\-clean\-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) - \-\-cache\-chunk\-no\-memory Disable the in\-memory cache for storing chunks during streaming. - \-\-cache\-chunk\-path string Directory to cache chunk files. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) - \-\-cache\-chunk\-size SizeSuffix The size of a chunk (partial file data). (default 5M) - \-\-cache\-chunk\-total\-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) - \-\-cache\-db\-path string Directory to store file structure metadata DB. (default \[dq]$HOME/.cache/rclone/cache\-backend\[dq]) - \-\-cache\-db\-purge Clear all the cached data for this remote on start. - \-\-cache\-db\-wait\-time Duration How long to wait for the DB to be available \- 0 is unlimited (default 1s) - \-\-cache\-info\-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) - \-\-cache\-plex\-insecure string Skip all certificate verification when connecting to the Plex server - \-\-cache\-plex\-password string The password of the Plex user (obscured) - \-\-cache\-plex\-url string The URL of the Plex server - \-\-cache\-plex\-username string The username of the Plex user - \-\-cache\-read\-retries int How many times to retry a read from a cache storage. (default 10) - \-\-cache\-remote string Remote to cache. - \-\-cache\-rps int Limits the number of requests per second to the source FS (\-1 to disable) (default \-1) - \-\-cache\-tmp\-upload\-path string Directory to keep temporary files until they are uploaded. - \-\-cache\-tmp\-wait\-time Duration How long should files be stored in local cache before being uploaded (default 15s) - \-\-cache\-workers int How many workers should run in parallel to download chunks. (default 4) - \-\-cache\-writes Cache file data on writes through the FS - \-\-chunker\-chunk\-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) - \-\-chunker\-fail\-hard Choose how chunker should handle files with missing or invalid chunks. - \-\-chunker\-hash\-type string Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. (default \[dq]md5\[dq]) - \-\-chunker\-meta\-format string Format of the metadata object or \[dq]none\[dq]. By default \[dq]simplejson\[dq]. (default \[dq]simplejson\[dq]) - \-\-chunker\-name\-format string String format of chunk file names. (default \[dq]*.rclone_chunk.###\[dq]) - \-\-chunker\-remote string Remote to chunk/unchunk. - \-\-chunker\-start\-from int Minimum valid chunk number. Usually 0 or 1. (default 1) -\f[R] -.fi -\-L, \-\-copy\-links Follow symlinks and copy the pointed to item. -\-\-crypt\-directory\-name\-encryption Option to either encrypt -directory names or leave them intact. -(default true) \-\-crypt\-filename\-encryption string How to encrypt the -filenames. -(default \[dq]standard\[dq]) \-\-crypt\-password string Password or pass -phrase for encryption. -(obscured) \-\-crypt\-password2 string Password or pass phrase for salt. -Optional but recommended. -(obscured) \-\-crypt\-remote string Remote to encrypt/decrypt. -\-\-crypt\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different crypt configs. -\-\-crypt\-show\-mapping For all files listed show how the names -encrypt. -\-\-drive\-acknowledge\-abuse Set to allow files which return -cannotDownloadAbusiveFile to be downloaded. -\-\-drive\-allow\-import\-name\-change Allow the filetype to change when -uploading Google docs (e.g. -file.doc to file.docx). -This will confuse sync and reupload every time. -\-\-drive\-auth\-owner\-only Only consider files owned by the -authenticated user. -\-\-drive\-auth\-url string Auth server URL. -\-\-drive\-chunk\-size SizeSuffix Upload chunk size. -Must a power of 2 >= 256k. -(default 8M) \-\-drive\-client\-id string OAuth Client Id -\-\-drive\-client\-secret string OAuth Client Secret -\-\-drive\-disable\-http2 Disable drive using http2 (default true) -\-\-drive\-encoding MultiEncoder This sets the encoding for the backend. -(default InvalidUtf8) \-\-drive\-export\-formats string Comma separated -list of preferred formats for downloading Google docs. -(default \[dq]docx,xlsx,pptx,svg\[dq]) \-\-drive\-formats string -Deprecated: see export_formats \-\-drive\-impersonate string Impersonate -this user when using a service account. -\-\-drive\-import\-formats string Comma separated list of preferred -formats for uploading Google docs. -\-\-drive\-keep\-revision\-forever Keep new head revision of each file -forever. -\-\-drive\-list\-chunk int Size of listing chunk 100\-1000. -0 to disable. -(default 1000) \-\-drive\-pacer\-burst int Number of API calls to allow -without sleeping. -(default 100) \-\-drive\-pacer\-min\-sleep Duration Minimum time to -sleep between API calls. -(default 100ms) \-\-drive\-root\-folder\-id string ID of the root folder -\-\-drive\-scope string Scope that rclone should use when requesting -access from drive. -\-\-drive\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different drive configs. -\-\-drive\-service\-account\-credentials string Service Account -Credentials JSON blob \-\-drive\-service\-account\-file string Service -Account Credentials JSON file path \-\-drive\-shared\-with\-me Only show -files that are shared with me. -\-\-drive\-size\-as\-quota Show sizes as storage quota usage, not actual -size. -\-\-drive\-skip\-checksum\-gphotos Skip MD5 checksum on Google photos -and videos only. -\-\-drive\-skip\-gdocs Skip google documents in all listings. -\-\-drive\-skip\-shortcuts If set skip shortcut files -\-\-drive\-starred\-only Only show files that are starred. -\-\-drive\-stop\-on\-upload\-limit Make upload limit errors be fatal -\-\-drive\-team\-drive string ID of the Team Drive \-\-drive\-token -string OAuth Access Token as a JSON blob. -\-\-drive\-token\-url string Token server url. -\-\-drive\-trashed\-only Only show files that are in the trash. -\-\-drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked -upload (default 8M) \-\-drive\-use\-created\-date Use file created date -instead of modified date., \-\-drive\-use\-shared\-date Use date file -was shared instead of modified date. -\-\-drive\-use\-trash Send files to the trash instead of deleting -permanently. -(default true) \-\-drive\-v2\-download\-min\-size SizeSuffix If -Object\[aq]s are greater, use drive v2 API to download. -(default off) \-\-dropbox\-auth\-url string Auth server URL. -\-\-dropbox\-chunk\-size SizeSuffix Upload chunk size. -(< 150M). -(default 48M) \-\-dropbox\-client\-id string OAuth Client Id -\-\-dropbox\-client\-secret string OAuth Client Secret -\-\-dropbox\-encoding MultiEncoder This sets the encoding for the -backend. -(default Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot) -\-\-dropbox\-impersonate string Impersonate this user when using a -business account. -\-\-dropbox\-token string OAuth Access Token as a JSON blob. -\-\-dropbox\-token\-url string Token server url. -\-\-fichier\-api\-key string Your API Key, get it from -https://1fichier.com/console/params.pl \-\-fichier\-encoding -MultiEncoder This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot) -\-\-fichier\-shared\-folder string If you want to download a shared -folder, add this parameter \-\-ftp\-concurrency int Maximum number of -FTP simultaneous connections, 0 for unlimited \-\-ftp\-disable\-epsv -Disable using EPSV even if server advertises support \-\-ftp\-encoding -MultiEncoder This sets the encoding for the backend. -(default Slash,Del,Ctl,RightSpace,Dot) \-\-ftp\-explicit\-tls Use FTP -over TLS (Explicit) \-\-ftp\-host string FTP host to connect to -\-\-ftp\-no\-check\-certificate Do not verify the TLS certificate of the -server \-\-ftp\-pass string FTP password (obscured) \-\-ftp\-port string -FTP port, leave blank to use default (21) \-\-ftp\-tls Use FTPS over TLS -(Implicit) \-\-ftp\-user string FTP username, leave blank for current -username, $USER \-\-gcs\-anonymous Access public buckets and objects -without credentials \-\-gcs\-auth\-url string Auth server URL. -\-\-gcs\-bucket\-acl string Access Control List for new buckets. -\-\-gcs\-bucket\-policy\-only Access checks should use bucket\-level IAM -policies. -\-\-gcs\-client\-id string OAuth Client Id \-\-gcs\-client\-secret -string OAuth Client Secret \-\-gcs\-encoding MultiEncoder This sets the -encoding for the backend. -(default Slash,CrLf,InvalidUtf8,Dot) \-\-gcs\-location string Location -for the newly created buckets. -\-\-gcs\-object\-acl string Access Control List for new objects. -\-\-gcs\-project\-number string Project number. -\-\-gcs\-service\-account\-file string Service Account Credentials JSON -file path \-\-gcs\-storage\-class string The storage class to use when -storing objects in Google Cloud Storage. -\-\-gcs\-token string OAuth Access Token as a JSON blob. -\-\-gcs\-token\-url string Token server url. -\-\-gphotos\-auth\-url string Auth server URL. -\-\-gphotos\-client\-id string OAuth Client Id -\-\-gphotos\-client\-secret string OAuth Client Secret -\-\-gphotos\-read\-only Set to make the Google Photos backend read only. -\-\-gphotos\-read\-size Set to read the size of media items. -\-\-gphotos\-start\-year int Year limits the photos to be downloaded to -those which are uploaded after the given year (default 2000) -\-\-gphotos\-token string OAuth Access Token as a JSON blob. -\-\-gphotos\-token\-url string Token server url. -\-\-http\-headers CommaSepList Set HTTP headers for all transactions -\-\-http\-no\-head Don\[aq]t use HEAD requests to find file sizes in dir -listing \-\-http\-no\-slash Set this if the site doesn\[aq]t end -directories with / \-\-http\-url string URL of http host to connect to -\-\-hubic\-auth\-url string Auth server URL. -\-\-hubic\-chunk\-size SizeSuffix Above this size files will be chunked -into a _segments container. -(default 5G) \-\-hubic\-client\-id string OAuth Client Id -\-\-hubic\-client\-secret string OAuth Client Secret \-\-hubic\-encoding -MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8) \-\-hubic\-no\-chunk Don\[aq]t chunk files -during streaming upload. -\-\-hubic\-token string OAuth Access Token as a JSON blob. -\-\-hubic\-token\-url string Token server url. -\-\-jottacloud\-encoding MultiEncoder This sets the encoding for the -backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot) -\-\-jottacloud\-hard\-delete Delete files permanently rather than -putting them into the trash. -\-\-jottacloud\-md5\-memory\-limit SizeSuffix Files bigger than this -will be cached on disk to calculate the MD5 if required. -(default 10M) \-\-jottacloud\-trashed\-only Only show files that are in -the trash. -\-\-jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this -can be resumed if the upload fail\[aq]s. -(default 10M) \-\-koofr\-encoding MultiEncoder This sets the encoding -for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) \-\-koofr\-endpoint -string The Koofr API endpoint to use (default -\[dq]https://app.koofr.net\[dq]) \-\-koofr\-mountid string Mount ID of -the mount to use. -If omitted, the primary mount is used. -\-\-koofr\-password string Your Koofr password for rclone (generate one -at https://app.koofr.net/app/admin/preferences/password) (obscured) -\-\-koofr\-setmtime Does the backend support setting modification time. -Set this to false if you use a mount ID that points to a Dropbox or -Amazon Drive backend. -(default true) \-\-koofr\-user string Your Koofr user name \-l, -\-\-links Translate symlinks to/from regular files with a -\[aq].rclonelink\[aq] extension \-\-local\-case\-insensitive Force the -filesystem to report itself as case insensitive -\-\-local\-case\-sensitive Force the filesystem to report itself as case -sensitive. -\-\-local\-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,Dot) \-\-local\-no\-check\-updated Don\[aq]t check to see -if the files change during upload \-\-local\-no\-set\-modtime Disable -setting modtime \-\-local\-no\-sparse Disable sparse files for -multi\-thread downloads \-\-local\-no\-unicode\-normalization Don\[aq]t -apply unicode normalization to paths and filenames (Deprecated) -\-\-local\-nounc string Disable UNC (long path names) conversion on -Windows \-\-mailru\-check\-hash What should copy do if file checksum is -mismatched or invalid (default true) \-\-mailru\-encoding MultiEncoder -This sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot) -\-\-mailru\-pass string Password (obscured) \-\-mailru\-speedup\-enable -Skip full upload if there is another file with same data hash. -(default true) \-\-mailru\-speedup\-file\-patterns string Comma -separated list of file name patterns eligible for speedup (put by hash). -(default -\[dq]\f[I].mkv,\f[R].avi,\f[I].mp4,\f[R].mp3,\f[I].zip,\f[R].gz,\f[I].rar,\f[R].pdf\[dq]) -\-\-mailru\-speedup\-max\-disk SizeSuffix This option allows you to -disable speedup (put by hash) for large files (default 3G) -\-\-mailru\-speedup\-max\-memory SizeSuffix Files larger than the size -given below will always be hashed on disk. -(default 32M) \-\-mailru\-user string User name (usually email) -\-\-mega\-debug Output more debug from Mega. -\-\-mega\-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,InvalidUtf8,Dot) \-\-mega\-hard\-delete Delete files -permanently rather than putting them into the trash. -\-\-mega\-pass string Password. -(obscured) \-\-mega\-user string User name \-x, \-\-one\-file\-system -Don\[aq]t cross filesystem boundaries (unix/macOS only). -\-\-onedrive\-auth\-url string Auth server URL. -\-\-onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- -must be multiple of 320k (327,680 bytes). -(default 10M) \-\-onedrive\-client\-id string OAuth Client Id -\-\-onedrive\-client\-secret string OAuth Client Secret -\-\-onedrive\-drive\-id string The ID of the drive to use -\-\-onedrive\-drive\-type string The type of the drive ( personal | -business | documentLibrary ) \-\-onedrive\-encoding MultiEncoder This -sets the encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot) -\-\-onedrive\-expose\-onenote\-files Set to make OneNote files show up -in directory listings. -\-\-onedrive\-no\-versions Remove all versions on modifying operations -\-\-onedrive\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different onedrive configs. -\-\-onedrive\-token string OAuth Access Token as a JSON blob. -\-\-onedrive\-token\-url string Token server url. -\-\-opendrive\-chunk\-size SizeSuffix Files will be uploaded in chunks -this size. -(default 10M) \-\-opendrive\-encoding MultiEncoder This sets the -encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot) -\-\-opendrive\-password string Password. -(obscured) \-\-opendrive\-username string Username \-\-pcloud\-auth\-url -string Auth server URL. -\-\-pcloud\-client\-id string OAuth Client Id \-\-pcloud\-client\-secret -string OAuth Client Secret \-\-pcloud\-encoding MultiEncoder This sets -the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) \-\-pcloud\-hostname -string Hostname to connect to. -(default \[dq]api.pcloud.com\[dq]) \-\-pcloud\-root\-folder\-id string -Fill in for rclone to use a non root folder as its starting point. -(default \[dq]d0\[dq]) \-\-pcloud\-token string OAuth Access Token as a -JSON blob. -\-\-pcloud\-token\-url string Token server url. -\-\-premiumizeme\-encoding MultiEncoder This sets the encoding for the -backend. -(default Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot) -\-\-putio\-encoding MultiEncoder This sets the encoding for the backend. -(default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) -\-\-qingstor\-access\-key\-id string QingStor Access Key ID -\-\-qingstor\-chunk\-size SizeSuffix Chunk size to use for uploading. -(default 4M) \-\-qingstor\-connection\-retries int Number of connection -retries. -(default 3) \-\-qingstor\-encoding MultiEncoder This sets the encoding -for the backend. -(default Slash,Ctl,InvalidUtf8) \-\-qingstor\-endpoint string Enter an -endpoint URL to connection QingStor API. -\-\-qingstor\-env\-auth Get QingStor credentials from runtime. -Only applies if access_key_id and secret_access_key is blank. -\-\-qingstor\-secret\-access\-key string QingStor Secret Access Key -(password) \-\-qingstor\-upload\-concurrency int Concurrency for -multipart uploads. -(default 1) \-\-qingstor\-upload\-cutoff SizeSuffix Cutoff for switching -to chunked upload (default 200M) \-\-qingstor\-zone string Zone to -connect to. -\-\-s3\-access\-key\-id string AWS Access Key ID. -\-\-s3\-acl string Canned ACL used when creating buckets and storing or -copying objects. -\-\-s3\-bucket\-acl string Canned ACL used when creating buckets. -\-\-s3\-chunk\-size SizeSuffix Chunk size to use for uploading. -(default 5M) \-\-s3\-copy\-cutoff SizeSuffix Cutoff for switching to -multipart copy (default 4.656G) \-\-s3\-disable\-checksum Don\[aq]t -store MD5 checksum with object metadata \-\-s3\-encoding MultiEncoder -This sets the encoding for the backend. -(default Slash,InvalidUtf8,Dot) \-\-s3\-endpoint string Endpoint for S3 -API. -\-\-s3\-env\-auth Get AWS credentials from runtime (environment -variables or EC2/ECS meta data if no env vars). -\-\-s3\-force\-path\-style If true use path style access if false use -virtual hosted style. -(default true) \-\-s3\-leave\-parts\-on\-error If true avoid calling -abort upload on a failure, leaving all successfully uploaded parts on S3 -for manual recovery. -\-\-s3\-list\-chunk int Size of listing chunk (response list for each -ListObject S3 request). -(default 1000) \-\-s3\-location\-constraint string Location constraint -\- must be set to match the Region. -\-\-s3\-max\-upload\-parts int Maximum number of parts in a multipart -upload. -(default 10000) \-\-s3\-memory\-pool\-flush\-time Duration How often -internal memory buffer pools will be flushed. -(default 1m0s) \-\-s3\-memory\-pool\-use\-mmap Whether to use mmap -buffers in internal memory pool. -\-\-s3\-no\-check\-bucket If set don\[aq]t attempt to check the bucket -exists or create it \-\-s3\-profile string Profile to use in the shared -credentials file \-\-s3\-provider string Choose your S3 provider. -\-\-s3\-region string Region to connect to. -\-\-s3\-secret\-access\-key string AWS Secret Access Key (password) -\-\-s3\-server\-side\-encryption string The server\-side encryption -algorithm used when storing this object in S3. -\-\-s3\-session\-token string An AWS session token -\-\-s3\-shared\-credentials\-file string Path to the shared credentials -file \-\-s3\-sse\-customer\-algorithm string If using SSE\-C, the -server\-side encryption algorithm used when storing this object in S3. -\-\-s3\-sse\-customer\-key string If using SSE\-C you must provide the -secret encryption key used to encrypt/decrypt your data. -\-\-s3\-sse\-customer\-key\-md5 string If using SSE\-C you must provide -the secret encryption key MD5 checksum. -\-\-s3\-sse\-kms\-key\-id string If using KMS ID you must provide the -ARN of Key. -\-\-s3\-storage\-class string The storage class to use when storing new -objects in S3. -\-\-s3\-upload\-concurrency int Concurrency for multipart uploads. -(default 4) \-\-s3\-upload\-cutoff SizeSuffix Cutoff for switching to -chunked upload (default 200M) \-\-s3\-use\-accelerate\-endpoint If true -use the AWS S3 accelerated endpoint. -\-\-s3\-v2\-auth If true use v2 authentication. -\-\-seafile\-2fa Two\-factor authentication (\[aq]true\[aq] if the -account has 2FA enabled) \-\-seafile\-create\-library Should rclone -create a library if it doesn\[aq]t exist \-\-seafile\-encoding -MultiEncoder This sets the encoding for the backend. -(default Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8) -\-\-seafile\-library string Name of the library. -Leave blank to access all non\-encrypted libraries. -\-\-seafile\-library\-key string Library password (for encrypted -libraries only). -Leave blank if you pass it through the command line. -(obscured) \-\-seafile\-pass string Password (obscured) \-\-seafile\-url -string URL of seafile host to connect to \-\-seafile\-user string User -name (usually email address) \-\-sftp\-ask\-password Allow asking for -SFTP password when needed. -\-\-sftp\-disable\-hashcheck Disable the execution of SSH commands to -determine if remote file hashing is available. -\-\-sftp\-host string SSH host to connect to \-\-sftp\-key\-file string -Path to PEM\-encoded private key file, leave blank or set -key\-use\-agent to use ssh\-agent. -\-\-sftp\-key\-file\-pass string The passphrase to decrypt the -PEM\-encoded private key file. -(obscured) \-\-sftp\-key\-pem string Raw PEM\-encoded private key, If -specified, will override key_file parameter. -\-\-sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. -\-\-sftp\-md5sum\-command string The command used to read md5 hashes. -Leave blank for autodetect. -\-\-sftp\-pass string SSH password, leave blank to use ssh\-agent. -(obscured) \-\-sftp\-path\-override string Override path used by SSH -connection. -\-\-sftp\-port string SSH port, leave blank to use default (22) -\-\-sftp\-server\-command string Specifies the path or command to run a -sftp server on the remote host. -\-\-sftp\-set\-modtime Set the modified time on the remote if set. -(default true) \-\-sftp\-sha1sum\-command string The command used to -read sha1 hashes. -Leave blank for autodetect. -\-\-sftp\-skip\-links Set to skip any symlinks and any other non regular -files. -\-\-sftp\-subsystem string Specifies the SSH2 subsystem on the remote -host. -(default \[dq]sftp\[dq]) \-\-sftp\-use\-insecure\-cipher Enable the use -of insecure ciphers and key exchange methods. -\-\-sftp\-user string SSH username, leave blank for current username, -ncw \-\-sharefile\-chunk\-size SizeSuffix Upload chunk size. -Must a power of 2 >= 256k. -(default 64M) \-\-sharefile\-encoding MultiEncoder This sets the -encoding for the backend. -(default -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot) -\-\-sharefile\-endpoint string Endpoint for API calls. -\-\-sharefile\-root\-folder\-id string ID of the root folder -\-\-sharefile\-upload\-cutoff SizeSuffix Cutoff for switching to -multipart upload. -(default 128M) \-\-skip\-links Don\[aq]t warn about skipped symlinks. -\-\-sugarsync\-access\-key\-id string Sugarsync Access Key ID. -\-\-sugarsync\-app\-id string Sugarsync App ID. -\-\-sugarsync\-authorization string Sugarsync authorization -\-\-sugarsync\-authorization\-expiry string Sugarsync authorization -expiry \-\-sugarsync\-deleted\-id string Sugarsync deleted folder id -\-\-sugarsync\-encoding MultiEncoder This sets the encoding for the -backend. -(default Slash,Ctl,InvalidUtf8,Dot) \-\-sugarsync\-hard\-delete -Permanently delete files if true \-\-sugarsync\-private\-access\-key -string Sugarsync Private Access Key \-\-sugarsync\-refresh\-token string -Sugarsync refresh token \-\-sugarsync\-root\-id string Sugarsync root id -\-\-sugarsync\-user string Sugarsync user -\-\-swift\-application\-credential\-id string Application Credential ID -(OS_APPLICATION_CREDENTIAL_ID) \-\-swift\-application\-credential\-name -string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) -\-\-swift\-application\-credential\-secret string Application Credential -Secret (OS_APPLICATION_CREDENTIAL_SECRET) \-\-swift\-auth string -Authentication URL for server (OS_AUTH_URL). -\-\-swift\-auth\-token string Auth Token from alternate authentication -\- optional (OS_AUTH_TOKEN) \-\-swift\-auth\-version int AuthVersion \- -optional \- set to (1,2,3) if your auth URL has no version -(ST_AUTH_VERSION) \-\-swift\-chunk\-size SizeSuffix Above this size -files will be chunked into a _segments container. -(default 5G) \-\-swift\-domain string User domain \- optional (v3 auth) -(OS_USER_DOMAIN_NAME) \-\-swift\-encoding MultiEncoder This sets the -encoding for the backend. -(default Slash,InvalidUtf8) \-\-swift\-endpoint\-type string Endpoint -type to choose from the service catalogue (OS_ENDPOINT_TYPE) (default -\[dq]public\[dq]) \-\-swift\-env\-auth Get swift credentials from -environment variables in standard OpenStack form. -\-\-swift\-key string API key or password (OS_PASSWORD). -\-\-swift\-no\-chunk Don\[aq]t chunk files during streaming upload. -\-\-swift\-region string Region name \- optional (OS_REGION_NAME) -\-\-swift\-storage\-policy string The storage policy to use when -creating a new container \-\-swift\-storage\-url string Storage URL \- -optional (OS_STORAGE_URL) \-\-swift\-tenant string Tenant name \- -optional for v1 auth, this or tenant_id required otherwise -(OS_TENANT_NAME or OS_PROJECT_NAME) \-\-swift\-tenant\-domain string -Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) -\-\-swift\-tenant\-id string Tenant ID \- optional for v1 auth, this or -tenant required otherwise (OS_TENANT_ID) \-\-swift\-user string User -name to log in (OS_USERNAME). -\-\-swift\-user\-id string User ID to log in \- optional \- most swift -systems use user and leave this blank (v3 auth) (OS_USER_ID). -\-\-tardigrade\-access\-grant string Access Grant. -\-\-tardigrade\-api\-key string API Key. -\-\-tardigrade\-passphrase string Encryption Passphrase. -To access existing objects enter passphrase used for uploading. -\-\-tardigrade\-provider string Choose an authentication method. -(default \[dq]existing\[dq]) \-\-tardigrade\-satellite\-address \[at] -: Satellite Address. -Custom satellite address should match the format: \[at] -.PP -:. -(default \[dq]us\-central\-1.tardigrade.io\[dq]) -\-\-union\-action\-policy string Policy to choose upstream on ACTION -category. -(default \[dq]epall\[dq]) \-\-union\-cache\-time int Cache time of usage -and free space (in seconds). -This option is only useful when a path preserving policy is used. -(default 120) \-\-union\-create\-policy string Policy to choose upstream -on CREATE category. -(default \[dq]epmfs\[dq]) \-\-union\-search\-policy string Policy to -choose upstream on SEARCH category. -(default \[dq]ff\[dq]) \-\-union\-upstreams string List of space -separated upstreams. -\-\-webdav\-bearer\-token string Bearer token instead of user/pass (eg a -Macaroon) \-\-webdav\-bearer\-token\-command string Command to run to -get a bearer token \-\-webdav\-pass string Password. -(obscured) \-\-webdav\-url string URL of http host to connect to -\-\-webdav\-user string User name \-\-webdav\-vendor string Name of the -Webdav site/service/software you are using \-\-yandex\-auth\-url string -Auth server URL. -\-\-yandex\-client\-id string OAuth Client Id \-\-yandex\-client\-secret -string OAuth Client Secret \-\-yandex\-encoding MultiEncoder This sets -the encoding for the backend. -(default Slash,Del,Ctl,InvalidUtf8,Dot) \-\-yandex\-token string OAuth -Access Token as a JSON blob. -\-\-yandex\-token\-url string Token server url. -.IP -.nf -\f[C] - - 1Fichier -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -This is a backend for the [1fichier](https://1fichier.com) cloud -storage service. Note that a Premium subscription is required to use -the API. - -Paths are specified as \[ga]remote:path\[ga] - -Paths may be as deep as required, eg \[ga]remote:directory/subdirectory\[ga]. - -The initial setup for 1Fichier involves getting the API key from the website which you -need to do in your browser. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] XX / -1Fichier \ \[dq]fichier\[dq] [snip] Storage> fichier ** See help for -fichier backend at: https://rclone.org/fichier/ ** -.PP -Your API Key, get it from https://1fichier.com/console/params.pl Enter a -string value. -Press Enter for the default (\[dq]\[dq]). -api_key> example_key -.PP -Edit advanced config? -(y/n) y) Yes n) No y/n> Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = fichier api_key -= example_key \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y .IP .nf \f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / 1Fichier + \[rs] \[dq]fichier\[dq] +[snip] +Storage> fichier +** See help for fichier backend at: https://rclone.org/fichier/ ** -Once configured you can then use \[ga]rclone\[ga] like this, +Your API Key, get it from https://1fichier.com/console/params.pl +Enter a string value. Press Enter for the default (\[dq]\[dq]). +api_key> example_key +Edit advanced config? (y/n) +y) Yes +n) No +y/n> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = fichier +api_key = example_key +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP List directories in top level of your 1Fichier account - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP List all the files in your 1Fichier account - - rclone ls remote: - +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP To copy a local directory to a 1Fichier directory called backup - - rclone copy /home/source remote:backup - -### Modified time and hashes ### - -1Fichier does not support modification times. It supports the Whirlpool hash algorithm. - -### Duplicated files ### - -1Fichier can have two files with exactly the same name and path (unlike a -normal file system). - +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Modified time and hashes +.PP +1Fichier does not support modification times. +It supports the Whirlpool hash algorithm. +.SS Duplicated files +.PP +1Fichier can have two files with exactly the same name and path (unlike +a normal file system). +.PP Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs] | 0x5C | \[uFF3C] | -| < | 0x3C | \[uFF1C] | -| > | 0x3E | \[uFF1E] | -| \[dq] | 0x22 | \[uFF02] | -| $ | 0x24 | \[uFF04] | -| \[ga] | 0x60 | \[uFF40] | -| \[aq] | 0x27 | \[uFF07] | - +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +T{ +< +T}@T{ +0x3C +T}@T{ +\[uFF1C] +T} +T{ +> +T}@T{ +0x3E +T}@T{ +\[uFF1E] +T} +T{ +\[dq] +T}@T{ +0x22 +T}@T{ +\[uFF02] +T} +T{ +$ +T}@T{ +0x24 +T}@T{ +\[uFF04] +T} +T{ +\[ga] +T}@T{ +0x60 +T}@T{ +\[uFF40] +T} +T{ +\[aq] +T}@T{ +0x27 +T}@T{ +\[uFF07] +T} +.TE +.PP File names can also not start or end with the following characters. These only get replaced if they are the first or last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP Here are the standard options specific to fichier (1Fichier). - -#### \-\-fichier\-api\-key - +.SS \-\-fichier\-api\-key +.PP Your API Key, get it from https://1fichier.com/console/params.pl - -\- Config: api_key -\- Env Var: RCLONE_FICHIER_API_KEY -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - +.IP \[bu] 2 +Config: api_key +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_API_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP Here are the advanced options specific to fichier (1Fichier). - -#### \-\-fichier\-shared\-folder - +.SS \-\-fichier\-shared\-folder +.PP If you want to download a shared folder, add this parameter - -\- Config: shared_folder -\- Env Var: RCLONE_FICHIER_SHARED_FOLDER -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-fichier\-encoding - +.IP \[bu] 2 +Config: shared_folder +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_SHARED_FOLDER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-fichier\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_FICHIER_ENCODING -\- Type: MultiEncoder -\- Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot - - - - Alias -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]alias\[ga] remote provides a new name for another remote. - -Paths may be as deep as required or a local path, -eg \[ga]remote:directory/subdirectory\[ga] or \[ga]/directory/subdirectory\[ga]. - -During the initial setup with \[ga]rclone config\[ga] you will specify the target -remote. The target remote can either be a local path or another remote. - -Subfolders can be used in target remote. Assume an alias remote named \[ga]backup\[ga] -with the target \[ga]mydrive:private/backup\[ga]. Invoking \[ga]rclone mkdir backup:desktop\[ga] -is exactly the same as invoking \[ga]rclone mkdir mydrive:private/backup/desktop\[ga]. - -There will be no special handling of paths containing \[ga]..\[ga] segments. -Invoking \[ga]rclone mkdir backup:../desktop\[ga] is exactly the same as invoking -\[ga]rclone mkdir mydrive:private/backup/../desktop\[ga]. -The empty path is not allowed as a remote. To alias the current directory -use \[ga].\[ga] instead. - -Here is an example of how to make an alias called \[ga]remote\[ga] for local folder. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the 1Fichier backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Alias +.PP +The \f[C]alias\f[R] remote provides a new name for another remote. +.PP +Paths may be as deep as required or a local path, e.g. +\f[C]remote:directory/subdirectory\f[R] or +\f[C]/directory/subdirectory\f[R]. +.PP +During the initial setup with \f[C]rclone config\f[R] you will specify +the target remote. +The target remote can either be a local path or another remote. +.PP +Subfolders can be used in target remote. +Assume an alias remote named \f[C]backup\f[R] with the target +\f[C]mydrive:private/backup\f[R]. +Invoking \f[C]rclone mkdir backup:desktop\f[R] is exactly the same as +invoking \f[C]rclone mkdir mydrive:private/backup/desktop\f[R]. +.PP +There will be no special handling of paths containing \f[C]..\f[R] +segments. +Invoking \f[C]rclone mkdir backup:../desktop\f[R] is exactly the same as +invoking \f[C]rclone mkdir mydrive:private/backup/../desktop\f[R]. +The empty path is not allowed as a remote. +To alias the current directory use \f[C].\f[R] instead. +.PP +Here is an example of how to make an alias called \f[C]remote\f[R] for +local folder. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Alias -for an existing remote \ \[dq]alias\[dq] [snip] Storage> alias Remote or -path to alias. -Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], -\[dq]myremote:\[dq] or \[dq]/local/path\[dq]. -remote> /mnt/storage/backup Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] remote = -/mnt/storage/backup \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this -is OK e) Edit this remote d) Delete this remote y/e/d> y Current -remotes: -.PP -Name Type ==== ==== remote alias -.IP "e)" 3 -Edit existing remote -.IP "f)" 3 -New remote -.IP "g)" 3 -Delete remote -.IP "h)" 3 -Rename remote -.IP "i)" 3 -Copy remote -.IP "j)" 3 -Set configuration password -.IP "k)" 3 -Quit config e/n/d/r/c/s/q> q .IP .nf \f[C] - -Once configured you can then use \[ga]rclone\[ga] like this, - -List directories in top level in \[ga]/mnt/storage/backup\[ga] - - rclone lsd remote: - -List all the files in \[ga]/mnt/storage/backup\[ga] - - rclone ls remote: - -Copy another local directory to the alias directory called source - - rclone copy /home/source remote:source - - -### Standard Options - -Here are the standard options specific to alias (Alias for an existing remote). - -#### \-\-alias\-remote - + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Alias for an existing remote + \[rs] \[dq]alias\[dq] +[snip] +Storage> alias Remote or path to alias. Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], \[dq]myremote:\[dq] or \[dq]/local/path\[dq]. +remote> /mnt/storage/backup +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +remote = /mnt/storage/backup +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: -\- Config: remote -\- Env Var: RCLONE_ALIAS_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - - - - Amazon Drive -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +Name Type +==== ==== +remote alias +e) Edit existing remote +n) New remote +d) Delete remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +e/n/d/r/c/s/q> q +\f[R] +.fi +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level in \f[C]/mnt/storage/backup\f[R] +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in \f[C]/mnt/storage/backup\f[R] +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +Copy another local directory to the alias directory called source +.IP +.nf +\f[C] +rclone copy /home/source remote:source +\f[R] +.fi +.SS Standard Options +.PP +Here are the standard options specific to alias (Alias for an existing +remote). +.SS \-\-alias\-remote +.PP +Remote or path to alias. +Can be \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq], +\[dq]myremote:\[dq] or \[dq]/local/path\[dq]. +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_ALIAS_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Amazon Drive +.PP Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage service run by Amazon for consumers. - -## Status - -**Important:** rclone supports Amazon Drive only if you have your own -set of API keys. Unfortunately the [Amazon Drive developer -program](https://developer.amazon.com/amazon\-drive) is now closed to -new entries so if you don\[aq]t already have your own set of keys you will -not be able to use rclone with Amazon Drive. - -For the history on why rclone no longer has a set of Amazon Drive API -keys see [the forum](https://forum.rclone.org/t/rclone\-has\-been\-banned\-from\-amazon\-drive/2314). - -If you happen to know anyone who works at Amazon then please ask them -to re\-instate rclone into the Amazon Drive developer program \- thanks! - -## Setup - -The initial setup for Amazon Drive involves getting a token from -Amazon which you need to do in your browser. \[ga]rclone config\[ga] walks -you through it. - -The configuration process for Amazon Drive may involve using an [oauth -proxy](https://github.com/ncw/oauthproxy). This is used to keep the -Amazon credentials out of the source code. The proxy runs in Google\[aq]s -very secure App Engine environment and doesn\[aq]t store any credentials -which pass through it. - -Since rclone doesn\[aq]t currently have its own Amazon Drive credentials -so you will either need to have your own \[ga]client_id\[ga] and -\[ga]client_secret\[ga] with Amazon Drive, or use a third party oauth proxy -in which case you will need to enter \[ga]client_id\[ga], \[ga]client_secret\[ga], -\[ga]auth_url\[ga] and \[ga]token_url\[ga]. - -Note also if you are not using Amazon\[aq]s \[ga]auth_url\[ga] and \[ga]token_url\[ga], -(ie you filled in something for those) then if setting up on a remote -machine you can only use the [copying the config method of -configuration](https://rclone.org/remote_setup/#configuring\-by\-copying\-the\-config\-file) -\- \[ga]rclone authorize\[ga] will not work. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi +.SS Status .PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -Drive \ \[dq]amazon cloud drive\[dq] [snip] Storage> amazon cloud drive -Amazon Application Client Id \- required. -client_id> your client ID goes here Amazon Application Client Secret \- -required. -client_secret> your client secret goes here Auth server URL \- leave -blank to use Amazon\[aq]s. -auth_url> Optional auth URL Token server url \- leave blank to use -Amazon\[aq]s. -token_url> Optional token URL Remote config Make sure your Redirect URL -is set to \[dq]http://127.0.0.1:53682/\[dq] in your custom config. -Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: http://127.0.0.1:53682/auth Log -in and authorize rclone for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] client_id = -your client ID goes here client_secret = your client secret goes here -auth_url = Optional auth URL token_url = Optional token URL token = -{\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxx\[dq],\[dq]expiry\[dq]:\[dq]2015\-09\-06T16:07:39.658438471+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +\f[B]Important:\f[R] rclone supports Amazon Drive only if you have your +own set of API keys. +Unfortunately the Amazon Drive developer +program (https://developer.amazon.com/amazon-drive) is now closed to new +entries so if you don\[aq]t already have your own set of keys you will +not be able to use rclone with Amazon Drive. +.PP +For the history on why rclone no longer has a set of Amazon Drive API +keys see the +forum (https://forum.rclone.org/t/rclone-has-been-banned-from-amazon-drive/2314). +.PP +If you happen to know anyone who works at Amazon then please ask them to +re\-instate rclone into the Amazon Drive developer program \- thanks! +.SS Setup +.PP +The initial setup for Amazon Drive involves getting a token from Amazon +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +The configuration process for Amazon Drive may involve using an oauth +proxy (https://github.com/ncw/oauthproxy). +This is used to keep the Amazon credentials out of the source code. +The proxy runs in Google\[aq]s very secure App Engine environment and +doesn\[aq]t store any credentials which pass through it. +.PP +Since rclone doesn\[aq]t currently have its own Amazon Drive credentials +so you will either need to have your own \f[C]client_id\f[R] and +\f[C]client_secret\f[R] with Amazon Drive, or use a third party oauth +proxy in which case you will need to enter \f[C]client_id\f[R], +\f[C]client_secret\f[R], \f[C]auth_url\f[R] and \f[C]token_url\f[R]. +.PP +Note also if you are not using Amazon\[aq]s \f[C]auth_url\f[R] and +\f[C]token_url\f[R], (ie you filled in something for those) then if +setting up on a remote machine you can only use the copying the config +method of +configuration (https://rclone.org/remote_setup/#configuring-by-copying-the-config-file) +\- \f[C]rclone authorize\f[R] will not work. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: .IP .nf \f[C] - -See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a -machine with no Internet browser available. - + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] +[snip] +Storage> amazon cloud drive +Amazon Application Client Id \- required. +client_id> your client ID goes here +Amazon Application Client Secret \- required. +client_secret> your client secret goes here +Auth server URL \- leave blank to use Amazon\[aq]s. +auth_url> Optional auth URL +Token server url \- leave blank to use Amazon\[aq]s. +token_url> Optional token URL +Remote config +Make sure your Redirect URL is set to \[dq]http://127.0.0.1:53682/\[dq] in your custom config. +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = your client ID goes here +client_secret = your client secret goes here +auth_url = Optional auth URL +token_url = Optional token URL +token = {\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxx\[dq],\[dq]expiry\[dq]:\[dq]2015\-09\-06T16:07:39.658438471+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP Note that rclone runs a webserver on your local machine to collect the -token as returned from Amazon. This only runs from the moment it -opens your browser to the moment you get back the verification -code. This is on \[ga]http://127.0.0.1:53682/\[ga] and this it may require -you to unblock it temporarily if you are running a host firewall. - -Once configured you can then use \[ga]rclone\[ga] like this, - +token as returned from Amazon. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP List directories in top level of your Amazon Drive - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP List all the files in your Amazon Drive - - rclone ls remote: - +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP To copy a local directory to an Amazon Drive directory called backup - - rclone copy /home/source remote:backup - -### Modified time and MD5SUMs ### - -Amazon Drive doesn\[aq]t allow modification times to be changed via -the API so these won\[aq]t be accurate or used for syncing. - +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Modified time and MD5SUMs +.PP +Amazon Drive doesn\[aq]t allow modification times to be changed via the +API so these won\[aq]t be accurate or used for syncing. +.PP It does store MD5SUMs so for a more accurate sync, you can use the -\[ga]\-\-checksum\[ga] flag. - -#### Restricted filename characters - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| / | 0x2F | \[uFF0F] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -### Deleting files ### - -Any files you delete with rclone will end up in the trash. Amazon -don\[aq]t provide an API to permanently delete files, nor to empty the -trash, so you will have to do that with one of Amazon\[aq]s apps or via -the Amazon Drive website. As of November 17, 2016, files are -automatically deleted by Amazon from the trash after 30 days. - -### Using with non \[ga].com\[ga] Amazon accounts ### - -Let\[aq]s say you usually use \[ga]amazon.co.uk\[ga]. When you authenticate with -rclone it will take you to an \[ga]amazon.com\[ga] page to log in. Your -\[ga]amazon.co.uk\[ga] email and password should work here just fine. - - -### Standard Options - -Here are the standard options specific to amazon cloud drive (Amazon Drive). - -#### \-\-acd\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_ACD_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_ACD_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - -Here are the advanced options specific to amazon cloud drive (Amazon Drive). - -#### \-\-acd\-token - +\f[C]\-\-checksum\f[R] flag. +.SS Restricted filename characters +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Deleting files +.PP +Any files you delete with rclone will end up in the trash. +Amazon don\[aq]t provide an API to permanently delete files, nor to +empty the trash, so you will have to do that with one of Amazon\[aq]s +apps or via the Amazon Drive website. +As of November 17, 2016, files are automatically deleted by Amazon from +the trash after 30 days. +.SS Using with non \f[C].com\f[R] Amazon accounts +.PP +Let\[aq]s say you usually use \f[C]amazon.co.uk\f[R]. +When you authenticate with rclone it will take you to an +\f[C]amazon.com\f[R] page to log in. +Your \f[C]amazon.co.uk\f[R] email and password should work here just +fine. +.SS Standard Options +.PP +Here are the standard options specific to amazon cloud drive (Amazon +Drive). +.SS \-\-acd\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_ACD_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_ACD_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to amazon cloud drive (Amazon +Drive). +.SS \-\-acd\-token +.PP OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_ACD_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-auth\-url - +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_ACD_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-auth\-url +.PP Auth server URL. Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_ACD_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-token\-url - +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_ACD_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-token\-url +.PP Token server url. Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_ACD_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-checkpoint - +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_ACD_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-checkpoint +.PP Checkpoint for internal polling (debug). - -\- Config: checkpoint -\- Env Var: RCLONE_ACD_CHECKPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-acd\-upload\-wait\-per\-gb - -Additional time per GB to wait after a failed complete upload to see if it appears. - +.IP \[bu] 2 +Config: checkpoint +.IP \[bu] 2 +Env Var: RCLONE_ACD_CHECKPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-acd\-upload\-wait\-per\-gb +.PP +Additional time per GB to wait after a failed complete upload to see if +it appears. +.PP Sometimes Amazon Drive gives an error when a file has been fully -uploaded but the file appears anyway after a little while. This -happens sometimes for files over 1GB in size and nearly every time for -files bigger than 10GB. This parameter controls the time rclone waits -for the file to appear. - -The default value for this parameter is 3 minutes per GB, so by -default it will wait 3 minutes for every GB uploaded to see if the -file appears. - -You can disable this feature by setting it to 0. This may cause -conflict errors as rclone retries the failed upload but the file will -most likely appear correctly eventually. - -These values were determined empirically by observing lots of uploads -of big files for a range of file sizes. - -Upload with the \[dq]\-v\[dq] flag to see more info about what rclone is doing -in this situation. - -\- Config: upload_wait_per_gb -\- Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB -\- Type: Duration -\- Default: 3m0s - -#### \-\-acd\-templink\-threshold - +uploaded but the file appears anyway after a little while. +This happens sometimes for files over 1GB in size and nearly every time +for files bigger than 10GB. +This parameter controls the time rclone waits for the file to appear. +.PP +The default value for this parameter is 3 minutes per GB, so by default +it will wait 3 minutes for every GB uploaded to see if the file appears. +.PP +You can disable this feature by setting it to 0. +This may cause conflict errors as rclone retries the failed upload but +the file will most likely appear correctly eventually. +.PP +These values were determined empirically by observing lots of uploads of +big files for a range of file sizes. +.PP +Upload with the \[dq]\-v\[dq] flag to see more info about what rclone is +doing in this situation. +.IP \[bu] 2 +Config: upload_wait_per_gb +.IP \[bu] 2 +Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 3m0s +.SS \-\-acd\-templink\-threshold +.PP Files >= this size will be downloaded via their tempLink. - -Files this size or more will be downloaded via their \[dq]tempLink\[dq]. This -is to work around a problem with Amazon Drive which blocks downloads -of files bigger than about 10GB. The default for this is 9GB which -shouldn\[aq]t need to be changed. - -To download files above this threshold, rclone requests a \[dq]tempLink\[dq] -which downloads the file through a temporary URL directly from the -underlying S3 storage. - -\- Config: templink_threshold -\- Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD -\- Type: SizeSuffix -\- Default: 9G - -#### \-\-acd\-encoding - +.PP +Files this size or more will be downloaded via their \[dq]tempLink\[dq]. +This is to work around a problem with Amazon Drive which blocks +downloads of files bigger than about 10GB. +The default for this is 9GB which shouldn\[aq]t need to be changed. +.PP +To download files above this threshold, rclone requests a +\[dq]tempLink\[dq] which downloads the file through a temporary URL +directly from the underlying S3 storage. +.IP \[bu] 2 +Config: templink_threshold +.IP \[bu] 2 +Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 9G +.SS \-\-acd\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_ACD_ENCODING -\- Type: MultiEncoder -\- Default: Slash,InvalidUtf8,Dot - - - -### Limitations ### - -Note that Amazon Drive is case insensitive so you can\[aq]t have a -file called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -Amazon Drive has rate limiting so you may notice errors in the -sync (429 errors). rclone will automatically retry the sync up to 3 -times by default (see \[ga]\-\-retries\[ga] flag) which should hopefully work -around this problem. - -Amazon Drive has an internal limit of file sizes that can be uploaded -to the service. This limit is not officially published, but all files -larger than this will fail. - +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_ACD_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8,Dot +.SS Limitations +.PP +Note that Amazon Drive is case insensitive so you can\[aq]t have a file +called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +Amazon Drive has rate limiting so you may notice errors in the sync (429 +errors). +rclone will automatically retry the sync up to 3 times by default (see +\f[C]\-\-retries\f[R] flag) which should hopefully work around this +problem. +.PP +Amazon Drive has an internal limit of file sizes that can be uploaded to +the service. +This limit is not officially published, but all files larger than this +will fail. +.PP At the time of writing (Jan 2016) is in the area of 50GB per file. This means that larger files are likely to fail. - +.PP Unfortunately there is no way for rclone to see that this failure is because of file size, so it will retry the operation, as any other -failure. To avoid this problem, use \[ga]\-\-max\-size 50000M\[ga] option to limit -the maximum size of uploaded files. Note that \[ga]\-\-max\-size\[ga] does not split -files into segments, it only ignores files over this size. - - Amazon S3 Storage Providers -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - +failure. +To avoid this problem, use \f[C]\-\-max\-size 50000M\f[R] option to +limit the maximum size of uploaded files. +Note that \f[C]\-\-max\-size\f[R] does not split files into segments, it +only ignores files over this size. +.PP +\f[C]rclone about\f[R] is not supported by the Amazon Drive backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Amazon S3 Storage Providers +.PP The S3 backend can be used with a number of different providers: - - -\- AWS S3 -\- Alibaba Cloud (Aliyun) Object Storage System (OSS) -\- Ceph -\- DigitalOcean Spaces -\- Dreamhost -\- IBM COS S3 -\- Minio -\- Scaleway -\- StackPath -\- Wasabi - - -Paths are specified as \[ga]remote:bucket\[ga] (or \[ga]remote:\[ga] for the \[ga]lsd\[ga] -command.) You may put subdirectories in too, eg \[ga]remote:bucket/path/to/dir\[ga]. - +.IP \[bu] 2 +AWS S3 +.IP \[bu] 2 +Alibaba Cloud (Aliyun) Object Storage System (OSS) +.IP \[bu] 2 +Ceph +.IP \[bu] 2 +DigitalOcean Spaces +.IP \[bu] 2 +Dreamhost +.IP \[bu] 2 +IBM COS S3 +.IP \[bu] 2 +Minio +.IP \[bu] 2 +Scaleway +.IP \[bu] 2 +StackPath +.IP \[bu] 2 +Tencent Cloud Object Storage (COS) +.IP \[bu] 2 +Wasabi +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. +\f[C]remote:bucket/path/to/dir\f[R]. +.PP Once you have made a remote (see the provider specific section above) you can use it like this: - -See all buckets - - rclone lsd remote: - -Make a new bucket - - rclone mkdir remote:bucket - -List the contents of a bucket - - rclone ls remote:bucket - -Sync \[ga]/home/local/directory\[ga] to the remote bucket, deleting any excess -files in the bucket. - - rclone sync \-i /home/local/directory remote:bucket - -## AWS S3 {#amazon\-s3} - -Here is an example of making an s3 configuration. First run - - rclone config - -This will guide you through an interactive setup process. -\f[R] -.fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) -\ \[dq]s3\[dq] [snip] Storage> s3 Choose your S3 provider. -Choose a number from below, or type in your own value 1 / Amazon Web -Services (AWS) S3 \ \[dq]AWS\[dq] 2 / Ceph Object Storage -\ \[dq]Ceph\[dq] 3 / Digital Ocean Spaces \ \[dq]DigitalOcean\[dq] 4 / -Dreamhost DreamObjects \ \[dq]Dreamhost\[dq] 5 / IBM COS S3 -\ \[dq]IBMCOS\[dq] 6 / Minio Object Storage \ \[dq]Minio\[dq] 7 / Wasabi -Object Storage \ \[dq]Wasabi\[dq] 8 / Any other S3 compatible provider -\ \[dq]Other\[dq] provider> 1 Get AWS credentials from runtime -(environment variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[dq]false\[dq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[dq]true\[dq] env_auth> 1 AWS -Access Key ID \- leave blank for anonymous access or runtime -credentials. -access_key_id> XXX AWS Secret Access Key (password) \- leave blank for -anonymous access or runtime credentials. -secret_access_key> YYY Region to connect to. -Choose a number from below, or type in your own value / The default -endpoint \- a good choice if you are unsure. -1 | US Region, Northern Virginia or Pacific Northwest. -| Leave location constraint empty. -\ \[dq]us\-east\-1\[dq] / US East (Ohio) Region 2 | Needs location -constraint us\-east\-2. -\ \[dq]us\-east\-2\[dq] / US West (Oregon) Region 3 | Needs location -constraint us\-west\-2. -\ \[dq]us\-west\-2\[dq] / US West (Northern California) Region 4 | Needs -location constraint us\-west\-1. -\ \[dq]us\-west\-1\[dq] / Canada (Central) Region 5 | Needs location -constraint ca\-central\-1. -\ \[dq]ca\-central\-1\[dq] / EU (Ireland) Region 6 | Needs location -constraint EU or eu\-west\-1. -\ \[dq]eu\-west\-1\[dq] / EU (London) Region 7 | Needs location -constraint eu\-west\-2. -\ \[dq]eu\-west\-2\[dq] / EU (Frankfurt) Region 8 | Needs location -constraint eu\-central\-1. -\ \[dq]eu\-central\-1\[dq] / Asia Pacific (Singapore) Region 9 | Needs -location constraint ap\-southeast\-1. -\ \[dq]ap\-southeast\-1\[dq] / Asia Pacific (Sydney) Region 10 | Needs -location constraint ap\-southeast\-2. -\ \[dq]ap\-southeast\-2\[dq] / Asia Pacific (Tokyo) Region 11 | Needs -location constraint ap\-northeast\-1. -\ \[dq]ap\-northeast\-1\[dq] / Asia Pacific (Seoul) 12 | Needs location -constraint ap\-northeast\-2. -\ \[dq]ap\-northeast\-2\[dq] / Asia Pacific (Mumbai) 13 | Needs location -constraint ap\-south\-1. -\ \[dq]ap\-south\-1\[dq] / Asia Patific (Hong Kong) Region 14 | Needs -location constraint ap\-east\-1. -\ \[dq]ap\-east\-1\[dq] / South America (Sao Paulo) Region 15 | Needs -location constraint sa\-east\-1. -\ \[dq]sa\-east\-1\[dq] region> 1 Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -endpoint> Location constraint \- must be set to match the Region. -Used when creating buckets only. -Choose a number from below, or type in your own value 1 / Empty for US -Region, Northern Virginia or Pacific Northwest. -\ \[dq]\[dq] 2 / US East (Ohio) Region. -\ \[dq]us\-east\-2\[dq] 3 / US West (Oregon) Region. -\ \[dq]us\-west\-2\[dq] 4 / US West (Northern California) Region. -\ \[dq]us\-west\-1\[dq] 5 / Canada (Central) Region. -\ \[dq]ca\-central\-1\[dq] 6 / EU (Ireland) Region. -\ \[dq]eu\-west\-1\[dq] 7 / EU (London) Region. -\ \[dq]eu\-west\-2\[dq] 8 / EU Region. -\ \[dq]EU\[dq] 9 / Asia Pacific (Singapore) Region. -\ \[dq]ap\-southeast\-1\[dq] 10 / Asia Pacific (Sydney) Region. -\ \[dq]ap\-southeast\-2\[dq] 11 / Asia Pacific (Tokyo) Region. -\ \[dq]ap\-northeast\-1\[dq] 12 / Asia Pacific (Seoul) -\ \[dq]ap\-northeast\-2\[dq] 13 / Asia Pacific (Mumbai) -\ \[dq]ap\-south\-1\[dq] 14 / Asia Pacific (Hong Kong) -\ \[dq]ap\-east\-1\[dq] 15 / South America (Sao Paulo) Region. -\ \[dq]sa\-east\-1\[dq] location_constraint> 1 Canned ACL used when -creating buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -\ \[dq]public\-read\[dq] / Owner gets FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -3 | Granting this on a bucket is generally not recommended. -\ \[dq]public\-read\-write\[dq] 4 / Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -\ \[dq]authenticated\-read\[dq] / Object owner gets FULL_CONTROL. -Bucket owner gets READ access. -5 | If you specify this canned ACL when creating a bucket, Amazon S3 -ignores it. -\ \[dq]bucket\-owner\-read\[dq] / Both the object owner and the bucket -owner get FULL_CONTROL over the object. -6 | If you specify this canned ACL when creating a bucket, Amazon S3 -ignores it. -\ \[dq]bucket\-owner\-full\-control\[dq] acl> 1 The server\-side -encryption algorithm used when storing this object in S3. -Choose a number from below, or type in your own value 1 / None -\ \[dq]\[dq] 2 / AES256 \ \[dq]AES256\[dq] server_side_encryption> 1 The -storage class to use when storing objects in S3. -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Standard storage class \ \[dq]STANDARD\[dq] 3 / Reduced -redundancy storage class \ \[dq]REDUCED_REDUNDANCY\[dq] 4 / Standard -Infrequent Access storage class \ \[dq]STANDARD_IA\[dq] 5 / One Zone -Infrequent Access storage class \ \[dq]ONEZONE_IA\[dq] 6 / Glacier -storage class \ \[dq]GLACIER\[dq] 7 / Glacier Deep Archive storage class -\ \[dq]DEEP_ARCHIVE\[dq] 8 / Intelligent\-Tiering storage class -\ \[dq]INTELLIGENT_TIERING\[dq] storage_class> 1 Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = s3 provider = -AWS env_auth = false access_key_id = XXX secret_access_key = YYY region -= us\-east\-1 endpoint = location_constraint = acl = private -server_side_encryption = storage_class = -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> +See all buckets .IP .nf \f[C] - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -### \-\-update and \-\-use\-server\-modtime ### - -As noted below, the modified time is stored on metadata on the object. It is -used by default for all operations that require checking the time a file was -last updated. It allows rclone to treat the remote more like a true filesystem, -but it is inefficient because it requires an extra API call to retrieve the -metadata. - -For many operations, the time the object was last uploaded to the remote is -sufficient to determine if it is \[dq]dirty\[dq]. By using \[ga]\-\-update\[ga] along with -\[ga]\-\-use\-server\-modtime\[ga], you can avoid the extra API call and simply upload -files whose local modtime is newer than the time it was last uploaded. - -### Modified time ### - +rclone lsd remote: +\f[R] +.fi +.PP +Make a new bucket +.IP +.nf +\f[C] +rclone mkdir remote:bucket +\f[R] +.fi +.PP +List the contents of a bucket +.IP +.nf +\f[C] +rclone ls remote:bucket +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any +excess files in the bucket. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:bucket +\f[R] +.fi +.SS AWS S3 +.PP +Here is an example of making an s3 configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon S3 Compliant Storage Providers including AWS, Ceph, Dreamhost, IBM COS, Minio, and Tencent COS + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Choose your S3 provider. +Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] + 2 / Ceph Object Storage + \[rs] \[dq]Ceph\[dq] + 3 / Digital Ocean Spaces + \[rs] \[dq]DigitalOcean\[dq] + 4 / Dreamhost DreamObjects + \[rs] \[dq]Dreamhost\[dq] + 5 / IBM COS S3 + \[rs] \[dq]IBMCOS\[dq] + 6 / Minio Object Storage + \[rs] \[dq]Minio\[dq] + 7 / Wasabi Object Storage + \[rs] \[dq]Wasabi\[dq] + 8 / Any other S3 compatible provider + \[rs] \[dq]Other\[dq] +provider> 1 +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> XXX +AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> YYY +Region to connect to. +Choose a number from below, or type in your own value + / The default endpoint \- a good choice if you are unsure. + 1 | US Region, Northern Virginia, or Pacific Northwest. + | Leave location constraint empty. + \[rs] \[dq]us\-east\-1\[dq] + / US East (Ohio) Region + 2 | Needs location constraint us\-east\-2. + \[rs] \[dq]us\-east\-2\[dq] + / US West (Oregon) Region + 3 | Needs location constraint us\-west\-2. + \[rs] \[dq]us\-west\-2\[dq] + / US West (Northern California) Region + 4 | Needs location constraint us\-west\-1. + \[rs] \[dq]us\-west\-1\[dq] + / Canada (Central) Region + 5 | Needs location constraint ca\-central\-1. + \[rs] \[dq]ca\-central\-1\[dq] + / EU (Ireland) Region + 6 | Needs location constraint EU or eu\-west\-1. + \[rs] \[dq]eu\-west\-1\[dq] + / EU (London) Region + 7 | Needs location constraint eu\-west\-2. + \[rs] \[dq]eu\-west\-2\[dq] + / EU (Frankfurt) Region + 8 | Needs location constraint eu\-central\-1. + \[rs] \[dq]eu\-central\-1\[dq] + / Asia Pacific (Singapore) Region + 9 | Needs location constraint ap\-southeast\-1. + \[rs] \[dq]ap\-southeast\-1\[dq] + / Asia Pacific (Sydney) Region +10 | Needs location constraint ap\-southeast\-2. + \[rs] \[dq]ap\-southeast\-2\[dq] + / Asia Pacific (Tokyo) Region +11 | Needs location constraint ap\-northeast\-1. + \[rs] \[dq]ap\-northeast\-1\[dq] + / Asia Pacific (Seoul) +12 | Needs location constraint ap\-northeast\-2. + \[rs] \[dq]ap\-northeast\-2\[dq] + / Asia Pacific (Mumbai) +13 | Needs location constraint ap\-south\-1. + \[rs] \[dq]ap\-south\-1\[dq] + / Asia Pacific (Hong Kong) Region +14 | Needs location constraint ap\-east\-1. + \[rs] \[dq]ap\-east\-1\[dq] + / South America (Sao Paulo) Region +15 | Needs location constraint sa\-east\-1. + \[rs] \[dq]sa\-east\-1\[dq] +region> 1 +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +endpoint> +Location constraint \- must be set to match the Region. Used when creating buckets only. +Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. + \[rs] \[dq]\[dq] + 2 / US East (Ohio) Region. + \[rs] \[dq]us\-east\-2\[dq] + 3 / US West (Oregon) Region. + \[rs] \[dq]us\-west\-2\[dq] + 4 / US West (Northern California) Region. + \[rs] \[dq]us\-west\-1\[dq] + 5 / Canada (Central) Region. + \[rs] \[dq]ca\-central\-1\[dq] + 6 / EU (Ireland) Region. + \[rs] \[dq]eu\-west\-1\[dq] + 7 / EU (London) Region. + \[rs] \[dq]eu\-west\-2\[dq] + 8 / EU Region. + \[rs] \[dq]EU\[dq] + 9 / Asia Pacific (Singapore) Region. + \[rs] \[dq]ap\-southeast\-1\[dq] +10 / Asia Pacific (Sydney) Region. + \[rs] \[dq]ap\-southeast\-2\[dq] +11 / Asia Pacific (Tokyo) Region. + \[rs] \[dq]ap\-northeast\-1\[dq] +12 / Asia Pacific (Seoul) + \[rs] \[dq]ap\-northeast\-2\[dq] +13 / Asia Pacific (Mumbai) + \[rs] \[dq]ap\-south\-1\[dq] +14 / Asia Pacific (Hong Kong) + \[rs] \[dq]ap\-east\-1\[dq] +15 / South America (Sao Paulo) Region. + \[rs] \[dq]sa\-east\-1\[dq] +location_constraint> 1 +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \[rs] \[dq]public\-read\[dq] + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. + 3 | Granting this on a bucket is generally not recommended. + \[rs] \[dq]public\-read\-write\[dq] + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. + \[rs] \[dq]authenticated\-read\[dq] + / Object owner gets FULL_CONTROL. Bucket owner gets READ access. + 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \[rs] \[dq]bucket\-owner\-read\[dq] + / Both the object owner and the bucket owner get FULL_CONTROL over the object. + 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \[rs] \[dq]bucket\-owner\-full\-control\[dq] +acl> 1 +The server\-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value + 1 / None + \[rs] \[dq]\[dq] + 2 / AES256 + \[rs] \[dq]AES256\[dq] +server_side_encryption> 1 +The storage class to use when storing objects in S3. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Reduced redundancy storage class + \[rs] \[dq]REDUCED_REDUNDANCY\[dq] + 4 / Standard Infrequent Access storage class + \[rs] \[dq]STANDARD_IA\[dq] + 5 / One Zone Infrequent Access storage class + \[rs] \[dq]ONEZONE_IA\[dq] + 6 / Glacier storage class + \[rs] \[dq]GLACIER\[dq] + 7 / Glacier Deep Archive storage class + \[rs] \[dq]DEEP_ARCHIVE\[dq] + 8 / Intelligent\-Tiering storage class + \[rs] \[dq]INTELLIGENT_TIERING\[dq] +storage_class> 1 +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = s3 +provider = AWS +env_auth = false +access_key_id = XXX +secret_access_key = YYY +region = us\-east\-1 +endpoint = +location_constraint = +acl = private +server_side_encryption = +storage_class = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> +\f[R] +.fi +.SS Modified time +.PP The modified time is stored as metadata on the object as -\[ga]X\-Amz\-Meta\-Mtime\[ga] as floating point since the epoch accurate to 1 ns. - -If the modification time needs to be updated rclone will attempt to perform a server -side copy to update the modification if the object can be copied in a single part. -In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive -storage the object will be uploaded rather than copied. - -### Cleanup ### - -If you run \[ga]rclone cleanup s3:bucket\[ga] then it will remove all pending -multipart uploads older than 24 hours. You can use the \[ga]\-i\[ga] flag to -see exactly what it will do. If you want more control over the expiry -date then run \[ga]rclone backend cleanup s3:bucket \-o max\-age=1h\[ga] to -expire all uploads older than one hour. You can use \[ga]rclone backend -list\-multipart\-uploads s3:bucket\[ga] to see the pending multipart -uploads. - -#### Restricted filename characters - +\f[C]X\-Amz\-Meta\-Mtime\f[R] as floating point since the epoch accurate +to 1 ns. +.PP +If the modification time needs to be updated rclone will attempt to +perform a server side copy to update the modification if the object can +be copied in a single part. +In the case the object is larger than 5Gb or is in Glacier or Glacier +Deep Archive storage the object will be uploaded rather than copied. +.PP +Note that reading this from the object takes an additional +\f[C]HEAD\f[R] request as the metadata isn\[aq]t returned in object +listings. +.SS Reducing costs +.SS Avoiding HEAD requests to read the modification time +.PP +By default rclone will use the modification time of objects stored in S3 +for syncing. +This is stored in object metadata which unfortunately takes an extra +HEAD request to read which can be expensive (in time and money). +.PP +The modification time 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 on S3 because it requires an extra API call to retrieve +the metadata. +.PP +The extra API calls can be avoided when syncing (using +\f[C]rclone sync\f[R] or \f[C]rclone copy\f[R]) in a few different ways, +each with its own tradeoffs. +.IP \[bu] 2 +\f[C]\-\-size\-only\f[R] +.RS 2 +.IP \[bu] 2 +Only checks the size of files. +.IP \[bu] 2 +Uses no extra transactions. +.IP \[bu] 2 +If the file doesn\[aq]t change size then rclone won\[aq]t detect it has +changed. +.IP \[bu] 2 +\f[C]rclone sync \-\-size\-only /path/to/source s3:bucket\f[R] +.RE +.IP \[bu] 2 +\f[C]\-\-checksum\f[R] +.RS 2 +.IP \[bu] 2 +Checks the size and MD5 checksum of files. +.IP \[bu] 2 +Uses no extra transactions. +.IP \[bu] 2 +The most accurate detection of changes possible. +.IP \[bu] 2 +Will cause the source to read an MD5 checksum which, if it is a local +disk, will cause lots of disk activity. +.IP \[bu] 2 +If the source and destination are both S3 this is the +\f[B]recommended\f[R] flag to use for maximum efficiency. +.IP \[bu] 2 +\f[C]rclone sync \-\-checksum /path/to/source s3:bucket\f[R] +.RE +.IP \[bu] 2 +\f[C]\-\-update \-\-use\-server\-modtime\f[R] +.RS 2 +.IP \[bu] 2 +Uses no extra transactions. +.IP \[bu] 2 +Modification time becomes the time the object was uploaded. +.IP \[bu] 2 +For many operations this is sufficient to determine if it needs +uploading. +.IP \[bu] 2 +Using \f[C]\-\-update\f[R] along with +\f[C]\-\-use\-server\-modtime\f[R], avoids the extra API call and +uploads files whose local modification time is newer than the time it +was last uploaded. +.IP \[bu] 2 +Files created with timestamps in the past will be missed by the sync. +.IP \[bu] 2 +\f[C]rclone sync \-\-update \-\-use\-server\-modtime /path/to/source s3:bucket\f[R] +.RE +.PP +These flags can and should be used in combination with +\f[C]\-\-fast\-list\f[R] \- see below. +.PP +If using \f[C]rclone mount\f[R] or any command using the VFS (eg +\f[C]rclone serve\f[R]) commands then you might want to consider using +the VFS flag \f[C]\-\-no\-modtime\f[R] which will stop rclone reading +the modification time for every object. +You could also use \f[C]\-\-use\-server\-modtime\f[R] if you are happy +with the modification times of the objects being the time of upload. +.SS Avoiding GET requests to read directory listings +.PP +Rclone\[aq]s default directory traversal is to process each directory +individually. +This takes one API call per directory. +Using the \f[C]\-\-fast\-list\f[R] flag will read all info about the the +objects into memory first using a smaller number of API calls (one per +1000 objects). +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.IP +.nf +\f[C] +rclone sync \-\-fast\-list \-\-checksum /path/to/source s3:bucket +\f[R] +.fi +.PP +\f[C]\-\-fast\-list\f[R] trades off API transactions for memory use. +As a rough guide rclone uses 1k of memory per object stored, so using +\f[C]\-\-fast\-list\f[R] on a sync of a million objects will use roughly +1 GB of RAM. +.PP +If you are only copying a small number of files into a big repository +then using \f[C]\-\-no\-traverse\f[R] is a good idea. +This finds objects directly instead of through directory listings. +You can do a \[dq]top\-up\[dq] sync very cheaply by using +\f[C]\-\-max\-age\f[R] and \f[C]\-\-no\-traverse\f[R] to copy only +recent files, eg +.IP +.nf +\f[C] +rclone copy \-\-min\-age 24h \-\-no\-traverse /path/to/source s3:bucket +\f[R] +.fi +.PP +You\[aq]d then do a full \f[C]rclone sync\f[R] less often. +.PP +Note that \f[C]\-\-fast\-list\f[R] isn\[aq]t required in the top\-up +sync. +.SS Hashes +.PP +For small objects which weren\[aq]t uploaded as multipart uploads +(objects sized below \f[C]\-\-s3\-upload\-cutoff\f[R] if uploaded with +rclone) rclone uses the \f[C]ETag:\f[R] header as an MD5 checksum. +.PP +However for objects which were uploaded as multipart uploads or with +server side encryption (SSE\-AWS or SSE\-C) the \f[C]ETag\f[R] header is +no longer the MD5 sum of the data, so rclone adds an additional piece of +metadata \f[C]X\-Amz\-Meta\-Md5chksum\f[R] which is a base64 encoded MD5 +hash (in the same format as is required for \f[C]Content\-MD5\f[R]). +.PP +For large objects, calculating this hash can take some time so the +addition of this hash can be disabled with +\f[C]\-\-s3\-disable\-checksum\f[R]. +This will mean that these objects do not have an MD5 checksum. +.PP +Note that reading this from the object takes an additional +\f[C]HEAD\f[R] request as the metadata isn\[aq]t returned in object +listings. +.SS Cleanup +.PP +If you run \f[C]rclone cleanup s3:bucket\f[R] then it will remove all +pending multipart uploads older than 24 hours. +You can use the \f[C]\-i\f[R] flag to see exactly what it will do. +If you want more control over the expiry date then run +\f[C]rclone backend cleanup s3:bucket \-o max\-age=1h\f[R] to expire all +uploads older than one hour. +You can use \f[C]rclone backend list\-multipart\-uploads s3:bucket\f[R] +to see the pending multipart uploads. +.SS Restricted filename characters +.PP S3 allows any valid UTF\-8 string as a key. - -Invalid UTF\-8 bytes will be [replaced](https://rclone.org/overview/#invalid\-utf8), as -they can\[aq]t be used in XML. - +.PP +Invalid UTF\-8 bytes will be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in XML. +.PP The following characters are replaced since these are problematic when dealing with the REST API: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| / | 0x2F | \[uFF0F] | - +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +.TE +.PP The encoding will also encode these file names as they don\[aq]t seem to work with the SDK properly: - -| File name | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-:| -| . | \[uFF0E] | -| .. | \[uFF0E]\[uFF0E] | - -### Multipart uploads ### - -rclone supports multipart uploads with S3 which means that it can -upload files bigger than 5GB. - -Note that files uploaded *both* with multipart upload *and* through -crypt remotes do not have MD5 sums. - +.PP +.TS +tab(@); +l c. +T{ +File name +T}@T{ +Replacement +T} +_ +T{ +\&. +T}@T{ +\[uFF0E] +T} +T{ +\&.. +T}@T{ +\[uFF0E]\[uFF0E] +T} +.TE +.SS Multipart uploads +.PP +rclone supports multipart uploads with S3 which means that it can upload +files bigger than 5GB. +.PP +Note that files uploaded \f[I]both\f[R] with multipart upload +\f[I]and\f[R] through crypt remotes do not have MD5 sums. +.PP rclone switches from single part uploads to multipart uploads at the -point specified by \[ga]\-\-s3\-upload\-cutoff\[ga]. This can be a maximum of 5GB -and a minimum of 0 (ie always upload multipart files). - +point specified by \f[C]\-\-s3\-upload\-cutoff\f[R]. +This can be a maximum of 5GB and a minimum of 0 (ie always upload +multipart files). +.PP The chunk sizes used in the multipart upload are specified by -\[ga]\-\-s3\-chunk\-size\[ga] and the number of chunks uploaded concurrently is -specified by \[ga]\-\-s3\-upload\-concurrency\[ga]. - -Multipart uploads will use \[ga]\-\-transfers\[ga] * \[ga]\-\-s3\-upload\-concurrency\[ga] * -\[ga]\-\-s3\-chunk\-size\[ga] extra memory. Single part uploads to not use extra -memory. - +\f[C]\-\-s3\-chunk\-size\f[R] and the number of chunks uploaded +concurrently is specified by \f[C]\-\-s3\-upload\-concurrency\f[R]. +.PP +Multipart uploads will use \f[C]\-\-transfers\f[R] * +\f[C]\-\-s3\-upload\-concurrency\f[R] * \f[C]\-\-s3\-chunk\-size\f[R] +extra memory. +Single part uploads to not use extra memory. +.PP Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 \- the more latency, the more likely single part transfers will be faster. - -Increasing \[ga]\-\-s3\-upload\-concurrency\[ga] will increase throughput (8 would -be a sensible value) and increasing \[ga]\-\-s3\-chunk\-size\[ga] also increases -throughput (16M would be sensible). Increasing either of these will -use more memory. The default values are high enough to gain most of -the possible performance without using too much memory. - - -### Buckets and Regions ### - -With Amazon S3 you can list buckets (\[ga]rclone lsd\[ga]) using any region, -but you can only access the content of a bucket from the region it was -created in. If you attempt to access a bucket from the wrong region, -you will get an error, \[ga]incorrect region, the bucket is not in \[aq]XXX\[aq] -region\[ga]. - -### Authentication ### - -There are a number of ways to supply \[ga]rclone\[ga] with a set of AWS -credentials, with and without using the environment. - -The different authentication methods are tried in this order: - - \- Directly in the rclone configuration file (\[ga]env_auth = false\[ga] in the config file): - \- \[ga]access_key_id\[ga] and \[ga]secret_access_key\[ga] are required. - \- \[ga]session_token\[ga] can be optionally set when using AWS STS. - \- Runtime configuration (\[ga]env_auth = true\[ga] in the config file): - \- Export the following environment variables before running \[ga]rclone\[ga]: - \- Access Key ID: \[ga]AWS_ACCESS_KEY_ID\[ga] or \[ga]AWS_ACCESS_KEY\[ga] - \- Secret Access Key: \[ga]AWS_SECRET_ACCESS_KEY\[ga] or \[ga]AWS_SECRET_KEY\[ga] - \- Session Token: \[ga]AWS_SESSION_TOKEN\[ga] (optional) - \- Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli\-multiple\-profiles.html): - \- Profile files are standard files used by AWS CLI tools - \- By default it will use the profile in your home directory (eg \[ga]\[ti]/.aws/credentials\[ga] on unix based systems) file and the \[dq]default\[dq] profile, to change set these environment variables: - \- \[ga]AWS_SHARED_CREDENTIALS_FILE\[ga] to control which file. - \- \[ga]AWS_PROFILE\[ga] to control which profile to use. - \- Or, run \[ga]rclone\[ga] in an ECS task with an IAM role (AWS only). - \- Or, run \[ga]rclone\[ga] on an EC2 instance with an IAM role (AWS only). - \- Or, run \[ga]rclone\[ga] in an EKS pod with an IAM role that is associated with a service account (AWS only). - -If none of these option actually end up providing \[ga]rclone\[ga] with AWS -credentials then S3 interaction will be non\-authenticated (see below). - -### S3 Permissions ### - -When using the \[ga]sync\[ga] subcommand of \[ga]rclone\[ga] the following minimum -permissions are required to be available on the bucket being written to: - -* \[ga]ListBucket\[ga] -* \[ga]DeleteObject\[ga] -* \[ga]GetObject\[ga] -* \[ga]PutObject\[ga] -* \[ga]PutObjectACL\[ga] - -When using the \[ga]lsd\[ga] subcommand, the \[ga]ListAllMyBuckets\[ga] permission is required. - -Example policy: -\f[R] -.fi .PP -{ \[dq]Version\[dq]: \[dq]2012\-10\-17\[dq], \[dq]Statement\[dq]: [ { -\[dq]Effect\[dq]: \[dq]Allow\[dq], \[dq]Principal\[dq]: { \[dq]AWS\[dq]: -\[dq]arn:aws:iam::USER_SID:user/USER_NAME\[dq] }, \[dq]Action\[dq]: [ -\[dq]s3:ListBucket\[dq], \[dq]s3:DeleteObject\[dq], -\[dq]s3:GetObject\[dq], \[dq]s3:PutObject\[dq], -\[dq]s3:PutObjectAcl\[dq] ], \[dq]Resource\[dq]: [ -\[dq]arn:aws:s3:::BUCKET_NAME/*\[dq], \[dq]arn:aws:s3:::BUCKET_NAME\[dq] -] }, { \[dq]Effect\[dq]: \[dq]Allow\[dq], \[dq]Action\[dq]: -\[dq]s3:ListAllMyBuckets\[dq], \[dq]Resource\[dq]: -\[dq]arn:aws:s3:::*\[dq] } -.PD 0 -.P -.PD -] } +Increasing \f[C]\-\-s3\-upload\-concurrency\f[R] will increase +throughput (8 would be a sensible value) and increasing +\f[C]\-\-s3\-chunk\-size\f[R] also increases throughput (16M would be +sensible). +Increasing either of these will use more memory. +The default values are high enough to gain most of the possible +performance without using too much memory. +.SS Buckets and Regions +.PP +With Amazon S3 you can list buckets (\f[C]rclone lsd\f[R]) using any +region, but you can only access the content of a bucket from the region +it was created in. +If you attempt to access a bucket from the wrong region, you will get an +error, +\f[C]incorrect region, the bucket is not in \[aq]XXX\[aq] region\f[R]. +.SS Authentication +.PP +There are a number of ways to supply \f[C]rclone\f[R] with a set of AWS +credentials, with and without using the environment. +.PP +The different authentication methods are tried in this order: +.IP \[bu] 2 +Directly in the rclone configuration file (\f[C]env_auth = false\f[R] in +the config file): +.RS 2 +.IP \[bu] 2 +\f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R] are required. +.IP \[bu] 2 +\f[C]session_token\f[R] can be optionally set when using AWS STS. +.RE +.IP \[bu] 2 +Runtime configuration (\f[C]env_auth = true\f[R] in the config file): +.RS 2 +.IP \[bu] 2 +Export the following environment variables before running +\f[C]rclone\f[R]: +.RS 2 +.IP \[bu] 2 +Access Key ID: \f[C]AWS_ACCESS_KEY_ID\f[R] or \f[C]AWS_ACCESS_KEY\f[R] +.IP \[bu] 2 +Secret Access Key: \f[C]AWS_SECRET_ACCESS_KEY\f[R] or +\f[C]AWS_SECRET_KEY\f[R] +.IP \[bu] 2 +Session Token: \f[C]AWS_SESSION_TOKEN\f[R] (optional) +.RE +.IP \[bu] 2 +Or, use a named +profile (https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html): +.RS 2 +.IP \[bu] 2 +Profile files are standard files used by AWS CLI tools +.IP \[bu] 2 +By default it will use the profile in your home directory (e.g. +\f[C]\[ti]/.aws/credentials\f[R] on unix based systems) file and the +\[dq]default\[dq] profile, to change set these environment variables: +.RS 2 +.IP \[bu] 2 +\f[C]AWS_SHARED_CREDENTIALS_FILE\f[R] to control which file. +.IP \[bu] 2 +\f[C]AWS_PROFILE\f[R] to control which profile to use. +.RE +.RE +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] in an ECS task with an IAM role (AWS only). +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] on an EC2 instance with an IAM role (AWS only). +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] in an EKS pod with an IAM role that is +associated with a service account (AWS only). +.RE +.PP +If none of these option actually end up providing \f[C]rclone\f[R] with +AWS credentials then S3 interaction will be non\-authenticated (see +below). +.SS S3 Permissions +.PP +When using the \f[C]sync\f[R] subcommand of \f[C]rclone\f[R] the +following minimum permissions are required to be available on the bucket +being written to: +.IP \[bu] 2 +\f[C]ListBucket\f[R] +.IP \[bu] 2 +\f[C]DeleteObject\f[R] +.IP \[bu] 2 +\f[C]GetObject\f[R] +.IP \[bu] 2 +\f[C]PutObject\f[R] +.IP \[bu] 2 +\f[C]PutObjectACL\f[R] +.PP +When using the \f[C]lsd\f[R] subcommand, the \f[C]ListAllMyBuckets\f[R] +permission is required. +.PP +Example policy: .IP .nf \f[C] - -Notes on above: - -1. This is a policy that can be used when creating bucket. It assumes - that \[ga]USER_NAME\[ga] has been created. -2. The Resource entry must include both resource ARNs, as one implies - the bucket and the other implies the bucket\[aq]s objects. - -For reference, [here\[aq]s an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) -that will generate one or more buckets that will work with \[ga]rclone sync\[ga]. - -### Key Management System (KMS) ### - -If you are using server side encryption with KMS then you will find -you can\[aq]t transfer small objects. As a work\-around you can use the -\[ga]\-\-ignore\-checksum\[ga] flag. - -A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824). - -### Glacier and Glacier Deep Archive ### - -You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user\-guide/create\-lifecycle.html). -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 - -Choose your S3 provider. - -\- Config: provider -\- Env Var: RCLONE_S3_PROVIDER -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]AWS\[dq] - \- Amazon Web Services (AWS) S3 - \- \[dq]Alibaba\[dq] - \- Alibaba Cloud Object Storage System (OSS) formerly Aliyun - \- \[dq]Ceph\[dq] - \- Ceph Object Storage - \- \[dq]DigitalOcean\[dq] - \- Digital Ocean Spaces - \- \[dq]Dreamhost\[dq] - \- Dreamhost DreamObjects - \- \[dq]IBMCOS\[dq] - \- IBM COS S3 - \- \[dq]Minio\[dq] - \- Minio Object Storage - \- \[dq]Netease\[dq] - \- Netease Object Storage (NOS) - \- \[dq]Scaleway\[dq] - \- Scaleway Object Storage - \- \[dq]StackPath\[dq] - \- StackPath Object Storage - \- \[dq]Wasabi\[dq] - \- Wasabi Object Storage - \- \[dq]Other\[dq] - \- Any other S3 compatible provider - -#### \-\-s3\-env\-auth - -Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. - -\- Config: env_auth -\- Env Var: RCLONE_S3_ENV_AUTH -\- Type: bool -\- Default: false -\- Examples: - \- \[dq]false\[dq] - \- Enter AWS credentials in the next step - \- \[dq]true\[dq] - \- Get AWS credentials from the environment (env vars or IAM) - -#### \-\-s3\-access\-key\-id - -AWS Access Key ID. -Leave blank for anonymous access or runtime credentials. - -\- Config: access_key_id -\- Env Var: RCLONE_S3_ACCESS_KEY_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-secret\-access\-key - -AWS Secret Access Key (password) -Leave blank for anonymous access or runtime credentials. - -\- Config: secret_access_key -\- Env Var: RCLONE_S3_SECRET_ACCESS_KEY -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-region - -Region to connect to. - -\- Config: region -\- Env Var: RCLONE_S3_REGION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]us\-east\-1\[dq] - \- The default endpoint \- a good choice if you are unsure. - \- US Region, Northern Virginia or Pacific Northwest. - \- Leave location constraint empty. - \- \[dq]us\-east\-2\[dq] - \- US East (Ohio) Region - \- Needs location constraint us\-east\-2. - \- \[dq]us\-west\-2\[dq] - \- US West (Oregon) Region - \- Needs location constraint us\-west\-2. - \- \[dq]us\-west\-1\[dq] - \- US West (Northern California) Region - \- Needs location constraint us\-west\-1. - \- \[dq]ca\-central\-1\[dq] - \- Canada (Central) Region - \- Needs location constraint ca\-central\-1. - \- \[dq]eu\-west\-1\[dq] - \- EU (Ireland) Region - \- Needs location constraint EU or eu\-west\-1. - \- \[dq]eu\-west\-2\[dq] - \- EU (London) Region - \- Needs location constraint eu\-west\-2. - \- \[dq]eu\-north\-1\[dq] - \- EU (Stockholm) Region - \- Needs location constraint eu\-north\-1. - \- \[dq]eu\-central\-1\[dq] - \- EU (Frankfurt) Region - \- Needs location constraint eu\-central\-1. - \- \[dq]ap\-southeast\-1\[dq] - \- Asia Pacific (Singapore) Region - \- Needs location constraint ap\-southeast\-1. - \- \[dq]ap\-southeast\-2\[dq] - \- Asia Pacific (Sydney) Region - \- Needs location constraint ap\-southeast\-2. - \- \[dq]ap\-northeast\-1\[dq] - \- Asia Pacific (Tokyo) Region - \- Needs location constraint ap\-northeast\-1. - \- \[dq]ap\-northeast\-2\[dq] - \- Asia Pacific (Seoul) - \- Needs location constraint ap\-northeast\-2. - \- \[dq]ap\-south\-1\[dq] - \- Asia Pacific (Mumbai) - \- Needs location constraint ap\-south\-1. - \- \[dq]ap\-east\-1\[dq] - \- Asia Patific (Hong Kong) Region - \- Needs location constraint ap\-east\-1. - \- \[dq]sa\-east\-1\[dq] - \- South America (Sao Paulo) Region - \- Needs location constraint sa\-east\-1. - -#### \-\-s3\-region - -Region to connect to. - -\- Config: region -\- Env Var: RCLONE_S3_REGION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]nl\-ams\[dq] - \- Amsterdam, The Netherlands - \- \[dq]fr\-par\[dq] - \- Paris, France - -#### \-\-s3\-region - -Region to connect to. -Leave blank if you are using an S3 clone and you don\[aq]t have a region. - -\- Config: region -\- Env Var: RCLONE_S3_REGION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Use this if unsure. Will use v4 signatures and an empty region. - \- \[dq]other\-v2\-signature\[dq] - \- Use this only if v4 signatures don\[aq]t work, eg pre Jewel/v10 CEPH. - -#### \-\-s3\-endpoint - -Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-endpoint - -Endpoint for IBM COS S3 API. -Specify if using an IBM COS On Premise. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]s3.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Endpoint - \- \[dq]s3.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Dallas Endpoint - \- \[dq]s3.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Washington DC Endpoint - \- \[dq]s3.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region San Jose Endpoint - \- \[dq]s3.private.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Private Endpoint - \- \[dq]s3.private.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Dallas Private Endpoint - \- \[dq]s3.private.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region Washington DC Private Endpoint - \- \[dq]s3.private.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Cross Region San Jose Private Endpoint - \- \[dq]s3.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region East Endpoint - \- \[dq]s3.private.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region East Private Endpoint - \- \[dq]s3.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region South Endpoint - \- \[dq]s3.private.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] - \- US Region South Private Endpoint - \- \[dq]s3.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Endpoint - \- \[dq]s3.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Frankfurt Endpoint - \- \[dq]s3.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Milan Endpoint - \- \[dq]s3.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Amsterdam Endpoint - \- \[dq]s3.private.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Private Endpoint - \- \[dq]s3.private.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Frankfurt Private Endpoint - \- \[dq]s3.private.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Milan Private Endpoint - \- \[dq]s3.private.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Cross Region Amsterdam Private Endpoint - \- \[dq]s3.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] - \- Great Britain Endpoint - \- \[dq]s3.private.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] - \- Great Britain Private Endpoint - \- \[dq]s3.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Region DE Endpoint - \- \[dq]s3.private.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] - \- EU Region DE Private Endpoint - \- \[dq]s3.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Endpoint - \- \[dq]s3.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Tokyo Endpoint - \- \[dq]s3.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional HongKong Endpoint - \- \[dq]s3.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Seoul Endpoint - \- \[dq]s3.private.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Private Endpoint - \- \[dq]s3.private.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Tokyo Private Endpoint - \- \[dq]s3.private.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional HongKong Private Endpoint - \- \[dq]s3.private.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Cross Regional Seoul Private Endpoint - \- \[dq]s3.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Japan Endpoint - \- \[dq]s3.private.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Japan Private Endpoint - \- \[dq]s3.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Australia Endpoint - \- \[dq]s3.private.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] - \- APAC Region Australia Private Endpoint - \- \[dq]s3.ams03.cloud\-object\-storage.appdomain.cloud\[dq] - \- Amsterdam Single Site Endpoint - \- \[dq]s3.private.ams03.cloud\-object\-storage.appdomain.cloud\[dq] - \- Amsterdam Single Site Private Endpoint - \- \[dq]s3.che01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Chennai Single Site Endpoint - \- \[dq]s3.private.che01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Chennai Single Site Private Endpoint - \- \[dq]s3.mel01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Melbourne Single Site Endpoint - \- \[dq]s3.private.mel01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Melbourne Single Site Private Endpoint - \- \[dq]s3.osl01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Oslo Single Site Endpoint - \- \[dq]s3.private.osl01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Oslo Single Site Private Endpoint - \- \[dq]s3.tor01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Toronto Single Site Endpoint - \- \[dq]s3.private.tor01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Toronto Single Site Private Endpoint - \- \[dq]s3.seo01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Seoul Single Site Endpoint - \- \[dq]s3.private.seo01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Seoul Single Site Private Endpoint - \- \[dq]s3.mon01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Montreal Single Site Endpoint - \- \[dq]s3.private.mon01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Montreal Single Site Private Endpoint - \- \[dq]s3.mex01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Mexico Single Site Endpoint - \- \[dq]s3.private.mex01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Mexico Single Site Private Endpoint - \- \[dq]s3.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] - \- San Jose Single Site Endpoint - \- \[dq]s3.private.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] - \- San Jose Single Site Private Endpoint - \- \[dq]s3.mil01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Milan Single Site Endpoint - \- \[dq]s3.private.mil01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Milan Single Site Private Endpoint - \- \[dq]s3.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] - \- Hong Kong Single Site Endpoint - \- \[dq]s3.private.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] - \- Hong Kong Single Site Private Endpoint - \- \[dq]s3.par01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Paris Single Site Endpoint - \- \[dq]s3.private.par01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Paris Single Site Private Endpoint - \- \[dq]s3.sng01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Singapore Single Site Endpoint - \- \[dq]s3.private.sng01.cloud\-object\-storage.appdomain.cloud\[dq] - \- Singapore Single Site Private Endpoint - -#### \-\-s3\-endpoint - -Endpoint for OSS API. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] - \- East China 1 (Hangzhou) - \- \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] - \- East China 2 (Shanghai) - \- \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] - \- North China 1 (Qingdao) - \- \[dq]oss\-cn\-beijing.aliyuncs.com\[dq] - \- North China 2 (Beijing) - \- \[dq]oss\-cn\-zhangjiakou.aliyuncs.com\[dq] - \- North China 3 (Zhangjiakou) - \- \[dq]oss\-cn\-huhehaote.aliyuncs.com\[dq] - \- North China 5 (Huhehaote) - \- \[dq]oss\-cn\-shenzhen.aliyuncs.com\[dq] - \- South China 1 (Shenzhen) - \- \[dq]oss\-cn\-hongkong.aliyuncs.com\[dq] - \- Hong Kong (Hong Kong) - \- \[dq]oss\-us\-west\-1.aliyuncs.com\[dq] - \- US West 1 (Silicon Valley) - \- \[dq]oss\-us\-east\-1.aliyuncs.com\[dq] - \- US East 1 (Virginia) - \- \[dq]oss\-ap\-southeast\-1.aliyuncs.com\[dq] - \- Southeast Asia Southeast 1 (Singapore) - \- \[dq]oss\-ap\-southeast\-2.aliyuncs.com\[dq] - \- Asia Pacific Southeast 2 (Sydney) - \- \[dq]oss\-ap\-southeast\-3.aliyuncs.com\[dq] - \- Southeast Asia Southeast 3 (Kuala Lumpur) - \- \[dq]oss\-ap\-southeast\-5.aliyuncs.com\[dq] - \- Asia Pacific Southeast 5 (Jakarta) - \- \[dq]oss\-ap\-northeast\-1.aliyuncs.com\[dq] - \- Asia Pacific Northeast 1 (Japan) - \- \[dq]oss\-ap\-south\-1.aliyuncs.com\[dq] - \- Asia Pacific South 1 (Mumbai) - \- \[dq]oss\-eu\-central\-1.aliyuncs.com\[dq] - \- Central Europe 1 (Frankfurt) - \- \[dq]oss\-eu\-west\-1.aliyuncs.com\[dq] - \- West Europe (London) - \- \[dq]oss\-me\-east\-1.aliyuncs.com\[dq] - \- Middle East 1 (Dubai) - -#### \-\-s3\-endpoint - -Endpoint for Scaleway Object Storage. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]s3.nl\-ams.scw.cloud\[dq] - \- Amsterdam Endpoint - \- \[dq]s3.fr\-par.scw.cloud\[dq] - \- Paris Endpoint - -#### \-\-s3\-endpoint - -Endpoint for StackPath Object Storage. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]s3.us\-east\-2.stackpathstorage.com\[dq] - \- US East Endpoint - \- \[dq]s3.us\-west\-1.stackpathstorage.com\[dq] - \- US West Endpoint - \- \[dq]s3.eu\-central\-1.stackpathstorage.com\[dq] - \- EU Endpoint - -#### \-\-s3\-endpoint - -Endpoint for S3 API. -Required when using an S3 clone. - -\- Config: endpoint -\- Env Var: RCLONE_S3_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]objects\-us\-east\-1.dream.io\[dq] - \- Dream Objects endpoint - \- \[dq]nyc3.digitaloceanspaces.com\[dq] - \- Digital Ocean Spaces New York 3 - \- \[dq]ams3.digitaloceanspaces.com\[dq] - \- Digital Ocean Spaces Amsterdam 3 - \- \[dq]sgp1.digitaloceanspaces.com\[dq] - \- Digital Ocean Spaces Singapore 1 - \- \[dq]s3.wasabisys.com\[dq] - \- Wasabi US East endpoint - \- \[dq]s3.us\-west\-1.wasabisys.com\[dq] - \- Wasabi US West endpoint - \- \[dq]s3.eu\-central\-1.wasabisys.com\[dq] - \- Wasabi EU Central endpoint - -#### \-\-s3\-location\-constraint - -Location constraint \- must be set to match the Region. -Used when creating buckets only. - -\- Config: location_constraint -\- Env Var: RCLONE_S3_LOCATION_CONSTRAINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Empty for US Region, Northern Virginia or Pacific Northwest. - \- \[dq]us\-east\-2\[dq] - \- US East (Ohio) Region. - \- \[dq]us\-west\-2\[dq] - \- US West (Oregon) Region. - \- \[dq]us\-west\-1\[dq] - \- US West (Northern California) Region. - \- \[dq]ca\-central\-1\[dq] - \- Canada (Central) Region. - \- \[dq]eu\-west\-1\[dq] - \- EU (Ireland) Region. - \- \[dq]eu\-west\-2\[dq] - \- EU (London) Region. - \- \[dq]eu\-north\-1\[dq] - \- EU (Stockholm) Region. - \- \[dq]EU\[dq] - \- EU Region. - \- \[dq]ap\-southeast\-1\[dq] - \- Asia Pacific (Singapore) Region. - \- \[dq]ap\-southeast\-2\[dq] - \- Asia Pacific (Sydney) Region. - \- \[dq]ap\-northeast\-1\[dq] - \- Asia Pacific (Tokyo) Region. - \- \[dq]ap\-northeast\-2\[dq] - \- Asia Pacific (Seoul) - \- \[dq]ap\-south\-1\[dq] - \- Asia Pacific (Mumbai) - \- \[dq]ap\-east\-1\[dq] - \- Asia Pacific (Hong Kong) - \- \[dq]sa\-east\-1\[dq] - \- South America (Sao Paulo) Region. - -#### \-\-s3\-location\-constraint - -Location constraint \- must match endpoint when using IBM Cloud Public. -For on\-prem COS, do not make a selection from this list, hit enter - -\- Config: location_constraint -\- Env Var: RCLONE_S3_LOCATION_CONSTRAINT -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]us\-standard\[dq] - \- US Cross Region Standard - \- \[dq]us\-vault\[dq] - \- US Cross Region Vault - \- \[dq]us\-cold\[dq] - \- US Cross Region Cold - \- \[dq]us\-flex\[dq] - \- US Cross Region Flex - \- \[dq]us\-east\-standard\[dq] - \- US East Region Standard - \- \[dq]us\-east\-vault\[dq] - \- US East Region Vault - \- \[dq]us\-east\-cold\[dq] - \- US East Region Cold - \- \[dq]us\-east\-flex\[dq] - \- US East Region Flex - \- \[dq]us\-south\-standard\[dq] - \- US South Region Standard - \- \[dq]us\-south\-vault\[dq] - \- US South Region Vault - \- \[dq]us\-south\-cold\[dq] - \- US South Region Cold - \- \[dq]us\-south\-flex\[dq] - \- US South Region Flex - \- \[dq]eu\-standard\[dq] - \- EU Cross Region Standard - \- \[dq]eu\-vault\[dq] - \- EU Cross Region Vault - \- \[dq]eu\-cold\[dq] - \- EU Cross Region Cold - \- \[dq]eu\-flex\[dq] - \- EU Cross Region Flex - \- \[dq]eu\-gb\-standard\[dq] - \- Great Britain Standard - \- \[dq]eu\-gb\-vault\[dq] - \- Great Britain Vault - \- \[dq]eu\-gb\-cold\[dq] - \- Great Britain Cold - \- \[dq]eu\-gb\-flex\[dq] - \- Great Britain Flex - \- \[dq]ap\-standard\[dq] - \- APAC Standard - \- \[dq]ap\-vault\[dq] - \- APAC Vault - \- \[dq]ap\-cold\[dq] - \- APAC Cold - \- \[dq]ap\-flex\[dq] - \- APAC Flex - \- \[dq]mel01\-standard\[dq] - \- Melbourne Standard - \- \[dq]mel01\-vault\[dq] - \- Melbourne Vault - \- \[dq]mel01\-cold\[dq] - \- Melbourne Cold - \- \[dq]mel01\-flex\[dq] - \- Melbourne Flex - \- \[dq]tor01\-standard\[dq] - \- Toronto Standard - \- \[dq]tor01\-vault\[dq] - \- Toronto Vault - \- \[dq]tor01\-cold\[dq] - \- Toronto Cold - \- \[dq]tor01\-flex\[dq] - \- Toronto Flex - -#### \-\-s3\-location\-constraint - -Location constraint \- must be set to match the Region. -Leave blank if not sure. Used when creating buckets only. - -\- Config: location_constraint -\- Env Var: RCLONE_S3_LOCATION_CONSTRAINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-acl - -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. - -\- Config: acl -\- Env Var: RCLONE_S3_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]private\[dq] - \- Owner gets FULL_CONTROL. No one else has access rights (default). - \- \[dq]public\-read\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ access. - \- \[dq]public\-read\-write\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - \- Granting this on a bucket is generally not recommended. - \- \[dq]authenticated\-read\[dq] - \- Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - \- \[dq]bucket\-owner\-read\[dq] - \- Object owner gets FULL_CONTROL. Bucket owner gets READ access. - \- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - \- \[dq]bucket\-owner\-full\-control\[dq] - \- Both the object owner and the bucket owner get FULL_CONTROL over the object. - \- If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - \- \[dq]private\[dq] - \- Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise COS - \- \[dq]public\-read\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise IBM COS - \- \[dq]public\-read\-write\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On\-Premise IBM COS - \- \[dq]authenticated\-read\[dq] - \- Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS - -#### \-\-s3\-server\-side\-encryption - -The server\-side encryption algorithm used when storing this object in S3. - -\- Config: server_side_encryption -\- Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - \- \[dq]AES256\[dq] - \- AES256 - \- \[dq]aws:kms\[dq] - \- aws:kms - -#### \-\-s3\-sse\-kms\-key\-id - -If using KMS ID you must provide the ARN of Key. - -\- Config: sse_kms_key_id -\- Env Var: RCLONE_S3_SSE_KMS_KEY_ID -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - \- \[dq]arn:aws:kms:us\-east\-1:*\[dq] - \- arn:aws:kms:* - -#### \-\-s3\-storage\-class - -The storage class to use when storing new objects in S3. - -\- Config: storage_class -\- Env Var: RCLONE_S3_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]STANDARD\[dq] - \- Standard storage class - \- \[dq]REDUCED_REDUNDANCY\[dq] - \- Reduced redundancy storage class - \- \[dq]STANDARD_IA\[dq] - \- Standard Infrequent Access storage class - \- \[dq]ONEZONE_IA\[dq] - \- One Zone Infrequent Access storage class - \- \[dq]GLACIER\[dq] - \- Glacier storage class - \- \[dq]DEEP_ARCHIVE\[dq] - \- Glacier Deep Archive storage class - \- \[dq]INTELLIGENT_TIERING\[dq] - \- Intelligent\-Tiering storage class - -#### \-\-s3\-storage\-class - -The storage class to use when storing new objects in OSS. - -\- Config: storage_class -\- Env Var: RCLONE_S3_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]STANDARD\[dq] - \- Standard storage class - \- \[dq]GLACIER\[dq] - \- Archive storage mode. - \- \[dq]STANDARD_IA\[dq] - \- Infrequent access storage mode. - -#### \-\-s3\-storage\-class - -The storage class to use when storing new objects in S3. - -\- Config: storage_class -\- Env Var: RCLONE_S3_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]STANDARD\[dq] - \- The Standard class for any upload; suitable for on\-demand content like streaming or CDN. - \- \[dq]GLACIER\[dq] - \- Archived storage; prices are lower, but it needs to be restored first to be accessed. - -### Advanced Options - -Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - -#### \-\-s3\-bucket\-acl - -Canned ACL used when creating buckets. - -For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl - -Note that this ACL is applied when only when creating buckets. If it -isn\[aq]t set then \[dq]acl\[dq] is used instead. - -\- Config: bucket_acl -\- Env Var: RCLONE_S3_BUCKET_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]private\[dq] - \- Owner gets FULL_CONTROL. No one else has access rights (default). - \- \[dq]public\-read\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ access. - \- \[dq]public\-read\-write\[dq] - \- Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - \- Granting this on a bucket is generally not recommended. - \- \[dq]authenticated\-read\[dq] - \- Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - -#### \-\-s3\-sse\-customer\-algorithm - -If using SSE\-C, the server\-side encryption algorithm used when storing this object in S3. - -\- Config: sse_customer_algorithm -\- Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - \- \[dq]AES256\[dq] - \- AES256 - -#### \-\-s3\-sse\-customer\-key - -If using SSE\-C you must provide the secret encryption key used to encrypt/decrypt your data. - -\- Config: sse_customer_key -\- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - -#### \-\-s3\-sse\-customer\-key\-md5 - -If using SSE\-C you must provide the secret encryption key MD5 checksum. - -\- Config: sse_customer_key_md5 -\- Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- None - -#### \-\-s3\-upload\-cutoff - -Cutoff for switching to chunked upload - -Any files larger than this will be uploaded in chunks of chunk_size. -The minimum is 0 and the maximum is 5GB. - -\- Config: upload_cutoff -\- Env Var: RCLONE_S3_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 200M - -#### \-\-s3\-chunk\-size - -Chunk size to use for uploading. - -When uploading files larger than upload_cutoff or files with unknown -size (eg from \[dq]rclone rcat\[dq] or uploaded with \[dq]rclone mount\[dq] or google -photos or google docs) they will be uploaded as multipart uploads -using this chunk size. - -Note that \[dq]\-\-s3\-upload\-concurrency\[dq] chunks of this size are buffered -in memory per transfer. - -If you are transferring large files over high speed links and you have -enough memory, then increasing this will speed up the transfers. - -Rclone will automatically increase the chunk size when uploading a -large file of known size to stay below the 10,000 chunks limit. - -Files of unknown size are uploaded with the configured -chunk_size. Since the default chunk size is 5MB and there can be at -most 10,000 chunks, this means that by default the maximum size of -file you can stream upload is 48GB. If you wish to stream upload -larger files then you will need to increase chunk_size. - -\- Config: chunk_size -\- Env Var: RCLONE_S3_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 5M - -#### \-\-s3\-max\-upload\-parts - -Maximum number of parts in a multipart upload. - -This option defines the maximum number of multipart chunks to use -when doing a multipart upload. - -This can be useful if a service does not support the AWS S3 -specification of 10,000 chunks. - -Rclone will automatically increase the chunk size when uploading a -large file of a known size to stay below this number of chunks limit. - - -\- Config: max_upload_parts -\- Env Var: RCLONE_S3_MAX_UPLOAD_PARTS -\- Type: int -\- Default: 10000 - -#### \-\-s3\-copy\-cutoff - -Cutoff for switching to multipart copy - -Any files larger than this that need to be server side copied will be -copied in chunks of this size. - -The minimum is 0 and the maximum is 5GB. - -\- Config: copy_cutoff -\- Env Var: RCLONE_S3_COPY_CUTOFF -\- Type: SizeSuffix -\- Default: 4.656G - -#### \-\-s3\-disable\-checksum - -Don\[aq]t store MD5 checksum with object metadata - -Normally rclone will calculate the MD5 checksum of the input before -uploading it so it can add it to metadata on the object. This is great -for data integrity checking but can cause long delays for large files -to start uploading. - -\- Config: disable_checksum -\- Env Var: RCLONE_S3_DISABLE_CHECKSUM -\- Type: bool -\- Default: false - -#### \-\-s3\-shared\-credentials\-file - -Path to the shared credentials file - -If env_auth = true then rclone can use a shared credentials file. - -If this variable is empty rclone will look for the -\[dq]AWS_SHARED_CREDENTIALS_FILE\[dq] env variable. If the env value is empty -it will default to the current user\[aq]s home directory. - - Linux/OSX: \[dq]$HOME/.aws/credentials\[dq] - Windows: \[dq]%USERPROFILE%\[rs].aws\[rs]credentials\[dq] - - -\- Config: shared_credentials_file -\- Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-profile - -Profile to use in the shared credentials file - -If env_auth = true then rclone can use a shared credentials file. This -variable controls which profile is used in that file. - -If empty it will default to the environment variable \[dq]AWS_PROFILE\[dq] or -\[dq]default\[dq] if that environment variable is also not set. - - -\- Config: profile -\- Env Var: RCLONE_S3_PROFILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-session\-token - -An AWS session token - -\- Config: session_token -\- Env Var: RCLONE_S3_SESSION_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-s3\-upload\-concurrency - -Concurrency for multipart uploads. - -This is the number of chunks of the same file that are uploaded -concurrently. - -If you are uploading small numbers of large file over high speed link -and these uploads do not fully utilize your bandwidth, then increasing -this may help to speed up the transfers. - -\- Config: upload_concurrency -\- Env Var: RCLONE_S3_UPLOAD_CONCURRENCY -\- Type: int -\- Default: 4 - -#### \-\-s3\-force\-path\-style - -If true use path style access if false use virtual hosted style. - -If this is true (the default) then rclone will use path style access, -if false then rclone will use virtual path style. See [the AWS S3 -docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access\-bucket\-intro) -for more info. - -Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to -false \- rclone will do this automatically based on the provider -setting. - -\- Config: force_path_style -\- Env Var: RCLONE_S3_FORCE_PATH_STYLE -\- Type: bool -\- Default: true - -#### \-\-s3\-v2\-auth - -If true use v2 authentication. - -If this is false (the default) then rclone will use v4 authentication. -If it is set then rclone will use v2 authentication. - -Use this only if v4 signatures don\[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 - -#### \-\-s3\-list\-chunk - -Size of listing chunk (response list for each ListObject S3 request). - -This option is also known as \[dq]MaxKeys\[dq], \[dq]max\-items\[dq], or \[dq]page\-size\[dq] from the AWS S3 specification. -Most services truncate the response list to 1000 objects even if requested more than that. -In AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). -In Ceph, this can be increased with the \[dq]rgw list buckets max chunk\[dq] option. - - -\- Config: list_chunk -\- Env Var: RCLONE_S3_LIST_CHUNK -\- Type: int -\- Default: 1000 - -#### \-\-s3\-no\-check\-bucket - -If set don\[aq]t attempt to check the bucket exists or create it - -This can be useful when trying to minimise the number of transactions -rclone does if you know the bucket exists already. - - -\- Config: no_check_bucket -\- Env Var: RCLONE_S3_NO_CHECK_BUCKET -\- Type: bool -\- Default: false - -#### \-\-s3\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_S3_ENCODING -\- Type: MultiEncoder -\- Default: Slash,InvalidUtf8,Dot - -#### \-\-s3\-memory\-pool\-flush\-time - -How often internal memory buffer pools will be flushed. -Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. -This option controls how often unused buffers will be removed from the pool. - -\- Config: memory_pool_flush_time -\- Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME -\- Type: Duration -\- Default: 1m0s - -#### \-\-s3\-memory\-pool\-use\-mmap - -Whether to use mmap buffers in internal memory pool. - -\- Config: memory_pool_use_mmap -\- Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP -\- Type: bool -\- Default: false - -### Backend commands - -Here are the commands specific to the s3 backend. - -Run them with - - rclone backend COMMAND remote: - -The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - -These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### restore - -Restore objects from GLACIER to normal storage - - rclone backend restore remote: [options] [+] - -This command can be used to restore one or more objects from GLACIER -to normal storage. - -Usage Examples: - - rclone backend restore s3:bucket/path/to/object [\-o priority=PRIORITY] [\-o lifetime=DAYS] - rclone backend restore s3:bucket/path/to/directory [\-o priority=PRIORITY] [\-o lifetime=DAYS] - rclone backend restore s3:bucket [\-o priority=PRIORITY] [\-o lifetime=DAYS] - -This flag also obeys the filters. Test first with \-i/\-\-interactive or \-\-dry\-run flags - - rclone \-i backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard - -All the objects shown will be marked for restore, then - - rclone backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard - -It returns a list of status dictionaries with Remote and Status -keys. The Status will be OK if it was successfull or an error message -if not. - - [ +{ + \[dq]Version\[dq]: \[dq]2012\-10\-17\[dq], + \[dq]Statement\[dq]: [ { - \[dq]Status\[dq]: \[dq]OK\[dq], - \[dq]Path\[dq]: \[dq]test.txt\[dq] + \[dq]Effect\[dq]: \[dq]Allow\[dq], + \[dq]Principal\[dq]: { + \[dq]AWS\[dq]: \[dq]arn:aws:iam::USER_SID:user/USER_NAME\[dq] + }, + \[dq]Action\[dq]: [ + \[dq]s3:ListBucket\[dq], + \[dq]s3:DeleteObject\[dq], + \[dq]s3:GetObject\[dq], + \[dq]s3:PutObject\[dq], + \[dq]s3:PutObjectAcl\[dq] + ], + \[dq]Resource\[dq]: [ + \[dq]arn:aws:s3:::BUCKET_NAME/*\[dq], + \[dq]arn:aws:s3:::BUCKET_NAME\[dq] + ] }, { - \[dq]Status\[dq]: \[dq]OK\[dq], - \[dq]Path\[dq]: \[dq]test/file4.txt\[dq] - } + \[dq]Effect\[dq]: \[dq]Allow\[dq], + \[dq]Action\[dq]: \[dq]s3:ListAllMyBuckets\[dq], + \[dq]Resource\[dq]: \[dq]arn:aws:s3:::*\[dq] + } ] - - - +} +\f[R] +.fi +.PP +Notes on above: +.IP "1." 3 +This is a policy that can be used when creating bucket. +It assumes that \f[C]USER_NAME\f[R] has been created. +.IP "2." 3 +The Resource entry must include both resource ARNs, as one implies the +bucket and the other implies the bucket\[aq]s objects. +.PP +For reference, here\[aq]s an Ansible +script (https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) +that will generate one or more buckets that will work with +\f[C]rclone sync\f[R]. +.SS Key Management System (KMS) +.PP +If you are using server\-side encryption with KMS then you must make +sure rclone is configured with +\f[C]server_side_encryption = aws:kms\f[R] otherwise you will find you +can\[aq]t transfer small objects \- these will create checksum errors. +.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[R] +.fi +.PP +In this case you need to +restore (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) +the object(s) in question before using rclone. +.PP +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. +.SS Standard Options +.PP +Here are the standard options specific to s3 (Amazon S3 Compliant +Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, +Dreamhost, IBM COS, Minio, and Tencent COS). +.SS \-\-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: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]AWS\[dq] +.RS 2 +.IP \[bu] 2 +Amazon Web Services (AWS) S3 +.RE +.IP \[bu] 2 +\[dq]Alibaba\[dq] +.RS 2 +.IP \[bu] 2 +Alibaba Cloud Object Storage System (OSS) formerly Aliyun +.RE +.IP \[bu] 2 +\[dq]Ceph\[dq] +.RS 2 +.IP \[bu] 2 +Ceph Object Storage +.RE +.IP \[bu] 2 +\[dq]DigitalOcean\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces +.RE +.IP \[bu] 2 +\[dq]Dreamhost\[dq] +.RS 2 +.IP \[bu] 2 +Dreamhost DreamObjects +.RE +.IP \[bu] 2 +\[dq]IBMCOS\[dq] +.RS 2 +.IP \[bu] 2 +IBM COS S3 +.RE +.IP \[bu] 2 +\[dq]Minio\[dq] +.RS 2 +.IP \[bu] 2 +Minio Object Storage +.RE +.IP \[bu] 2 +\[dq]Netease\[dq] +.RS 2 +.IP \[bu] 2 +Netease Object Storage (NOS) +.RE +.IP \[bu] 2 +\[dq]Scaleway\[dq] +.RS 2 +.IP \[bu] 2 +Scaleway Object Storage +.RE +.IP \[bu] 2 +\[dq]StackPath\[dq] +.RS 2 +.IP \[bu] 2 +StackPath Object Storage +.RE +.IP \[bu] 2 +\[dq]TencentCOS\[dq] +.RS 2 +.IP \[bu] 2 +Tencent Cloud Object Storage (COS) +.RE +.IP \[bu] 2 +\[dq]Wasabi\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi Object Storage +.RE +.IP \[bu] 2 +\[dq]Other\[dq] +.RS 2 +.IP \[bu] 2 +Any other S3 compatible provider +.RE +.RE +.SS \-\-s3\-env\-auth +.PP +Get AWS credentials from runtime (environment variables or EC2/ECS meta +data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +.IP \[bu] 2 +Config: env_auth +.IP \[bu] 2 +Env Var: RCLONE_S3_ENV_AUTH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]false\[dq] +.RS 2 +.IP \[bu] 2 +Enter AWS credentials in the next step +.RE +.IP \[bu] 2 +\[dq]true\[dq] +.RS 2 +.IP \[bu] 2 +Get AWS credentials from the environment (env vars or IAM) +.RE +.RE +.SS \-\-s3\-access\-key\-id +.PP +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +.IP \[bu] 2 +Config: access_key_id +.IP \[bu] 2 +Env Var: RCLONE_S3_ACCESS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-secret\-access\-key +.PP +AWS Secret Access Key (password) Leave blank for anonymous access or +runtime credentials. +.IP \[bu] 2 +Config: secret_access_key +.IP \[bu] 2 +Env Var: RCLONE_S3_SECRET_ACCESS_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-region +.PP +Region to connect to. +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_S3_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]us\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +The default endpoint \- a good choice if you are unsure. +.IP \[bu] 2 +US Region, Northern Virginia, or Pacific Northwest. +.IP \[bu] 2 +Leave location constraint empty. +.RE +.IP \[bu] 2 +\[dq]us\-east\-2\[dq] +.RS 2 +.IP \[bu] 2 +US East (Ohio) Region +.IP \[bu] 2 +Needs location constraint us\-east\-2. +.RE +.IP \[bu] 2 +\[dq]us\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +US West (Northern California) Region +.IP \[bu] 2 +Needs location constraint us\-west\-1. +.RE +.IP \[bu] 2 +\[dq]us\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +US West (Oregon) Region +.IP \[bu] 2 +Needs location constraint us\-west\-2. +.RE +.IP \[bu] 2 +\[dq]ca\-central\-1\[dq] +.RS 2 +.IP \[bu] 2 +Canada (Central) Region +.IP \[bu] 2 +Needs location constraint ca\-central\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Ireland) Region +.IP \[bu] 2 +Needs location constraint EU or eu\-west\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +EU (London) Region +.IP \[bu] 2 +Needs location constraint eu\-west\-2. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-3\[dq] +.RS 2 +.IP \[bu] 2 +EU (Paris) Region +.IP \[bu] 2 +Needs location constraint eu\-west\-3. +.RE +.IP \[bu] 2 +\[dq]eu\-north\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Stockholm) Region +.IP \[bu] 2 +Needs location constraint eu\-north\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Milan) Region +.IP \[bu] 2 +Needs location constraint eu\-south\-1. +.RE +.IP \[bu] 2 +\[dq]eu\-central\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Frankfurt) Region +.IP \[bu] 2 +Needs location constraint eu\-central\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Singapore) Region +.IP \[bu] 2 +Needs location constraint ap\-southeast\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Sydney) Region +.IP \[bu] 2 +Needs location constraint ap\-southeast\-2. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Tokyo) Region +.IP \[bu] 2 +Needs location constraint ap\-northeast\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Seoul) +.IP \[bu] 2 +Needs location constraint ap\-northeast\-2. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-3\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Osaka\-Local) +.IP \[bu] 2 +Needs location constraint ap\-northeast\-3. +.RE +.IP \[bu] 2 +\[dq]ap\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Mumbai) +.IP \[bu] 2 +Needs location constraint ap\-south\-1. +.RE +.IP \[bu] 2 +\[dq]ap\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Hong Kong) Region +.IP \[bu] 2 +Needs location constraint ap\-east\-1. +.RE +.IP \[bu] 2 +\[dq]sa\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +South America (Sao Paulo) Region +.IP \[bu] 2 +Needs location constraint sa\-east\-1. +.RE +.IP \[bu] 2 +\[dq]me\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Middle East (Bahrain) Region +.IP \[bu] 2 +Needs location constraint me\-south\-1. +.RE +.IP \[bu] 2 +\[dq]af\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Africa (Cape Town) Region +.IP \[bu] 2 +Needs location constraint af\-south\-1. +.RE +.IP \[bu] 2 +\[dq]cn\-north\-1\[dq] +.RS 2 +.IP \[bu] 2 +China (Beijing) Region +.IP \[bu] 2 +Needs location constraint cn\-north\-1. +.RE +.IP \[bu] 2 +\[dq]cn\-northwest\-1\[dq] +.RS 2 +.IP \[bu] 2 +China (Ningxia) Region +.IP \[bu] 2 +Needs location constraint cn\-northwest\-1. +.RE +.IP \[bu] 2 +\[dq]us\-gov\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +AWS GovCloud (US\-East) Region +.IP \[bu] 2 +Needs location constraint us\-gov\-east\-1. +.RE +.IP \[bu] 2 +\[dq]us\-gov\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +AWS GovCloud (US) Region +.IP \[bu] 2 +Needs location constraint us\-gov\-west\-1. +.RE +.RE +.SS \-\-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: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]nl\-ams\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam, The Netherlands +.RE +.IP \[bu] 2 +\[dq]fr\-par\[dq] +.RS 2 +.IP \[bu] 2 +Paris, France +.RE +.RE +.SS \-\-s3\-region +.PP +Region to connect to. +Leave blank if you are using an S3 clone and you don\[aq]t have a +region. +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_S3_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Use this if unsure. +Will use v4 signatures and an empty region. +.RE +.IP \[bu] 2 +\[dq]other\-v2\-signature\[dq] +.RS 2 +.IP \[bu] 2 +Use this only if v4 signatures don\[aq]t work, e.g. +pre Jewel/v10 CEPH. +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-endpoint +.PP +Endpoint for IBM COS S3 API. +Specify if using an IBM COS On Premise. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]s3.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Dallas Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Washington DC Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region San Jose Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.dal.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Dallas Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.wdc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Washington DC Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.sjc.us.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region San Jose Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region East Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.us\-east.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region East Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region South Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.us\-south.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +US Region South Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Frankfurt Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Milan Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Amsterdam Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.fra.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Frankfurt Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mil.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Milan Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.ams.eu.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Amsterdam Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.eu\-gb.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Region DE Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.eu\-de.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +EU Region DE Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Tokyo Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional HongKong Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Seoul Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.tok.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Tokyo Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.hkg.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional HongKong Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.seo.ap.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Seoul Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Japan Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.jp\-tok.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Japan Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Australia Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.au\-syd.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +APAC Region Australia Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.ams03.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.ams03.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.che01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Chennai Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.che01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Chennai Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mel01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mel01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.osl01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Oslo Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.osl01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Oslo Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.tor01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.tor01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.seo01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Seoul Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.seo01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Seoul Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mon01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Montreal Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mon01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Montreal Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mex01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Mexico Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mex01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Mexico Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +San Jose Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.sjc04.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +San Jose Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.mil01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Milan Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.mil01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Milan Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.hkg02.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.par01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Paris Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.par01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Paris Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.sng01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Singapore Single Site Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.private.sng01.cloud\-object\-storage.appdomain.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Singapore Single Site Private Endpoint +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for OSS API. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +East China 1 (Hangzhou) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +East China 2 (Shanghai) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 1 (Qingdao) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-beijing.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 2 (Beijing) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-zhangjiakou.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 3 (Zhangjiakou) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-huhehaote.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +North China 5 (Huhehaote) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-shenzhen.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +South China 1 (Shenzhen) +.RE +.IP \[bu] 2 +\[dq]oss\-cn\-hongkong.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong (Hong Kong) +.RE +.IP \[bu] 2 +\[dq]oss\-us\-west\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +US West 1 (Silicon Valley) +.RE +.IP \[bu] 2 +\[dq]oss\-us\-east\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +US East 1 (Virginia) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Southeast Asia Southeast 1 (Singapore) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-2.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Southeast 2 (Sydney) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-3.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Southeast Asia Southeast 3 (Kuala Lumpur) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-southeast\-5.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Southeast 5 (Jakarta) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-northeast\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Northeast 1 (Japan) +.RE +.IP \[bu] 2 +\[dq]oss\-ap\-south\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific South 1 (Mumbai) +.RE +.IP \[bu] 2 +\[dq]oss\-eu\-central\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Central Europe 1 (Frankfurt) +.RE +.IP \[bu] 2 +\[dq]oss\-eu\-west\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +West Europe (London) +.RE +.IP \[bu] 2 +\[dq]oss\-me\-east\-1.aliyuncs.com\[dq] +.RS 2 +.IP \[bu] 2 +Middle East 1 (Dubai) +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for Scaleway Object Storage. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]s3.nl\-ams.scw.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Amsterdam Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.fr\-par.scw.cloud\[dq] +.RS 2 +.IP \[bu] 2 +Paris Endpoint +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for StackPath Object Storage. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]s3.us\-east\-2.stackpathstorage.com\[dq] +.RS 2 +.IP \[bu] 2 +US East Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-west\-1.stackpathstorage.com\[dq] +.RS 2 +.IP \[bu] 2 +US West Endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-central\-1.stackpathstorage.com\[dq] +.RS 2 +.IP \[bu] 2 +EU Endpoint +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for Tencent COS API. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]cos.ap\-beijing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Beijing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-nanjing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Nanjing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-shanghai.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Shanghai Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-guangzhou.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Guangzhou Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-nanjing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Nanjing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-chengdu.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Chengdu Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-chongqing.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Chongqing Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-hongkong.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong (China) Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-singapore.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Singapore Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-mumbai.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Mumbai Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-seoul.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Seoul Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-bangkok.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Bangkok Region. +.RE +.IP \[bu] 2 +\[dq]cos.ap\-tokyo.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Tokyo Region. +.RE +.IP \[bu] 2 +\[dq]cos.na\-siliconvalley.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Silicon Valley Region. +.RE +.IP \[bu] 2 +\[dq]cos.na\-ashburn.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Virginia Region. +.RE +.IP \[bu] 2 +\[dq]cos.na\-toronto.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Region. +.RE +.IP \[bu] 2 +\[dq]cos.eu\-frankfurt.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Frankfurt Region. +.RE +.IP \[bu] 2 +\[dq]cos.eu\-moscow.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Moscow Region. +.RE +.IP \[bu] 2 +\[dq]cos.accelerate.myqcloud.com\[dq] +.RS 2 +.IP \[bu] 2 +Use Tencent COS Accelerate Endpoint. +.RE +.RE +.SS \-\-s3\-endpoint +.PP +Endpoint for S3 API. +Required when using an S3 clone. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]objects\-us\-east\-1.dream.io\[dq] +.RS 2 +.IP \[bu] 2 +Dream Objects endpoint +.RE +.IP \[bu] 2 +\[dq]nyc3.digitaloceanspaces.com\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces New York 3 +.RE +.IP \[bu] 2 +\[dq]ams3.digitaloceanspaces.com\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces Amsterdam 3 +.RE +.IP \[bu] 2 +\[dq]sgp1.digitaloceanspaces.com\[dq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces Singapore 1 +.RE +.IP \[bu] 2 +\[dq]s3.wasabisys.com\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi US East endpoint +.RE +.IP \[bu] 2 +\[dq]s3.us\-west\-1.wasabisys.com\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi US West endpoint +.RE +.IP \[bu] 2 +\[dq]s3.eu\-central\-1.wasabisys.com\[dq] +.RS 2 +.IP \[bu] 2 +Wasabi EU Central endpoint +.RE +.RE +.SS \-\-s3\-location\-constraint +.PP +Location constraint \- must be set to match the Region. +Used when creating buckets only. +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Empty for US Region, Northern Virginia, or Pacific Northwest. +.RE +.IP \[bu] 2 +\[dq]us\-east\-2\[dq] +.RS 2 +.IP \[bu] 2 +US East (Ohio) Region. +.RE +.IP \[bu] 2 +\[dq]us\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +US West (Northern California) Region. +.RE +.IP \[bu] 2 +\[dq]us\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +US West (Oregon) Region. +.RE +.IP \[bu] 2 +\[dq]ca\-central\-1\[dq] +.RS 2 +.IP \[bu] 2 +Canada (Central) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Ireland) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-2\[dq] +.RS 2 +.IP \[bu] 2 +EU (London) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-west\-3\[dq] +.RS 2 +.IP \[bu] 2 +EU (Paris) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-north\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Stockholm) Region. +.RE +.IP \[bu] 2 +\[dq]eu\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +EU (Milan) Region. +.RE +.IP \[bu] 2 +\[dq]EU\[dq] +.RS 2 +.IP \[bu] 2 +EU Region. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Singapore) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-southeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Sydney) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Tokyo) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-2\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Seoul) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-northeast\-3\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Osaka\-Local) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Mumbai) Region. +.RE +.IP \[bu] 2 +\[dq]ap\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Hong Kong) Region. +.RE +.IP \[bu] 2 +\[dq]sa\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +South America (Sao Paulo) Region. +.RE +.IP \[bu] 2 +\[dq]me\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Middle East (Bahrain) Region. +.RE +.IP \[bu] 2 +\[dq]af\-south\-1\[dq] +.RS 2 +.IP \[bu] 2 +Africa (Cape Town) Region. +.RE +.IP \[bu] 2 +\[dq]cn\-north\-1\[dq] +.RS 2 +.IP \[bu] 2 +China (Beijing) Region +.RE +.IP \[bu] 2 +\[dq]cn\-northwest\-1\[dq] +.RS 2 +.IP \[bu] 2 +China (Ningxia) Region. +.RE +.IP \[bu] 2 +\[dq]us\-gov\-east\-1\[dq] +.RS 2 +.IP \[bu] 2 +AWS GovCloud (US\-East) Region. +.RE +.IP \[bu] 2 +\[dq]us\-gov\-west\-1\[dq] +.RS 2 +.IP \[bu] 2 +AWS GovCloud (US) Region. +.RE +.RE +.SS \-\-s3\-location\-constraint +.PP +Location constraint \- must match endpoint when using IBM Cloud Public. +For on\-prem COS, do not make a selection from this list, hit enter +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]us\-standard\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Standard +.RE +.IP \[bu] 2 +\[dq]us\-vault\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Vault +.RE +.IP \[bu] 2 +\[dq]us\-cold\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Cold +.RE +.IP \[bu] 2 +\[dq]us\-flex\[dq] +.RS 2 +.IP \[bu] 2 +US Cross Region Flex +.RE +.IP \[bu] 2 +\[dq]us\-east\-standard\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Standard +.RE +.IP \[bu] 2 +\[dq]us\-east\-vault\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Vault +.RE +.IP \[bu] 2 +\[dq]us\-east\-cold\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Cold +.RE +.IP \[bu] 2 +\[dq]us\-east\-flex\[dq] +.RS 2 +.IP \[bu] 2 +US East Region Flex +.RE +.IP \[bu] 2 +\[dq]us\-south\-standard\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Standard +.RE +.IP \[bu] 2 +\[dq]us\-south\-vault\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Vault +.RE +.IP \[bu] 2 +\[dq]us\-south\-cold\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Cold +.RE +.IP \[bu] 2 +\[dq]us\-south\-flex\[dq] +.RS 2 +.IP \[bu] 2 +US South Region Flex +.RE +.IP \[bu] 2 +\[dq]eu\-standard\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Standard +.RE +.IP \[bu] 2 +\[dq]eu\-vault\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Vault +.RE +.IP \[bu] 2 +\[dq]eu\-cold\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Cold +.RE +.IP \[bu] 2 +\[dq]eu\-flex\[dq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Flex +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-standard\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Standard +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-vault\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Vault +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-cold\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Cold +.RE +.IP \[bu] 2 +\[dq]eu\-gb\-flex\[dq] +.RS 2 +.IP \[bu] 2 +Great Britain Flex +.RE +.IP \[bu] 2 +\[dq]ap\-standard\[dq] +.RS 2 +.IP \[bu] 2 +APAC Standard +.RE +.IP \[bu] 2 +\[dq]ap\-vault\[dq] +.RS 2 +.IP \[bu] 2 +APAC Vault +.RE +.IP \[bu] 2 +\[dq]ap\-cold\[dq] +.RS 2 +.IP \[bu] 2 +APAC Cold +.RE +.IP \[bu] 2 +\[dq]ap\-flex\[dq] +.RS 2 +.IP \[bu] 2 +APAC Flex +.RE +.IP \[bu] 2 +\[dq]mel01\-standard\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Standard +.RE +.IP \[bu] 2 +\[dq]mel01\-vault\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Vault +.RE +.IP \[bu] 2 +\[dq]mel01\-cold\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Cold +.RE +.IP \[bu] 2 +\[dq]mel01\-flex\[dq] +.RS 2 +.IP \[bu] 2 +Melbourne Flex +.RE +.IP \[bu] 2 +\[dq]tor01\-standard\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Standard +.RE +.IP \[bu] 2 +\[dq]tor01\-vault\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Vault +.RE +.IP \[bu] 2 +\[dq]tor01\-cold\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Cold +.RE +.IP \[bu] 2 +\[dq]tor01\-flex\[dq] +.RS 2 +.IP \[bu] 2 +Toronto Flex +.RE +.RE +.SS \-\-s3\-location\-constraint +.PP +Location constraint \- must be set to match the Region. +Leave blank if not sure. +Used when creating buckets only. +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-acl +.PP +Canned ACL used when creating buckets and storing or copying objects. +.PP +This ACL is used for creating objects and if bucket_acl isn\[aq]t set, +for creating buckets too. +.PP +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +.PP +Note that this ACL is applied when server\-side copying objects as S3 +doesn\[aq]t copy the ACL from the source but rather writes a fresh one. +.IP \[bu] 2 +Config: acl +.IP \[bu] 2 +Env Var: RCLONE_S3_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]default\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets Full_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[dq]public\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +.RE +.IP \[bu] 2 +\[dq]public\-read\-write\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +.IP \[bu] 2 +Granting this on a bucket is generally not recommended. +.RE +.IP \[bu] 2 +\[dq]authenticated\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +.RE +.IP \[bu] 2 +\[dq]bucket\-owner\-read\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets FULL_CONTROL. +Bucket owner gets READ access. +.IP \[bu] 2 +If you specify this canned ACL when creating a bucket, Amazon S3 ignores +it. +.RE +.IP \[bu] 2 +\[dq]bucket\-owner\-full\-control\[dq] +.RS 2 +.IP \[bu] 2 +Both the object owner and the bucket owner get FULL_CONTROL over the +object. +.IP \[bu] 2 +If you specify this canned ACL when creating a bucket, Amazon S3 ignores +it. +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), +On\-Premise COS +.RE +.IP \[bu] 2 +\[dq]public\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), +On\-Premise IBM COS +.RE +.IP \[bu] 2 +\[dq]public\-read\-write\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +This acl is available on IBM Cloud (Infra), On\-Premise IBM COS +.RE +.IP \[bu] 2 +\[dq]authenticated\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +Not supported on Buckets. +This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS +.RE +.RE +.SS \-\-s3\-server\-side\-encryption +.PP +The server\-side encryption algorithm used when storing this object in +S3. +.IP \[bu] 2 +Config: server_side_encryption +.IP \[bu] 2 +Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[dq]AES256\[dq] +.RS 2 +.IP \[bu] 2 +AES256 +.RE +.IP \[bu] 2 +\[dq]aws:kms\[dq] +.RS 2 +.IP \[bu] 2 +aws:kms +.RE +.RE +.SS \-\-s3\-sse\-kms\-key\-id +.PP +If using KMS ID you must provide the ARN of Key. +.IP \[bu] 2 +Config: sse_kms_key_id +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_KMS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[dq]arn:aws:kms:us\-east\-1:*\[dq] +.RS 2 +.IP \[bu] 2 +arn:aws:kms:* +.RE +.RE +.SS \-\-s3\-storage\-class +.PP +The storage class to use when storing new objects in S3. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]REDUCED_REDUNDANCY\[dq] +.RS 2 +.IP \[bu] 2 +Reduced redundancy storage class +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Standard Infrequent Access storage class +.RE +.IP \[bu] 2 +\[dq]ONEZONE_IA\[dq] +.RS 2 +.IP \[bu] 2 +One Zone Infrequent Access storage class +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Glacier storage class +.RE +.IP \[bu] 2 +\[dq]DEEP_ARCHIVE\[dq] +.RS 2 +.IP \[bu] 2 +Glacier Deep Archive storage class +.RE +.IP \[bu] 2 +\[dq]INTELLIGENT_TIERING\[dq] +.RS 2 +.IP \[bu] 2 +Intelligent\-Tiering storage class +.RE +.RE +.SS \-\-s3\-storage\-class +.PP +The storage class to use when storing new objects in OSS. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage mode. +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Infrequent access storage mode. +.RE +.RE +.SS \-\-s3\-storage\-class +.PP +The storage class to use when storing new objects in Tencent COS. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[dq]ARCHIVE\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage mode. +.RE +.IP \[bu] 2 +\[dq]STANDARD_IA\[dq] +.RS 2 +.IP \[bu] 2 +Infrequent access storage mode. +.RE +.RE +.SS \-\-s3\-storage\-class +.PP +The storage class to use when storing new objects in S3. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]STANDARD\[dq] +.RS 2 +.IP \[bu] 2 +The Standard class for any upload; suitable for on\-demand content like +streaming or CDN. +.RE +.IP \[bu] 2 +\[dq]GLACIER\[dq] +.RS 2 +.IP \[bu] 2 +Archived storage; prices are lower, but it needs to be restored first to +be accessed. +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to s3 (Amazon S3 Compliant +Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, +Dreamhost, IBM COS, Minio, and Tencent COS). +.SS \-\-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\[aq]t set then \[dq]acl\[dq] is used instead. +.IP \[bu] 2 +Config: bucket_acl +.IP \[bu] 2 +Env Var: RCLONE_S3_BUCKET_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[dq]public\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +.RE +.IP \[bu] 2 +\[dq]public\-read\-write\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +.IP \[bu] 2 +Granting this on a bucket is generally not recommended. +.RE +.IP \[bu] 2 +\[dq]authenticated\-read\[dq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +.RE +.RE +.SS \-\-s3\-requester\-pays +.PP +Enables requester pays option when interacting with S3 bucket. +.IP \[bu] 2 +Config: requester_pays +.IP \[bu] 2 +Env Var: RCLONE_S3_REQUESTER_PAYS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-sse\-customer\-algorithm +.PP +If using SSE\-C, the server\-side encryption algorithm used when storing +this object in S3. +.IP \[bu] 2 +Config: sse_customer_algorithm +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[dq]AES256\[dq] +.RS 2 +.IP \[bu] 2 +AES256 +.RE +.RE +.SS \-\-s3\-sse\-customer\-key +.PP +If using SSE\-C you must provide the secret encryption key used to +encrypt/decrypt your data. +.IP \[bu] 2 +Config: sse_customer_key +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_CUSTOMER_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.RE +.SS \-\-s3\-sse\-customer\-key\-md5 +.PP +If using SSE\-C you may provide the secret encryption key MD5 checksum +(optional). +.PP +If you leave it blank, this is calculated automatically from the +sse_customer_key provided. +.IP \[bu] 2 +Config: sse_customer_key_md5 +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5 +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.RE +.SS \-\-s3\-upload\-cutoff +.PP +Cutoff for switching to chunked upload +.PP +Any files larger than this will be uploaded in chunks of chunk_size. +The minimum is 0 and the maximum is 5GB. +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_S3_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 200M +.SS \-\-s3\-chunk\-size +.PP +Chunk size to use for uploading. +.PP +When uploading files larger than upload_cutoff or files with unknown +size (e.g. +from \[dq]rclone rcat\[dq] or uploaded with \[dq]rclone mount\[dq] or +google photos or google docs) they will be uploaded as multipart uploads +using this chunk size. +.PP +Note that \[dq]\-\-s3\-upload\-concurrency\[dq] chunks of this size are +buffered in memory per transfer. +.PP +If you are transferring large files over high\-speed links and you have +enough memory, then increasing this will speed up the transfers. +.PP +Rclone will automatically increase the chunk size when uploading a large +file of known size to stay below the 10,000 chunks limit. +.PP +Files of unknown size are uploaded with the configured chunk_size. +Since the default chunk size is 5MB and there can be at most 10,000 +chunks, this means that by default the maximum size of a file you can +stream upload is 48GB. +If you wish to stream upload larger files then you will need to increase +chunk_size. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_S3_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 5M +.SS \-\-s3\-max\-upload\-parts +.PP +Maximum number of parts in a multipart upload. +.PP +This option defines the maximum number of multipart chunks to use when +doing a multipart upload. +.PP +This can be useful if a service does not support the AWS S3 +specification of 10,000 chunks. +.PP +Rclone will automatically increase the chunk size when uploading a large +file of a known size to stay below this number of chunks limit. +.IP \[bu] 2 +Config: max_upload_parts +.IP \[bu] 2 +Env Var: RCLONE_S3_MAX_UPLOAD_PARTS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 10000 +.SS \-\-s3\-copy\-cutoff +.PP +Cutoff for switching to multipart copy +.PP +Any files larger than this that need to be server\-side copied will be +copied in chunks of this size. +.PP +The minimum is 0 and the maximum is 5GB. +.IP \[bu] 2 +Config: copy_cutoff +.IP \[bu] 2 +Env Var: RCLONE_S3_COPY_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 4.656G +.SS \-\-s3\-disable\-checksum +.PP +Don\[aq]t store MD5 checksum with object metadata +.PP +Normally rclone will calculate the MD5 checksum of the input before +uploading it so it can add it to metadata on the object. +This is great for data integrity checking but can cause long delays for +large files to start uploading. +.IP \[bu] 2 +Config: disable_checksum +.IP \[bu] 2 +Env Var: RCLONE_S3_DISABLE_CHECKSUM +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-shared\-credentials\-file +.PP +Path to the shared credentials file +.PP +If env_auth = true then rclone can use a shared credentials file. +.PP +If this variable is empty rclone will look for the +\[dq]AWS_SHARED_CREDENTIALS_FILE\[dq] env variable. +If the env value is empty it will default to the current user\[aq]s home +directory. +.IP +.nf +\f[C] +Linux/OSX: \[dq]$HOME/.aws/credentials\[dq] +Windows: \[dq]%USERPROFILE%\[rs].aws\[rs]credentials\[dq] +\f[R] +.fi +.IP \[bu] 2 +Config: shared_credentials_file +.IP \[bu] 2 +Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-profile +.PP +Profile to use in the shared credentials file +.PP +If env_auth = true then rclone can use a shared credentials file. +This variable controls which profile is used in that file. +.PP +If empty it will default to the environment variable +\[dq]AWS_PROFILE\[dq] or \[dq]default\[dq] if that environment variable +is also not set. +.IP \[bu] 2 +Config: profile +.IP \[bu] 2 +Env Var: RCLONE_S3_PROFILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-session\-token +.PP +An AWS session token +.IP \[bu] 2 +Config: session_token +.IP \[bu] 2 +Env Var: RCLONE_S3_SESSION_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-s3\-upload\-concurrency +.PP +Concurrency for multipart uploads. +.PP +This is the number of chunks of the same file that are uploaded +concurrently. +.PP +If you are uploading small numbers of large files over high\-speed links +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 \-\-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 (e.g. +AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false +\- rclone will do this automatically based on the provider setting. +.IP \[bu] 2 +Config: force_path_style +.IP \[bu] 2 +Env Var: RCLONE_S3_FORCE_PATH_STYLE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.SS \-\-s3\-v2\-auth +.PP +If true use v2 authentication. +.PP +If this is false (the default) then rclone will use v4 authentication. +If it is set then rclone will use v2 authentication. +.PP +Use this only if v4 signatures don\[aq]t work, e.g. +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 \-\-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 \-\-s3\-leave\-parts\-on\-error +.PP +If true avoid calling abort upload on a failure, leaving all +successfully uploaded parts on S3 for manual recovery. +.PP +It should be set to true for resuming uploads across different sessions. +.PP +WARNING: Storing parts of an incomplete multipart upload counts towards +space usage on S3 and will add additional costs if not cleaned up. +.IP \[bu] 2 +Config: leave_parts_on_error +.IP \[bu] 2 +Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-list\-chunk +.PP +Size of listing chunk (response list for each ListObject S3 request). +.PP +This option is also known as \[dq]MaxKeys\[dq], \[dq]max\-items\[dq], or +\[dq]page\-size\[dq] from the AWS S3 specification. +Most services truncate the response list to 1000 objects even if +requested more than that. +In AWS S3 this is a global maximum and cannot be changed, see AWS +S3 (https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html). +In Ceph, this can be increased with the \[dq]rgw list buckets max +chunk\[dq] option. +.IP \[bu] 2 +Config: list_chunk +.IP \[bu] 2 +Env Var: RCLONE_S3_LIST_CHUNK +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1000 +.SS \-\-s3\-no\-check\-bucket +.PP +If set, don\[aq]t attempt to check the bucket exists or create it +.PP +This can be useful when trying to minimise the number of transactions +rclone does if you know the bucket exists already. +.PP +It can also be needed if the user you are using does not have bucket +creation permissions. +Before v1.52.0 this would have passed silently due to a bug. +.IP \[bu] 2 +Config: no_check_bucket +.IP \[bu] 2 +Env Var: RCLONE_S3_NO_CHECK_BUCKET +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-no\-head +.PP +If set, don\[aq]t HEAD uploaded objects to check integrity +.PP +This can be useful when trying to minimise the number of transactions +rclone does. +.PP +Setting it means that if rclone receives a 200 OK message after +uploading an object with PUT then it will assume that it got uploaded +properly. +.PP +In particular it will assume: +.IP \[bu] 2 +the metadata, including modtime, storage class and content type was as +uploaded +.IP \[bu] 2 +the size was as uploaded +.PP +It reads the following items from the response for a single part PUT: +.IP \[bu] 2 +the MD5SUM +.IP \[bu] 2 +The uploaded date +.PP +For multipart uploads these items aren\[aq]t read. +.PP +If an source object of unknown length is uploaded then rclone +\f[B]will\f[R] do a HEAD request. +.PP +Setting this flag increases the chance for undetected upload failures, +in particular an incorrect size, so it isn\[aq]t recommended for normal +operation. +In practice the chance of an undetected upload failure is very small +even with this flag. +.IP \[bu] 2 +Config: no_head +.IP \[bu] 2 +Env Var: RCLONE_S3_NO_HEAD +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_S3_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8,Dot +.SS \-\-s3\-memory\-pool\-flush\-time +.PP +How often internal memory buffer pools will be flushed. +Uploads which requires additional buffers (f.e multipart) will use +memory pool for allocations. +This option controls how often unused buffers will be removed from the +pool. +.IP \[bu] 2 +Config: memory_pool_flush_time +.IP \[bu] 2 +Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \-\-s3\-memory\-pool\-use\-mmap +.PP +Whether to use mmap buffers in internal memory pool. +.IP \[bu] 2 +Config: memory_pool_use_mmap +.IP \[bu] 2 +Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-s3\-disable\-http2 +.PP +Disable usage of http2 for S3 backends +.PP +There is currently an unsolved issue with the s3 (specifically minio) +backend and HTTP/2. +HTTP/2 is enabled by default for the s3 backend but can be disabled +here. +When the issue is solved this flag will be removed. +.PP +See: https://github.com/rclone/rclone/issues/4673, +https://github.com/rclone/rclone/issues/3631 +.IP \[bu] 2 +Config: disable_http2 +.IP \[bu] 2 +Env Var: RCLONE_S3_DISABLE_HTTP2 +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Backend commands +.PP +Here are the commands specific to the s3 backend. +.PP +Run them with +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP +The help below will explain what arguments each command takes. +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP +These can be run on a running backend using the rc command +backend/command (https://rclone.org/rc/#backend/command). +.SS restore +.PP +Restore objects from GLACIER to normal storage +.IP +.nf +\f[C] +rclone backend restore remote: [options] [+] +\f[R] +.fi +.PP +This command can be used to restore one or more objects from GLACIER to +normal storage. +.PP +Usage Examples: +.IP +.nf +\f[C] +rclone backend restore s3:bucket/path/to/object [\-o priority=PRIORITY] [\-o lifetime=DAYS] +rclone backend restore s3:bucket/path/to/directory [\-o priority=PRIORITY] [\-o lifetime=DAYS] +rclone backend restore s3:bucket [\-o priority=PRIORITY] [\-o lifetime=DAYS] +\f[R] +.fi +.PP +This flag also obeys the filters. +Test first with \-i/\-\-interactive or \-\-dry\-run flags +.IP +.nf +\f[C] +rclone \-i backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard +\f[R] +.fi +.PP +All the objects shown will be marked for restore, then +.IP +.nf +\f[C] +rclone backend restore \-\-include \[dq]*.txt\[dq] s3:bucket/path \-o priority=Standard +\f[R] +.fi +.PP +It returns a list of status dictionaries with Remote and Status keys. +The Status will be OK if it was successful or an error message if not. +.IP +.nf +\f[C] +[ + { + \[dq]Status\[dq]: \[dq]OK\[dq], + \[dq]Path\[dq]: \[dq]test.txt\[dq] + }, + { + \[dq]Status\[dq]: \[dq]OK\[dq], + \[dq]Path\[dq]: \[dq]test/file4.txt\[dq] + } +] +\f[R] +.fi +.PP Options: - -\- \[dq]description\[dq]: The optional description for the job. -\- \[dq]lifetime\[dq]: Lifetime of the active copy in days -\- \[dq]priority\[dq]: Priority of restore: Standard|Expedited|Bulk - -#### list\-multipart\-uploads - +.IP \[bu] 2 +\[dq]description\[dq]: The optional description for the job. +.IP \[bu] 2 +\[dq]lifetime\[dq]: Lifetime of the active copy in days +.IP \[bu] 2 +\[dq]priority\[dq]: Priority of restore: Standard|Expedited|Bulk +.SS list\-multipart\-uploads +.PP List the unfinished multipart uploads - - rclone backend list\-multipart\-uploads remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend list\-multipart\-uploads remote: [options] [+] +\f[R] +.fi +.PP This command lists the unfinished multipart uploads in JSON format. - - rclone backend list\-multipart s3:bucket/path/to/object - +.IP +.nf +\f[C] +rclone backend list\-multipart s3:bucket/path/to/object +\f[R] +.fi +.PP It returns a dictionary of buckets with values as lists of unfinished multipart uploads. - -You can call it with no bucket in which case it lists all bucket, with -a bucket or with a bucket and path. - +.PP +You can call it with no bucket in which case it lists all bucket, with a +bucket or with a bucket and path. +.IP +.nf +\f[C] +{ + \[dq]rclone\[dq]: [ { - \[dq]rclone\[dq]: [ - { - \[dq]Initiated\[dq]: \[dq]2020\-06\-26T14:20:36Z\[dq], - \[dq]Initiator\[dq]: { - \[dq]DisplayName\[dq]: \[dq]XXX\[dq], - \[dq]ID\[dq]: \[dq]arn:aws:iam::XXX:user/XXX\[dq] - }, - \[dq]Key\[dq]: \[dq]KEY\[dq], - \[dq]Owner\[dq]: { - \[dq]DisplayName\[dq]: null, - \[dq]ID\[dq]: \[dq]XXX\[dq] - }, - \[dq]StorageClass\[dq]: \[dq]STANDARD\[dq], - \[dq]UploadId\[dq]: \[dq]XXX\[dq] - } - ], - \[dq]rclone\-1000files\[dq]: [], - \[dq]rclone\-dst\[dq]: [] + \[dq]Initiated\[dq]: \[dq]2020\-06\-26T14:20:36Z\[dq], + \[dq]Initiator\[dq]: { + \[dq]DisplayName\[dq]: \[dq]XXX\[dq], + \[dq]ID\[dq]: \[dq]arn:aws:iam::XXX:user/XXX\[dq] + }, + \[dq]Key\[dq]: \[dq]KEY\[dq], + \[dq]Owner\[dq]: { + \[dq]DisplayName\[dq]: null, + \[dq]ID\[dq]: \[dq]XXX\[dq] + }, + \[dq]StorageClass\[dq]: \[dq]STANDARD\[dq], + \[dq]UploadId\[dq]: \[dq]XXX\[dq] } - - - -#### cleanup - + ], + \[dq]rclone\-1000files\[dq]: [], + \[dq]rclone\-dst\[dq]: [] +} +\f[R] +.fi +.SS cleanup +.PP Remove unfinished multipart uploads. - - rclone backend cleanup remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend cleanup remote: [options] [+] +\f[R] +.fi +.PP This command removes unfinished multipart uploads of age greater than max\-age which defaults to 24 hours. - +.PP Note that you can use \-i/\-\-dry\-run with this command to see what it would do. - - rclone backend cleanup s3:bucket/path/to/object - rclone backend cleanup \-o max\-age=7w s3:bucket/path/to/object - +.IP +.nf +\f[C] +rclone backend cleanup s3:bucket/path/to/object +rclone backend cleanup \-o max\-age=7w s3:bucket/path/to/object +\f[R] +.fi +.PP Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc. - - +.PP Options: - -\- \[dq]max\-age\[dq]: Max age of upload to delete - - - -### Anonymous access to public buckets ### - +.IP \[bu] 2 +\[dq]max\-age\[dq]: Max age of upload to delete +.SS Anonymous access to public buckets +.PP If you want to use rclone to access a public bucket, configure with a -blank \[ga]access_key_id\[ga] and \[ga]secret_access_key\[ga]. Your config should end -up looking like this: -\f[R] -.fi -.PP -[anons3] type = s3 provider = AWS env_auth = false access_key_id = -secret_access_key = region = us\-east\-1 endpoint = location_constraint -= acl = private server_side_encryption = storage_class = +blank \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. +Your config should end up looking like this: .IP .nf \f[C] - -Then use it as normal with the name of the public bucket, eg - - rclone lsd anons3:1000genomes - +[anons3] +type = s3 +provider = AWS +env_auth = false +access_key_id = +secret_access_key = +region = us\-east\-1 +endpoint = +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.PP +Then use it as normal with the name of the public bucket, e.g. +.IP +.nf +\f[C] +rclone lsd anons3:1000genomes +\f[R] +.fi +.PP You will be able to list and copy data but not upload it. - -### Ceph ### - -[Ceph](https://ceph.com/) is an open source unified, distributed -storage system designed for excellent performance, reliability and -scalability. It has an S3 compatible object storage interface. - -To use rclone with Ceph, configure as above but leave the region blank -and set the endpoint. You should end up with something like this in -your config: - -\f[R] -.fi +.SS Ceph .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 = +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] - -If you are using an older version of CEPH, eg 10.2.x Jewel, then you -may need to supply the parameter \[ga]\-\-s3\-upload\-cutoff 0\[ga] or put this in -the config file as \[ga]upload_cutoff 0\[ga] to work around a bug which causes -uploading of small files to fail. - -Note also that Ceph sometimes puts \[ga]/\[ga] in the passwords it gives -users. If you read the secret access key using the command line tools -you will get a JSON blob with the \[ga]/\[ga] escaped as \[ga]\[rs]/\[ga]. Make sure you -only write \[ga]/\[ga] in the secret access key. - +[ceph] +type = s3 +provider = Ceph +env_auth = false +access_key_id = XXX +secret_access_key = YYY +region = +endpoint = https://ceph.endpoint.example.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.PP +If you are using an older version of CEPH, e.g. +10.2.x Jewel, then you may need to supply the parameter +\f[C]\-\-s3\-upload\-cutoff 0\f[R] or put this in the config file as +\f[C]upload_cutoff 0\f[R] to work around a bug which causes uploading of +small files to fail. +.PP +Note also that Ceph sometimes puts \f[C]/\f[R] in the passwords it gives +users. +If you read the secret access key using the command line tools you will +get a JSON blob with the \f[C]/\f[R] escaped as \f[C]\[rs]/\f[R]. +Make sure you only write \f[C]/\f[R] in the secret access key. +.PP Eg the dump from Ceph looks something like this (irrelevant keys removed). -\f[R] -.fi -.PP -{ \[dq]user_id\[dq]: \[dq]xxx\[dq], \[dq]display_name\[dq]: -\[dq]xxxx\[dq], \[dq]keys\[dq]: [ { \[dq]user\[dq]: \[dq]xxx\[dq], -\[dq]access_key\[dq]: \[dq]xxxxxx\[dq], \[dq]secret_key\[dq]: -\[dq]xxxxxx/xxxx\[dq] } ], } .IP .nf \f[C] - -Because this is a json dump, it is encoding the \[ga]/\[ga] as \[ga]\[rs]/\[ga], so if you -use the secret key as \[ga]xxxxxx/xxxx\[ga] it will work fine. - -### Dreamhost ### - -Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is -an object storage system based on CEPH. - -To use rclone with Dreamhost, configure as above but leave the region blank -and set the endpoint. You should end up with something like this in -your config: +{ + \[dq]user_id\[dq]: \[dq]xxx\[dq], + \[dq]display_name\[dq]: \[dq]xxxx\[dq], + \[dq]keys\[dq]: [ + { + \[dq]user\[dq]: \[dq]xxx\[dq], + \[dq]access_key\[dq]: \[dq]xxxxxx\[dq], + \[dq]secret_key\[dq]: \[dq]xxxxxx\[rs]/xxxx\[dq] + } + ], +} \f[R] .fi .PP -[dreamobjects] type = s3 provider = DreamHost env_auth = false -access_key_id = your_access_key secret_access_key = your_secret_key -region = endpoint = objects\-us\-west\-1.dream.io location_constraint = -acl = private server_side_encryption = storage_class = +Because this is a json dump, it is encoding the \f[C]/\f[R] as +\f[C]\[rs]/\f[R], so if you use the secret key as \f[C]xxxxxx/xxxx\f[R] +it will work fine. +.SS Dreamhost +.PP +Dreamhost DreamObjects (https://www.dreamhost.com/cloud/storage/) is an +object storage system based on CEPH. +.PP +To use rclone with Dreamhost, configure as above but leave the region +blank and set the endpoint. +You should end up with something like this in your config: .IP .nf \f[C] - -### DigitalOcean Spaces ### - -[Spaces](https://www.digitalocean.com/products/object\-storage/) is an [S3\-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean. - -To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the \[dq][Applications & API](https://cloud.digitalocean.com/settings/api/tokens)\[dq] page of the DigitalOcean control panel. They will be needed when prompted by \[ga]rclone config\[ga] for your \[ga]access_key_id\[ga] and \[ga]secret_access_key\[ga]. - -When prompted for a \[ga]region\[ga] or \[ga]location_constraint\[ga], press enter to use the default value. The region must be included in the \[ga]endpoint\[ga] setting (e.g. \[ga]nyc3.digitaloceanspaces.com\[ga]). The default values can be used for other settings. - -Going through the whole process of creating a new remote by running \[ga]rclone config\[ga], each prompt should be answered as shown below: +[dreamobjects] +type = s3 +provider = DreamHost +env_auth = false +access_key_id = your_access_key +secret_access_key = your_secret_key +region = +endpoint = objects\-us\-west\-1.dream.io +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.SS DigitalOcean Spaces +.PP +Spaces (https://www.digitalocean.com/products/object-storage/) is an +S3\-interoperable (https://developers.digitalocean.com/documentation/spaces/) +object storage service from cloud provider DigitalOcean. +.PP +To connect to DigitalOcean Spaces you will need an access key and secret +key. +These can be retrieved on the \[dq]Applications & +API (https://cloud.digitalocean.com/settings/api/tokens)\[dq] page of +the DigitalOcean control panel. +They will be needed when prompted by \f[C]rclone config\f[R] for your +\f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. +.PP +When prompted for a \f[C]region\f[R] or \f[C]location_constraint\f[R], +press enter to use the default value. +The region must be included in the \f[C]endpoint\f[R] setting (e.g. +\f[C]nyc3.digitaloceanspaces.com\f[R]). +The default values can be used for other settings. +.PP +Going through the whole process of creating a new remote by running +\f[C]rclone config\f[R], each prompt should be answered as shown below: +.IP +.nf +\f[C] +Storage> s3 +env_auth> 1 +access_key_id> YOUR_ACCESS_KEY +secret_access_key> YOUR_SECRET_KEY +region> +endpoint> nyc3.digitaloceanspaces.com +location_constraint> +acl> +storage_class> \f[R] .fi .PP -Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY -secret_access_key> YOUR_SECRET_KEY region> endpoint> -nyc3.digitaloceanspaces.com location_constraint> acl> storage_class> -.IP -.nf -\f[C] - The resulting configuration file should look like: -\f[R] -.fi -.PP -[spaces] type = s3 provider = DigitalOcean env_auth = false -access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY -region = endpoint = nyc3.digitaloceanspaces.com location_constraint = -acl = server_side_encryption = storage_class = .IP .nf \f[C] - -Once configured, you can create a new Space and begin copying files. For example: +[spaces] +type = s3 +provider = DigitalOcean +env_auth = false +access_key_id = YOUR_ACCESS_KEY +secret_access_key = YOUR_SECRET_KEY +region = +endpoint = nyc3.digitaloceanspaces.com +location_constraint = +acl = +server_side_encryption = +storage_class = \f[R] .fi .PP -rclone mkdir spaces:my\-new\-space rclone copy /path/to/files -spaces:my\-new\-space +Once configured, you can create a new Space and begin copying files. +For example: .IP .nf \f[C] - -### IBM COS (S3) ### - -Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM\[cq]s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object\-storage) - +rclone mkdir spaces:my\-new\-space +rclone copy /path/to/files spaces:my\-new\-space +\f[R] +.fi +.SS IBM COS (S3) +.PP +Information stored with IBM Cloud Object Storage is encrypted and +dispersed across multiple geographic locations, and accessed through an +implementation of the S3 API. +This service makes use of the distributed storage technologies provided +by IBM\[cq]s Cloud Object Storage System (formerly Cleversafe). +For more information visit: (http://www.ibm.com/cloud/object\-storage) +.PP To configure access to IBM COS S3, follow the steps below: - -1. Run rclone config and select n for a new remote. -\f[R] -.fi +.IP "1." 3 +Run rclone config and select n for a new remote. .IP .nf \f[C] -2018/02/14 14:13:11 NOTICE: Config file \[dq]C:\[rs]\[rs]Users\[rs]\[rs]a\[rs]\[rs].config\[rs]\[rs]rclone\[rs]\[rs]rclone.conf\[dq] not found \- using defaults + 2018/02/14 14:13:11 NOTICE: Config file \[dq]C:\[rs]\[rs]Users\[rs]\[rs]a\[rs]\[rs].config\[rs]\[rs]rclone\[rs]\[rs]rclone.conf\[dq] not found \- using defaults + No remotes found \- make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n +\f[R] +.fi +.IP "2." 3 +Enter the name for the configuration +.IP +.nf +\f[C] + name> +\f[R] +.fi +.IP "3." 3 +Select \[dq]s3\[dq] storage. +.IP +.nf +\f[C] +Choose a number from below, or type in your own value + 1 / Alias for an existing remote + \[rs] \[dq]alias\[dq] + 2 / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + \[rs] \[dq]s3\[dq] + 4 / Backblaze B2 + \[rs] \[dq]b2\[dq] +[snip] + 23 / http Connection + \[rs] \[dq]http\[dq] +Storage> 3 +\f[R] +.fi +.IP "4." 3 +Select IBM COS as the S3 Storage Provider. +.IP +.nf +\f[C] +Choose the S3 provider. +Choose a number from below, or type in your own value + 1 / Choose this option to configure Storage to AWS S3 + \[rs] \[dq]AWS\[dq] + 2 / Choose this option to configure Storage to Ceph Systems + \[rs] \[dq]Ceph\[dq] + 3 / Choose this option to configure Storage to Dreamhost + \[rs] \[dq]Dreamhost\[dq] + 4 / Choose this option to the configure Storage to IBM COS S3 + \[rs] \[dq]IBMCOS\[dq] + 5 / Choose this option to the configure Storage to Minio + \[rs] \[dq]Minio\[dq] + Provider>4 +\f[R] +.fi +.IP "5." 3 +Enter the Access Key and Secret. +.IP +.nf +\f[C] + AWS Access Key ID \- leave blank for anonymous access or runtime credentials. + access_key_id> <> + AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. + secret_access_key> <> +\f[R] +.fi +.IP "6." 3 +Specify the endpoint for IBM COS. +For Public IBM COS, choose from the option below. +For On Premise IBM COS, enter an endpoint address. +.IP +.nf +\f[C] + Endpoint for IBM COS S3 API. + Specify if using an IBM COS On Premise. + Choose a number from below, or type in your own value + 1 / US Cross Region Endpoint + \[rs] \[dq]s3\-api.us\-geo.objectstorage.softlayer.net\[dq] + 2 / US Cross Region Dallas Endpoint + \[rs] \[dq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[dq] + 3 / US Cross Region Washington DC Endpoint + \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[dq] + 4 / US Cross Region San Jose Endpoint + \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[dq] + 5 / US Cross Region Private Endpoint + \[rs] \[dq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[dq] + 6 / US Cross Region Dallas Private Endpoint + \[rs] \[dq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[dq] + 7 / US Cross Region Washington DC Private Endpoint + \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[dq] + 8 / US Cross Region San Jose Private Endpoint + \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[dq] + 9 / US Region East Endpoint + \[rs] \[dq]s3.us\-east.objectstorage.softlayer.net\[dq] + 10 / US Region East Private Endpoint + \[rs] \[dq]s3.us\-east.objectstorage.service.networklayer.com\[dq] + 11 / US Region South Endpoint +[snip] + 34 / Toronto Single Site Private Endpoint + \[rs] \[dq]s3.tor01.objectstorage.service.networklayer.com\[dq] + endpoint>1 +\f[R] +.fi +.IP "7." 3 +Specify a IBM COS Location Constraint. +The location constraint must match endpoint when using IBM Cloud Public. +For on\-prem COS, do not make a selection from this list, hit enter +.IP +.nf +\f[C] + 1 / US Cross Region Standard + \[rs] \[dq]us\-standard\[dq] + 2 / US Cross Region Vault + \[rs] \[dq]us\-vault\[dq] + 3 / US Cross Region Cold + \[rs] \[dq]us\-cold\[dq] + 4 / US Cross Region Flex + \[rs] \[dq]us\-flex\[dq] + 5 / US East Region Standard + \[rs] \[dq]us\-east\-standard\[dq] + 6 / US East Region Vault + \[rs] \[dq]us\-east\-vault\[dq] + 7 / US East Region Cold + \[rs] \[dq]us\-east\-cold\[dq] + 8 / US East Region Flex + \[rs] \[dq]us\-east\-flex\[dq] + 9 / US South Region Standard + \[rs] \[dq]us\-south\-standard\[dq] + 10 / US South Region Vault + \[rs] \[dq]us\-south\-vault\[dq] +[snip] + 32 / Toronto Flex + \[rs] \[dq]tor01\-flex\[dq] +location_constraint>1 +\f[R] +.fi +.IP "9." 3 +Specify a canned ACL. +IBM Cloud (Storage) supports \[dq]public\-read\[dq] and +\[dq]private\[dq]. +IBM Cloud(Infra) supports all the canned ACLs. +On\-Premise COS supports all the canned ACLs. +.IP +.nf +\f[C] +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise COS + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise IBM COS + \[rs] \[dq]public\-read\[dq] + 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On\-Premise IBM COS + \[rs] \[dq]public\-read\-write\[dq] + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS + \[rs] \[dq]authenticated\-read\[dq] +acl> 1 +\f[R] +.fi +.IP "12." 4 +Review the displayed configuration and accept to save the +\[dq]remote\[dq] then quit. +The config file should look like this +.IP +.nf +\f[C] + [xxx] + type = s3 + Provider = IBMCOS + access_key_id = xxx + secret_access_key = yyy + endpoint = s3\-api.us\-geo.objectstorage.softlayer.net + location_constraint = us\-standard + acl = private +\f[R] +.fi +.IP "13." 4 +Execute rclone commands +.IP +.nf +\f[C] + 1) Create a bucket. + rclone mkdir IBM\-COS\-XREGION:newbucket + 2) List available buckets. + rclone lsd IBM\-COS\-XREGION: + \-1 2017\-11\-08 21:16:22 \-1 test + \-1 2018\-02\-14 20:16:39 \-1 newbucket + 3) List contents of a bucket. + rclone ls IBM\-COS\-XREGION:newbucket + 18685952 test.exe + 4) Copy a file from local to remote. + rclone copy /Users/file.txt IBM\-COS\-XREGION:newbucket + 5) Copy a file from remote to local. + rclone copy IBM\-COS\-XREGION:newbucket/file.txt . + 6) Delete a file on remote. + rclone delete IBM\-COS\-XREGION:newbucket/file.txt +\f[R] +.fi +.SS Minio +.PP +Minio (https://minio.io/) is an object storage server built for cloud +application developers and devops. +.PP +It is very easy to install and provides an S3 compatible server which +can be used by rclone. +.PP +To use it, install Minio following the instructions +here (https://docs.minio.io/docs/minio-quickstart-guide). +.PP +When it configures itself Minio will print something like this +.IP +.nf +\f[C] +Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 +AccessKey: USWUXHGYZQYFYFFIT3RE +SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +Region: us\-east\-1 +SQS ARNs: arn:minio:sqs:us\-east\-1:1:redis arn:minio:sqs:us\-east\-1:2:redis + +Browser Access: + http://192.168.1.106:9000 http://172.23.0.1:9000 + +Command\-line Access: https://docs.minio.io/docs/minio\-client\-quickstart\-guide + $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + +Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang\-client\-quickstart\-guide + Java: https://docs.minio.io/docs/java\-client\-quickstart\-guide + Python: https://docs.minio.io/docs/python\-client\-quickstart\-guide + JavaScript: https://docs.minio.io/docs/javascript\-client\-quickstart\-guide + .NET: https://docs.minio.io/docs/dotnet\-client\-quickstart\-guide + +Drive Capacity: 26 GiB Free, 165 GiB Total +\f[R] +.fi +.PP +These details need to go into \f[C]rclone config\f[R] like this. +Note that it is important to put the region in as stated above. +.IP +.nf +\f[C] +env_auth> 1 +access_key_id> USWUXHGYZQYFYFFIT3RE +secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +region> us\-east\-1 +endpoint> http://192.168.1.106:9000 +location_constraint> +server_side_encryption> +\f[R] +.fi +.PP +Which makes the config file look like this +.IP +.nf +\f[C] +[minio] +type = s3 +provider = Minio +env_auth = false +access_key_id = USWUXHGYZQYFYFFIT3RE +secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 +region = us\-east\-1 +endpoint = http://192.168.1.106:9000 +location_constraint = +server_side_encryption = +\f[R] +.fi +.PP +So once set up, for example to copy files into a bucket +.IP +.nf +\f[C] +rclone copy /path/to/files minio:bucket +\f[R] +.fi +.SS Scaleway +.PP +Scaleway (https://www.scaleway.com/object-storage/) The Object Storage +platform allows you to store anything from backups, logs and web assets +to documents and photos. +Files can be dropped from the Scaleway console or transferred through +our API and CLI or using any S3\-compatible tool. +.PP +Scaleway provides an S3 interface which can be configured for use with +rclone like this: +.IP +.nf +\f[C] +[scaleway] +type = s3 +provider = Scaleway +env_auth = false +endpoint = s3.nl\-ams.scw.cloud +access_key_id = SCWXXXXXXXXXXXXXX +secret_access_key = 1111111\-2222\-3333\-44444\-55555555555555 +region = nl\-ams +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.SS Wasabi +.PP +Wasabi (https://wasabi.com) is a cloud\-based object storage service for +a broad range of applications and use cases. +Wasabi is designed for individuals and organizations that require a +high\-performance, reliable, and secure data storage infrastructure at +minimal cost. +.PP +Wasabi provides an S3 interface which can be configured for use with +rclone like this. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +n/s> n +name> wasabi +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon S3 (also Dreamhost, Ceph, Minio) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> YOURACCESSKEY +AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> YOURSECRETACCESSKEY +Region to connect to. +Choose a number from below, or type in your own value + / The default endpoint \- a good choice if you are unsure. + 1 | US Region, Northern Virginia, or Pacific Northwest. + | Leave location constraint empty. + \[rs] \[dq]us\-east\-1\[dq] +[snip] +region> us\-east\-1 +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +Specify if using an S3 clone such as Ceph. +endpoint> s3.wasabisys.com +Location constraint \- must be set to match the Region. Used when creating buckets only. +Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia, or Pacific Northwest. + \[rs] \[dq]\[dq] +[snip] +location_constraint> +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] +[snip] +acl> +The server\-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value + 1 / None + \[rs] \[dq]\[dq] + 2 / AES256 + \[rs] \[dq]AES256\[dq] +server_side_encryption> +The storage class to use when storing objects in S3. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Reduced redundancy storage class + \[rs] \[dq]REDUCED_REDUNDANCY\[dq] + 4 / Standard Infrequent Access storage class + \[rs] \[dq]STANDARD_IA\[dq] +storage_class> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[wasabi] +env_auth = false +access_key_id = YOURACCESSKEY +secret_access_key = YOURSECRETACCESSKEY +region = us\-east\-1 +endpoint = s3.wasabisys.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +This will leave the config file looking like this. +.IP +.nf +\f[C] +[wasabi] +type = s3 +provider = Wasabi +env_auth = false +access_key_id = YOURACCESSKEY +secret_access_key = YOURSECRETACCESSKEY +region = +endpoint = s3.wasabisys.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.SS Alibaba OSS +.PP +Here is an example of making an Alibaba Cloud (Aliyun) +OSS (https://www.alibabacloud.com/product/oss/) configuration. +First run: +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> oss +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Choose your S3 provider. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] + 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun + \[rs] \[dq]Alibaba\[dq] + 3 / Ceph Object Storage + \[rs] \[dq]Ceph\[dq] +[snip] +provider> Alibaba +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_key_id> accesskeyid +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +secret_access_key> secretaccesskey +Endpoint for OSS API. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / East China 1 (Hangzhou) + \[rs] \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] + 2 / East China 2 (Shanghai) + \[rs] \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] + 3 / North China 1 (Qingdao) + \[rs] \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] +[snip] +endpoint> 1 +Canned ACL used when creating buckets and storing or copying objects. + +Note that this ACL is applied when server\-side copying objects as S3 +doesn\[aq]t copy the ACL from the source but rather writes a fresh one. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \[rs] \[dq]public\-read\[dq] + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. +[snip] +acl> 1 +The storage class to use when storing new objects in OSS. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Archive storage mode. + \[rs] \[dq]GLACIER\[dq] + 4 / Infrequent access storage mode. + \[rs] \[dq]STANDARD_IA\[dq] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[oss] +type = s3 +provider = Alibaba +env_auth = false +access_key_id = accesskeyid +secret_access_key = secretaccesskey +endpoint = oss\-cn\-hangzhou.aliyuncs.com +acl = private +storage_class = Standard +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Tencent COS +.PP +Tencent Cloud Object Storage +(COS) (https://intl.cloud.tencent.com/product/cos) is a distributed +storage service offered by Tencent Cloud for unstructured data. +It is secure, stable, massive, convenient, low\-delay and low\-cost. +.PP +To configure access to Tencent COS, follow the steps below: +.IP "1." 3 +Run \f[C]rclone config\f[R] and select \f[C]n\f[R] for a new remote. +.IP +.nf +\f[C] +rclone config No remotes found \- make a new one n) New remote s) Set configuration password @@ -15135,5413 +20115,7717 @@ q) Quit config n/s/q> n \f[R] .fi +.IP "2." 3 +Give the name of the configuration. +For example, name it \[aq]cos\[aq]. .IP .nf \f[C] - -2. Enter the name for the configuration +name> cos \f[R] .fi +.IP "3." 3 +Select \f[C]s3\f[R] storage. .IP .nf \f[C] -name> -\f[R] -.fi -.IP -.nf -\f[C] - -3. Select \[dq]s3\[dq] storage. -\f[R] -.fi -.PP -Choose a number from below, or type in your own value 1 / Alias for an -existing remote \ \[dq]alias\[dq] 2 / Amazon Drive \ \[dq]amazon cloud -drive\[dq] 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, -Minio, IBM COS) \ \[dq]s3\[dq] 4 / Backblaze B2 \ \[dq]b2\[dq] [snip] 23 -/ http Connection \ \[dq]http\[dq] Storage> 3 -.IP -.nf -\f[C] - -4. Select IBM COS as the S3 Storage Provider. -\f[R] -.fi -.PP -Choose the S3 provider. -Choose a number from below, or type in your own value 1 / Choose this -option to configure Storage to AWS S3 \ \[dq]AWS\[dq] 2 / Choose this -option to configure Storage to Ceph Systems \ \[dq]Ceph\[dq] 3 / Choose -this option to configure Storage to Dreamhost \ \[dq]Dreamhost\[dq] 4 / -Choose this option to the configure Storage to IBM COS S3 -\ \[dq]IBMCOS\[dq] 5 / Choose this option to the configure Storage to -Minio \ \[dq]Minio\[dq] Provider>4 -.IP -.nf -\f[C] - -5. Enter the Access Key and Secret. -\f[R] -.fi -.IP -.nf -\f[C] -AWS Access Key ID \- leave blank for anonymous access or runtime credentials. -access_key_id> <> -AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. -secret_access_key> <> -\f[R] -.fi -.IP -.nf -\f[C] - -6. Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an enpoint address. -\f[R] -.fi -.IP -.nf -\f[C] -Endpoint for IBM COS S3 API. -Specify if using an IBM COS On Premise. Choose a number from below, or type in your own value - 1 / US Cross Region Endpoint - \[rs] \[dq]s3\-api.us\-geo.objectstorage.softlayer.net\[dq] - 2 / US Cross Region Dallas Endpoint - \[rs] \[dq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[dq] - 3 / US Cross Region Washington DC Endpoint - \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[dq] - 4 / US Cross Region San Jose Endpoint - \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[dq] - 5 / US Cross Region Private Endpoint - \[rs] \[dq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[dq] - 6 / US Cross Region Dallas Private Endpoint - \[rs] \[dq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[dq] - 7 / US Cross Region Washington DC Private Endpoint - \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[dq] - 8 / US Cross Region San Jose Private Endpoint - \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[dq] - 9 / US Region East Endpoint - \[rs] \[dq]s3.us\-east.objectstorage.softlayer.net\[dq] -10 / US Region East Private Endpoint - \[rs] \[dq]s3.us\-east.objectstorage.service.networklayer.com\[dq] -11 / US Region South Endpoint +1 / 1Fichier + \[rs] \[dq]fichier\[dq] + 2 / Alias for an existing remote + \[rs] \[dq]alias\[dq] + 3 / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] + 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, and Tencent COS + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 \f[R] .fi -.PP -[snip] 34 / Toronto Single Site Private Endpoint -\ \[dq]s3.tor01.objectstorage.service.networklayer.com\[dq] endpoint>1 +.IP "4." 3 +Select \f[C]TencentCOS\f[R] provider. .IP .nf \f[C] - - -7. Specify a IBM COS Location Constraint. The location constraint must match endpoint when using IBM Cloud Public. For on\-prem COS, do not make a selection from this list, hit enter +Choose a number from below, or type in your own value +1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] +[snip] +11 / Tencent Cloud Object Storage (COS) + \[rs] \[dq]TencentCOS\[dq] +[snip] +provider> TencentCOS \f[R] .fi +.IP "5." 3 +Enter your SecretId and SecretKey of Tencent Cloud. .IP .nf \f[C] - 1 / US Cross Region Standard - \[rs] \[dq]us\-standard\[dq] - 2 / US Cross Region Vault - \[rs] \[dq]us\-vault\[dq] - 3 / US Cross Region Cold - \[rs] \[dq]us\-cold\[dq] - 4 / US Cross Region Flex - \[rs] \[dq]us\-flex\[dq] - 5 / US East Region Standard - \[rs] \[dq]us\-east\-standard\[dq] - 6 / US East Region Vault - \[rs] \[dq]us\-east\-vault\[dq] - 7 / US East Region Cold - \[rs] \[dq]us\-east\-cold\[dq] - 8 / US East Region Flex - \[rs] \[dq]us\-east\-flex\[dq] - 9 / US South Region Standard - \[rs] \[dq]us\-south\-standard\[dq] -10 / US South Region Vault - \[rs] \[dq]us\-south\-vault\[dq] -\f[R] -.fi -.PP -[snip] 32 / Toronto Flex \ \[dq]tor01\-flex\[dq] location_constraint>1 -.IP -.nf -\f[C] - -9. Specify a canned ACL. IBM Cloud (Strorage) supports \[dq]public\-read\[dq] and \[dq]private\[dq]. IBM Cloud(Infra) supports all the canned ACLs. On\-Premise COS supports all the canned ACLs. -\f[R] -.fi -.PP -Canned ACL used when creating buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On\-Premise COS \ \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On\-Premise IBM COS \ \[dq]public\-read\[dq] 3 / Owner gets -FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -This acl is available on IBM Cloud (Infra), On\-Premise IBM COS -\ \[dq]public\-read\-write\[dq] 4 / Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -Not supported on Buckets. -This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS -\ \[dq]authenticated\-read\[dq] acl> 1 -.IP -.nf -\f[C] - - -12. Review the displayed configuration and accept to save the \[dq]remote\[dq] then quit. The config file should look like this -\f[R] -.fi -.IP -.nf -\f[C] -[xxx] -type = s3 -Provider = IBMCOS -access_key_id = xxx -secret_access_key = yyy -endpoint = s3\-api.us\-geo.objectstorage.softlayer.net -location_constraint = us\-standard -acl = private -\f[R] -.fi -.IP -.nf -\f[C] - -13. Execute rclone commands -\f[R] -.fi -.IP -.nf -\f[C] -1) Create a bucket. - rclone mkdir IBM\-COS\-XREGION:newbucket -2) List available buckets. - rclone lsd IBM\-COS\-XREGION: - \-1 2017\-11\-08 21:16:22 \-1 test - \-1 2018\-02\-14 20:16:39 \-1 newbucket -3) List contents of a bucket. - rclone ls IBM\-COS\-XREGION:newbucket - 18685952 test.exe -4) Copy a file from local to remote. - rclone copy /Users/file.txt IBM\-COS\-XREGION:newbucket -5) Copy a file from remote to local. - rclone copy IBM\-COS\-XREGION:newbucket/file.txt . -6) Delete a file on remote. - rclone delete IBM\-COS\-XREGION:newbucket/file.txt -\f[R] -.fi -.IP -.nf -\f[C] - -### Minio ### - -[Minio](https://minio.io/) is an object storage server built for cloud application developers and devops. - -It is very easy to install and provides an S3 compatible server which can be used by rclone. - -To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio\-quickstart\-guide). - -When it configures itself Minio will print something like this -\f[R] -.fi -.PP -Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 AccessKey: -USWUXHGYZQYFYFFIT3RE SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 -Region: us\-east\-1 SQS ARNs: arn:minio:sqs:us\-east\-1:1:redis -arn:minio:sqs:us\-east\-1:2:redis -.PP -Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000 -.PP -Command\-line Access: -https://docs.minio.io/docs/minio\-client\-quickstart\-guide $ mc config -host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 -.PP -Object API (Amazon S3 compatible): Go: -https://docs.minio.io/docs/golang\-client\-quickstart\-guide Java: -https://docs.minio.io/docs/java\-client\-quickstart\-guide Python: -https://docs.minio.io/docs/python\-client\-quickstart\-guide JavaScript: -https://docs.minio.io/docs/javascript\-client\-quickstart\-guide .NET: -https://docs.minio.io/docs/dotnet\-client\-quickstart\-guide -.PP -Drive Capacity: 26 GiB Free, 165 GiB Total -.IP -.nf -\f[C] - -These details need to go into \[ga]rclone config\[ga] like this. Note that it -is important to put the region in as stated above. -\f[R] -.fi -.PP -env_auth> 1 access_key_id> USWUXHGYZQYFYFFIT3RE secret_access_key> -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region> us\-east\-1 endpoint> -http://192.168.1.106:9000 location_constraint> server_side_encryption> -.IP -.nf -\f[C] - -Which makes the config file look like this -\f[R] -.fi -.PP -[minio] type = s3 provider = Minio env_auth = false access_key_id = -USWUXHGYZQYFYFFIT3RE secret_access_key = -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us\-east\-1 endpoint = -http://192.168.1.106:9000 location_constraint = server_side_encryption = -.IP -.nf -\f[C] - -So once set up, for example to copy files into a bucket -\f[R] -.fi -.PP -rclone copy /path/to/files minio:bucket -.IP -.nf -\f[C] - -### Scaleway {#scaleway} - -[Scaleway](https://www.scaleway.com/object\-storage/) The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. -Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3\-compatible tool. - -Scaleway provides an S3 interface which can be configured for use with rclone like this: -\f[R] -.fi -.PP -[scaleway] type = s3 provider = Scaleway env_auth = false endpoint = -s3.nl\-ams.scw.cloud access_key_id = SCWXXXXXXXXXXXXXX secret_access_key -= 1111111\-2222\-3333\-44444\-55555555555555 region = nl\-ams -location_constraint = acl = private server_side_encryption = -storage_class = -.IP -.nf -\f[C] - -### Wasabi ### - -[Wasabi](https://wasabi.com) is a cloud\-based object storage service for a -broad range of applications and use cases. Wasabi is designed for -individuals and organizations that require a high\-performance, -reliable, and secure data storage infrastructure at minimal cost. - -Wasabi provides an S3 interface which can be configured for use with -rclone like this. -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password n/s> n name> wasabi Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -S3 (also Dreamhost, Ceph, Minio) \ \[dq]s3\[dq] [snip] Storage> s3 Get -AWS credentials from runtime (environment variables or EC2/ECS meta data -if no env vars). +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[dq]false\[dq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[dq]true\[dq] env_auth> 1 AWS -Access Key ID \- leave blank for anonymous access or runtime -credentials. -access_key_id> YOURACCESSKEY AWS Secret Access Key (password) \- leave -blank for anonymous access or runtime credentials. -secret_access_key> YOURSECRETACCESSKEY Region to connect to. -Choose a number from below, or type in your own value / The default -endpoint \- a good choice if you are unsure. -1 | US Region, Northern Virginia or Pacific Northwest. -| Leave location constraint empty. -\ \[dq]us\-east\-1\[dq] [snip] region> us\-east\-1 Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -Specify if using an S3 clone such as Ceph. -endpoint> s3.wasabisys.com Location constraint \- must be set to match -the Region. -Used when creating buckets only. -Choose a number from below, or type in your own value 1 / Empty for US -Region, Northern Virginia or Pacific Northwest. -\ \[dq]\[dq] [snip] location_constraint> Canned ACL used when creating -buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[dq]private\[dq] [snip] acl> The server\-side encryption algorithm -used when storing this object in S3. -Choose a number from below, or type in your own value 1 / None -\ \[dq]\[dq] 2 / AES256 \ \[dq]AES256\[dq] server_side_encryption> The -storage class to use when storing objects in S3. -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Standard storage class \ \[dq]STANDARD\[dq] 3 / Reduced -redundancy storage class \ \[dq]REDUCED_REDUNDANCY\[dq] 4 / Standard -Infrequent Access storage class \ \[dq]STANDARD_IA\[dq] storage_class> -Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [wasabi] env_auth -= false access_key_id = YOURACCESSKEY secret_access_key = -YOURSECRETACCESSKEY region = us\-east\-1 endpoint = s3.wasabisys.com -location_constraint = acl = server_side_encryption = storage_class = -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -This will leave the config file looking like this. -\f[R] -.fi -.PP -[wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint -= s3.wasabisys.com location_constraint = acl = server_side_encryption = -storage_class = -.IP -.nf -\f[C] - -### Alibaba OSS {#alibaba\-oss} - -Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/) -configuration. First run: - - rclone config - -This will guide you through an interactive setup process. -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> oss Type of storage to configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] 4 / Amazon -S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, -Dreamhost, IBM COS, Minio, etc) \ \[dq]s3\[dq] [snip] Storage> s3 Choose -your S3 provider. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Amazon Web -Services (AWS) S3 \ \[dq]AWS\[dq] 2 / Alibaba Cloud Object Storage -System (OSS) formerly Aliyun \ \[dq]Alibaba\[dq] 3 / Ceph Object Storage -\ \[dq]Ceph\[dq] [snip] provider> Alibaba Get AWS credentials from -runtime (environment variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Enter a boolean value (true or false). -Press Enter for the default (\[dq]false\[dq]). -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[dq]false\[dq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[dq]true\[dq] env_auth> 1 AWS -Access Key ID. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID. Leave blank for anonymous access or runtime credentials. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -access_key_id> accesskeyid AWS Secret Access Key (password) Leave blank -for anonymous access or runtime credentials. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -secret_access_key> secretaccesskey Endpoint for OSS API. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / East China 1 -(Hangzhou) \ \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] 2 / East China 2 -(Shanghai) \ \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] 3 / North China 1 -(Qingdao) \ \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] [snip] endpoint> 1 -Canned ACL used when creating buckets and storing or copying objects. -.PP -Note that this ACL is applied when server side copying objects as S3 -doesn\[aq]t copy the ACL from the source but rather writes a fresh one. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[dq]private\[dq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -\ \[dq]public\-read\[dq] / Owner gets FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -[snip] acl> 1 The storage class to use when storing new objects in OSS. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Standard storage class \ \[dq]STANDARD\[dq] 3 / Archive -storage mode. -\ \[dq]GLACIER\[dq] 4 / Infrequent access storage mode. -\ \[dq]STANDARD_IA\[dq] storage_class> 1 Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [oss] type = s3 provider = -Alibaba env_auth = false access_key_id = accesskeyid secret_access_key = -secretaccesskey endpoint = oss\-cn\-hangzhou.aliyuncs.com acl = private -storage_class = Standard \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes -this is OK e) Edit this remote d) Delete this remote y/e/d> y +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_key_id> AKIDxxxxxxxxxx +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +secret_access_key> xxxxxxxxxxx +\f[R] +.fi +.IP "6." 3 +Select endpoint for Tencent COS. +This is the standard endpoint for different region. .IP .nf \f[C] + 1 / Beijing Region. + \[rs] \[dq]cos.ap\-beijing.myqcloud.com\[dq] + 2 / Nanjing Region. + \[rs] \[dq]cos.ap\-nanjing.myqcloud.com\[dq] + 3 / Shanghai Region. + \[rs] \[dq]cos.ap\-shanghai.myqcloud.com\[dq] + 4 / Guangzhou Region. + \[rs] \[dq]cos.ap\-guangzhou.myqcloud.com\[dq] +[snip] +endpoint> 4 +\f[R] +.fi +.IP "7." 3 +Choose acl and storage class. +.IP +.nf +\f[C] +Note that this ACL is applied when server\-side copying objects as S3 +doesn\[aq]t copy the ACL from the source but rather writes a fresh one. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Owner gets Full_CONTROL. No one else has access rights (default). + \[rs] \[dq]default\[dq] +[snip] +acl> 1 +The storage class to use when storing new objects in Tencent COS. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] +[snip] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[cos] +type = s3 +provider = TencentCOS +env_auth = false +access_key_id = xxx +secret_access_key = xxx +endpoint = cos.ap\-guangzhou.myqcloud.com +acl = default +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: -### Netease NOS ### - -For Netease NOS configure as per the configurator \[ga]rclone config\[ga] -setting the provider \[ga]Netease\[ga]. This will automatically set -\[ga]force_path_style = false\[ga] which is necessary for it to run properly. - - Backblaze B2 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -B2 is [Backblaze\[aq]s cloud storage system](https://www.backblaze.com/b2/). - -Paths are specified as \[ga]remote:bucket\[ga] (or \[ga]remote:\[ga] for the \[ga]lsd\[ga] -command.) You may put subdirectories in too, eg \[ga]remote:bucket/path/to/dir\[ga]. - -Here is an example of making a b2 configuration. First run - - rclone config - -This will guide you through an interactive setup process. To authenticate -you will either need your Account ID (a short hex number) and Master -Application Key (a long hex number) OR an Application Key, which is the -recommended method. See below for further details on generating and using -an Application Key. +Name Type +==== ==== +cos s3 +\f[R] +.fi +.SS Netease NOS +.PP +For Netease NOS configure as per the configurator +\f[C]rclone config\f[R] setting the provider \f[C]Netease\f[R]. +This will automatically set \f[C]force_path_style = false\f[R] which is +necessary for it to run properly. +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the S3 backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Backblaze B2 +.PP +B2 is Backblaze\[aq]s cloud storage +system (https://www.backblaze.com/b2/). +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +Here is an example of making a b2 configuration. +First run +.IP +.nf +\f[C] +rclone config \f[R] .fi .PP -No remotes found \- make a new one n) New remote q) Quit config n/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Backblaze B2 \ \[dq]b2\[dq] [snip] Storage> b2 Account ID or Application -Key ID account> 123456789abc Application Key key> -0123456789abcdef0123456789abcdef0123456789 Endpoint for the service \- -leave blank normally. -endpoint> Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -[remote] account = 123456789abc key = -0123456789abcdef0123456789abcdef0123456789 endpoint = -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +This will guide you through an interactive setup process. +To authenticate you will either need your Account ID (a short hex +number) and Master Application Key (a long hex number) OR an Application +Key, which is the recommended method. +See below for further details on generating and using an Application +Key. .IP .nf \f[C] - -This remote is called \[ga]remote\[ga] and can now be used like this - +No remotes found \- make a new one +n) New remote +q) Quit config +n/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Backblaze B2 + \[rs] \[dq]b2\[dq] +[snip] +Storage> b2 +Account ID or Application Key ID +account> 123456789abc +Application Key +key> 0123456789abcdef0123456789abcdef0123456789 +Endpoint for the service \- leave blank normally. +endpoint> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +account = 123456789abc +key = 0123456789abcdef0123456789abcdef0123456789 +endpoint = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP See all buckets - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP Create a new bucket - - rclone mkdir remote:bucket - +.IP +.nf +\f[C] +rclone mkdir remote:bucket +\f[R] +.fi +.PP List the contents of a bucket - - rclone ls remote:bucket - -Sync \[ga]/home/local/directory\[ga] to the remote bucket, deleting any +.IP +.nf +\f[C] +rclone ls remote:bucket +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any excess files in the bucket. - - rclone sync \-i /home/local/directory remote:bucket - -### Application Keys ### - -B2 supports multiple [Application Keys for different access permission -to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html). - -You can use these with rclone too; you will need to use rclone version 1.43 -or later. - -Follow Backblaze\[aq]s docs to create an Application Key with the required -permission and add the \[ga]applicationKeyId\[ga] as the \[ga]account\[ga] and the -\[ga]Application Key\[ga] itself as the \[ga]key\[ga]. - -Note that you must put the _applicationKeyId_ as the \[ga]account\[ga] \[en] you -can\[aq]t use the master Account ID. If you try then B2 will return 401 -errors. - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -### Modified time ### - +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:bucket +\f[R] +.fi +.SS Application Keys +.PP +B2 supports multiple Application Keys for different access permission to +B2 Buckets (https://www.backblaze.com/b2/docs/application_keys.html). +.PP +You can use these with rclone too; you will need to use rclone version +1.43 or later. +.PP +Follow Backblaze\[aq]s docs to create an Application Key with the +required permission and add the \f[C]applicationKeyId\f[R] as the +\f[C]account\f[R] and the \f[C]Application Key\f[R] itself as the +\f[C]key\f[R]. +.PP +Note that you must put the \f[I]applicationKeyId\f[R] as the +\f[C]account\f[R] \[en] you can\[aq]t use the master Account ID. +If you try then B2 will return 401 errors. +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS Modified time +.PP The modified time is stored as metadata on the object as -\[ga]X\-Bz\-Info\-src_last_modified_millis\[ga] as milliseconds since 1970\-01\-01 -in the Backblaze standard. Other tools should be able to use this as -a modified time. - -Modified times are used in syncing and are fully supported. Note that -if a modification time needs to be updated on an object then it will -create a new version of the object. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs] | 0x5C | \[uFF3C] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -Note that in 2020\-05 Backblaze started allowing \[rs] characters in file -names. Rclone hasn\[aq]t changed its encoding as this could cause syncs to -re\-transfer files. If you want rclone not to replace \[rs] then see the -\[ga]\-\-b2\-encoding\[ga] flag below and remove the \[ga]BackSlash\[ga] from the -string. This can be set in the config. - -### SHA1 checksums ### - +\f[C]X\-Bz\-Info\-src_last_modified_millis\f[R] as milliseconds since +1970\-01\-01 in the Backblaze standard. +Other tools should be able to use this as a modified time. +.PP +Modified times are used in syncing and are fully supported. +Note that if a modification time needs to be updated on an object then +it will create a new version of the object. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.PP +Note that in 2020\-05 Backblaze started allowing \ characters in file +names. +Rclone hasn\[aq]t changed its encoding as this could cause syncs to +re\-transfer files. +If you want rclone not to replace \ then see the +\f[C]\-\-b2\-encoding\f[R] flag below and remove the \f[C]BackSlash\f[R] +from the string. +This can be set in the config. +.SS SHA1 checksums +.PP The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process. - -Large files (bigger than the limit in \[ga]\-\-b2\-upload\-cutoff\[ga]) which are -uploaded in chunks will store their SHA1 on the object as -\[ga]X\-Bz\-Info\-large_file_sha1\[ga] as recommended by Backblaze. - -For a large file to be uploaded with an SHA1 checksum, the source -needs to support SHA1 checksums. The local disk supports SHA1 -checksums so large file transfers from local disk will have an SHA1. -See [the overview](https://rclone.org/overview/#features) for exactly which remotes -support SHA1. - -Sources which don\[aq]t support SHA1, in particular \[ga]crypt\[ga] will upload -large files without SHA1 checksums. This may be fixed in the future -(see [#1767](https://github.com/rclone/rclone/issues/1767)). - -Files sizes below \[ga]\-\-b2\-upload\-cutoff\[ga] will always have an SHA1 -regardless of the source. - -### Transfers ### - +.PP +Large files (bigger than the limit in \f[C]\-\-b2\-upload\-cutoff\f[R]) +which are uploaded in chunks will store their SHA1 on the object as +\f[C]X\-Bz\-Info\-large_file_sha1\f[R] as recommended by Backblaze. +.PP +For a large file to be uploaded with an SHA1 checksum, the source needs +to support SHA1 checksums. +The local disk supports SHA1 checksums so large file transfers from +local disk will have an SHA1. +See the overview (https://rclone.org/overview/#features) for exactly +which remotes support SHA1. +.PP +Sources which don\[aq]t support SHA1, in particular \f[C]crypt\f[R] will +upload large files without SHA1 checksums. +This may be fixed in the future (see +#1767 (https://github.com/rclone/rclone/issues/1767)). +.PP +Files sizes below \f[C]\-\-b2\-upload\-cutoff\f[R] will always have an +SHA1 regardless of the source. +.SS Transfers +.PP Backblaze recommends that you do lots of transfers simultaneously for -maximum speed. In tests from my SSD equipped laptop the optimum -setting is about \[ga]\-\-transfers 32\[ga] though higher numbers may be used -for a slight speed improvement. The optimum number for you may vary -depending on your hardware, how big the files are, how much you want -to load your computer, etc. The default of \[ga]\-\-transfers 4\[ga] is -definitely too low for Backblaze B2 though. - -Note that uploading big files (bigger than 200 MB by default) will use -a 96 MB RAM buffer by default. There can be at most \[ga]\-\-transfers\[ga] of -these in use at any moment, so this sets the upper limit on the memory -used. - -### Versions ### - -When rclone uploads a new version of a file it creates a [new version -of it](https://www.backblaze.com/b2/docs/file_versions.html). +maximum speed. +In tests from my SSD equipped laptop the optimum setting is about +\f[C]\-\-transfers 32\f[R] though higher numbers may be used for a +slight speed improvement. +The optimum number for you may vary depending on your hardware, how big +the files are, how much you want to load your computer, etc. +The default of \f[C]\-\-transfers 4\f[R] is definitely too low for +Backblaze B2 though. +.PP +Note that uploading big files (bigger than 200 MB by default) will use a +96 MB RAM buffer by default. +There can be at most \f[C]\-\-transfers\f[R] of these in use at any +moment, so this sets the upper limit on the memory used. +.SS Versions +.PP +When rclone uploads a new version of a file it creates a new version of +it (https://www.backblaze.com/b2/docs/file_versions.html). Likewise when you delete a file, the old version will be marked hidden -and still be available. Conversely, you may opt in to a \[dq]hard delete\[dq] -of files with the \[ga]\-\-b2\-hard\-delete\[ga] flag which would permanently remove -the file instead of hiding it. - -Old versions of files, where available, are visible using the -\[ga]\-\-b2\-versions\[ga] flag. - -**NB** Note that \[ga]\-\-b2\-versions\[ga] does not work with crypt at the -moment [#1627](https://github.com/rclone/rclone/issues/1627). Using -[\-\-backup\-dir](https://rclone.org/docs/#backup\-dir\-dir) with rclone is the recommended -way of working around this. - +and still be available. +Conversely, you may opt in to a \[dq]hard delete\[dq] of files with the +\f[C]\-\-b2\-hard\-delete\f[R] flag which would permanently remove the +file instead of hiding it. +.PP +Old versions of files, where available, are visible using the +\f[C]\-\-b2\-versions\f[R] flag. +.PP +\f[B]NB\f[R] Note that \f[C]\-\-b2\-versions\f[R] does not work with +crypt at the moment +#1627 (https://github.com/rclone/rclone/issues/1627). +Using \-\-backup\-dir (https://rclone.org/docs/#backup-dir-dir) with +rclone is the recommended way of working around this. +.PP If you wish to remove all the old versions then you can use the -\[ga]rclone cleanup remote:bucket\[ga] command which will delete all the old -versions of files, leaving the current ones intact. You can also -supply a path and only old versions under that path will be deleted, -eg \[ga]rclone cleanup remote:bucket/path/to/stuff\[ga]. - -Note that \[ga]cleanup\[ga] will remove partially uploaded files from the bucket -if they are more than a day old. - -When you \[ga]purge\[ga] a bucket, the current and the old versions will be -deleted then the bucket will be deleted. - -However \[ga]delete\[ga] will cause the current versions of the files to +\f[C]rclone cleanup remote:bucket\f[R] command which will delete all the +old versions of files, leaving the current ones intact. +You can also supply a path and only old versions under that path will be +deleted, e.g. +\f[C]rclone cleanup remote:bucket/path/to/stuff\f[R]. +.PP +Note that \f[C]cleanup\f[R] will remove partially uploaded files from +the bucket if they are more than a day old. +.PP +When you \f[C]purge\f[R] a bucket, the current and the old versions will +be deleted then the bucket will be deleted. +.PP +However \f[C]delete\f[R] will cause the current versions of the files to become hidden old versions. - -Here is a session showing the listing and retrieval of an old -version followed by a \[ga]cleanup\[ga] of the old versions. - -Show current version and all the versions with \[ga]\-\-b2\-versions\[ga] flag. -\f[R] -.fi .PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt +Here is a session showing the listing and retrieval of an old version +followed by a \f[C]cleanup\f[R] of the old versions. .PP -$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test 9 one.txt 8 -one\-v2016\-07\-04\-141032\-000.txt 16 -one\-v2016\-07\-04\-141003\-000.txt 15 -one\-v2016\-07\-02\-155621\-000.txt +Show current version and all the versions with +\f[C]\-\-b2\-versions\f[R] flag. .IP .nf \f[C] +$ rclone \-q ls b2:cleanup\-test + 9 one.txt +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt + 8 one\-v2016\-07\-04\-141032\-000.txt + 16 one\-v2016\-07\-04\-141003\-000.txt + 15 one\-v2016\-07\-02\-155621\-000.txt +\f[R] +.fi +.PP Retrieve an old version -\f[R] -.fi -.PP -$ rclone \-q \-\-b2\-versions copy -b2:cleanup\-test/one\-v2016\-07\-04\-141003\-000.txt /tmp -.PP -$ ls \-l /tmp/one\-v2016\-07\-04\-141003\-000.txt \-rw\-rw\-r\-\- 1 ncw -ncw 16 Jul 2 17:46 /tmp/one\-v2016\-07\-04\-141003\-000.txt .IP .nf \f[C] +$ rclone \-q \-\-b2\-versions copy b2:cleanup\-test/one\-v2016\-07\-04\-141003\-000.txt /tmp +$ ls \-l /tmp/one\-v2016\-07\-04\-141003\-000.txt +\-rw\-rw\-r\-\- 1 ncw ncw 16 Jul 2 17:46 /tmp/one\-v2016\-07\-04\-141003\-000.txt +\f[R] +.fi +.PP Clean up all the old versions and show that they\[aq]ve gone. -\f[R] -.fi -.PP +.IP +.nf +\f[C] $ rclone \-q cleanup b2:cleanup\-test + +$ rclone \-q ls b2:cleanup\-test + 9 one.txt + +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt +\f[R] +.fi +.SS Data usage .PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt +It is useful to know how many requests are sent to the server in +different scenarios. .PP -$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test 9 one.txt +All copy commands send the following 4 requests: .IP .nf \f[C] - -### Data usage ### - -It is useful to know how many requests are sent to the server in different scenarios. - -All copy commands send the following 4 requests: +/b2api/v1/b2_authorize_account +/b2api/v1/b2_create_bucket +/b2api/v1/b2_list_buckets +/b2api/v1/b2_list_file_names \f[R] .fi .PP -/b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket -/b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names -.IP -.nf -\f[C] - -The \[ga]b2_list_file_names\[ga] request will be sent once for every 1k files -in the remote path, providing the checksum and modification time of -the listed files. As of version 1.33 issue -[#818](https://github.com/rclone/rclone/issues/818) causes extra requests -to be sent when using B2 with Crypt. When a copy operation does not -require any files to be uploaded, no more requests will be sent. - +The \f[C]b2_list_file_names\f[R] request will be sent once for every 1k +files in the remote path, providing the checksum and modification time +of the listed files. +As of version 1.33 issue +#818 (https://github.com/rclone/rclone/issues/818) causes extra requests +to be sent when using B2 with Crypt. +When a copy operation does not require any files to be uploaded, no more +requests will be sent. +.PP Uploading files that do not require chunking, will send 2 requests per file upload: -\f[R] -.fi -.PP -/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ .IP .nf \f[C] - +/b2api/v1/b2_get_upload_url +/b2api/v1/b2_upload_file/ +\f[R] +.fi +.PP Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk: -\f[R] -.fi -.PP -/b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url -/b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file .IP .nf \f[C] - -#### Versions #### - -Versions can be viewed with the \[ga]\-\-b2\-versions\[ga] flag. When it is set -rclone will show and act on older versions of files. For example - -Listing without \[ga]\-\-b2\-versions\[ga] +/b2api/v1/b2_start_large_file +/b2api/v1/b2_get_upload_part_url +/b2api/v1/b2_upload_part/ +/b2api/v1/b2_finish_large_file \f[R] .fi +.SS Versions .PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt +Versions can be viewed with the \f[C]\-\-b2\-versions\f[R] flag. +When it is set rclone will show and act on older versions of files. +For example +.PP +Listing without \f[C]\-\-b2\-versions\f[R] .IP .nf \f[C] - +$ rclone \-q ls b2:cleanup\-test + 9 one.txt +\f[R] +.fi +.PP And with -\f[R] -.fi -.PP -$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test 9 one.txt 8 -one\-v2016\-07\-04\-141032\-000.txt 16 -one\-v2016\-07\-04\-141003\-000.txt 15 -one\-v2016\-07\-02\-155621\-000.txt .IP .nf \f[C] - -Showing that the current version is unchanged but older versions can -be seen. These have the UTC date that they were uploaded to the -server to the nearest millisecond appended to them. - -Note that when using \[ga]\-\-b2\-versions\[ga] no file write operations are -permitted, so you can\[aq]t upload files or delete them. - -### B2 and rclone link ### - +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt + 8 one\-v2016\-07\-04\-141032\-000.txt + 16 one\-v2016\-07\-04\-141003\-000.txt + 15 one\-v2016\-07\-02\-155621\-000.txt +\f[R] +.fi +.PP +Showing that the current version is unchanged but older versions can be +seen. +These have the UTC date that they were uploaded to the server to the +nearest millisecond appended to them. +.PP +Note that when using \f[C]\-\-b2\-versions\f[R] no file write operations +are permitted, so you can\[aq]t upload files or delete them. +.SS B2 and rclone link +.PP Rclone supports generating file share links for private B2 buckets. They can either be for a file for example: -\f[R] -.fi -.PP +.IP +.nf +\f[C] \&./rclone link B2:bucket/path/to/file.txt https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx -.IP -.nf -\f[C] - -or if run on a directory you will get: \f[R] .fi .PP +or if run on a directory you will get: +.IP +.nf +\f[C] \&./rclone link B2:bucket/path https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx -.IP -.nf -\f[C] - -you can then use the authorization token (the part of the url from the - \[ga]?Authorization=\[ga] on) on any file path under that directory. For example: \f[R] .fi .PP +you can then use the authorization token (the part of the url from the +\f[C]?Authorization=\f[R] on) on any file path under that directory. +For example: +.IP +.nf +\f[C] https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx -.IP -.nf -\f[C] - - -### Standard Options - +\f[R] +.fi +.SS Standard Options +.PP Here are the standard options specific to b2 (Backblaze B2). - -#### \-\-b2\-account - +.SS \-\-b2\-account +.PP Account ID or Application Key ID - -\- Config: account -\- Env Var: RCLONE_B2_ACCOUNT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-key - +.IP \[bu] 2 +Config: account +.IP \[bu] 2 +Env Var: RCLONE_B2_ACCOUNT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-key +.PP Application Key - -\- Config: key -\- Env Var: RCLONE_B2_KEY -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-hard\-delete - +.IP \[bu] 2 +Config: key +.IP \[bu] 2 +Env Var: RCLONE_B2_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-hard\-delete +.PP Permanently delete files on remote removal, otherwise hide files. - -\- Config: hard_delete -\- Env Var: RCLONE_B2_HARD_DELETE -\- Type: bool -\- Default: false - -### Advanced Options - +.IP \[bu] 2 +Config: hard_delete +.IP \[bu] 2 +Env Var: RCLONE_B2_HARD_DELETE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP Here are the advanced options specific to b2 (Backblaze B2). - -#### \-\-b2\-endpoint - +.SS \-\-b2\-endpoint +.PP Endpoint for the service. Leave blank normally. - -\- Config: endpoint -\- Env Var: RCLONE_B2_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-test\-mode - +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_B2_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-test\-mode +.PP A flag string for X\-Bz\-Test\-Mode header for debugging. - -This is for debugging purposes only. Setting it to one of the strings -below will cause b2 to return specific errors: - - * \[dq]fail_some_uploads\[dq] - * \[dq]expire_some_account_authorization_tokens\[dq] - * \[dq]force_cap_exceeded\[dq] - -These will be set in the \[dq]X\-Bz\-Test\-Mode\[dq] header which is documented -in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html). - -\- Config: test_mode -\- Env Var: RCLONE_B2_TEST_MODE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-versions - +.PP +This is for debugging purposes only. +Setting it to one of the strings below will cause b2 to return specific +errors: +.IP \[bu] 2 +\[dq]fail_some_uploads\[dq] +.IP \[bu] 2 +\[dq]expire_some_account_authorization_tokens\[dq] +.IP \[bu] 2 +\[dq]force_cap_exceeded\[dq] +.PP +These will be set in the \[dq]X\-Bz\-Test\-Mode\[dq] header which is +documented in the b2 integrations +checklist (https://www.backblaze.com/b2/docs/integration_checklist.html). +.IP \[bu] 2 +Config: test_mode +.IP \[bu] 2 +Env Var: RCLONE_B2_TEST_MODE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-versions +.PP Include old versions in directory listings. -Note that when using this no file write operations are permitted, -so you can\[aq]t upload files or delete them. - -\- Config: versions -\- Env Var: RCLONE_B2_VERSIONS -\- Type: bool -\- Default: false - -#### \-\-b2\-upload\-cutoff - +Note that when using this no file write operations are permitted, so you +can\[aq]t upload files or delete them. +.IP \[bu] 2 +Config: versions +.IP \[bu] 2 +Env Var: RCLONE_B2_VERSIONS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-b2\-upload\-cutoff +.PP Cutoff for switching to chunked upload. - -Files above this size will be uploaded in chunks of \[dq]\-\-b2\-chunk\-size\[dq]. - +.PP +Files above this size will be uploaded in chunks of +\[dq]\-\-b2\-chunk\-size\[dq]. +.PP This value should be set no larger than 4.657GiB (== 5GB). - -\- Config: upload_cutoff -\- Env Var: RCLONE_B2_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 200M - -#### \-\-b2\-copy\-cutoff - +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_B2_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 200M +.SS \-\-b2\-copy\-cutoff +.PP Cutoff for switching to multipart copy - -Any files larger than this that need to be server side copied will be +.PP +Any files larger than this that need to be server\-side copied will be copied in chunks of this size. - +.PP The minimum is 0 and the maximum is 4.6GB. - -\- Config: copy_cutoff -\- Env Var: RCLONE_B2_COPY_CUTOFF -\- Type: SizeSuffix -\- Default: 4G - -#### \-\-b2\-chunk\-size - -Upload chunk size. Must fit in memory. - -When uploading large files, chunk the file into this size. Note that -these chunks are buffered in memory and there might a maximum of -\[dq]\-\-transfers\[dq] chunks in progress at once. 5,000,000 Bytes is the -minimum size. - -\- Config: chunk_size -\- Env Var: RCLONE_B2_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 96M - -#### \-\-b2\-disable\-checksum - +.IP \[bu] 2 +Config: copy_cutoff +.IP \[bu] 2 +Env Var: RCLONE_B2_COPY_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 4G +.SS \-\-b2\-chunk\-size +.PP +Upload chunk size. +Must fit in memory. +.PP +When uploading large files, chunk the file into this size. +Note that these chunks are buffered in memory and there might a maximum +of \[dq]\-\-transfers\[dq] chunks in progress at once. +5,000,000 Bytes is the minimum size. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_B2_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 96M +.SS \-\-b2\-disable\-checksum +.PP Disable checksums for large (> upload cutoff) files - +.PP Normally rclone will calculate the SHA1 checksum of the input before -uploading it so it can add it to metadata on the object. This is great -for data integrity checking but can cause long delays for large files -to start uploading. - -\- Config: disable_checksum -\- Env Var: RCLONE_B2_DISABLE_CHECKSUM -\- Type: bool -\- Default: false - -#### \-\-b2\-download\-url - +uploading it so it can add it to metadata on the object. +This is great for data integrity checking but can cause long delays for +large files to start uploading. +.IP \[bu] 2 +Config: disable_checksum +.IP \[bu] 2 +Env Var: RCLONE_B2_DISABLE_CHECKSUM +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-b2\-download\-url +.PP Custom endpoint for downloads. - -This is usually set to a Cloudflare CDN URL as Backblaze offers -free egress for data downloaded through the Cloudflare network. -This is probably only useful for a public bucket. +.PP +This is usually set to a Cloudflare CDN URL as Backblaze offers free +egress for data downloaded through the Cloudflare network. +Rclone works with private buckets by sending an \[dq]Authorization\[dq] +header. +If the custom endpoint rewrites the requests for authentication, e.g., +in Cloudflare Workers, this header needs to be handled properly. Leave blank if you want to use the endpoint provided by Backblaze. - -\- Config: download_url -\- Env Var: RCLONE_B2_DOWNLOAD_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-b2\-download\-auth\-duration - -Time before the authorization token will expire in s or suffix ms|s|m|h|d. - +.IP \[bu] 2 +Config: download_url +.IP \[bu] 2 +Env Var: RCLONE_B2_DOWNLOAD_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-b2\-download\-auth\-duration +.PP +Time before the authorization token will expire in s or suffix +ms|s|m|h|d. +.PP The duration before the download authorization token will expire. -The minimum value is 1 second. The maximum value is one week. - -\- Config: download_auth_duration -\- Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION -\- Type: Duration -\- Default: 1w - -#### \-\-b2\-memory\-pool\-flush\-time - +The minimum value is 1 second. +The maximum value is one week. +.IP \[bu] 2 +Config: download_auth_duration +.IP \[bu] 2 +Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1w +.SS \-\-b2\-memory\-pool\-flush\-time +.PP How often internal memory buffer pools will be flushed. -Uploads which requires additional buffers (f.e multipart) will use memory pool for allocations. -This option controls how often unused buffers will be removed from the pool. - -\- Config: memory_pool_flush_time -\- Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME -\- Type: Duration -\- Default: 1m0s - -#### \-\-b2\-memory\-pool\-use\-mmap - +Uploads which requires additional buffers (f.e multipart) will use +memory pool for allocations. +This option controls how often unused buffers will be removed from the +pool. +.IP \[bu] 2 +Config: memory_pool_flush_time +.IP \[bu] 2 +Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \-\-b2\-memory\-pool\-use\-mmap +.PP Whether to use mmap buffers in internal memory pool. - -\- Config: memory_pool_use_mmap -\- Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP -\- Type: bool -\- Default: false - -#### \-\-b2\-encoding - +.IP \[bu] 2 +Config: memory_pool_use_mmap +.IP \[bu] 2 +Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-b2\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_B2_ENCODING -\- Type: MultiEncoder -\- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot - - - - Box -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]remote:path\[ga] - -Paths may be as deep as required, eg \[ga]remote:directory/subdirectory\[ga]. - +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_B2_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the B2 backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Box +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, e.g. +\f[C]remote:directory/subdirectory\f[R]. +.PP The initial setup for Box involves getting a token from Box which you can do either in your browser, or with a config.json downloaded from Box -to use JWT authentication. \[ga]rclone config\[ga] walks you through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - +to use JWT authentication. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Box -\ \[dq]box\[dq] [snip] Storage> box Box App Client Id \- leave blank -normally. -client_id> Box App Client Secret \- leave blank normally. -client_secret> Box App config.json location Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -box_config_file> Box App Primary Access Token Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -access_token> -.PP -Enter a string value. -Press Enter for the default (\[dq]user\[dq]). -Choose a number from below, or type in your own value 1 / Rclone should -act on behalf of a user \ \[dq]user\[dq] 2 / Rclone should act on behalf -of a service account \ \[dq]enterprise\[dq] box_sub_type> Remote config -Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: http://127.0.0.1:53682/auth Log -in and authorize rclone for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] client_id = -client_secret = token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]XXX\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y .IP .nf \f[C] - -See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a -machine with no Internet browser available. - -Note that rclone runs a webserver on your local machine to collect the -token as returned from Box. This only runs from the moment it opens -your browser to the moment you get back the verification code. This -is on \[ga]http://127.0.0.1:53682/\[ga] and this it may require you to unblock -it temporarily if you are running a host firewall. - -Once configured you can then use \[ga]rclone\[ga] like this, - -List directories in top level of your Box - - rclone lsd remote: - -List all the files in your Box - - rclone ls remote: - -To copy a local directory to an Box directory called backup - - rclone copy /home/source remote:backup - -### Using rclone with an Enterprise account with SSO ### - -If you have an \[dq]Enterprise\[dq] account type with Box with single sign on -(SSO), you need to create a password to use Box with rclone. This can -be done at your Enterprise Box account by going to Settings, \[dq]Account\[dq] -Tab, and then set the password in the \[dq]Authentication\[dq] field. - -Once you have done this, you can setup your Enterprise Box account -using the same procedure detailed above in the, using the password you -have just set. - -### Invalid refresh token ### - -According to the [box docs](https://developer.box.com/v2.0/docs/oauth\-20#section\-6\-using\-the\-access\-and\-refresh\-tokens): - -> Each refresh_token is valid for one use in 60 days. - -This means that if you - - * Don\[aq]t use the box remote for 60 days - * Copy the config file with a box refresh token in and use it in two places - * Get an error on a token refresh - -then rclone will return an error which includes the text \[ga]Invalid -refresh token\[ga]. - -To fix this you will need to use oauth2 again to update the refresh -token. You can use the methods in [the remote setup -docs](https://rclone.org/remote_setup/), bearing in mind that if you use the copy the -config file method, you should not use that remote on the computer you -did the authentication on. - -Here is how to do it. -\f[R] -.fi -.PP -$ rclone config Current remotes: -.PP -Name Type ==== ==== remote box -.IP "e)" 3 -Edit existing remote -.IP "f)" 3 -New remote -.IP "g)" 3 -Delete remote -.IP "h)" 3 -Rename remote -.IP "i)" 3 -Copy remote -.IP "j)" 3 -Set configuration password -.IP "k)" 3 -Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in an -existing value 1 > remote remote> remote -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = box token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-08T23:40:08.059167677+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Edit remote Value -\[dq]client_id\[dq] = \[dq]\[dq] Edit? -(y/n)> -.IP "l)" 3 -Yes -.IP "m)" 3 -No y/n> n Value \[dq]client_secret\[dq] = \[dq]\[dq] Edit? -(y/n)> -.IP "n)" 3 -Yes -.IP "o)" 3 -No y/n> n Remote config Already have a token \- refresh? -.IP "p)" 3 -Yes -.IP "q)" 3 -No y/n> y Use auto config? -.IP \[bu] 2 -Say Y if not sure -.IP \[bu] 2 -Say N if you are working on a remote or headless machine -.IP "y)" 3 -Yes -.IP "z)" 3 -No y/n> y If your browser doesn\[aq]t open automatically go to the -following link: http://127.0.0.1:53682/auth Log in and authorize rclone -for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = box -token = -{\[dq]access_token\[dq]:\[dq]YYY\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]YYY\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-23T12:22:29.259137901+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.IP "a)" 3 -Yes this is OK -.IP "b)" 3 -Edit this remote -.IP "c)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -### Modified time and hashes ### - -Box allows modification times to be set on objects accurate to 1 -second. These will be used to detect whether objects need syncing or -not. - -Box supports SHA1 type hashes, so you can use the \[ga]\-\-checksum\[ga] -flag. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs] | 0x5C | \[uFF3C] | - -File names can also not end with the following characters. -These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -### Transfers ### - -For files above 50MB rclone will use a chunked transfer. Rclone will -upload up to \[ga]\-\-transfers\[ga] chunks at the same time (shared among all -the multipart uploads). Chunks are buffered in memory and are -normally 8MB so increasing \[ga]\-\-transfers\[ga] will increase memory use. - -### Deleting files ### - -Depending on the enterprise settings for your user, the item will -either be actually deleted from Box or moved to the trash. - -Emptying the trash is supported via the rclone however cleanup command -however this deletes every trashed file and folder individually so it -may take a very long time. -Emptying the trash via the WebUI does not have this limitation -so it is advised to empty the trash via the WebUI. - -### Root folder ID ### - -You can set the \[ga]root_folder_id\[ga] for rclone. This is the directory -(identified by its \[ga]Folder ID\[ga]) that rclone considers to be the root -of your Box drive. - -Normally you will leave this blank and rclone will determine the -correct root to use itself. - -However you can set this to restrict rclone to a specific folder -hierarchy. - -In order to do this you will have to find the \[ga]Folder ID\[ga] of the -directory you wish rclone to display. This will be the last segment -of the URL when you open the relevant folder in the Box web -interface. - -So if the folder you want rclone to use has a URL which looks like -\[ga]https://app.box.com/folder/11xxxxxxxxx8\[ga] -in the browser, then you use \[ga]11xxxxxxxxx8\[ga] as -the \[ga]root_folder_id\[ga] in the config. - - -### Standard Options - -Here are the standard options specific to box (Box). - -#### \-\-box\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_BOX_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_BOX_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-box\-config\-file - +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Box + \[rs] \[dq]box\[dq] +[snip] +Storage> box +Box App Client Id \- leave blank normally. +client_id> +Box App Client Secret \- leave blank normally. +client_secret> Box App config.json location Leave blank normally. - -Leading \[ga]\[ti]\[ga] will be expanded in the file name as will environment variables such as \[ga]${RCLONE_CONFIG_DIR}\[ga]. - - -\- Config: box_config_file -\- Env Var: RCLONE_BOX_BOX_CONFIG_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-access\-token - +Enter a string value. Press Enter for the default (\[dq]\[dq]). +box_config_file> Box App Primary Access Token Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_token> -\- Config: access_token -\- Env Var: RCLONE_BOX_ACCESS_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-box\-sub\-type - - - -\- Config: box_sub_type -\- Env Var: RCLONE_BOX_BOX_SUB_TYPE -\- Type: string -\- Default: \[dq]user\[dq] -\- Examples: - \- \[dq]user\[dq] - \- Rclone should act on behalf of a user - \- \[dq]enterprise\[dq] - \- Rclone should act on behalf of a service account - -### Advanced Options - -Here are the advanced options specific to box (Box). - -#### \-\-box\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_BOX_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_BOX_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_BOX_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-box\-root\-folder\-id - -Fill in for rclone to use a non root folder as its starting point. - -\- Config: root_folder_id -\- Env Var: RCLONE_BOX_ROOT_FOLDER_ID -\- Type: string -\- Default: \[dq]0\[dq] - -#### \-\-box\-upload\-cutoff - -Cutoff for switching to multipart upload (>= 50MB). - -\- Config: upload_cutoff -\- Env Var: RCLONE_BOX_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 50M - -#### \-\-box\-commit\-retries - -Max number of times to try committing a multipart file. - -\- Config: commit_retries -\- Env Var: RCLONE_BOX_COMMIT_RETRIES -\- Type: int -\- Default: 100 - -#### \-\-box\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_BOX_ENCODING -\- Type: MultiEncoder -\- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot - - - -### Limitations ### - -Note that Box is case insensitive so you can\[aq]t have a file called -\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -Box file names can\[aq]t have the \[ga]\[rs]\[ga] character in. rclone maps this to -and from an identical looking unicode equivalent \[ga]\[uFF3C]\[ga]. - -Box only supports filenames up to 255 characters in length. - - Cache (BETA) -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]cache\[ga] remote wraps another existing remote and stores file structure -and its data for long running tasks like \[ga]rclone mount\[ga]. - -## Status - -The cache backend code is working but it currently doesn\[aq]t -have a maintainer so there are [outstanding bugs](https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) which aren\[aq]t getting fixed. - -The cache backend is due to be phased out in favour of the VFS caching -layer eventually which is more tightly integrated into rclone. - -Until this happens we recommend only using the cache backend if you -find you can\[aq]t work without it. There are many docs online describing -the use of the cache backend to minimize API hits and by\-and\-large -these are out of date and the cache backend isn\[aq]t needed in those -scenarios any more. - -## Setup - -To get started you just need to have an existing remote which can be configured -with \[ga]cache\[ga]. - -Here is an example of how to make a remote called \[ga]test\-cache\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +Enter a string value. Press Enter for the default (\[dq]user\[dq]). +Choose a number from below, or type in your own value + 1 / Rclone should act on behalf of a user + \[rs] \[dq]user\[dq] + 2 / Rclone should act on behalf of a service account + \[rs] \[dq]enterprise\[dq] +box_sub_type> +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]XXX\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y \f[R] .fi .PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> test\-cache Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Cache -a remote \ \[dq]cache\[dq] [snip] Storage> cache Remote to cache. -Normally should contain a \[aq]:\[aq] and a path, eg -\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe -\[dq]myremote:\[dq] (not recommended). -remote> local:/test Optional: The URL of the Plex server plex_url> -http://127.0.0.1:32400 Optional: The username of the Plex user -plex_username> dummyusername Optional: The password of the Plex user y) -Yes type in my own password g) Generate random password n) No leave this -optional password blank y/g/n> y Enter the password: password: Confirm -the password: password: The size of a chunk. -Lower value good for slow connections but can affect seamless reading. -Default: 5M Choose a number from below, or type in your own value 1 / -1MB \ \[dq]1m\[dq] 2 / 5 MB \ \[dq]5M\[dq] 3 / 10 MB \ \[dq]10M\[dq] -chunk_size> 2 How much time should object info (file size, file hashes -etc) be stored in cache. -Use a very high value if you don\[aq]t plan on changing the source FS -from outside the cache. -Accepted units are: \[dq]s\[dq], \[dq]m\[dq], \[dq]h\[dq]. -Default: 5m Choose a number from below, or type in your own value 1 / 1 -hour \ \[dq]1h\[dq] 2 / 24 hours \ \[dq]24h\[dq] 3 / 24 hours -\ \[dq]48h\[dq] info_age> 2 The maximum size of stored chunks. -When the storage grows beyond this size, the oldest chunks will be -deleted. -Default: 10G Choose a number from below, or type in your own value 1 / -500 MB \ \[dq]500M\[dq] 2 / 1 GB \ \[dq]1G\[dq] 3 / 10 GB -\ \[dq]10G\[dq] chunk_total_size> 3 Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [test\-cache] remote = -local:/test plex_url = http://127.0.0.1:32400 plex_username = -dummyusername plex_password = *** ENCRYPTED *** chunk_size = 5M info_age -= 48h chunk_total_size = 10G +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Box. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level of your Box .IP .nf \f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your Box +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an Box directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Using rclone with an Enterprise account with SSO +.PP +If you have an \[dq]Enterprise\[dq] account type with Box with single +sign on (SSO), you need to create a password to use Box with rclone. +This can be done at your Enterprise Box account by going to Settings, +\[dq]Account\[dq] Tab, and then set the password in the +\[dq]Authentication\[dq] field. +.PP +Once you have done this, you can setup your Enterprise Box account using +the same procedure detailed above in the, using the password you have +just set. +.SS Invalid refresh token +.PP +According to the box +docs (https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): +.RS +.PP +Each refresh_token is valid for one use in 60 days. +.RE +.PP +This means that if you +.IP \[bu] 2 +Don\[aq]t use the box remote for 60 days +.IP \[bu] 2 +Copy the config file with a box refresh token in and use it in two +places +.IP \[bu] 2 +Get an error on a token refresh +.PP +then rclone will return an error which includes the text +\f[C]Invalid refresh token\f[R]. +.PP +To fix this you will need to use oauth2 again to update the refresh +token. +You can use the methods in the remote setup +docs (https://rclone.org/remote_setup/), bearing in mind that if you use +the copy the config file method, you should not use that remote on the +computer you did the authentication on. +.PP +Here is how to do it. +.IP +.nf +\f[C] +$ rclone config +Current remotes: +Name Type +==== ==== +remote box + +e) Edit existing remote +n) New remote +d) Delete remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +e/n/d/r/c/s/q> e +Choose a number from below, or type in an existing value + 1 > remote +remote> remote +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = box +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-08T23:40:08.059167677+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +Edit remote +Value \[dq]client_id\[dq] = \[dq]\[dq] +Edit? (y/n)> +y) Yes +n) No +y/n> n +Value \[dq]client_secret\[dq] = \[dq]\[dq] +Edit? (y/n)> +y) Yes +n) No +y/n> n +Remote config +Already have a token \- refresh? +y) Yes +n) No +y/n> y +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = box +token = {\[dq]access_token\[dq]:\[dq]YYY\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]YYY\[dq],\[dq]expiry\[dq]:\[dq]2017\-07\-23T12:22:29.259137901+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Modified time and hashes +.PP +Box allows modification times to be set on objects accurate to 1 second. +These will be used to detect whether objects need syncing or not. +.PP +Box supports SHA1 type hashes, so you can use the \f[C]\-\-checksum\f[R] +flag. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP +File names can also not end with the following characters. +These only get replaced if they are the last character in the name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Transfers +.PP +For files above 50MB rclone will use a chunked transfer. +Rclone will upload up to \f[C]\-\-transfers\f[R] chunks at the same time +(shared among all the multipart uploads). +Chunks are buffered in memory and are normally 8MB so increasing +\f[C]\-\-transfers\f[R] will increase memory use. +.SS Deleting files +.PP +Depending on the enterprise settings for your user, the item will either +be actually deleted from Box or moved to the trash. +.PP +Emptying the trash is supported via the rclone however cleanup command +however this deletes every trashed file and folder individually so it +may take a very long time. +Emptying the trash via the WebUI does not have this limitation so it is +advised to empty the trash via the WebUI. +.SS Root folder ID +.PP +You can set the \f[C]root_folder_id\f[R] for rclone. +This is the directory (identified by its \f[C]Folder ID\f[R]) that +rclone considers to be the root of your Box drive. +.PP +Normally you will leave this blank and rclone will determine the correct +root to use itself. +.PP +However you can set this to restrict rclone to a specific folder +hierarchy. +.PP +In order to do this you will have to find the \f[C]Folder ID\f[R] of the +directory you wish rclone to display. +This will be the last segment of the URL when you open the relevant +folder in the Box web interface. +.PP +So if the folder you want rclone to use has a URL which looks like +\f[C]https://app.box.com/folder/11xxxxxxxxx8\f[R] in the browser, then +you use \f[C]11xxxxxxxxx8\f[R] as the \f[C]root_folder_id\f[R] in the +config. +.SS Standard Options +.PP +Here are the standard options specific to box (Box). +.SS \-\-box\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_BOX_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_BOX_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-box\-config\-file +.PP +Box App config.json location Leave blank normally. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: box_config_file +.IP \[bu] 2 +Env Var: RCLONE_BOX_BOX_CONFIG_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-access\-token +.PP +Box App Primary Access Token Leave blank normally. +.IP \[bu] 2 +Config: access_token +.IP \[bu] 2 +Env Var: RCLONE_BOX_ACCESS_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-box\-sub\-type +.IP \[bu] 2 +Config: box_sub_type +.IP \[bu] 2 +Env Var: RCLONE_BOX_BOX_SUB_TYPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]user\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]user\[dq] +.RS 2 +.IP \[bu] 2 +Rclone should act on behalf of a user +.RE +.IP \[bu] 2 +\[dq]enterprise\[dq] +.RS 2 +.IP \[bu] 2 +Rclone should act on behalf of a service account +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to box (Box). +.SS \-\-box\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_BOX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_BOX_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_BOX_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-box\-root\-folder\-id +.PP +Fill in for rclone to use a non root folder as its starting point. +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_BOX_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]0\[dq] +.SS \-\-box\-upload\-cutoff +.PP +Cutoff for switching to multipart upload (>= 50MB). +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_BOX_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 50M +.SS \-\-box\-commit\-retries +.PP +Max number of times to try committing a multipart file. +.IP \[bu] 2 +Config: commit_retries +.IP \[bu] 2 +Env Var: RCLONE_BOX_COMMIT_RETRIES +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 100 +.SS \-\-box\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_BOX_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot +.SS Limitations +.PP +Note that Box is case insensitive so you can\[aq]t have a file called +\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +Box file names can\[aq]t have the \f[C]\[rs]\f[R] character in. +rclone maps this to and from an identical looking unicode equivalent +\f[C]\[uFF3C]\f[R] (U+FF3C Fullwidth Reverse Solidus). +.PP +Box only supports filenames up to 255 characters in length. +.PP +\f[C]rclone about\f[R] is not supported by the Box backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Cache (BETA) +.PP +The \f[C]cache\f[R] remote wraps another existing remote and stores file +structure and its data for long running tasks like +\f[C]rclone mount\f[R]. +.SS Status +.PP +The cache backend code is working but it currently doesn\[aq]t have a +maintainer so there are outstanding +bugs (https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3A%22Remote%3A+Cache%22) +which aren\[aq]t getting fixed. +.PP +The cache backend is due to be phased out in favour of the VFS caching +layer eventually which is more tightly integrated into rclone. +.PP +Until this happens we recommend only using the cache backend if you find +you can\[aq]t work without it. +There are many docs online describing the use of the cache backend to +minimize API hits and by\-and\-large these are out of date and the cache +backend isn\[aq]t needed in those scenarios any more. +.SS Setup +.PP +To get started you just need to have an existing remote which can be +configured with \f[C]cache\f[R]. +.PP +Here is an example of how to make a remote called \f[C]test\-cache\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> test\-cache +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Cache a remote + \[rs] \[dq]cache\[dq] +[snip] +Storage> cache +Remote to cache. +Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], +\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). +remote> local:/test +Optional: The URL of the Plex server +plex_url> http://127.0.0.1:32400 +Optional: The username of the Plex user +plex_username> dummyusername +Optional: The password of the Plex user +y) Yes type in my own password +g) Generate random password +n) No leave this optional password blank +y/g/n> y +Enter the password: +password: +Confirm the password: +password: +The size of a chunk. Lower value good for slow connections but can affect seamless reading. +Default: 5M +Choose a number from below, or type in your own value + 1 / 1MB + \[rs] \[dq]1m\[dq] + 2 / 5 MB + \[rs] \[dq]5M\[dq] + 3 / 10 MB + \[rs] \[dq]10M\[dq] +chunk_size> 2 +How much time should object info (file size, file hashes, etc.) be stored in cache. Use a very high value if you don\[aq]t plan on changing the source FS from outside the cache. +Accepted units are: \[dq]s\[dq], \[dq]m\[dq], \[dq]h\[dq]. +Default: 5m +Choose a number from below, or type in your own value + 1 / 1 hour + \[rs] \[dq]1h\[dq] + 2 / 24 hours + \[rs] \[dq]24h\[dq] + 3 / 24 hours + \[rs] \[dq]48h\[dq] +info_age> 2 +The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. +Default: 10G +Choose a number from below, or type in your own value + 1 / 500 MB + \[rs] \[dq]500M\[dq] + 2 / 1 GB + \[rs] \[dq]1G\[dq] + 3 / 10 GB + \[rs] \[dq]10G\[dq] +chunk_total_size> 3 +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[test\-cache] +remote = local:/test +plex_url = http://127.0.0.1:32400 +plex_username = dummyusername +plex_password = *** ENCRYPTED *** +chunk_size = 5M +info_age = 48h +chunk_total_size = 10G +\f[R] +.fi +.PP You can then use it like this, - +.PP List directories in top level of your drive - - rclone lsd test\-cache: - +.IP +.nf +\f[C] +rclone lsd test\-cache: +\f[R] +.fi +.PP List all the files in your drive - - rclone ls test\-cache: - +.IP +.nf +\f[C] +rclone ls test\-cache: +\f[R] +.fi +.PP 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 +.IP +.nf +\f[C] +rclone mount \-\-allow\-other test\-cache: /var/tmp/test\-cache +\f[R] +.fi +.SS Write Features +.SS Offline uploading +.PP +In an effort to make writing through cache more reliable, the backend now supports this feature which can be activated by specifying a -\[ga]cache\-tmp\-upload\-path\[ga]. - +\f[C]cache\-tmp\-upload\-path\f[R]. +.PP A files goes through these states when using this feature: - -1. An upload is started (usually by copying a file on the cache remote) -2. When the copy to the temporary location is complete the file is part -of the cached remote and looks and behaves like any other file (reading included) -3. After \[ga]cache\-tmp\-wait\-time\[ga] passes and the file is next in line, \[ga]rclone move\[ga] -is used to move the file to the cloud provider -4. Reading the file still works during the upload but most modifications on it will be prohibited -5. Once the move is complete the file is unlocked for modifications as it +.IP "1." 3 +An upload is started (usually by copying a file on the cache remote) +.IP "2." 3 +When the copy to the temporary location is complete the file is part of +the cached remote and looks and behaves like any other file (reading +included) +.IP "3." 3 +After \f[C]cache\-tmp\-wait\-time\f[R] passes and the file is next in +line, \f[C]rclone move\f[R] is used to move the file to the cloud +provider +.IP "4." 3 +Reading the file still works during the upload but most modifications on +it will be prohibited +.IP "5." 3 +Once the move is complete the file is unlocked for modifications as it becomes as any other regular file -6. If the file is being read through \[ga]cache\[ga] when it\[aq]s actually -deleted from the temporary path then \[ga]cache\[ga] will simply swap the source -to the cloud provider without interrupting the reading (small blip can happen though) - +.IP "6." 3 +If the file is being read through \f[C]cache\f[R] when it\[aq]s actually +deleted from the temporary path then \f[C]cache\f[R] will simply swap +the source to the cloud provider without interrupting the reading (small +blip can happen though) +.PP Files are uploaded in sequence and only one file is uploaded at a time. -Uploads will be stored in a queue and be processed based on the order they were added. +Uploads will be stored in a queue and be processed based on the order +they were added. The queue and the temporary storage is persistent across restarts but -can be cleared on startup with the \[ga]\-\-cache\-db\-purge\[ga] flag. - -### Write Support ### - -Writes are supported through \[ga]cache\[ga]. -One caveat is that a mounted cache remote does not add any retry or fallback -mechanism to the upload operation. This will depend on the implementation -of the wrapped remote. Consider using \[ga]Offline uploading\[ga] for reliable writes. - -One special case is covered with \[ga]cache\-writes\[ga] which will cache the file -data at the same time as the upload when it is enabled making it available -from the cache store immediately once the upload is finished. - -### Read Features ### - -#### Multiple connections #### - +can be cleared on startup with the \f[C]\-\-cache\-db\-purge\f[R] flag. +.SS Write Support +.PP +Writes are supported through \f[C]cache\f[R]. +One caveat is that a mounted cache remote does not add any retry or +fallback mechanism to the upload operation. +This will depend on the implementation of the wrapped remote. +Consider using \f[C]Offline uploading\f[R] for reliable writes. +.PP +One special case is covered with \f[C]cache\-writes\f[R] which will +cache the file data at the same time as the upload when it is enabled +making it available from the cache store immediately once the upload is +finished. +.SS Read Features +.SS Multiple connections +.PP To counter the high latency between a local PC where rclone is running and cloud providers, the cache remote can split multiple requests to the -cloud provider for smaller file chunks and combines them together locally -where they can be available almost immediately before the reader usually -needs them. - -This is similar to buffering when media files are played online. Rclone -will stay around the current marker but always try its best to stay ahead -and prepare the data before. - -#### Plex Integration #### - -There is a direct integration with Plex which allows cache to detect during reading -if the file is in playback or not. This helps cache to adapt how it queries -the cloud provider depending on what is needed for. - -Scans will have a minimum amount of workers (1) while in a confirmed playback cache -will deploy the configured number of workers. - -This integration opens the doorway to additional performance improvements -which will be explored in the near future. - -**Note:** If Plex options are not configured, \[ga]cache\[ga] will function with its -configured options without adapting any of its settings. - -How to enable? Run \[ga]rclone config\[ga] and add all the Plex options (endpoint, username -and password) in your remote and it will be automatically enabled. - -Affected settings: -\- \[ga]cache\-workers\[ga]: _Configured value_ during confirmed playback or _1_ all the other times - -##### Certificate Validation ##### - -When the Plex server is configured to only accept secure connections, it is -possible to use \[ga].plex.direct\[ga] URLs to ensure certificate validation succeeds. -These URLs are used by Plex internally to connect to the Plex server securely. - +cloud provider for smaller file chunks and combines them together +locally where they can be available almost immediately before the reader +usually needs them. +.PP +This is similar to buffering when media files are played online. +Rclone will stay around the current marker but always try its best to +stay ahead and prepare the data before. +.SS Plex Integration +.PP +There is a direct integration with Plex which allows cache to detect +during reading if the file is in playback or not. +This helps cache to adapt how it queries the cloud provider depending on +what is needed for. +.PP +Scans will have a minimum amount of workers (1) while in a confirmed +playback cache will deploy the configured number of workers. +.PP +This integration opens the doorway to additional performance +improvements which will be explored in the near future. +.PP +\f[B]Note:\f[R] If Plex options are not configured, \f[C]cache\f[R] will +function with its configured options without adapting any of its +settings. +.PP +How to enable? +Run \f[C]rclone config\f[R] and add all the Plex options (endpoint, +username and password) in your remote and it will be automatically +enabled. +.PP +Affected settings: \- \f[C]cache\-workers\f[R]: \f[I]Configured +value\f[R] during confirmed playback or \f[I]1\f[R] all the other times +.SS Certificate Validation +.PP +When the Plex server is configured to only accept secure connections, it +is possible to use \f[C].plex.direct\f[R] URLs to ensure certificate +validation succeeds. +These URLs are used by Plex internally to connect to the Plex server +securely. +.PP The format for these URLs is the following: - +.PP https://ip\-with\-dots\-replaced.server\-hash.plex.direct:32400/ - -The \[ga]ip\-with\-dots\-replaced\[ga] part can be any IPv4 address, where the dots -have been replaced with dashes, e.g. \[ga]127.0.0.1\[ga] becomes \[ga]127\-0\-0\-1\[ga]. - -To get the \[ga]server\-hash\[ga] part, the easiest way is to visit - +.PP +The \f[C]ip\-with\-dots\-replaced\f[R] part can be any IPv4 address, +where the dots have been replaced with dashes, e.g. +\f[C]127.0.0.1\f[R] becomes \f[C]127\-0\-0\-1\f[R]. +.PP +To get the \f[C]server\-hash\f[R] part, the easiest way is to visit +.PP https://plex.tv/api/resources?includeHttps=1&X\-Plex\-Token=your\-plex\-token - -This page will list all the available Plex servers for your account -with at least one \[ga].plex.direct\[ga] link for each. Copy one URL and replace -the IP address with the desired address. This can be used as the -\[ga]plex_url\[ga] value. - -### Known issues ### - -#### Mount and \-\-dir\-cache\-time #### - -\-\-dir\-cache\-time controls the first layer of directory caching which works at the mount layer. -Being an independent caching mechanism from the \[ga]cache\[ga] backend, it will manage its own entries -based on the configured time. - -To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct -one, try to set \[ga]\-\-dir\-cache\-time\[ga] to a lower time than \[ga]\-\-cache\-info\-age\[ga]. Default values are -already configured in this way. - -#### Windows support \- Experimental #### - -There are a couple of issues with Windows \[ga]mount\[ga] functionality that still require some investigations. -It should be considered as experimental thus far as fixes come in for this OS. - -Most of the issues seem to be related to the difference between filesystems -on Linux flavors and Windows as cache is heavily dependent on them. - -Any reports or feedback on how cache behaves on this OS is greatly appreciated. - -\- https://github.com/rclone/rclone/issues/1935 -\- https://github.com/rclone/rclone/issues/1907 -\- https://github.com/rclone/rclone/issues/1834 - -#### Risk of throttling #### - -Future iterations of the cache backend will make use of the pooling functionality -of the cloud provider to synchronize and at the same time make writing through it -more tolerant to failures. - -There are a couple of enhancements in track to add these but in the meantime -there is a valid concern that the expiring cache listings can lead to cloud provider -throttles or bans due to repeated queries on it for very large mounts. - -Some recommendations: -\- don\[aq]t use a very small interval for entry information (\[ga]\-\-cache\-info\-age\[ga]) -\- while writes aren\[aq]t yet optimised, you can still write through \[ga]cache\[ga] which gives you the advantage -of adding the file in the cache at the same time if configured to do so. - +.PP +This page will list all the available Plex servers for your account with +at least one \f[C].plex.direct\f[R] link for each. +Copy one URL and replace the IP address with the desired address. +This can be used as the \f[C]plex_url\f[R] value. +.SS Known issues +.SS Mount and \-\-dir\-cache\-time +.PP +\-\-dir\-cache\-time controls the first layer of directory caching which +works at the mount layer. +Being an independent caching mechanism from the \f[C]cache\f[R] backend, +it will manage its own entries based on the configured time. +.PP +To avoid getting in a scenario where dir cache has obsolete data and +cache would have the correct one, try to set +\f[C]\-\-dir\-cache\-time\f[R] to a lower time than +\f[C]\-\-cache\-info\-age\f[R]. +Default values are already configured in this way. +.SS Windows support \- Experimental +.PP +There are a couple of issues with Windows \f[C]mount\f[R] functionality +that still require some investigations. +It should be considered as experimental thus far as fixes come in for +this OS. +.PP +Most of the issues seem to be related to the difference between +filesystems on Linux flavors and Windows as cache is heavily dependent +on them. +.PP +Any reports or feedback on how cache behaves on this OS is greatly +appreciated. +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1935 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1907 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1834 +.SS Risk of throttling +.PP +Future iterations of the cache backend will make use of the pooling +functionality of the cloud provider to synchronize and at the same time +make writing through it more tolerant to failures. +.PP +There are a couple of enhancements in track to add these but in the +meantime there is a valid concern that the expiring cache listings can +lead to cloud provider throttles or bans due to repeated queries on it +for very large mounts. +.PP +Some recommendations: \- don\[aq]t use a very small interval for entry +information (\f[C]\-\-cache\-info\-age\f[R]) \- while writes aren\[aq]t +yet optimised, you can still write through \f[C]cache\f[R] which gives +you the advantage of adding the file in the cache at the same time if +configured to do so. +.PP Future enhancements: - -\- https://github.com/rclone/rclone/issues/1937 -\- https://github.com/rclone/rclone/issues/1936 - -#### cache and crypt #### - +.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 \[ga]crypt\[ga] remote. \[ga]crypt\[ga] uses a similar technique to wrap around -an existing remote and handles this translation in a seamless way. - -There is an issue with wrapping the remotes in this order: -**cloud remote** \-> **crypt** \-> **cache** - -During testing, I experienced a lot of bans with the remotes in this order. -I suspect it might be related to how crypt opens files on the cloud provider -which makes it think we\[aq]re downloading the full file instead of small chunks. -Organizing the remotes in this order yields better results: -**cloud remote** \-> **cache** \-> **crypt** - -#### absolute remote paths #### - -\[ga]cache\[ga] can not differentiate between relative and absolute paths for the wrapped remote. -Any path given in the \[ga]remote\[ga] config setting and on the command line will be passed to -the wrapped remote as is, but for storing the chunks on disk the path will be made -relative by removing any leading \[ga]/\[ga] character. - -This behavior is irrelevant for most backend types, but there are backends where a leading \[ga]/\[ga] -changes the effective directory, e.g. in the \[ga]sftp\[ga] backend paths starting with a \[ga]/\[ga] are -relative to the root of the SSH server and paths without are relative to the user home directory. -As a result \[ga]sftp:bin\[ga] and \[ga]sftp:/bin\[ga] will share the same cache folder, even if they represent -a different directory on the SSH server. - -### Cache and Remote Control (\-\-rc) ### -Cache supports the new \[ga]\-\-rc\[ga] mode in rclone and can be remote controlled through the following end points: -By default, the listener is disabled if you do not add the flag. - -### rc cache/expire -Purge a remote from the cache backend. Supports either a directory or a file. -It supports both encrypted and unencrypted file names if cache is wrapped by crypt. - -Params: - \- **remote** = path to remote **(required)** - \- **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - - -### Standard Options - +using the \f[C]crypt\f[R] remote. +\f[C]crypt\f[R] uses a similar technique to wrap around an existing +remote and handles this translation in a seamless way. +.PP +There is an issue with wrapping the remotes in this order: \f[B]cloud +remote\f[R] \-> \f[B]crypt\f[R] \-> \f[B]cache\f[R] +.PP +During testing, I experienced a lot of bans with the remotes in this +order. +I suspect it might be related to how crypt opens files on the cloud +provider which makes it think we\[aq]re downloading the full file +instead of small chunks. +Organizing the remotes in this order yields better results: \f[B]cloud +remote\f[R] \-> \f[B]cache\f[R] \-> \f[B]crypt\f[R] +.SS absolute remote paths +.PP +\f[C]cache\f[R] can not differentiate between relative and absolute +paths for the wrapped remote. +Any path given in the \f[C]remote\f[R] config setting and on the command +line will be passed to the wrapped remote as is, but for storing the +chunks on disk the path will be made relative by removing any leading +\f[C]/\f[R] character. +.PP +This behavior is irrelevant for most backend types, but there are +backends where a leading \f[C]/\f[R] changes the effective directory, +e.g. +in the \f[C]sftp\f[R] backend paths starting with a \f[C]/\f[R] are +relative to the root of the SSH server and paths without are relative to +the user home directory. +As a result \f[C]sftp:bin\f[R] and \f[C]sftp:/bin\f[R] will share the +same cache folder, even if they represent a different directory on the +SSH server. +.SS Cache and Remote Control (\-\-rc) +.PP +Cache supports the new \f[C]\-\-rc\f[R] mode in rclone and can be remote +controlled through the following end points: By default, the listener is +disabled if you do not add the flag. +.SS rc cache/expire +.PP +Purge a remote from the cache backend. +Supports either a directory or a file. +It supports both encrypted and unencrypted file names if cache is +wrapped by crypt. +.PP +Params: \- \f[B]remote\f[R] = path to remote \f[B](required)\f[R] \- +\f[B]withData\f[R] = true/false to delete cached data (chunks) as well +\f[I](optional, false by default)\f[R] +.SS Standard Options +.PP Here are the standard options specific to cache (Cache a remote). - -#### \-\-cache\-remote - +.SS \-\-cache\-remote +.PP Remote to cache. -Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], -\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). - -\- Config: remote -\- Env Var: RCLONE_CACHE_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-url - +Normally should contain a \[aq]:\[aq] and a path, e.g. +\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe +\[dq]myremote:\[dq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CACHE_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-url +.PP The URL of the Plex server - -\- Config: plex_url -\- Env Var: RCLONE_CACHE_PLEX_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-username - +.IP \[bu] 2 +Config: plex_url +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-username +.PP The username of the Plex user - -\- Config: plex_username -\- Env Var: RCLONE_CACHE_PLEX_USERNAME -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-password - +.IP \[bu] 2 +Config: plex_username +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_USERNAME +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-password +.PP The password of the Plex user - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: plex_password -\- Env Var: RCLONE_CACHE_PLEX_PASSWORD -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-chunk\-size - +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: plex_password +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-chunk\-size +.PP The size of a chunk (partial file data). - -Use lower numbers for slower connections. If the chunk size is -changed, any downloaded chunks will be invalid and cache\-chunk\-path -will need to be cleared or unexpected EOF errors will occur. - -\- Config: chunk_size -\- Env Var: RCLONE_CACHE_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 5M -\- Examples: - \- \[dq]1m\[dq] - \- 1MB - \- \[dq]5M\[dq] - \- 5 MB - \- \[dq]10M\[dq] - \- 10 MB - -#### \-\-cache\-info\-age - -How long to cache file structure information (directory listings, file size, times etc). -If all write operations are done through the cache then you can safely make -this value very large as the cache store will also be updated in real time. - -\- Config: info_age -\- Env Var: RCLONE_CACHE_INFO_AGE -\- Type: Duration -\- Default: 6h0m0s -\- Examples: - \- \[dq]1h\[dq] - \- 1 hour - \- \[dq]24h\[dq] - \- 24 hours - \- \[dq]48h\[dq] - \- 48 hours - -#### \-\-cache\-chunk\-total\-size - +.PP +Use lower numbers for slower connections. +If the chunk size is changed, any downloaded chunks will be invalid and +cache\-chunk\-path will need to be cleared or unexpected EOF errors will +occur. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 5M +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]1m\[dq] +.RS 2 +.IP \[bu] 2 +1MB +.RE +.IP \[bu] 2 +\[dq]5M\[dq] +.RS 2 +.IP \[bu] 2 +5 MB +.RE +.IP \[bu] 2 +\[dq]10M\[dq] +.RS 2 +.IP \[bu] 2 +10 MB +.RE +.RE +.SS \-\-cache\-info\-age +.PP +How long to cache file structure information (directory listings, file +size, times, etc.). +If all write operations are done through the cache then you can safely +make this value very large as the cache store will also be updated in +real time. +.IP \[bu] 2 +Config: info_age +.IP \[bu] 2 +Env Var: RCLONE_CACHE_INFO_AGE +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 6h0m0s +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]1h\[dq] +.RS 2 +.IP \[bu] 2 +1 hour +.RE +.IP \[bu] 2 +\[dq]24h\[dq] +.RS 2 +.IP \[bu] 2 +24 hours +.RE +.IP \[bu] 2 +\[dq]48h\[dq] +.RS 2 +.IP \[bu] 2 +48 hours +.RE +.RE +.SS \-\-cache\-chunk\-total\-size +.PP The total size that the chunks can take up on the local disk. - -If the cache exceeds this value then it will start to delete the -oldest chunks until it goes under this value. - -\- Config: chunk_total_size -\- Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE -\- Type: SizeSuffix -\- Default: 10G -\- Examples: - \- \[dq]500M\[dq] - \- 500 MB - \- \[dq]1G\[dq] - \- 1 GB - \- \[dq]10G\[dq] - \- 10 GB - -### Advanced Options - +.PP +If the cache exceeds this value then it will start to delete the oldest +chunks until it goes under this value. +.IP \[bu] 2 +Config: chunk_total_size +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 10G +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]500M\[dq] +.RS 2 +.IP \[bu] 2 +500 MB +.RE +.IP \[bu] 2 +\[dq]1G\[dq] +.RS 2 +.IP \[bu] 2 +1 GB +.RE +.IP \[bu] 2 +\[dq]10G\[dq] +.RS 2 +.IP \[bu] 2 +10 GB +.RE +.RE +.SS Advanced Options +.PP Here are the advanced options specific to cache (Cache a remote). - -#### \-\-cache\-plex\-token - +.SS \-\-cache\-plex\-token +.PP The plex token for authentication \- auto set normally - -\- Config: plex_token -\- Env Var: RCLONE_CACHE_PLEX_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-plex\-insecure - +.IP \[bu] 2 +Config: plex_token +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-plex\-insecure +.PP Skip all certificate verification when connecting to the Plex server - -\- Config: plex_insecure -\- Env Var: RCLONE_CACHE_PLEX_INSECURE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-db\-path - +.IP \[bu] 2 +Config: plex_insecure +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_INSECURE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-db\-path +.PP Directory to store file structure metadata DB. The remote name is used as the DB file name. - -\- Config: db_path -\- Env Var: RCLONE_CACHE_DB_PATH -\- Type: string -\- Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] - -#### \-\-cache\-chunk\-path - +.IP \[bu] 2 +Config: db_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] +.SS \-\-cache\-chunk\-path +.PP Directory to cache chunk files. - -Path to where partial file data (chunks) are stored locally. The remote -name is appended to the final path. - -This config follows the \[dq]\-\-cache\-db\-path\[dq]. If you specify a custom -location for \[dq]\-\-cache\-db\-path\[dq] and don\[aq]t specify one for \[dq]\-\-cache\-chunk\-path\[dq] -then \[dq]\-\-cache\-chunk\-path\[dq] will use the same path as \[dq]\-\-cache\-db\-path\[dq]. - -\- Config: chunk_path -\- Env Var: RCLONE_CACHE_CHUNK_PATH -\- Type: string -\- Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] - -#### \-\-cache\-db\-purge - +.PP +Path to where partial file data (chunks) are stored locally. +The remote name is appended to the final path. +.PP +This config follows the \[dq]\-\-cache\-db\-path\[dq]. +If you specify a custom location for \[dq]\-\-cache\-db\-path\[dq] and +don\[aq]t specify one for \[dq]\-\-cache\-chunk\-path\[dq] then +\[dq]\-\-cache\-chunk\-path\[dq] will use the same path as +\[dq]\-\-cache\-db\-path\[dq]. +.IP \[bu] 2 +Config: chunk_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]$HOME/.cache/rclone/cache\-backend\[dq] +.SS \-\-cache\-db\-purge +.PP Clear all the cached data for this remote on start. - -\- Config: db_purge -\- Env Var: RCLONE_CACHE_DB_PURGE -\- Type: bool -\- Default: false - -#### \-\-cache\-chunk\-clean\-interval - +.IP \[bu] 2 +Config: db_purge +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_PURGE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-cache\-chunk\-clean\-interval +.PP How often should the cache perform cleanups of the chunk storage. -The default value should be ok for most people. If you find that the -cache goes over \[dq]cache\-chunk\-total\-size\[dq] too often then try to lower -this value to force it to perform cleanups more often. - -\- Config: chunk_clean_interval -\- Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL -\- Type: Duration -\- Default: 1m0s - -#### \-\-cache\-read\-retries - +The default value should be ok for most people. +If you find that the cache goes over \[dq]cache\-chunk\-total\-size\[dq] +too often then try to lower this value to force it to perform cleanups +more often. +.IP \[bu] 2 +Config: chunk_clean_interval +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \-\-cache\-read\-retries +.PP How many times to retry a read from a cache storage. - +.PP Since reading from a cache stream is independent from downloading file data, readers can get to a point where there\[aq]s no more data in the -cache. Most of the times this can indicate a connectivity issue if -cache isn\[aq]t able to provide file data anymore. - -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 - +cache. +Most of the times this can indicate a connectivity issue if cache +isn\[aq]t able to provide file data anymore. +.PP +For really slow connections, increase this to a point where the stream +is able to provide data but your experience will be very stuttering. +.IP \[bu] 2 +Config: read_retries +.IP \[bu] 2 +Env Var: RCLONE_CACHE_READ_RETRIES +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 10 +.SS \-\-cache\-workers +.PP How many workers should run in parallel to download chunks. - -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 +.PP +Higher values will mean more parallel processing (better CPU needed) and +more concurrent requests on the cloud provider. +This impacts several aspects like the cloud provider API limits, more +stress on the hardware that rclone runs on but it also means that +streams will be more fluid and data will be available much more faster +to readers. +.PP +\f[B]Note\f[R]: If the optional Plex integration is enabled then this setting will adapt to the type of reading performed and the value specified here will be used as a maximum number of workers to use. - -\- Config: workers -\- Env Var: RCLONE_CACHE_WORKERS -\- Type: int -\- Default: 4 - -#### \-\-cache\-chunk\-no\-memory - +.IP \[bu] 2 +Config: workers +.IP \[bu] 2 +Env Var: RCLONE_CACHE_WORKERS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 4 +.SS \-\-cache\-chunk\-no\-memory +.PP Disable the in\-memory cache for storing chunks during streaming. - -By default, cache will keep file data during streaming in RAM as well -to provide it to readers as fast as possible. - +.PP +By default, cache will keep file data during streaming in RAM as well to +provide it to readers as fast as possible. +.PP This transient data is evicted as soon as it is read and the number of -chunks stored doesn\[aq]t exceed the number of workers. However, depending -on other settings like \[dq]cache\-chunk\-size\[dq] and \[dq]cache\-workers\[dq] this footprint -can increase if there are parallel streams too (multiple files being read -at the same time). - -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) - +chunks stored doesn\[aq]t exceed the number of workers. +However, depending on other settings like \[dq]cache\-chunk\-size\[dq] +and \[dq]cache\-workers\[dq] this footprint can increase if there are +parallel streams too (multiple files being read at the same time). +.PP +If the hardware permits it, use this feature to provide an overall +better performance during streaming but it can also be disabled if RAM +is not available on the local machine. +.IP \[bu] 2 +Config: chunk_no_memory +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-cache\-rps +.PP +Limits the number of requests per second to the source FS (\-1 to +disable) +.PP This setting places a hard limit on the number of requests per second -that cache will be doing to the cloud provider remote and try to -respect that value by setting waits between reads. - +that cache will be doing to the cloud provider remote and try to respect +that value by setting waits between reads. +.PP If you find that you\[aq]re getting banned or limited on the cloud provider through cache and know that a smaller number of requests per -second will allow you to work with it then you can use this setting -for that. - +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. - -**NOTE**: This will limit the number of requests during streams but -other API calls to the cloud provider like directory listings will +.PP +\f[B]NOTE\f[R]: This will limit the number of requests during streams +but other API calls to the cloud provider like directory listings will still pass. - -\- Config: rps -\- Env Var: RCLONE_CACHE_RPS -\- Type: int -\- Default: \-1 - -#### \-\-cache\-writes - +.IP \[bu] 2 +Config: rps +.IP \[bu] 2 +Env Var: RCLONE_CACHE_RPS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: \-1 +.SS \-\-cache\-writes +.PP Cache file data on writes through the FS - +.PP If you need to read files immediately after you upload them through -cache you can enable this flag to have their data stored in the -cache store at the same time during upload. - -\- Config: writes -\- Env Var: RCLONE_CACHE_WRITES -\- Type: bool -\- Default: false - -#### \-\-cache\-tmp\-upload\-path - +cache you can enable this flag to have their data stored in the cache +store at the same time during upload. +.IP \[bu] 2 +Config: writes +.IP \[bu] 2 +Env Var: RCLONE_CACHE_WRITES +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-cache\-tmp\-upload\-path +.PP Directory to keep temporary files until they are uploaded. - +.PP This is the path where cache will use as a temporary storage for new files that need to be uploaded to the cloud provider. - -Specifying a value will enable this feature. Without it, it is -completely disabled and files will be uploaded directly to the cloud -provider - -\- Config: tmp_upload_path -\- Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-cache\-tmp\-wait\-time - +.PP +Specifying a value will enable this feature. +Without it, it is completely disabled and files will be uploaded +directly to the cloud provider +.IP \[bu] 2 +Config: tmp_upload_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-cache\-tmp\-wait\-time +.PP How long should files be stored in local cache before being uploaded - +.PP This is the duration that a file must wait in the temporary location -_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 - +\f[I]cache\-tmp\-upload\-path\f[R] before it is selected for upload. +.PP +Note that only one file is uploaded at a time and it can take longer to +start the upload if a queue formed for this purpose. +.IP \[bu] 2 +Config: tmp_wait_time +.IP \[bu] 2 +Env Var: RCLONE_CACHE_TMP_WAIT_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 15s +.SS \-\-cache\-db\-wait\-time +.PP How long to wait for the DB to be available \- 0 is unlimited - +.PP Only one process can have the DB open at any one time, so rclone waits for this duration for the DB to become available before it gives an error. - -If you set it to 0 then it will wait forever. - -\- Config: db_wait_time -\- Env Var: RCLONE_CACHE_DB_WAIT_TIME -\- Type: Duration -\- Default: 1s - -### Backend commands - -Here are the commands specific to the cache backend. - -Run them with - - rclone backend COMMAND remote: - -The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - -These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### stats - -Print stats on the cache backend in JSON format. - - rclone backend stats remote: [options] [+] - - - -Chunker (BETA) -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]chunker\[ga] overlay transparently splits large files into smaller chunks -during upload to wrapped remote and transparently assembles them back -when the file is downloaded. This allows to effectively overcome size limits -imposed by storage providers. - -To use it, first set up the underlying remote following the configuration -instructions for that remote. You can also use a local pathname instead of -a remote. - -First check your chosen remote is working \- we\[aq]ll call it \[ga]remote:path\[ga] here. -Note that anything inside \[ga]remote:path\[ga] will be chunked and anything outside -won\[aq]t. This means that if you are using a bucket based remote (eg S3, B2, swift) -then you should probably put the bucket in the remote \[ga]s3:bucket\[ga]. - -Now configure \[ga]chunker\[ga] using \[ga]rclone config\[ga]. We will call this one \[ga]overlay\[ga] -to separate it from the \[ga]remote\[ga] itself. -\f[R] -.fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> overlay Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / -Transparently chunk/split large files \ \[dq]chunker\[dq] [snip] -Storage> chunker Remote to chunk/unchunk. -Normally should contain a \[aq]:\[aq] and a path, eg -\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe -\[dq]myremote:\[dq] (not recommended). -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -remote> remote:path Files larger than chunk size will be split in -chunks. -Enter a size with suffix k,M,G,T. -Press Enter for the default (\[dq]2G\[dq]). -chunk_size> 100M Choose how chunker handles hash sums. -All modes but \[dq]none\[dq] require metadata. -Enter a string value. -Press Enter for the default (\[dq]md5\[dq]). -Choose a number from below, or type in your own value 1 / Pass any hash -supported by wrapped remote for non\-chunked files, return nothing -otherwise \ \[dq]none\[dq] 2 / MD5 for composite files \ \[dq]md5\[dq] 3 -/ SHA1 for composite files \ \[dq]sha1\[dq] 4 / MD5 for all files -\ \[dq]md5all\[dq] 5 / SHA1 for all files \ \[dq]sha1all\[dq] 6 / -Copying a file to chunker will request MD5 from the source falling back -to SHA1 if unsupported \ \[dq]md5quick\[dq] 7 / Similar to -\[dq]md5quick\[dq] but prefers SHA1 over MD5 \ \[dq]sha1quick\[dq] -hash_type> md5 Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [overlay] type = chunker remote -= remote:bucket chunk_size = 100M hash_type = md5 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +If you set it to 0 then it will wait forever. +.IP \[bu] 2 +Config: db_wait_time +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_WAIT_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1s +.SS Backend commands +.PP +Here are the commands specific to the cache backend. +.PP +Run them with .IP .nf \f[C] - -### Specifying the remote - -In normal use, make sure the remote has a \[ga]:\[ga] in. If you specify the remote -without a \[ga]:\[ga] then rclone will use a local directory of that name. -So if you use a remote of \[ga]/path/to/secret/files\[ga] then rclone will -chunk stuff in that directory. If you use a remote of \[ga]name\[ga] then rclone -will put files in a directory called \[ga]name\[ga] in the current directory. - - -### Chunking - -When rclone starts a file upload, chunker checks the file size. If it -doesn\[aq]t exceed the configured chunk size, chunker will just pass the file -to the wrapped remote. If a file is large, chunker will transparently cut -data in pieces with temporary names and stream them one by one, on the fly. -Each data chunk will contain the specified number of bytes, except for the -last one which may have less data. If file size is unknown in advance -(this is called a streaming upload), chunker will internally create -a temporary copy, record its size and repeat the above process. - +rclone backend COMMAND remote: +\f[R] +.fi +.PP +The help below will explain what arguments each command takes. +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP +These can be run on a running backend using the rc command +backend/command (https://rclone.org/rc/#backend/command). +.SS stats +.PP +Print stats on the cache backend in JSON format. +.IP +.nf +\f[C] +rclone backend stats remote: [options] [+] +\f[R] +.fi +.SS Chunker (BETA) +.PP +The \f[C]chunker\f[R] overlay transparently splits large files into +smaller chunks during upload to wrapped remote and transparently +assembles them back when the file is downloaded. +This allows to effectively overcome size limits imposed by storage +providers. +.PP +To use it, first set up the underlying remote following the +configuration instructions for that remote. +You can also use a local pathname instead of a remote. +.PP +First check your chosen remote is working \- we\[aq]ll call it +\f[C]remote:path\f[R] here. +Note that anything inside \f[C]remote:path\f[R] will be chunked and +anything outside won\[aq]t. +This means that if you are using a bucket based remote (e.g. +S3, B2, swift) then you should probably put the bucket in the remote +\f[C]s3:bucket\f[R]. +.PP +Now configure \f[C]chunker\f[R] using \f[C]rclone config\f[R]. +We will call this one \f[C]overlay\f[R] to separate it from the +\f[C]remote\f[R] itself. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> overlay +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Transparently chunk/split large files + \[rs] \[dq]chunker\[dq] +[snip] +Storage> chunker +Remote to chunk/unchunk. +Normally should contain a \[aq]:\[aq] and a path, e.g. \[dq]myremote:path/to/dir\[dq], +\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). +Enter a string value. Press Enter for the default (\[dq]\[dq]). +remote> remote:path +Files larger than chunk size will be split in chunks. +Enter a size with suffix k,M,G,T. Press Enter for the default (\[dq]2G\[dq]). +chunk_size> 100M +Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. +Enter a string value. Press Enter for the default (\[dq]md5\[dq]). +Choose a number from below, or type in your own value + 1 / Pass any hash supported by wrapped remote for non\-chunked files, return nothing otherwise + \[rs] \[dq]none\[dq] + 2 / MD5 for composite files + \[rs] \[dq]md5\[dq] + 3 / SHA1 for composite files + \[rs] \[dq]sha1\[dq] + 4 / MD5 for all files + \[rs] \[dq]md5all\[dq] + 5 / SHA1 for all files + \[rs] \[dq]sha1all\[dq] + 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported + \[rs] \[dq]md5quick\[dq] + 7 / Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 + \[rs] \[dq]sha1quick\[dq] +hash_type> md5 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[overlay] +type = chunker +remote = remote:bucket +chunk_size = 100M +hash_type = md5 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Specifying the remote +.PP +In normal use, make sure the remote has a \f[C]:\f[R] in. +If you specify the remote without a \f[C]:\f[R] then rclone will use a +local directory of that name. +So if you use a remote of \f[C]/path/to/secret/files\f[R] then rclone +will chunk stuff in that directory. +If you use a remote of \f[C]name\f[R] then rclone will put files in a +directory called \f[C]name\f[R] in the current directory. +.SS Chunking +.PP +When rclone starts a file upload, chunker checks the file size. +If it doesn\[aq]t exceed the configured chunk size, chunker will just +pass the file to the wrapped remote. +If a file is large, chunker will transparently cut data in pieces with +temporary names and stream them one by one, on the fly. +Each data chunk will contain the specified number of bytes, except for +the last one which may have less data. +If file size is unknown in advance (this is called a streaming upload), +chunker will internally create a temporary copy, record its size and +repeat the above process. +.PP When upload completes, temporary chunk files are finally renamed. This scheme guarantees that operations can be run in parallel and look from outside as atomic. -A similar method with hidden temporary chunks is used for other operations -(copy/move/rename etc). If an operation fails, hidden chunks are normally -destroyed, and the target composite file stays intact. - +A similar method with hidden temporary chunks is used for other +operations (copy/move/rename, etc.). +If an operation fails, hidden chunks are normally destroyed, and the +target composite file stays intact. +.PP When a composite file download is requested, chunker transparently -assembles it by concatenating data chunks in order. As the split is trivial -one could even manually concatenate data chunks together to obtain the -original content. - -When the \[ga]list\[ga] rclone command scans a directory on wrapped remote, -the potential chunk files are accounted for, grouped and assembled into -composite directory entries. Any temporary chunks are hidden. - +assembles it by concatenating data chunks in order. +As the split is trivial one could even manually concatenate data chunks +together to obtain the original content. +.PP +When the \f[C]list\f[R] rclone command scans a directory on wrapped +remote, the potential chunk files are accounted for, grouped and +assembled into composite directory entries. +Any temporary chunks are hidden. +.PP List and other commands can sometimes come across composite files with -missing or invalid chunks, eg. shadowed by like\-named directory or -another file. This usually means that wrapped file system has been directly -tampered with or damaged. If chunker detects a missing chunk it will -by default print warning, skip the whole incomplete group of chunks but -proceed with current command. -You can set the \[ga]\-\-chunker\-fail\-hard\[ga] flag to have commands abort with -error message in such cases. - - -#### Chunk names - -The default chunk name format is \[ga]*.rclone_chunk.###\[ga], hence by default -chunk names are \[ga]BIG_FILE_NAME.rclone_chunk.001\[ga], -\[ga]BIG_FILE_NAME.rclone_chunk.002\[ga] etc. You can configure another name format -using the \[ga]name_format\[ga] configuration file option. The format uses asterisk -\[ga]*\[ga] as a placeholder for the base file name and one or more consecutive -hash characters \[ga]#\[ga] as a placeholder for sequential chunk number. -There must be one and only one asterisk. The number of consecutive hash -characters defines the minimum length of a string representing a chunk number. +missing or invalid chunks, e.g. +shadowed by like\-named directory or another file. +This usually means that wrapped file system has been directly tampered +with or damaged. +If chunker detects a missing chunk it will by default print warning, +skip the whole incomplete group of chunks but proceed with current +command. +You can set the \f[C]\-\-chunker\-fail\-hard\f[R] flag to have commands +abort with error message in such cases. +.SS Chunk names +.PP +The default chunk name format is \f[C]*.rclone_chunk.###\f[R], hence by +default chunk names are \f[C]BIG_FILE_NAME.rclone_chunk.001\f[R], +\f[C]BIG_FILE_NAME.rclone_chunk.002\f[R] etc. +You can configure another name format using the \f[C]name_format\f[R] +configuration file option. +The format uses asterisk \f[C]*\f[R] as a placeholder for the base file +name and one or more consecutive hash characters \f[C]#\f[R] as a +placeholder for sequential chunk number. +There must be one and only one asterisk. +The number of consecutive hash characters defines the minimum length of +a string representing a chunk number. If decimal chunk number has less digits than the number of hashes, it is -left\-padded by zeros. If the decimal string is longer, it is left intact. -By default numbering starts from 1 but there is another option that allows -user to start from 0, eg. for compatibility with legacy software. - -For example, if name format is \[ga]big_*\-##.part\[ga] and original file name is -\[ga]data.txt\[ga] and numbering starts from 0, then the first chunk will be named -\[ga]big_data.txt\-00.part\[ga], the 99th chunk will be \[ga]big_data.txt\-98.part\[ga] -and the 302nd chunk will become \[ga]big_data.txt\-301.part\[ga]. - -Note that \[ga]list\[ga] assembles composite directory entries only when chunk names -match the configured format and treats non\-conforming file names as normal -non\-chunked files. - - -### Metadata - -Besides data chunks chunker will by default create metadata object for -a composite file. The object is named after the original file. -Chunker allows user to disable metadata completely (the \[ga]none\[ga] format). +left\-padded by zeros. +If the decimal string is longer, it is left intact. +By default numbering starts from 1 but there is another option that +allows user to start from 0, e.g. +for compatibility with legacy software. +.PP +For example, if name format is \f[C]big_*\-##.part\f[R] and original +file name is \f[C]data.txt\f[R] and numbering starts from 0, then the +first chunk will be named \f[C]big_data.txt\-00.part\f[R], the 99th +chunk will be \f[C]big_data.txt\-98.part\f[R] and the 302nd chunk will +become \f[C]big_data.txt\-301.part\f[R]. +.PP +Note that \f[C]list\f[R] assembles composite directory entries only when +chunk names match the configured format and treats non\-conforming file +names as normal non\-chunked files. +.SS Metadata +.PP +Besides data chunks chunker will by default create metadata object for a +composite file. +The object is named after the original file. +Chunker allows user to disable metadata completely (the \f[C]none\f[R] +format). Note that metadata is normally not created for files smaller than the -configured chunk size. This may change in future rclone releases. - -#### Simple JSON metadata format - -This is the default format. It supports hash sums and chunk validation -for composite files. Meta objects carry the following fields: - -\- \[ga]ver\[ga] \- version of format, currently \[ga]1\[ga] -\- \[ga]size\[ga] \- total size of composite file -\- \[ga]nchunks\[ga] \- number of data chunks in file -\- \[ga]md5\[ga] \- MD5 hashsum of composite file (if present) -\- \[ga]sha1\[ga] \- SHA1 hashsum (if present) - -There is no field for composite file name as it\[aq]s simply equal to the name -of meta object on the wrapped remote. Please refer to respective sections -for details on hashsums and modified time handling. - -#### No metadata - -You can disable meta objects by setting the meta format option to \[ga]none\[ga]. +configured chunk size. +This may change in future rclone releases. +.SS Simple JSON metadata format +.PP +This is the default format. +It supports hash sums and chunk validation for composite files. +Meta objects carry the following fields: +.IP \[bu] 2 +\f[C]ver\f[R] \- version of format, currently \f[C]1\f[R] +.IP \[bu] 2 +\f[C]size\f[R] \- total size of composite file +.IP \[bu] 2 +\f[C]nchunks\f[R] \- number of data chunks in file +.IP \[bu] 2 +\f[C]md5\f[R] \- MD5 hashsum of composite file (if present) +.IP \[bu] 2 +\f[C]sha1\f[R] \- SHA1 hashsum (if present) +.PP +There is no field for composite file name as it\[aq]s simply equal to +the name of meta object on the wrapped remote. +Please refer to respective sections for details on hashsums and modified +time handling. +.SS No metadata +.PP +You can disable meta objects by setting the meta format option to +\f[C]none\f[R]. In this mode chunker will scan directory for all files that follow -configured chunk name format, group them by detecting chunks with the same -base name and show group names as virtual composite files. +configured chunk name format, group them by detecting chunks with the +same base name and show group names as virtual composite files. This method is more prone to missing chunk errors (especially missing last chunk) than format with metadata enabled. - - -### Hashsums - +.SS Hashsums +.PP Chunker supports hashsums only when a compatible metadata is present. -Hence, if you choose metadata format of \[ga]none\[ga], chunker will report hashsum -as \[ga]UNSUPPORTED\[ga]. - +Hence, if you choose metadata format of \f[C]none\f[R], chunker will +report hashsum as \f[C]UNSUPPORTED\f[R]. +.PP Please note that by default metadata is stored only for composite files. -If a file is smaller than configured chunk size, chunker will transparently -redirect hash requests to wrapped remote, so support depends on that. +If a file is smaller than configured chunk size, chunker will +transparently redirect hash requests to wrapped remote, so support +depends on that. You will see the empty string as a hashsum of requested type for small files if the wrapped remote doesn\[aq]t support it. - +.PP Many storage backends support MD5 and SHA1 hash types, so does chunker. With chunker you can choose one or another but not both. MD5 is set by default as the most supported type. Since chunker keeps hashes for composite files and falls back to the -wrapped remote hash for non\-chunked ones, we advise you to choose the same -hash type as supported by wrapped remote so that your file listings +wrapped remote hash for non\-chunked ones, we advise you to choose the +same hash type as supported by wrapped remote so that your file listings look coherent. - -If your storage backend does not support MD5 or SHA1 but you need consistent -file hashing, configure chunker with \[ga]md5all\[ga] or \[ga]sha1all\[ga]. These two modes -guarantee given hash for all files. If wrapped remote doesn\[aq]t support it, -chunker will then add metadata to all files, even small. However, this can -double the amount of small files in storage and incur additional service charges. +.PP +If your storage backend does not support MD5 or SHA1 but you need +consistent file hashing, configure chunker with \f[C]md5all\f[R] or +\f[C]sha1all\f[R]. +These two modes guarantee given hash for all files. +If wrapped remote doesn\[aq]t support it, chunker will then add metadata +to all files, even small. +However, this can double the amount of small files in storage and incur +additional service charges. You can even use chunker to force md5/sha1 support in any other remote -at expense of sidecar meta objects by setting eg. \[ga]chunk_type=sha1all\[ga] -to force hashsums and \[ga]chunk_size=1P\[ga] to effectively disable chunking. - +at expense of sidecar meta objects by setting e.g. +\f[C]chunk_type=sha1all\f[R] to force hashsums and +\f[C]chunk_size=1P\f[R] to effectively disable chunking. +.PP Normally, when a file is copied to chunker controlled remote, chunker -will ask the file source for compatible file hash and revert to on\-the\-fly -calculation if none is found. This involves some CPU overhead but provides -a guarantee that given hashsum is available. Also, chunker will reject -a server\-side copy or move operation if source and destination hashsum -types are different resulting in the extra network bandwidth, too. -In some rare cases this may be undesired, so chunker provides two optional -choices: \[ga]sha1quick\[ga] and \[ga]md5quick\[ga]. If the source does not support primary -hash type and the quick mode is enabled, chunker will try to fall back to -the secondary type. This will save CPU and bandwidth but can result in empty -hashsums at destination. Beware of consequences: the \[ga]sync\[ga] command will -revert (sometimes silently) to time/size comparison if compatible hashsums +will ask the file source for compatible file hash and revert to +on\-the\-fly calculation if none is found. +This involves some CPU overhead but provides a guarantee that given +hashsum is available. +Also, chunker will reject a server\-side copy or move operation if +source and destination hashsum types are different resulting in the +extra network bandwidth, too. +In some rare cases this may be undesired, so chunker provides two +optional choices: \f[C]sha1quick\f[R] and \f[C]md5quick\f[R]. +If the source does not support primary hash type and the quick mode is +enabled, chunker will try to fall back to the secondary type. +This will save CPU and bandwidth but can result in empty hashsums at +destination. +Beware of consequences: the \f[C]sync\f[R] command will revert +(sometimes silently) to time/size comparison if compatible hashsums between source and target are not found. - - -### Modified time - +.SS Modified time +.PP Chunker stores modification times using the wrapped remote so support -depends on that. For a small non\-chunked file the chunker overlay simply -manipulates modification time of the wrapped remote file. -For a composite file with metadata chunker will get and set -modification time of the metadata object on the wrapped remote. -If file is chunked but metadata format is \[ga]none\[ga] then chunker will -use modification time of the first data chunk. - - -### Migrations - +depends on that. +For a small non\-chunked file the chunker overlay simply manipulates +modification time of the wrapped remote file. +For a composite file with metadata chunker will get and set modification +time of the metadata object on the wrapped remote. +If file is chunked but metadata format is \f[C]none\f[R] then chunker +will use modification time of the first data chunk. +.SS Migrations +.PP The idiomatic way to migrate to a different chunk size, hash type or chunk naming scheme is to: - -\- Collect all your chunked files under a directory and have your - chunker remote point to it. -\- Create another directory (most probably on the same cloud storage) - and configure a new remote with desired metadata format, - hash type, chunk naming etc. -\- Now run \[ga]rclone sync \-i oldchunks: newchunks:\[ga] and all your data - will be transparently converted in transfer. - This may take some time, yet chunker will try server\-side - copy if possible. -\- After checking data integrity you may remove configuration section - of the old remote. - +.IP \[bu] 2 +Collect all your chunked files under a directory and have your chunker +remote point to it. +.IP \[bu] 2 +Create another directory (most probably on the same cloud storage) and +configure a new remote with desired metadata format, hash type, chunk +naming etc. +.IP \[bu] 2 +Now run \f[C]rclone sync \-i oldchunks: newchunks:\f[R] and all your +data will be transparently converted in transfer. +This may take some time, yet chunker will try server\-side copy if +possible. +.IP \[bu] 2 +After checking data integrity you may remove configuration section of +the old remote. +.PP If rclone gets killed during a long operation on a big composite file, -hidden temporary chunks may stay in the directory. They will not be -shown by the \[ga]list\[ga] command but will eat up your account quota. -Please note that the \[ga]deletefile\[ga] command deletes only active -chunks of a file. As a workaround, you can use remote of the wrapped -file system to see them. +hidden temporary chunks may stay in the directory. +They will not be shown by the \f[C]list\f[R] command but will eat up +your account quota. +Please note that the \f[C]deletefile\f[R] command deletes only active +chunks of a file. +As a workaround, you can use remote of the wrapped file system to see +them. An easy way to get rid of hidden garbage is to copy littered directory somewhere using the chunker remote and purge the original directory. -The \[ga]copy\[ga] command will copy only active chunks while the \[ga]purge\[ga] will -remove everything including garbage. - - -### Caveats and Limitations - -Chunker requires wrapped remote to support server side \[ga]move\[ga] (or \[ga]copy\[ga] + -\[ga]delete\[ga]) operations, otherwise it will explicitly refuse to start. -This is because it internally renames temporary chunk files to their final -names when an operation completes successfully. - -Chunker encodes chunk number in file name, so with default \[ga]name_format\[ga] -setting it adds 17 characters. Also chunker adds 7 characters of temporary -suffix during operations. Many file systems limit base file name without path -by 255 characters. Using rclone\[aq]s crypt remote as a base file system limits -file name by 143 characters. Thus, maximum name length is 231 for most files -and 119 for chunker\-over\-crypt. A user in need can change name format to -eg. \[ga]*.rcc##\[ga] and save 10 characters (provided at most 99 chunks per file). - -Note that a move implemented using the copy\-and\-delete method may incur -double charging with some cloud storage providers. - +The \f[C]copy\f[R] command will copy only active chunks while the +\f[C]purge\f[R] will remove everything including garbage. +.SS Caveats and Limitations +.PP +Chunker requires wrapped remote to support server\-side \f[C]move\f[R] +(or \f[C]copy\f[R] + \f[C]delete\f[R]) operations, otherwise it will +explicitly refuse to start. +This is because it internally renames temporary chunk files to their +final names when an operation completes successfully. +.PP +Chunker encodes chunk number in file name, so with default +\f[C]name_format\f[R] setting it adds 17 characters. +Also chunker adds 7 characters of temporary suffix during operations. +Many file systems limit base file name without path by 255 characters. +Using rclone\[aq]s crypt remote as a base file system limits file name +by 143 characters. +Thus, maximum name length is 231 for most files and 119 for +chunker\-over\-crypt. +A user in need can change name format to e.g. +\f[C]*.rcc##\f[R] and save 10 characters (provided at most 99 chunks per +file). +.PP +Note that a move implemented using the copy\-and\-delete method may +incur double charging with some cloud storage providers. +.PP Chunker will not automatically rename existing chunks when you run -\[ga]rclone config\[ga] on a live remote and change the chunk name format. -Beware that in result of this some files which have been treated as chunks -before the change can pop up in directory listings as normal files -and vice versa. The same warning holds for the chunk size. +\f[C]rclone config\f[R] on a live remote and change the chunk name +format. +Beware that in result of this some files which have been treated as +chunks before the change can pop up in directory listings as normal +files and vice versa. +The same warning holds for the chunk size. If you desperately need to change critical chunking settings, you should run data migration as described above. - +.PP If wrapped remote is case insensitive, the chunker overlay will inherit -that property (so you can\[aq]t have a file called \[dq]Hello.doc\[dq] and \[dq]hello.doc\[dq] -in the same directory). - - - -### Standard Options - -Here are the standard options specific to chunker (Transparently chunk/split large files). - -#### \-\-chunker\-remote - +that property (so you can\[aq]t have a file called \[dq]Hello.doc\[dq] +and \[dq]hello.doc\[dq] in the same directory). +.PP +Chunker included in rclone releases up to \f[C]v1.54\f[R] can sometimes +fail to detect metadata produced by recent versions of rclone. +We recommend users to keep rclone up\-to\-date to avoid data corruption. +.SS Standard Options +.PP +Here are the standard options specific to chunker (Transparently +chunk/split large files). +.SS \-\-chunker\-remote +.PP Remote to chunk/unchunk. -Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], -\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). - -\- Config: remote -\- Env Var: RCLONE_CHUNKER_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-chunker\-chunk\-size - +Normally should contain a \[aq]:\[aq] and a path, e.g. +\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe +\[dq]myremote:\[dq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-chunker\-chunk\-size +.PP Files larger than chunk size will be split in chunks. - -\- Config: chunk_size -\- Env Var: RCLONE_CHUNKER_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 2G - -#### \-\-chunker\-hash\-type - -Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. - -\- Config: hash_type -\- Env Var: RCLONE_CHUNKER_HASH_TYPE -\- Type: string -\- Default: \[dq]md5\[dq] -\- Examples: - \- \[dq]none\[dq] - \- Pass any hash supported by wrapped remote for non\-chunked files, return nothing otherwise - \- \[dq]md5\[dq] - \- MD5 for composite files - \- \[dq]sha1\[dq] - \- SHA1 for composite files - \- \[dq]md5all\[dq] - \- MD5 for all files - \- \[dq]sha1all\[dq] - \- SHA1 for all files - \- \[dq]md5quick\[dq] - \- Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported - \- \[dq]sha1quick\[dq] - \- Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 - -### Advanced Options - -Here are the advanced options specific to chunker (Transparently chunk/split large files). - -#### \-\-chunker\-name\-format - +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 2G +.SS \-\-chunker\-hash\-type +.PP +Choose how chunker handles hash sums. +All modes but \[dq]none\[dq] require metadata. +.IP \[bu] 2 +Config: hash_type +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_HASH_TYPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]md5\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]none\[dq] +.RS 2 +.IP \[bu] 2 +Pass any hash supported by wrapped remote for non\-chunked files, return +nothing otherwise +.RE +.IP \[bu] 2 +\[dq]md5\[dq] +.RS 2 +.IP \[bu] 2 +MD5 for composite files +.RE +.IP \[bu] 2 +\[dq]sha1\[dq] +.RS 2 +.IP \[bu] 2 +SHA1 for composite files +.RE +.IP \[bu] 2 +\[dq]md5all\[dq] +.RS 2 +.IP \[bu] 2 +MD5 for all files +.RE +.IP \[bu] 2 +\[dq]sha1all\[dq] +.RS 2 +.IP \[bu] 2 +SHA1 for all files +.RE +.IP \[bu] 2 +\[dq]md5quick\[dq] +.RS 2 +.IP \[bu] 2 +Copying a file to chunker will request MD5 from the source falling back +to SHA1 if unsupported +.RE +.IP \[bu] 2 +\[dq]sha1quick\[dq] +.RS 2 +.IP \[bu] 2 +Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to chunker (Transparently +chunk/split large files). +.SS \-\-chunker\-name\-format +.PP String format of chunk file names. The two placeholders are: base file name (*) and chunk number (#...). -There must be one and only one asterisk and one or more consecutive hash characters. -If chunk number has less digits than the number of hashes, it is left\-padded by zeros. +There must be one and only one asterisk and one or more consecutive hash +characters. +If chunk number has less digits than the number of hashes, it is +left\-padded by zeros. If there are more digits in the number, they are left as is. -Possible chunk files are ignored if their name does not match given format. - -\- Config: name_format -\- Env Var: RCLONE_CHUNKER_NAME_FORMAT -\- Type: string -\- Default: \[dq]*.rclone_chunk.###\[dq] - -#### \-\-chunker\-start\-from - -Minimum valid chunk number. Usually 0 or 1. +Possible chunk files are ignored if their name does not match given +format. +.IP \[bu] 2 +Config: name_format +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_NAME_FORMAT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]*.rclone_chunk.###\[dq] +.SS \-\-chunker\-start\-from +.PP +Minimum valid chunk number. +Usually 0 or 1. By default chunk numbers start from 1. - -\- Config: start_from -\- Env Var: RCLONE_CHUNKER_START_FROM -\- Type: int -\- Default: 1 - -#### \-\-chunker\-meta\-format - -Format of the metadata object or \[dq]none\[dq]. By default \[dq]simplejson\[dq]. +.IP \[bu] 2 +Config: start_from +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_START_FROM +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1 +.SS \-\-chunker\-meta\-format +.PP +Format of the metadata object or \[dq]none\[dq]. +By default \[dq]simplejson\[dq]. Metadata is a small JSON file named after the composite file. - -\- Config: meta_format -\- Env Var: RCLONE_CHUNKER_META_FORMAT -\- Type: string -\- Default: \[dq]simplejson\[dq] -\- Examples: - \- \[dq]none\[dq] - \- Do not use metadata files at all. Requires hash type \[dq]none\[dq]. - \- \[dq]simplejson\[dq] - \- Simple JSON supports hash sums and chunk validation. - \- It has the following fields: ver, size, nchunks, md5, sha1. - -#### \-\-chunker\-fail\-hard - +.IP \[bu] 2 +Config: meta_format +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_META_FORMAT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]simplejson\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]none\[dq] +.RS 2 +.IP \[bu] 2 +Do not use metadata files at all. +Requires hash type \[dq]none\[dq]. +.RE +.IP \[bu] 2 +\[dq]simplejson\[dq] +.RS 2 +.IP \[bu] 2 +Simple JSON supports hash sums and chunk validation. +.IP \[bu] 2 +It has the following fields: ver, size, nchunks, md5, sha1. +.RE +.RE +.SS \-\-chunker\-fail\-hard +.PP Choose how chunker should handle files with missing or invalid chunks. - -\- Config: fail_hard -\- Env Var: RCLONE_CHUNKER_FAIL_HARD -\- Type: bool -\- Default: false -\- Examples: - \- \[dq]true\[dq] - \- Report errors and abort current command. - \- \[dq]false\[dq] - \- Warn user, skip incomplete file and proceed. - - - -## Citrix ShareFile - -[Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. - +.IP \[bu] 2 +Config: fail_hard +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_FAIL_HARD +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]true\[dq] +.RS 2 +.IP \[bu] 2 +Report errors and abort current command. +.RE +.IP \[bu] 2 +\[dq]false\[dq] +.RS 2 +.IP \[bu] 2 +Warn user, skip incomplete file and proceed. +.RE +.RE +.SS Citrix ShareFile +.PP +Citrix ShareFile (https://sharefile.com) is a secure file sharing and +transfer service aimed as business. +.PP The initial setup for Citrix ShareFile involves getting a token from -Citrix ShareFile which you can in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +Citrix ShareFile which you can in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config \f[R] .fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value XX / Citrix -Sharefile \ \[dq]sharefile\[dq] Storage> sharefile ** See help for -sharefile backend at: https://rclone.org/sharefile/ ** +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +XX / Citrix Sharefile + \[rs] \[dq]sharefile\[dq] +Storage> sharefile +** See help for sharefile backend at: https://rclone.org/sharefile/ ** + +ID of the root folder + +Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the +standard values here or any folder ID (long hex number ID). +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Access the Personal Folders. (Default) + \[rs] \[dq]\[dq] + 2 / Access the Favorites folder. + \[rs] \[dq]favorites\[dq] + 3 / Access all the shared folders. + \[rs] \[dq]allshared\[dq] + 4 / Access all the individual connectors. + \[rs] \[dq]connectors\[dq] + 5 / Access the home, favorites, and shared folders as well as the connectors. + \[rs] \[dq]top\[dq] +root_folder_id> +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = sharefile +endpoint = https://XXX.sharefile.com +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-09\-30T19:41:45.878561877+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Citrix ShareFile. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level of your ShareFile +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your ShareFile +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an ShareFile directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.PP +Paths may be as deep as required, e.g. +\f[C]remote:directory/subdirectory\f[R]. +.SS Modified time and hashes +.PP +ShareFile allows modification times to be set on objects accurate to 1 +second. +These will be used to detect whether objects need syncing or not. +.PP +ShareFile supports MD5 type hashes, so you can use the +\f[C]\-\-checksum\f[R] flag. +.SS Transfers +.PP +For files above 128MB rclone will use a chunked transfer. +Rclone will upload up to \f[C]\-\-transfers\f[R] chunks at the same time +(shared among all the multipart uploads). +Chunks are buffered in memory and are normally 64MB so increasing +\f[C]\-\-transfers\f[R] will increase memory use. +.SS Limitations +.PP +Note that ShareFile is case insensitive so you can\[aq]t have a file +called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +ShareFile only supports filenames up to 256 characters in length. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +T{ +* +T}@T{ +0x2A +T}@T{ +\[uFF0A] +T} +T{ +< +T}@T{ +0x3C +T}@T{ +\[uFF1C] +T} +T{ +> +T}@T{ +0x3E +T}@T{ +\[uFF1E] +T} +T{ +? +T}@T{ +0x3F +T}@T{ +\[uFF1F] +T} +T{ +: +T}@T{ +0x3A +T}@T{ +\[uFF1A] +T} +T{ +| +T}@T{ +0x7C +T}@T{ +\[uFF5C] +T} +T{ +\[dq] +T}@T{ +0x22 +T}@T{ +\[uFF02] +T} +.TE +.PP +File names can also not start or end with the following characters. +These only get replaced if they are the first or last character in the +name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +T{ +\&. +T}@T{ +0x2E +T}@T{ +\[uFF0E] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to sharefile (Citrix Sharefile). +.SS \-\-sharefile\-root\-folder\-id .PP ID of the root folder .PP Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the standard values here or any folder ID (long hex number ID). -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Access the -Personal Folders. -(Default) \ \[dq]\[dq] 2 / Access the Favorites folder. -\ \[dq]favorites\[dq] 3 / Access all the shared folders. -\ \[dq]allshared\[dq] 4 / Access all the individual connectors. -\ \[dq]connectors\[dq] 5 / Access the home, favorites, and shared -folders as well as the connectors. -\ \[dq]top\[dq] root_folder_id> Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: -http://127.0.0.1:53682/auth?state=XXX Log in and authorize rclone for -access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = -sharefile endpoint = https://XXX.sharefile.com token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-09\-30T19:41:45.878561877+01:00\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a -machine with no Internet browser available. - -Note that rclone runs a webserver on your local machine to collect the -token as returned from Citrix ShareFile. This only runs from the moment it opens -your browser to the moment you get back the verification code. This -is on \[ga]http://127.0.0.1:53682/\[ga] and this it may require you to unblock -it temporarily if you are running a host firewall. - -Once configured you can then use \[ga]rclone\[ga] like this, - -List directories in top level of your ShareFile - - rclone lsd remote: - -List all the files in your ShareFile - - rclone ls remote: - -To copy a local directory to an ShareFile directory called backup - - rclone copy /home/source remote:backup - -Paths may be as deep as required, eg \[ga]remote:directory/subdirectory\[ga]. - -### Modified time and hashes ### - -ShareFile allows modification times to be set on objects accurate to 1 -second. These will be used to detect whether objects need syncing or -not. - -ShareFile supports MD5 type hashes, so you can use the \[ga]\-\-checksum\[ga] -flag. - -### Transfers ### - -For files above 128MB rclone will use a chunked transfer. Rclone will -upload up to \[ga]\-\-transfers\[ga] chunks at the same time (shared among all -the multipart uploads). Chunks are buffered in memory and are -normally 64MB so increasing \[ga]\-\-transfers\[ga] will increase memory use. - -### Limitations ### - -Note that ShareFile is case insensitive so you can\[aq]t have a file called -\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -ShareFile only supports filenames up to 256 characters in length. - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| \[rs]\[rs] | 0x5C | \[uFF3C] | -| * | 0x2A | \[uFF0A] | -| < | 0x3C | \[uFF1C] | -| > | 0x3E | \[uFF1E] | -| ? | 0x3F | \[uFF1F] | -| : | 0x3A | \[uFF1A] | -| \[rs]| | 0x7C | \[uFF5C] | -| \[dq] | 0x22 | \[uFF02] | - -File names can also not start or end with the following characters. -These only get replaced if they are the first or last character in the -name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | -| . | 0x2E | \[uFF0E] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - -Here are the standard options specific to sharefile (Citrix Sharefile). - -#### \-\-sharefile\-root\-folder\-id - -ID of the root folder - -Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the -standard values here or any folder ID (long hex number ID). - -\- Config: root_folder_id -\- Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Access the Personal Folders. (Default) - \- \[dq]favorites\[dq] - \- Access the Favorites folder. - \- \[dq]allshared\[dq] - \- Access all the shared folders. - \- \[dq]connectors\[dq] - \- Access all the individual connectors. - \- \[dq]top\[dq] - \- Access the home, favorites, and shared folders as well as the connectors. - -### Advanced Options - +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Access the Personal Folders. +(Default) +.RE +.IP \[bu] 2 +\[dq]favorites\[dq] +.RS 2 +.IP \[bu] 2 +Access the Favorites folder. +.RE +.IP \[bu] 2 +\[dq]allshared\[dq] +.RS 2 +.IP \[bu] 2 +Access all the shared folders. +.RE +.IP \[bu] 2 +\[dq]connectors\[dq] +.RS 2 +.IP \[bu] 2 +Access all the individual connectors. +.RE +.IP \[bu] 2 +\[dq]top\[dq] +.RS 2 +.IP \[bu] 2 +Access the home, favorites, and shared folders as well as the +connectors. +.RE +.RE +.SS Advanced Options +.PP Here are the advanced options specific to sharefile (Citrix Sharefile). - -#### \-\-sharefile\-upload\-cutoff - +.SS \-\-sharefile\-upload\-cutoff +.PP Cutoff for switching to multipart upload. - -\- Config: upload_cutoff -\- Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 128M - -#### \-\-sharefile\-chunk\-size - -Upload chunk size. Must a power of 2 >= 256k. - -Making this larger will improve performance, but note that each chunk -is buffered in memory one per transfer. - +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 128M +.SS \-\-sharefile\-chunk\-size +.PP +Upload chunk size. +Must a power of 2 >= 256k. +.PP +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. +.PP Reducing this will reduce memory usage but decrease performance. - -\- Config: chunk_size -\- Env Var: RCLONE_SHAREFILE_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 64M - -#### \-\-sharefile\-endpoint - +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 64M +.SS \-\-sharefile\-endpoint +.PP Endpoint for API calls. - -This is usually auto discovered as part of the oauth process, but can -be set manually to something like: https://XXX.sharefile.com - - -\- Config: endpoint -\- Env Var: RCLONE_SHAREFILE_ENDPOINT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-sharefile\-encoding - +.PP +This is usually auto discovered as part of the oauth process, but can be +set manually to something like: https://XXX.sharefile.com +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-sharefile\-encoding +.PP This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_SHAREFILE_ENCODING -\- Type: MultiEncoder -\- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot - - - -Crypt -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The \[ga]crypt\[ga] remote encrypts and decrypts another remote. - -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 -\[ga]remote:path\[ga] in these docs. Note that anything inside \[ga]remote:path\[ga] -will be encrypted and anything outside won\[aq]t. This means that if you -are using a bucket based remote (eg S3, B2, swift) then you should -probably put the bucket in the remote \[ga]s3:bucket\[ga]. If you just use -\[ga]s3:\[ga] then rclone will make encrypted bucket names too (if using file -name encryption) which may or may not be what you want. - -Now configure \[ga]crypt\[ga] using \[ga]rclone config\[ga]. We will call this one -\[ga]secret\[ga] to differentiate it from the \[ga]remote\[ga]. -\f[R] -.fi .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n -.PD 0 -.P -.PD -name> secret Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Encrypt/Decrypt a remote \ \[dq]crypt\[dq] [snip] Storage> crypt Remote -to encrypt/decrypt. -Normally should contain a \[aq]:\[aq] and a path, eg -\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe -\[dq]myremote:\[dq] (not recommended). -remote> remote:path How to encrypt the filenames. -Choose a number from below, or type in your own value 1 / Don\[aq]t -encrypt the file names. -Adds a \[dq].bin\[dq] extension only. -\ \[dq]off\[dq] 2 / Encrypt the filenames see the docs for the details. -\ \[dq]standard\[dq] 3 / Very simple filename obfuscation. -\ \[dq]obfuscate\[dq] filename_encryption> 2 Option to either encrypt -directory names or leave them intact. -Choose a number from below, or type in your own value 1 / Encrypt -directory names. -\ \[dq]true\[dq] 2 / Don\[aq]t encrypt directory names, leave them -intact. -\ \[dq]false\[dq] filename_encryption> 1 Password or pass phrase for -encryption. -y) Yes type in my own password g) Generate random password y/g> y Enter -the password: password: Confirm the password: password: Password or pass -phrase for salt. -Optional but recommended. -Should be different to the previous password. -y) Yes type in my own password g) Generate random password n) No leave -this optional password blank y/g/n> g Password strength in bits. -64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 -Your password is: JAsJvRcgR\-_veXNfy_sGmQ Use this password? -y) Yes n) No y/n> y Remote config -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [secret] remote = remote:path -filename_encryption = standard password = *** ENCRYPTED \f[B]\f[BI] -password2 = \f[B]\f[R] ENCRYPTED *** -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the Citrix ShareFile backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Crypt +.PP +Rclone \f[C]crypt\f[R] remotes encrypt and decrypt other remotes. +.PP +A remote of type \f[C]crypt\f[R] does not access a storage +system (https://rclone.org/overview/) directly, but instead wraps +another remote, which in turn accesses the storage system. +This is similar to how alias (https://rclone.org/alias/), +union (https://rclone.org/union/), chunker (https://rclone.org/chunker/) +and a few others work. +It makes the usage very flexible, as you can add a layer, in this case +an encryption layer, on top of any other backend, even in multiple +layers. +Rclone\[aq]s functionality can be used as with any other remote, for +example you can mount (https://rclone.org/commands/rclone_mount/) a +crypt remote. +.PP +Accessing a storage system through a crypt remote realizes client\-side +encryption, which makes it safe to keep your data in a location you do +not trust will not get compromised. +When working against the \f[C]crypt\f[R] remote, rclone will +automatically encrypt (before uploading) and decrypt (after downloading) +on your local system as needed on the fly, leaving the data encrypted at +rest in the wrapped remote. +If you access the storage system using an application other than rclone, +or access the wrapped remote directly using rclone, there will not be +any encryption/decryption: Downloading existing content will just give +you the encrypted (scrambled) format, and anything you upload will +\f[I]not\f[R] become encrypted. +.PP +The encryption is a secret\-key encryption (also called symmetric key +encryption) algorithm, where a password (or pass phrase) is used to +generate real encryption key. +The password can be supplied by user, or you may chose to let rclone +generate one. +It will be stored in the configuration file, in a lightly obscured form. +If you are in an environment where you are not able to keep your +configuration secured, you should add configuration +encryption (https://rclone.org/docs/#configuration-encryption) as +protection. +As long as you have this configuration file, you will be able to decrypt +your data. +Without the configuration file, as long as you remember the password (or +keep it in a safe place), you can re\-create the configuration and gain +access to the existing data. +You may also configure a corresponding remote in a different +installation to access the same data. +See below for guidance to changing password. +.PP +Encryption uses cryptographic +salt (https://en.wikipedia.org/wiki/Salt_(cryptography)), to permute the +encryption key so that the same string may be encrypted in different +ways. +When configuring the crypt remote it is optional to enter a salt, or to +let rclone generate a unique salt. +If omitted, rclone uses a built\-in unique string. +Normally in cryptography, the salt is stored together with the encrypted +content, and do not have to be memorized by the user. +This is not the case in rclone, because rclone does not store any +additional information on the remotes. +Use of custom salt is effectively a second password that must be +memorized. +.PP +File content encryption is performed using NaCl +SecretBox (https://godoc.org/golang.org/x/crypto/nacl/secretbox), based +on XSalsa20 cipher and Poly1305 for integrity. +Names (file\- and directory names) are also encrypted by default, but +this has some implications and is therefore possible to turned off. +.SS Configuration +.PP +Here is an example of how to make a remote called \f[C]secret\f[R]. +.PP +To use \f[C]crypt\f[R], first set up the underlying remote. +Follow the \f[C]rclone config\f[R] instructions for the specific +backend. +.PP +Before configuring the crypt remote, check the underlying remote is +working. +In this example the underlying remote is called \f[C]remote\f[R]. +We will configure a path \f[C]path\f[R] within this remote to contain +the encrypted content. +Anything inside \f[C]remote:path\f[R] will be encrypted and anything +outside will not. +.PP +Configure \f[C]crypt\f[R] using \f[C]rclone config\f[R]. +In this example the \f[C]crypt\f[R] remote is called \f[C]secret\f[R], +to differentiate it from the underlying \f[C]remote\f[R]. +.PP +When you are done you can use the crypt remote named \f[C]secret\f[R] +just as you would with any other remote, e.g. +\f[C]rclone copy D:\[rs]docs secret:\[rs]docs\f[R], and rclone will +encrypt and decrypt as needed on the fly. +If you access the wrapped remote \f[C]remote:path\f[R] directly you will +bypass the encryption, and anything you read will be in encrypted form, +and anything you write will be undencrypted. +To avoid issues it is best to configure a dedicated path for encrypted +content, and access it exclusively through a crypt remote. .IP .nf \f[C] - -**Important** The password is stored in the config file is lightly -obscured so it isn\[aq]t immediately obvious what it is. It is in no way -secure unless you use config file encryption. - -A long passphrase is recommended, or you can use a random one. - -The obscured password is created by using AES\-CTR with a static key, with -the salt stored verbatim at the beginning of the obscured password. This -static key is shared by between all versions of rclone. - -If you reconfigure rclone with the same passwords/passphrases -elsewhere it will be compatible, but the obscured version will be different -due to the different salt. - -Note that rclone does not encrypt - - * file length \- this can be calculated within 16 bytes - * modification time \- used for syncing - -## Specifying the remote ## - -In normal use, make sure the remote has a \[ga]:\[ga] in. If you specify the -remote without a \[ga]:\[ga] then rclone will use a local directory of that -name. So if you use a remote of \[ga]/path/to/secret/files\[ga] then rclone -will encrypt stuff to that directory. If you use a remote of \[ga]name\[ga] -then rclone will put files in a directory called \[ga]name\[ga] in the current -directory. - -If you specify the remote as \[ga]remote:path/to/dir\[ga] then rclone will -store encrypted files in \[ga]path/to/dir\[ga] on the remote. If you are using -file name encryption, then when you save files to -\[ga]secret:subdir/subfile\[ga] this will store them in the unencrypted path -\[ga]path/to/dir\[ga] but the \[ga]subdir/subpath\[ga] bit will be encrypted. - -Note that unless you want encrypted bucket names (which are difficult -to manage because you won\[aq]t know what directory they represent in web -interfaces etc), you should probably specify a bucket, eg -\[ga]remote:secretbucket\[ga] when using bucket based remotes such as S3, -Swift, Hubic, B2, GCS. - -## Example ## - -To test I made a little directory of files using \[dq]standard\[dq] file name -encryption. -\f[R] -.fi -.PP -plaintext/ \[u251C]\[u2500]\[u2500] file0.txt \[u251C]\[u2500]\[u2500] -file1.txt \[u2514]\[u2500]\[u2500] subdir \[u251C]\[u2500]\[u2500] -file2.txt \[u251C]\[u2500]\[u2500] file3.txt \[u2514]\[u2500]\[u2500] -subsubdir \[u2514]\[u2500]\[u2500] file4.txt -.IP -.nf -\f[C] - -Copy these to the remote and list them back -\f[R] -.fi -.PP -$ rclone \-q copy plaintext secret: $ rclone \-q ls secret: 7 file1.txt -6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 -subdir/file3.txt -.IP -.nf -\f[C] - -Now see what that looked like when encrypted -\f[R] -.fi -.PP -$ rclone \-q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 -v05749mltvv1tf4onltun46gls 57 -86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 -86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc -56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps -.IP -.nf -\f[C] - -Note that this retains the directory structure which means you can do this -\f[R] -.fi -.PP -$ rclone \-q ls secret:subdir 8 file2.txt 9 file3.txt 10 -subsubdir/file4.txt -.IP -.nf -\f[C] - -If don\[aq]t use file name encryption then the remote will look like this -\- note the \[ga].bin\[ga] extensions added to prevent the cloud provider -attempting to interpret the data. -\f[R] -.fi -.PP -$ rclone \-q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 -subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin -.IP -.nf -\f[C] - -### File name encryption modes ### - -Here are some of the features of the file name encryption modes - -Off - - * doesn\[aq]t hide file names or directory structure - * allows for longer file names (\[ti]246 characters) - * can use sub paths and copy single files - -Standard - - * file names encrypted - * file names can\[aq]t be as long (\[ti]143 characters) - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - * can use shortcuts to shorten the directory recursion - -Obfuscation - -This is a simple \[dq]rotate\[dq] of the filename, with each file having a rot -distance based on the filename. We store the distance at the beginning -of the filename. So a file called \[dq]hello\[dq] may become \[dq]53.jgnnq\[dq]. - -This is not a strong encryption of filenames, but it may stop automated -scanning tools from picking up on filename patterns. As such it\[aq]s an -intermediate between \[dq]off\[dq] and \[dq]standard\[dq]. The advantage is that it -allows for longer path segment names. - -There is a possibility with some unicode based filenames that the -obfuscation is weak and may map lower case characters to upper case -equivalents. You can not rely on this for strong protection. - - * file names very lightly obfuscated - * file names can be longer than standard encryption - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - -Cloud storage systems have various limits on file name length and -total path length which you are more likely to hit using \[dq]Standard\[dq] -file name encryption. If you keep your file names to below 156 -characters in length then you should be OK on all providers. - -There may be an even more secure file name encryption mode in the -future which will address the long file name problem. - -### Directory name encryption ### -Crypt offers the option of encrypting dir names or leaving them intact. -There are two options: - -True - -Encrypts the whole file path including directory names -Example: -\[ga]1/12/123.txt\[ga] is encrypted to -\[ga]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\[ga] - -False - -Only encrypts file names, skips directory names -Example: -\[ga]1/12/123.txt\[ga] is encrypted to -\[ga]1/12/qgm4avr35m5loi1th53ato71v0\[ga] - - -### Modified time and hashes ### - -Crypt stores modification times using the underlying remote so support -depends on that. - -Hashes are not stored for crypt. However the data integrity is -protected by an extremely strong crypto authenticator. - -Note that you should use the \[ga]rclone cryptcheck\[ga] command to check the -integrity of a crypted remote instead of \[ga]rclone check\[ga] which can\[aq]t -check the checksums properly. - - -### Standard Options - -Here are the standard options specific to crypt (Encrypt/Decrypt a remote). - -#### \-\-crypt\-remote +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> secret +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / Encrypt/Decrypt a remote + \[rs] \[dq]crypt\[dq] +[snip] +Storage> crypt +** See help for crypt backend at: https://rclone.org/crypt/ ** Remote to encrypt/decrypt. Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). - -\- Config: remote -\- Env Var: RCLONE_CRYPT_REMOTE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-crypt\-filename\-encryption - +Enter a string value. Press Enter for the default (\[dq]\[dq]). +remote> remote:path How to encrypt the filenames. - -\- Config: filename_encryption -\- Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION -\- Type: string -\- Default: \[dq]standard\[dq] -\- Examples: - \- \[dq]standard\[dq] - \- Encrypt the filenames see the docs for the details. - \- \[dq]obfuscate\[dq] - \- Very simple filename obfuscation. - \- \[dq]off\[dq] - \- Don\[aq]t encrypt the file names. Adds a \[dq].bin\[dq] extension only. - -#### \-\-crypt\-directory\-name\-encryption - +Enter a string value. Press Enter for the default (\[dq]standard\[dq]). +Choose a number from below, or type in your own value + 1 / Encrypt the filenames see the docs for the details. + \[rs] \[dq]standard\[dq] + 2 / Very simple filename obfuscation. + \[rs] \[dq]obfuscate\[dq] + 3 / Don\[aq]t encrypt the file names. Adds a \[dq].bin\[dq] extension only. + \[rs] \[dq]off\[dq] +filename_encryption> Option to either encrypt directory names or leave them intact. NB If filename_encryption is \[dq]off\[dq] then this option will do nothing. - -\- Config: directory_name_encryption -\- Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION -\- Type: bool -\- Default: true -\- Examples: - \- \[dq]true\[dq] - \- Encrypt directory names. - \- \[dq]false\[dq] - \- Don\[aq]t encrypt directory names, leave them intact. - -#### \-\-crypt\-password - +Enter a boolean value (true or false). Press Enter for the default (\[dq]true\[dq]). +Choose a number from below, or type in your own value + 1 / Encrypt directory names. + \[rs] \[dq]true\[dq] + 2 / Don\[aq]t encrypt directory names, leave them intact. + \[rs] \[dq]false\[dq] +directory_name_encryption> Password or pass phrase for encryption. - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: password -\- Env Var: RCLONE_CRYPT_PASSWORD -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-crypt\-password2 - +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: +password: +Confirm the password: +password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: password2 -\- Env Var: RCLONE_CRYPT_PASSWORD2 -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - -Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). - -#### \-\-crypt\-server\-side\-across\-configs - -Allow server side operations (eg copy) to work across different crypt configs. - +y) Yes type in my own password +g) Generate random password +n) No leave this optional password blank (default) +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? Please note that an obscured version of this +password (and not the password itself) will be stored under your +configuration file, so keep this generated password in a safe place. +y) Yes (default) +n) No +y/n> +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[secret] +type = crypt +remote = remote:path +password = *** ENCRYPTED *** +password2 = *** ENCRYPTED *** +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> +\f[R] +.fi +.PP +\f[B]Important\f[R] The crypt password stored in \f[C]rclone.conf\f[R] +is lightly obscured. +That only protects it from cursory inspection. +It is not secure unless configuration +encryption (https://rclone.org/docs/#configuration-encryption) of +\f[C]rclone.conf\f[R] is specified. +.PP +A long passphrase is recommended, or \f[C]rclone config\f[R] can +generate a random one. +.PP +The obscured password is created using AES\-CTR with a static key. +The salt is stored verbatim at the beginning of the obscured password. +This static key is shared between all versions of rclone. +.PP +If you reconfigure rclone with the same passwords/passphrases elsewhere +it will be compatible, but the obscured version will be different due to +the different salt. +.PP +Rclone does not encrypt +.IP \[bu] 2 +file length \- this can be calculated within 16 bytes +.IP \[bu] 2 +modification time \- used for syncing +.SS Specifying the remote +.PP +When configuring the remote to encrypt/decrypt, you may specify any +string that rclone accepts as a source/destination of other commands. +.PP +The primary use case is to specify the path into an already configured +remote (e.g. +\f[C]remote:path/to/dir\f[R] or \f[C]remote:bucket\f[R]), such that data +in a remote untrusted location can be stored encrypted. +.PP +You may also specify a local filesystem path, such as +\f[C]/path/to/dir\f[R] on Linux, \f[C]C:\[rs]path\[rs]to\[rs]dir\f[R] on +Windows. +By creating a crypt remote pointing to such a local filesystem path, you +can use rclone as a utility for pure local file encryption, for example +to keep encrypted files on a removable USB drive. +.PP +\f[B]Note\f[R]: A string which do not contain a \f[C]:\f[R] will by +rclone be treated as a relative path in the local filesystem. +For example, if you enter the name \f[C]remote\f[R] without the trailing +\f[C]:\f[R], it will be treated as a subdirectory of the current +directory with name \[dq]remote\[dq]. +.PP +If a path \f[C]remote:path/to/dir\f[R] is specified, rclone stores +encrypted files in \f[C]path/to/dir\f[R] on the remote. +With file name encryption, files saved to +\f[C]secret:subdir/subfile\f[R] are stored in the unencrypted path +\f[C]path/to/dir\f[R] but the \f[C]subdir/subpath\f[R] element is +encrypted. +.PP +The path you specify does not have to exist, rclone will create it when +needed. +.PP +If you intend to use the wrapped remote both directly for keeping +unencrypted content, as well as through a crypt remote for encrypted +content, it is recommended to point the crypt remote to a separate +directory within the wrapped remote. +If you use a bucket based storage system (e.g. +Swift, S3, Google Compute Storage, B2, Hubic) it is generally advisable +to wrap the crypt remote around a specific bucket (\f[C]s3:bucket\f[R]). +If wrapping around the entire root of the storage (\f[C]s3:\f[R]), and +use the optional file name encryption, rclone will encrypt the bucket +name. +.SS Changing password +.PP +Should the password, or the configuration file containing a lightly +obscured form of the password, be compromised, you need to re\-encrypt +your data with a new password. +Since rclone uses secret\-key encryption, where the encryption key is +generated directly from the password kept on the client, it is not +possible to change the password/key of already encrypted content. +Just changing the password configured for an existing crypt remote means +you will no longer able to decrypt any of the previously encrypted +content. +The only possibility is to re\-upload everything via a crypt remote +configured with your new password. +.PP +Depending on the size of your data, your bandwith, storage quota etc, +there are different approaches you can take: \- If you have everything +in a different location, for example on your local system, you could +remove all of the prior encrypted files, change the password for your +configured crypt remote (or delete and re\-create the crypt +configuration), and then re\-upload everything from the alternative +location. +\- If you have enough space on the storage system you can create a new +crypt remote pointing to a separate directory on the same backend, and +then use rclone to copy everything from the original crypt remote to the +new, effectively decrypting everything on the fly using the old password +and re\-encrypting using the new password. +When done, delete the original crypt remote directory and finally the +rclone crypt configuration with the old password. +All data will be streamed from the storage system and back, so you will +get half the bandwith and be charged twice if you have upload and +download quota on the storage system. +.PP +\f[B]Note\f[R]: A security problem related to the random password +generator was fixed in rclone version 1.53.3 (released 2020\-11\-19). +Passwords generated by rclone config in version 1.49.0 (released +2019\-08\-26) to 1.53.2 (released 2020\-10\-26) are not considered +secure and should be changed. +If you made up your own password, or used rclone version older than +1.49.0 or newer than 1.53.2 to generate it, you are \f[I]not\f[R] +affected by this issue. +See issue #4783 (https://github.com/rclone/rclone/issues/4783) for more +details, and a tool you can use to check if you are affected. +.SS Example +.PP +Create the following file structure using \[dq]standard\[dq] file name +encryption. +.IP +.nf +\f[C] +plaintext/ +\[u251C]\[u2500]\[u2500] file0.txt +\[u251C]\[u2500]\[u2500] file1.txt +\[u2514]\[u2500]\[u2500] subdir + \[u251C]\[u2500]\[u2500] file2.txt + \[u251C]\[u2500]\[u2500] file3.txt + \[u2514]\[u2500]\[u2500] subsubdir + \[u2514]\[u2500]\[u2500] file4.txt +\f[R] +.fi +.PP +Copy these to the remote, and list them +.IP +.nf +\f[C] +$ rclone \-q copy plaintext secret: +$ rclone \-q ls secret: + 7 file1.txt + 6 file0.txt + 8 subdir/file2.txt + 10 subdir/subsubdir/file4.txt + 9 subdir/file3.txt +\f[R] +.fi +.PP +The crypt remote looks like +.IP +.nf +\f[C] +$ rclone \-q ls remote:path + 55 hagjclgavj2mbiqm6u6cnjjqcg + 54 v05749mltvv1tf4onltun46gls + 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo + 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc + 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps +\f[R] +.fi +.PP +The directory structure is preserved +.IP +.nf +\f[C] +$ rclone \-q ls secret:subdir + 8 file2.txt + 9 file3.txt + 10 subsubdir/file4.txt +\f[R] +.fi +.PP +Without file name encryption \f[C].bin\f[R] extensions are added to +underlying names. +This prevents the cloud provider attempting to interpret file content. +.IP +.nf +\f[C] +$ rclone \-q ls remote:path + 54 file0.txt.bin + 57 subdir/file3.txt.bin + 56 subdir/file2.txt.bin + 58 subdir/subsubdir/file4.txt.bin + 55 file1.txt.bin +\f[R] +.fi +.SS File name encryption modes +.PP +Off +.IP \[bu] 2 +doesn\[aq]t hide file names or directory structure +.IP \[bu] 2 +allows for longer file names (\[ti]246 characters) +.IP \[bu] 2 +can use sub paths and copy single files +.PP +Standard +.IP \[bu] 2 +file names encrypted +.IP \[bu] 2 +file names can\[aq]t be as long (\[ti]143 characters) +.IP \[bu] 2 +can use sub paths and copy single files +.IP \[bu] 2 +directory structure visible +.IP \[bu] 2 +identical files names will have identical uploaded names +.IP \[bu] 2 +can use shortcuts to shorten the directory recursion +.PP +Obfuscation +.PP +This is a simple \[dq]rotate\[dq] of the filename, with each file having +a rot distance based on the filename. +Rclone stores the distance at the beginning of the filename. +A file called \[dq]hello\[dq] may become \[dq]53.jgnnq\[dq]. +.PP +Obfuscation is not a strong encryption of filenames, but hinders +automated scanning tools picking up on filename patterns. +It is an intermediate between \[dq]off\[dq] and \[dq]standard\[dq] which +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. +.PP +Obfuscation cannot be relied upon 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 limits on file name length and total path +length which rclone is more likely to breach using \[dq]Standard\[dq] +file name encryption. +Where file names are less thn 156 characters in length issues should not +be encountered, irrespective of cloud storage provider. +.PP +An alternative, future rclone file name encryption mode may tolerate +backend provider path length limits. +.SS Directory name encryption +.PP +Crypt offers the option of encrypting dir names or leaving them intact. +There are two options: +.PP +True +.PP +Encrypts the whole file path including directory names Example: +\f[C]1/12/123.txt\f[R] is encrypted to +\f[C]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\f[R] +.PP +False +.PP +Only encrypts file names, skips directory names Example: +\f[C]1/12/123.txt\f[R] is encrypted to +\f[C]1/12/qgm4avr35m5loi1th53ato71v0\f[R] +.SS Modified time and hashes +.PP +Crypt stores modification times using the underlying remote so support +depends on that. +.PP +Hashes are not stored for crypt. +However the data integrity is protected by an extremely strong crypto +authenticator. +.PP +Use the \f[C]rclone cryptcheck\f[R] command to check the integrity of a +crypted remote instead of \f[C]rclone check\f[R] which can\[aq]t check +the checksums properly. +.SS Standard Options +.PP +Here are the standard options specific to crypt (Encrypt/Decrypt a +remote). +.SS \-\-crypt\-remote +.PP +Remote to encrypt/decrypt. +Normally should contain a \[aq]:\[aq] and a path, e.g. +\[dq]myremote:path/to/dir\[dq], \[dq]myremote:bucket\[dq] or maybe +\[dq]myremote:\[dq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-crypt\-filename\-encryption +.PP +How to encrypt the filenames. +.IP \[bu] 2 +Config: filename_encryption +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]standard\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]standard\[dq] +.RS 2 +.IP \[bu] 2 +Encrypt the filenames see the docs for the details. +.RE +.IP \[bu] 2 +\[dq]obfuscate\[dq] +.RS 2 +.IP \[bu] 2 +Very simple filename obfuscation. +.RE +.IP \[bu] 2 +\[dq]off\[dq] +.RS 2 +.IP \[bu] 2 +Don\[aq]t encrypt the file names. +Adds a \[dq].bin\[dq] extension only. +.RE +.RE +.SS \-\-crypt\-directory\-name\-encryption +.PP +Option to either encrypt directory names or leave them intact. +.PP +NB If filename_encryption is \[dq]off\[dq] then this option will do +nothing. +.IP \[bu] 2 +Config: directory_name_encryption +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]true\[dq] +.RS 2 +.IP \[bu] 2 +Encrypt directory names. +.RE +.IP \[bu] 2 +\[dq]false\[dq] +.RS 2 +.IP \[bu] 2 +Don\[aq]t encrypt directory names, leave them intact. +.RE +.RE +.SS \-\-crypt\-password +.PP +Password or pass phrase for encryption. +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: password +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-crypt\-password2 +.PP +Password or pass phrase for salt. +Optional but recommended. +Should be different to the previous password. +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: password2 +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_PASSWORD2 +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to crypt (Encrypt/Decrypt a +remote). +.SS \-\-crypt\-server\-side\-across\-configs +.PP +Allow server\-side operations (e.g. +copy) to work across different crypt configs. +.PP Normally this option is not what you want, but if you have two crypts pointing to the same backend you can use it. - +.PP This can be used, for example, to change file name encryption type -without re\-uploading all the data. Just make two crypt backends -pointing to two different directories with the single changed -parameter and use rclone move to move the files between the crypt -remotes. - -\- Config: server_side_across_configs -\- Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS -\- Type: bool -\- Default: false - -#### \-\-crypt\-show\-mapping - +without re\-uploading all the data. +Just make two crypt backends pointing to two different directories with +the single changed parameter and use rclone move to move the files +between the crypt remotes. +.IP \[bu] 2 +Config: server_side_across_configs +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_SERVER_SIDE_ACROSS_CONFIGS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-crypt\-show\-mapping +.PP For all files listed show how the names encrypt. - -If this flag is set then for each file that the remote is asked to -list, it will log (at level INFO) a line stating the decrypted file -name and the encrypted file name. - +.PP +If this flag is set then for each file that the remote is asked to list, +it will log (at level INFO) a line stating the decrypted file name and +the encrypted file name. +.PP This is so you can work out which encrypted names are which decrypted names just in case you need to do something with the encrypted file names, or for debugging purposes. - -\- Config: show_mapping -\- Env Var: RCLONE_CRYPT_SHOW_MAPPING -\- Type: bool -\- Default: false - -### Backend commands - +.IP \[bu] 2 +Config: show_mapping +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_SHOW_MAPPING +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Backend commands +.PP Here are the commands specific to the crypt backend. - +.PP Run them with - - rclone backend COMMAND remote: - +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### encode - +backend/command (https://rclone.org/rc/#backend/command). +.SS encode +.PP Encode the given filename(s) - - rclone backend encode remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend encode remote: [options] [+] +\f[R] +.fi +.PP This encodes the filenames given as arguments returning a list of strings of the encoded results. - +.PP Usage Example: - - rclone backend encode crypt: file1 [file2...] - rclone rc backend/command command=encode fs=crypt: file1 [file2...] - - -#### decode - +.IP +.nf +\f[C] +rclone backend encode crypt: file1 [file2...] +rclone rc backend/command command=encode fs=crypt: file1 [file2...] +\f[R] +.fi +.SS decode +.PP Decode the given filename(s) - - rclone backend decode remote: [options] [+] - +.IP +.nf +\f[C] +rclone backend decode remote: [options] [+] +\f[R] +.fi +.PP This decodes the filenames given as arguments returning a list of -strings of the decoded results. It will return an error if any of the -inputs are invalid. - +strings of the decoded results. +It will return an error if any of the inputs are invalid. +.PP Usage Example: - - rclone backend decode crypt: encryptedfile1 [encryptedfile2...] - rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] - - - - -## Backing up a crypted remote ## - +.IP +.nf +\f[C] +rclone backend decode crypt: encryptedfile1 [encryptedfile2...] +rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...] +\f[R] +.fi +.SS Backing up a crypted remote +.PP If you wish to backup a crypted remote, it is recommended that you use -\[ga]rclone sync\[ga] on the encrypted files, and make sure the passwords are -the same in the new encrypted remote. - +\f[C]rclone sync\f[R] on the encrypted files, and make sure the +passwords are the same in the new encrypted remote. +.PP This will have the following advantages - - * \[ga]rclone sync\[ga] will check the checksums while copying - * you can use \[ga]rclone check\[ga] between the encrypted remotes - * you don\[aq]t decrypt and encrypt unnecessarily - -For example, let\[aq]s say you have your original remote at \[ga]remote:\[ga] with -the encrypted version at \[ga]eremote:\[ga] with path \[ga]remote:crypt\[ga]. You -would then set up the new remote \[ga]remote2:\[ga] and then the encrypted -version \[ga]eremote2:\[ga] with path \[ga]remote2:crypt\[ga] using the same passwords -as \[ga]eremote:\[ga]. - +.IP \[bu] 2 +\f[C]rclone sync\f[R] will check the checksums while copying +.IP \[bu] 2 +you can use \f[C]rclone check\f[R] between the encrypted remotes +.IP \[bu] 2 +you don\[aq]t decrypt and encrypt unnecessarily +.PP +For example, let\[aq]s say you have your original remote at +\f[C]remote:\f[R] with the encrypted version at \f[C]eremote:\f[R] with +path \f[C]remote:crypt\f[R]. +You would then set up the new remote \f[C]remote2:\f[R] and then the +encrypted version \f[C]eremote2:\f[R] with path \f[C]remote2:crypt\f[R] +using the same passwords as \f[C]eremote:\f[R]. +.PP To sync the two remotes you would do - - rclone sync \-i remote:crypt remote2:crypt - +.IP +.nf +\f[C] +rclone sync \-i remote:crypt remote2:crypt +\f[R] +.fi +.PP And to check the integrity you would do - - rclone check remote:crypt remote2:crypt - -## File formats ## - -### File encryption ### - -Files are encrypted 1:1 source file to destination object. The file -has a header and is divided into chunks. - -#### Header #### - - * 8 bytes magic string \[ga]RCLONE\[rs]x00\[rs]x00\[ga] - * 24 bytes Nonce (IV) - -The initial nonce is generated from the operating systems crypto -strong random number generator. The nonce is incremented for each -chunk read making sure each nonce is unique for each block written. -The chance of a nonce being re\-used is minuscule. If you wrote an -exabyte of data (10\[S1]\[u2078] bytes) you would have a probability of -approximately 2\[tmu]10\[u207B]\[S3]\[S2] of re\-using a nonce. - -#### Chunk #### - -Each chunk will contain 64kB of data, except for the last one which -may have less data. The data chunk is in standard NACL secretbox -format. Secretbox uses XSalsa20 and Poly1305 to encrypt and -authenticate messages. - +.IP +.nf +\f[C] +rclone check remote:crypt remote2:crypt +\f[R] +.fi +.SS File formats +.SS File encryption +.PP +Files are encrypted 1:1 source file to destination object. +The file has a header and is divided into chunks. +.SS Header +.IP \[bu] 2 +8 bytes magic string \f[C]RCLONE\[rs]x00\[rs]x00\f[R] +.IP \[bu] 2 +24 bytes Nonce (IV) +.PP +The initial nonce is generated from the operating systems crypto strong +random number generator. +The nonce is incremented for each chunk read making sure each nonce is +unique for each block written. +The chance of a nonce being re\-used is minuscule. +If you wrote an exabyte of data (10\[S1]\[u2078] bytes) you would have a +probability of approximately 2\[tmu]10\[u207B]\[S3]\[S2] of re\-using a +nonce. +.SS Chunk +.PP +Each chunk will contain 64kB of data, except for the last one which may +have less data. +The data chunk is in standard NaCl SecretBox format. +SecretBox uses XSalsa20 and Poly1305 to encrypt and authenticate +messages. +.PP Each chunk contains: - - * 16 Bytes of Poly1305 authenticator - * 1 \- 65536 bytes XSalsa20 encrypted data - +.IP \[bu] 2 +16 Bytes of Poly1305 authenticator +.IP \[bu] 2 +1 \- 65536 bytes XSalsa20 encrypted data +.PP 64k chunk size was chosen as the best performing chunk size (the authenticator takes too much time below this and the performance drops -off due to cache effects above this). Note that these chunks are -buffered in memory so they can\[aq]t be too big. - +off due to cache effects above this). +Note that these chunks are buffered in memory so they can\[aq]t be too +big. +.PP This uses a 32 byte (256 bit key) key derived from the user password. - -#### Examples #### - +.SS Examples +.PP 1 byte file will encrypt to - - * 32 bytes header - * 17 bytes data chunk - +.IP \[bu] 2 +32 bytes header +.IP \[bu] 2 +17 bytes data chunk +.PP 49 bytes total - +.PP 1MB (1048576 bytes) file will encrypt to - - * 32 bytes header - * 16 chunks of 65568 bytes - -1049120 bytes total (a 0.05% overhead). This is the overhead for big -files. - -### Name encryption ### - +.IP \[bu] 2 +32 bytes header +.IP \[bu] 2 +16 chunks of 65568 bytes +.PP +1049120 bytes total (a 0.05% overhead). +This is the overhead for big files. +.SS Name encryption +.PP File names are encrypted segment by segment \- the path is broken up -into \[ga]/\[ga] separated strings and these are encrypted individually. - -File segments are padded using PKCS#7 to a multiple of 16 bytes -before encryption. - -They are then encrypted with EME using AES with 256 bit key. EME -(ECB\-Mix\-ECB) is a wide\-block encryption mode presented in the 2003 -paper \[dq]A Parallelizable Enciphering Mode\[dq] by Halevi and Rogaway. - +into \f[C]/\f[R] separated strings and these are encrypted individually. +.PP +File segments are padded using PKCS#7 to a multiple of 16 bytes before +encryption. +.PP +They are then encrypted with EME using AES with 256 bit key. +EME (ECB\-Mix\-ECB) is a wide\-block encryption mode presented in the +2003 paper \[dq]A Parallelizable Enciphering Mode\[dq] by Halevi and +Rogaway. +.PP This makes for deterministic encryption which is what we want \- the same filename must encrypt to the same thing otherwise we can\[aq]t find it on the cloud storage system. - +.PP This means that - - * filenames with the same name will encrypt the same - * filenames which start the same won\[aq]t have a common prefix - +.IP \[bu] 2 +filenames with the same name will encrypt the same +.IP \[bu] 2 +filenames which start the same won\[aq]t have a common prefix +.PP This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of which are derived from the user password. - +.PP After encryption they are written out using a modified version of -standard \[ga]base32\[ga] encoding as described in RFC4648. The standard -encoding is modified in two ways: +standard \f[C]base32\f[R] encoding as described in RFC4648. +The standard encoding is modified in two ways: +.IP \[bu] 2 +it becomes lower case (no\-one likes upper case filenames!) +.IP \[bu] 2 +we strip the padding character \f[C]=\f[R] +.PP +\f[C]base32\f[R] is used rather than the more efficient \f[C]base64\f[R] +so rclone can be used on case insensitive remotes (e.g. +Windows, Amazon Drive). +.SS Key derivation +.PP +Rclone uses \f[C]scrypt\f[R] with parameters \f[C]N=16384, r=8, p=1\f[R] +with an optional user supplied salt (password2) to derive the 32+32+16 = +80 bytes of key material required. +If the user doesn\[aq]t supply a salt then rclone uses an internal one. +.PP +\f[C]scrypt\f[R] makes it impractical to mount a dictionary attack on +rclone encrypted data. +For full protection against this you should always use a salt. +.SS SEE ALSO +.IP \[bu] 2 +rclone cryptdecode (https://rclone.org/commands/rclone_cryptdecode/) \- +Show forward/reverse mapping of encrypted filenames +.SS Compress (Experimental) +.SS Warning +.PP +This remote is currently \f[B]experimental\f[R]. +Things may break and data may be lost. +Anything you do with this remote is at your own risk. +Please understand the risks associated with using experimental code and +don\[aq]t use this remote in critical applications. +.PP +The \f[C]Compress\f[R] remote adds compression to another remote. +It is best used with remotes containing many large compressible files. +.PP +To use this remote, all you need to do is specify another remote and a +compression mode to use: +.IP +.nf +\f[C] +Current remotes: - * it becomes lower case (no\-one likes upper case filenames!) - * we strip the padding character \[ga]=\[ga] +Name Type +==== ==== +remote_to_press sometype -\[ga]base32\[ga] is used rather than the more efficient \[ga]base64\[ga] so rclone can be -used on case insensitive remotes (eg Windows, Amazon Drive). +e) Edit existing remote +$ rclone config +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> n +name> compress +\&... + 8 / Compress a remote + \[rs] \[dq]compress\[dq] +\&... +Storage> compress +** See help for compress backend at: https://rclone.org/compress/ ** -### Key derivation ### - -Rclone uses \[ga]scrypt\[ga] with parameters \[ga]N=16384, r=8, p=1\[ga] with an -optional user supplied salt (password2) to derive the 32+32+16 = 80 -bytes of key material required. If the user doesn\[aq]t supply a salt -then rclone uses an internal one. - -\[ga]scrypt\[ga] makes it impractical to mount a dictionary attack on rclone -encrypted data. For full protection against this you should always use -a salt. - - Dropbox -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]remote:path\[ga] - -Dropbox paths may be as deep as required, eg -\[ga]remote:directory/subdirectory\[ga]. - -The initial setup for dropbox involves getting a token from Dropbox -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: +Remote to compress. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +remote> remote_to_press:subdir +Compression mode. +Enter a string value. Press Enter for the default (\[dq]gzip\[dq]). +Choose a number from below, or type in your own value + 1 / Gzip compression balanced for speed and compression strength. + \[rs] \[dq]gzip\[dq] +compression_mode> gzip +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[compress] +type = compress +remote = remote_to_press:subdir +compression_mode = gzip +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y \f[R] .fi -.IP "n)" 3 -New remote -.IP "o)" 3 -Delete remote -.IP "p)" 3 -Quit config e/n/d/q> n name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Dropbox \ \[dq]dropbox\[dq] [snip] Storage> dropbox Dropbox App Key \- -leave blank normally. -app_key> Dropbox App Secret \- leave blank normally. -app_secret> Remote config Please visit: +.SS Compression Modes +.PP +Currently only gzip compression is supported, it provides a decent +balance between speed and strength and is well supported by other +application. +Compression strength can further be configured via an advanced setting +where 0 is no compression and 9 is strongest compression. +.SS Filetype +.PP +If you open a remote wrapped by press, you will see that there are many +files with an extension corresponding to the compression algorithm you +chose. +These files are standard files that can be opened by various archive +programs, but they have some hidden metadata that allows them to be used +by rclone. +While you may download and decompress these files at will, do +\f[B]not\f[R] manually delete or rename files. +Files without correct metadata files will not be recognized by rclone. +.SS File names +.PP +The compressed files will be named \f[C]*.###########.gz\f[R] where +\f[C]*\f[R] is the base file and the \f[C]#\f[R] part is base64 encoded +size of the uncompressed file. +The file names should not be changed by anything other than the rclone +compression backend. +.SS Standard Options +.PP +Here are the standard options specific to compress (Compress a remote). +.SS \-\-compress\-remote +.PP +Remote to compress. +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_COMPRESS_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-compress\-mode +.PP +Compression mode. +.IP \[bu] 2 +Config: mode +.IP \[bu] 2 +Env Var: RCLONE_COMPRESS_MODE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]gzip\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]gzip\[dq] +.RS 2 +.IP \[bu] 2 +Standard gzip compression with fastest parameters. +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to compress (Compress a remote). +.SS \-\-compress\-level +.PP +GZIP compression level (\-2 to 9). +.IP +.nf +\f[C] + Generally \-1 (default, equivalent to 5) is recommended. + Levels 1 to 9 increase compressiong at the cost of speed.. Going past 6 + generally offers very little return. + + Level \-2 uses Huffmann encoding only. Only use if you now what you + are doing + Level 0 turns off compression. +\f[R] +.fi +.IP \[bu] 2 +Config: level +.IP \[bu] 2 +Env Var: RCLONE_COMPRESS_LEVEL +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: \-1 +.SS \-\-compress\-ram\-cache\-limit +.PP +Some remotes don\[aq]t allow the upload of files with unknown size. +In this case the compressed file will need to be cached to determine +it\[aq]s size. +.IP +.nf +\f[C] + Files smaller than this limit will be cached in RAM, file larger than + this limit will be cached on disk +\f[R] +.fi +.IP \[bu] 2 +Config: ram_cache_limit +.IP \[bu] 2 +Env Var: RCLONE_COMPRESS_RAM_CACHE_LIMIT +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 20M +.SS Dropbox +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Dropbox paths may be as deep as required, e.g. +\f[C]remote:directory/subdirectory\f[R]. +.PP +The initial setup for dropbox involves getting a token from Dropbox +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +n) New remote +d) Delete remote +q) Quit config +e/n/d/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Dropbox + \[rs] \[dq]dropbox\[dq] +[snip] +Storage> dropbox +Dropbox App Key \- leave blank normally. +app_key> +Dropbox App Secret \- leave blank normally. +app_secret> +Remote config +Please visit: https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] app_key = app_secret = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +app_key = +app_secret = token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.IP "q)" 3 -Yes this is OK -.IP "r)" 3 -Edit this remote -.IP "s)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP You can then use it like this, - +.PP List directories in top level of your dropbox - - rclone lsd remote: - +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP List all the files in your dropbox - - rclone ls remote: - +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP To copy a local directory to a dropbox directory called backup - - rclone copy /home/source remote:backup - -### Dropbox for business ### - +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Dropbox for business +.PP Rclone supports Dropbox for business and Team Folders. - -When using Dropbox for business \[ga]remote:\[ga] and \[ga]remote:path/to/file\[ga] -will refer to your personal folder. - -If you wish to see Team Folders you must use a leading \[ga]/\[ga] in the -path, so \[ga]rclone lsd remote:/\[ga] will refer to the root and show you all -Team Folders and your User Folder. - -You can then use team folders like this \[ga]remote:/TeamFolder\[ga] and -\[ga]remote:/TeamFolder/path/to/file\[ga]. - -A leading \[ga]/\[ga] for a Dropbox personal account will do nothing, but it -will take an extra HTTP transaction so it should be avoided. - -### Modified time and Hashes ### - -Dropbox supports modified times, but the only way to set a -modification time is to re\-upload the file. - +.PP +When using Dropbox for business \f[C]remote:\f[R] and +\f[C]remote:path/to/file\f[R] will refer to your personal folder. +.PP +If you wish to see Team Folders you must use a leading \f[C]/\f[R] in +the path, so \f[C]rclone lsd remote:/\f[R] will refer to the root and +show you all Team Folders and your User Folder. +.PP +You can then use team folders like this \f[C]remote:/TeamFolder\f[R] and +\f[C]remote:/TeamFolder/path/to/file\f[R]. +.PP +A leading \f[C]/\f[R] for a Dropbox personal account will do nothing, +but it will take an extra HTTP transaction so it should be avoided. +.SS Modified time and Hashes +.PP +Dropbox supports modified times, but the only way to set a modification +time is to re\-upload the file. +.PP This means that if you uploaded your data with an older version of -rclone which didn\[aq]t support the v2 API and modified times, rclone will -decide to upload all your old data to fix the modification times. If -you don\[aq]t want this to happen use \[ga]\-\-size\-only\[ga] or \[ga]\-\-checksum\[ga] flag -to stop it. - -Dropbox supports [its own hash -type](https://www.dropbox.com/developers/reference/content\-hash) which +rclone which didn\[aq]t support the v2 API and modified times, rclone +will decide to upload all your old data to fix the modification times. +If you don\[aq]t want this to happen use \f[C]\-\-size\-only\f[R] or +\f[C]\-\-checksum\f[R] flag to stop it. +.PP +Dropbox supports its own hash +type (https://www.dropbox.com/developers/reference/content-hash) which is checked for all transfers. - -#### Restricted filename characters - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| / | 0x2F | \[uFF0F] | -| DEL | 0x7F | \[u2421] | -| \[rs] | 0x5C | \[uFF3C] | - -File names can also not end with the following characters. -These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - -Here are the standard options specific to dropbox (Dropbox). - -#### \-\-dropbox\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_DROPBOX_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_DROPBOX_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -### Advanced Options - -Here are the advanced options specific to dropbox (Dropbox). - -#### \-\-dropbox\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_DROPBOX_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_DROPBOX_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_DROPBOX_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-chunk\-size - -Upload chunk size. (< 150M). - -Any files larger than this will be uploaded in chunks of this size. - -Note that chunks are buffered in memory (one at a time) so rclone can -deal with retries. Setting this larger will increase the speed -slightly (at most 10% for 128MB in tests) at the cost of using more -memory. It can be set smaller if you are tight on memory. - -\- Config: chunk_size -\- Env Var: RCLONE_DROPBOX_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 48M - -#### \-\-dropbox\-impersonate - -Impersonate this user when using a business account. - -\- Config: impersonate -\- Env Var: RCLONE_DROPBOX_IMPERSONATE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-dropbox\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_DROPBOX_ENCODING -\- Type: MultiEncoder -\- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - - - -### Limitations ### - -Note that Dropbox is case insensitive so you can\[aq]t have a file called -\[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. - -There are some file names such as \[ga]thumbs.db\[ga] which Dropbox can\[aq]t -store. There is a full list of them in the [\[dq]Ignored Files\[dq] section -of this document](https://www.dropbox.com/en/help/145). Rclone will -issue an error message \[ga]File name disallowed \- not uploading\[ga] if it -attempts to upload one of those file names, but the sync won\[aq]t fail. - -Some errors may occur if you try to sync copyright\-protected files -because Dropbox has its own [copyright detector](https://techcrunch.com/2014/03/30/how\-dropbox\-knows\-when\-youre\-sharing\-copyrighted\-stuff\-without\-actually\-looking\-at\-your\-stuff/) that -prevents this sort of file being downloaded. This will return the error \[ga]ERROR : -/path/to/your/file: Failed to copy: failed to open source object: -path/restricted_content/.\[ga] - -If you have more than 10,000 files in a directory then \[ga]rclone purge -dropbox:dir\[ga] will return the error \[ga]Failed to purge: There are too -many files involved in this operation\[ga]. As a work\-around do an -\[ga]rclone delete dropbox:dir\[ga] followed by an \[ga]rclone rmdir dropbox:dir\[ga]. - -### Get your own Dropbox App ID ### - -When you use rclone with Dropbox in its default configuration you are using rclone\[aq]s App ID. This is shared between all the rclone users. - -Here is how to create your own Dropbox App ID for rclone: - -1. Log into the [Dropbox App console](https://www.dropbox.com/developers/apps/create) with your Dropbox Account (It need not -to be the same account as the Dropbox you want to access) - -2. Choose an API => Usually this should be \[ga]Dropbox API\[ga] - -3. Choose the type of access you want to use => \[ga]Full Dropbox\[ga] or \[ga]App Folder\[ga] - -4. Name your App. The app name is global, so you can\[aq]t use \[ga]rclone\[ga] for example - -5. Click the button \[ga]Create App\[ga] - -5. Fill \[ga]Redirect URIs\[ga] as \[ga]http://localhost:53682/\[ga] - -6. Find the \[ga]App key\[ga] and \[ga]App secret\[ga] Use these values in rclone config to add a new remote or edit an existing remote. - - FTP -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -FTP is the File Transfer Protocol. FTP support is provided using the -[github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) -package. - -Paths are specified as \[ga]remote:path\[ga]. If the path does not begin with -a \[ga]/\[ga] it is relative to the home directory of the user. An empty path -\[ga]remote:\[ga] refers to the user\[aq]s home directory. - -Here is an example of making an FTP configuration. First run - - rclone config - -This will guide you through an interactive setup process. An FTP remote only -needs a host together with and a username and a password. With anonymous FTP -server, you will need to use \[ga]anonymous\[ga] as username and your email address as -the password. -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] XX / FTP -Connection \ \[dq]ftp\[dq] [snip] Storage> ftp ** See help for ftp -backend at: https://rclone.org/ftp/ ** -.PP -FTP host to connect to Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value 1 / Connect to -ftp.example.com \ \[dq]ftp.example.com\[dq] host> ftp.example.com FTP -username, leave blank for current username, ncw Enter a string value. -Press Enter for the default (\[dq]\[dq]). -user> FTP port, leave blank to use default (21) Enter a string value. -Press Enter for the default (\[dq]\[dq]). -port> FTP password y) Yes type in my own password g) Generate random -password y/g> y Enter the password: password: Confirm the password: -password: Use FTP over TLS (Implicit) Enter a boolean value (true or -false). -Press Enter for the default (\[dq]false\[dq]). -tls> Use FTP over TLS (Explicit) Enter a boolean value (true or false). -Press Enter for the default (\[dq]false\[dq]). -explicit_tls> Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -[remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED *** -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -This remote is called \[ga]remote\[ga] and can now be used like this - -See all directories in the home directory - - rclone lsd remote: - -Make a new directory - - rclone mkdir remote:path/to/directory - -List the contents of a directory - - rclone ls remote:path/to/directory - -Sync \[ga]/home/local/directory\[ga] to the remote directory, deleting any -excess files in the directory. - - rclone sync \-i /home/local/directory remote:directory - -### Modified time ### - -FTP does not support modified times. Any times you see on the server -will be time of upload. - -### Checksums ### - -FTP does not support any checksums. - -### Usage without a config file ### - -An example how to use the ftp remote without a config file: - - rclone lsf :ftp: \-\-ftp\-host=speedtest.tele2.net \-\-ftp\-user=anonymous \-\-ftp\-pass=\[ga]rclone obscure dummy\[ga] - -#### Restricted filename characters - -In addition to the [default restricted characters set](https://rclone.org/overview/#restricted\-characters) -the following characters are also replaced: - -File names can also not end with the following characters. -These only get replaced if they are the last character in the name: - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| SP | 0x20 | \[u2420] | - -Note that not all FTP servers can have all characters in file names, for example: - -| FTP Server| Forbidden characters | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:| -| proftpd | \[ga]*\[ga] | -| pureftpd | \[ga]\[rs] [ ]\[ga] | - -### Implicit TLS ### - -FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled -in the config for the remote. The default FTPS port is \[ga]990\[ga] so the -port will likely have to be explicitly set in the config for the remote. - - -### Standard Options - -Here are the standard options specific to ftp (FTP Connection). - -#### \-\-ftp\-host - -FTP host to connect to - -\- Config: host -\- Env Var: RCLONE_FTP_HOST -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]ftp.example.com\[dq] - \- Connect to ftp.example.com - -#### \-\-ftp\-user - -FTP username, leave blank for current username, $USER - -\- Config: user -\- Env Var: RCLONE_FTP_USER -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-ftp\-port - -FTP port, leave blank to use default (21) - -\- Config: port -\- Env Var: RCLONE_FTP_PORT -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-ftp\-pass - -FTP password - -**NB** Input to this must be obscured \- see [rclone obscure](https://rclone.org/commands/rclone_obscure/). - -\- Config: pass -\- Env Var: RCLONE_FTP_PASS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-ftp\-tls - -Use FTPS over TLS (Implicit) -When using implicit FTP over TLS the client will connect using TLS -right from the start, which in turn breaks the compatibility with -non\-TLS\-aware servers. This is usually served over port 990 rather -than port 21. Cannot be used in combination with explicit FTP. - -\- Config: tls -\- Env Var: RCLONE_FTP_TLS -\- Type: bool -\- Default: false - -#### \-\-ftp\-explicit\-tls - -Use FTP over TLS (Explicit) -When using explicit FTP over TLS the client explicitly request -security from the server in order to upgrade a plain text connection -to an encrypted one. Cannot be used in combination with implicit FTP. - -\- Config: explicit_tls -\- Env Var: RCLONE_FTP_EXPLICIT_TLS -\- Type: bool -\- Default: false - -### Advanced Options - -Here are the advanced options specific to ftp (FTP Connection). - -#### \-\-ftp\-concurrency - -Maximum number of FTP simultaneous connections, 0 for unlimited - -\- Config: concurrency -\- Env Var: RCLONE_FTP_CONCURRENCY -\- Type: int -\- Default: 0 - -#### \-\-ftp\-no\-check\-certificate - -Do not verify the TLS certificate of the server - -\- Config: no_check_certificate -\- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE -\- Type: bool -\- Default: false - -#### \-\-ftp\-disable\-epsv - -Disable using EPSV even if server advertises support - -\- Config: disable_epsv -\- Env Var: RCLONE_FTP_DISABLE_EPSV -\- Type: bool -\- Default: false - -#### \-\-ftp\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_FTP_ENCODING -\- Type: MultiEncoder -\- Default: Slash,Del,Ctl,RightSpace,Dot - - - -### Limitations ### - -Note that FTP does have its own implementation of : \[ga]\-\-dump headers\[ga], -\[ga]\-\-dump bodies\[ga], \[ga]\-\-dump auth\[ga] for debugging which isn\[aq]t the same as -the HTTP based backends \- it has less fine grained control. - -Note that \[ga]\-\-timeout\[ga] isn\[aq]t supported (but \[ga]\-\-contimeout\[ga] is). - -Note that \[ga]\-\-bind\[ga] isn\[aq]t supported. - -FTP could support server side move but doesn\[aq]t yet. - -Note that the ftp backend does not support the \[ga]ftp_proxy\[ga] environment -variable yet. - - Google Cloud Storage -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]remote:bucket\[ga] (or \[ga]remote:\[ga] for the \[ga]lsd\[ga] -command.) You may put subdirectories in too, eg \[ga]remote:bucket/path/to/dir\[ga]. - -The initial setup for google cloud storage involves getting a token from Google Cloud Storage -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi -.IP "n)" 3 -New remote -.IP "o)" 3 -Delete remote -.IP "p)" 3 -Quit config e/n/d/q> n name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Google -Cloud Storage (this is not Google Drive) \ \[dq]google cloud -storage\[dq] [snip] Storage> google cloud storage Google Application -Client Id \- leave blank normally. -client_id> Google Application Client Secret \- leave blank normally. -client_secret> Project number optional \- needed only for -list/create/delete buckets \- see your developer console. -project_number> 12345678 Service Account Credentials JSON file path \- -needed only if you want use SA instead of interactive login. -service_account_file> Access Control List for new objects. -Choose a number from below, or type in your own value 1 / Object owner -gets OWNER access, and all Authenticated Users get READER access. -\ \[dq]authenticatedRead\[dq] 2 / Object owner gets OWNER access, and -project team owners get OWNER access. -\ \[dq]bucketOwnerFullControl\[dq] 3 / Object owner gets OWNER access, -and project team owners get READER access. -\ \[dq]bucketOwnerRead\[dq] 4 / Object owner gets OWNER access [default -if left blank]. -\ \[dq]private\[dq] 5 / Object owner gets OWNER access, and project team -members get access according to their roles. -\ \[dq]projectPrivate\[dq] 6 / Object owner gets OWNER access, and all -Users get READER access. -\ \[dq]publicRead\[dq] object_acl> 4 Access Control List for new -buckets. -Choose a number from below, or type in your own value 1 / Project team -owners get OWNER access, and all Authenticated Users get READER access. -\ \[dq]authenticatedRead\[dq] 2 / Project team owners get OWNER access -[default if left blank]. -\ \[dq]private\[dq] 3 / Project team members get access according to -their roles. -\ \[dq]projectPrivate\[dq] 4 / Project team owners get OWNER access, and -all Users get READER access. -\ \[dq]publicRead\[dq] 5 / Project team owners get OWNER access, and all -Users get WRITER access. -\ \[dq]publicReadWrite\[dq] bucket_acl> 2 Location for the newly created -buckets. -Choose a number from below, or type in your own value 1 / Empty for -default location (US). -\ \[dq]\[dq] 2 / Multi\-regional location for Asia. -\ \[dq]asia\[dq] 3 / Multi\-regional location for Europe. -\ \[dq]eu\[dq] 4 / Multi\-regional location for United States. -\ \[dq]us\[dq] 5 / Taiwan. -\ \[dq]asia\-east1\[dq] 6 / Tokyo. -\ \[dq]asia\-northeast1\[dq] 7 / Singapore. -\ \[dq]asia\-southeast1\[dq] 8 / Sydney. -\ \[dq]australia\-southeast1\[dq] 9 / Belgium. -\ \[dq]europe\-west1\[dq] 10 / London. -\ \[dq]europe\-west2\[dq] 11 / Iowa. -\ \[dq]us\-central1\[dq] 12 / South Carolina. -\ \[dq]us\-east1\[dq] 13 / Northern Virginia. -\ \[dq]us\-east4\[dq] 14 / Oregon. -\ \[dq]us\-west1\[dq] location> 12 The storage class to use when storing -objects in Google Cloud Storage. -Choose a number from below, or type in your own value 1 / Default -\ \[dq]\[dq] 2 / Multi\-regional storage class -\ \[dq]MULTI_REGIONAL\[dq] 3 / Regional storage class -\ \[dq]REGIONAL\[dq] 4 / Nearline storage class \ \[dq]NEARLINE\[dq] 5 / -Coldline storage class \ \[dq]COLDLINE\[dq] 6 / Durable reduced -availability storage class \ \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] -storage_class> 5 Remote config Use auto config? -.IP \[bu] 2 -Say Y if not sure -.IP \[bu] 2 -Say N if you are working on a remote or headless machine or Y didn\[aq]t -work -.IP "y)" 3 -Yes -.IP "z)" 3 -No y/n> y If your browser doesn\[aq]t open automatically go to the -following link: http://127.0.0.1:53682/auth Log in and authorize rclone -for access Waiting for code... -Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = google -cloud storage client_id = client_secret = token = -{\[dq]AccessToken\[dq]:\[dq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-07\-17T20:49:14.929208288+01:00\[dq],\[dq]Extra\[dq]:null} -project_number = 12345678 object_acl = private bucket_acl = private -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.IP "a)" 3 -Yes this is OK -.IP "b)" 3 -Edit this remote -.IP "c)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -Note that rclone runs a webserver on your local machine to collect the -token as returned from Google if you use auto config mode. This only -runs from the moment it opens your browser to the moment you get back -the verification code. This is on \[ga]http://127.0.0.1:53682/\[ga] and this -it may require you to unblock it temporarily if you are running a host -firewall, or use manual mode. - -This remote is called \[ga]remote\[ga] and can now be used like this - -See all the buckets in your project - - rclone lsd remote: - -Make a new bucket - - rclone mkdir remote:bucket - -List the contents of a bucket - - rclone ls remote:bucket - -Sync \[ga]/home/local/directory\[ga] to the remote bucket, deleting any excess -files in the bucket. - - rclone sync \-i /home/local/directory remote:bucket - -### Service Account support ### - -You can set up rclone with Google Cloud Storage in an unattended mode, -i.e. not tied to a specific end\-user Google account. This is useful -when you want to synchronise files onto machines that don\[aq]t have -actively logged\-in users, for example build machines. - -To get credentials for Google Cloud Platform -[IAM Service Accounts](https://cloud.google.com/iam/docs/service\-accounts), -please head to the -[Service Account](https://console.cloud.google.com/permissions/serviceaccounts) -section of the Google Developer Console. Service Accounts behave just -like normal \[ga]User\[ga] permissions in -[Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access\-control), -so you can limit their access (e.g. make them read only). After -creating an account, a JSON file containing the Service Account\[aq]s -credentials will be downloaded onto your machines. These credentials -are what rclone will use for authentication. - -To use a Service Account instead of OAuth2 token flow, enter the path -to your Service Account credentials at the \[ga]service_account_file\[ga] -prompt and rclone won\[aq]t use the browser based authentication -flow. If you\[aq]d rather stuff the contents of the credentials file into -the rclone config file, you can set \[ga]service_account_credentials\[ga] with -the actual contents of the file instead, or set the equivalent -environment variable. - -### Anonymous Access ### - -For downloads of objects that permit public access you can configure rclone -to use anonymous access by setting \[ga]anonymous\[ga] to \[ga]true\[ga]. -With unauthorized access you can\[aq]t write or create files but only read or list -those buckets and objects that have public read access. - -### Application Default Credentials ### - -If no other source of credentials is provided, rclone will fall back -to -[Application Default Credentials](https://cloud.google.com/video\-intelligence/docs/common/auth#authenticating_with_application_default_credentials) -this is useful both when you already have configured authentication -for your developer account, or in production when running on a google -compute host. Note that if running in docker, you may need to run -additional commands on your google compute machine \- -[see this page](https://cloud.google.com/container\-registry/docs/advanced\-authentication#gcloud_as_a_docker_credential_helper). - -Note that in the case application default credentials are used, there -is no need to explicitly configure a project number. - -### \-\-fast\-list ### - -This remote supports \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -### Custom upload headers ### - -You can set custom upload headers with the \[ga]\-\-header\-upload\[ga] -flag. Google Cloud Storage supports the headers as described in the -[working with metadata documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) - -\- Cache\-Control -\- Content\-Disposition -\- Content\-Encoding -\- Content\-Language -\- Content\-Type -\- X\-Goog\-Meta\- - -Eg \[ga]\-\-header\-upload \[dq]Content\-Type text/potato\[dq]\[ga] - -Note that the last of these is for setting custom metadata in the form -\[ga]\-\-header\-upload \[dq]x\-goog\-meta\-key: value\[dq]\[ga] - -### Modified time ### - -Google google cloud storage stores md5sums natively and rclone stores -modification times as metadata on the object, under the \[dq]mtime\[dq] key in -RFC3339 format accurate to 1ns. - -#### Restricted filename characters - -| Character | Value | Replacement | -| \-\-\-\-\-\-\-\-\- |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -| NUL | 0x00 | \[u2400] | -| LF | 0x0A | \[u240A] | -| CR | 0x0D | \[u240D] | -| / | 0x2F | \[uFF0F] | - -Invalid UTF\-8 bytes will also be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - - -### Standard Options - -Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - -#### \-\-gcs\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_GCS_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_GCS_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-project\-number - -Project number. -Optional \- needed only for list/create/delete buckets \- see your developer console. - -\- Config: project_number -\- Env Var: RCLONE_GCS_PROJECT_NUMBER -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-service\-account\-file - -Service Account Credentials JSON file path -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -Leading \[ga]\[ti]\[ga] will be expanded in the file name as will environment variables such as \[ga]${RCLONE_CONFIG_DIR}\[ga]. - - -\- Config: service_account_file -\- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-service\-account\-credentials - -Service Account Credentials JSON blob -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -\- Config: service_account_credentials -\- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-anonymous - -Access public buckets and objects without credentials -Set to \[aq]true\[aq] if you just want to download files and don\[aq]t configure credentials. - -\- Config: anonymous -\- Env Var: RCLONE_GCS_ANONYMOUS -\- Type: bool -\- Default: false - -#### \-\-gcs\-object\-acl - -Access Control List for new objects. - -\- Config: object_acl -\- Env Var: RCLONE_GCS_OBJECT_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]authenticatedRead\[dq] - \- Object owner gets OWNER access, and all Authenticated Users get READER access. - \- \[dq]bucketOwnerFullControl\[dq] - \- Object owner gets OWNER access, and project team owners get OWNER access. - \- \[dq]bucketOwnerRead\[dq] - \- Object owner gets OWNER access, and project team owners get READER access. - \- \[dq]private\[dq] - \- Object owner gets OWNER access [default if left blank]. - \- \[dq]projectPrivate\[dq] - \- Object owner gets OWNER access, and project team members get access according to their roles. - \- \[dq]publicRead\[dq] - \- Object owner gets OWNER access, and all Users get READER access. - -#### \-\-gcs\-bucket\-acl - -Access Control List for new buckets. - -\- Config: bucket_acl -\- Env Var: RCLONE_GCS_BUCKET_ACL -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]authenticatedRead\[dq] - \- Project team owners get OWNER access, and all Authenticated Users get READER access. - \- \[dq]private\[dq] - \- Project team owners get OWNER access [default if left blank]. - \- \[dq]projectPrivate\[dq] - \- Project team members get access according to their roles. - \- \[dq]publicRead\[dq] - \- Project team owners get OWNER access, and all Users get READER access. - \- \[dq]publicReadWrite\[dq] - \- Project team owners get OWNER access, and all Users get WRITER access. - -#### \-\-gcs\-bucket\-policy\-only - -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: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Empty for default location (US). - \- \[dq]asia\[dq] - \- Multi\-regional location for Asia. - \- \[dq]eu\[dq] - \- Multi\-regional location for Europe. - \- \[dq]us\[dq] - \- Multi\-regional location for United States. - \- \[dq]asia\-east1\[dq] - \- Taiwan. - \- \[dq]asia\-east2\[dq] - \- Hong Kong. - \- \[dq]asia\-northeast1\[dq] - \- Tokyo. - \- \[dq]asia\-south1\[dq] - \- Mumbai. - \- \[dq]asia\-southeast1\[dq] - \- Singapore. - \- \[dq]australia\-southeast1\[dq] - \- Sydney. - \- \[dq]europe\-north1\[dq] - \- Finland. - \- \[dq]europe\-west1\[dq] - \- Belgium. - \- \[dq]europe\-west2\[dq] - \- London. - \- \[dq]europe\-west3\[dq] - \- Frankfurt. - \- \[dq]europe\-west4\[dq] - \- Netherlands. - \- \[dq]us\-central1\[dq] - \- Iowa. - \- \[dq]us\-east1\[dq] - \- South Carolina. - \- \[dq]us\-east4\[dq] - \- Northern Virginia. - \- \[dq]us\-west1\[dq] - \- Oregon. - \- \[dq]us\-west2\[dq] - \- California. - -#### \-\-gcs\-storage\-class - -The storage class to use when storing objects in Google Cloud Storage. - -\- Config: storage_class -\- Env Var: RCLONE_GCS_STORAGE_CLASS -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]\[dq] - \- Default - \- \[dq]MULTI_REGIONAL\[dq] - \- Multi\-regional storage class - \- \[dq]REGIONAL\[dq] - \- Regional storage class - \- \[dq]NEARLINE\[dq] - \- Nearline storage class - \- \[dq]COLDLINE\[dq] - \- Coldline storage class - \- \[dq]ARCHIVE\[dq] - \- Archive storage class - \- \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] - \- Durable reduced availability storage class - -### Advanced Options - -Here are the advanced options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). - -#### \-\-gcs\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_GCS_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_GCS_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_GCS_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-gcs\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_GCS_ENCODING -\- Type: MultiEncoder -\- Default: Slash,CrLf,InvalidUtf8,Dot - - - - Google Drive -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths are specified as \[ga]drive:path\[ga] - -Drive paths may be as deep as required, eg \[ga]drive:directory/subdirectory\[ga]. - -The initial setup for drive involves getting a token from Google drive -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Google -Drive \ \[dq]drive\[dq] [snip] Storage> drive Google Application Client -Id \- leave blank normally. -client_id> Google Application Client Secret \- leave blank normally. -client_secret> Scope that rclone should use when requesting access from -drive. -Choose a number from below, or type in your own value 1 / Full access -all files, excluding Application Data Folder. -\ \[dq]drive\[dq] 2 / Read\-only access to file metadata and file -contents. -\ \[dq]drive.readonly\[dq] / Access to files created by rclone only. -3 | These are visible in the drive website. -| File authorization is revoked when the user deauthorizes the app. -\ \[dq]drive.file\[dq] / Allows read and write access to the Application -Data folder. -4 | This is not visible in the drive website. -\ \[dq]drive.appfolder\[dq] / Allows read\-only access to file metadata -but 5 | does not allow any access to read or download file content. -\ \[dq]drive.metadata.readonly\[dq] scope> 1 ID of the root folder \- -leave blank normally. -Fill in to access \[dq]Computers\[dq] folders. -(see docs). -root_folder_id> Service Account Credentials JSON file path \- needed -only if you want use SA instead of interactive login. -service_account_file> Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine or Y didn\[aq]t work y) Yes n) No y/n> y If your browser -doesn\[aq]t open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code... -Got code Configure this as a team drive? -y) Yes n) No y/n> n \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -client_id = client_secret = scope = drive root_folder_id = -service_account_file = token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq]} -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -Note that rclone runs a webserver on your local machine to collect the -token as returned from Google if you use auto config mode. This only -runs from the moment it opens your browser to the moment you get back -the verification code. This is on \[ga]http://127.0.0.1:53682/\[ga] and this -it may require you to unblock it temporarily if you are running a host -firewall, or use manual mode. - -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 \[ga]root_folder_id\[ga] for rclone. This is the directory -(identified by its \[ga]Folder ID\[ga]) that rclone considers to be the root -of your drive. - -Normally you will leave this blank and rclone will determine the -correct root to use itself. - -However you can set this to restrict rclone to a specific folder -hierarchy or to access data within the \[dq]Computers\[dq] tab on the drive -web interface (where files from Google\[aq]s Backup and Sync desktop -program go). - -In order to do this you will have to find the \[ga]Folder ID\[ga] of the -directory you wish rclone to display. This will be the last segment -of the URL when you open the relevant folder in the drive web -interface. - -So if the folder you want rclone to use has a URL which looks like -\[ga]https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\[ga] -in the browser, then you use \[ga]1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\[ga] as -the \[ga]root_folder_id\[ga] in the config. - -**NB** folders under the \[dq]Computers\[dq] tab seem to be read only (drive -gives a 500 error) when using rclone. - -There doesn\[aq]t appear to be an API to discover the folder IDs of the -\[dq]Computers\[dq] tab \- please contact us if you know otherwise! - -Note also that rclone can\[aq]t access any data under the \[dq]Backups\[dq] tab on -the google drive web interface yet. - -### Service Account support ### - -You can set up rclone with Google Drive in an unattended mode, -i.e. not tied to a specific end\-user Google account. This is useful -when you want to synchronise files onto machines that don\[aq]t have -actively logged\-in users, for example build machines. - -To use a Service Account instead of OAuth2 token flow, enter the path -to your Service Account credentials at the \[ga]service_account_file\[ga] -prompt during \[ga]rclone config\[ga] and rclone won\[aq]t use the browser based -authentication flow. If you\[aq]d rather stuff the contents of the -credentials file into the rclone config file, you can set -\[ga]service_account_credentials\[ga] with the actual contents of the file -instead, or set the equivalent environment variable. - -#### Use case \- Google Apps/G\-suite account and individual Drive #### - -Let\[aq]s say that you are the administrator of a Google Apps (old) or -G\-suite account. -The goal is to store data on an individual\[aq]s Drive account, who IS -a member of the domain. -We\[aq]ll call the domain **example.com**, and the user -**foo\[at]example.com**. - -There\[aq]s a few steps we need to go through to accomplish this: - -##### 1. Create a service account for example.com ##### - \- To create a service account and obtain its credentials, go to the -[Google Developer Console](https://console.developers.google.com). - \- You must have a project \- create one if you don\[aq]t. - \- Then go to \[dq]IAM & admin\[dq] \-> \[dq]Service Accounts\[dq]. - \- Use the \[dq]Create Credentials\[dq] button. Fill in \[dq]Service account name\[dq] -with something that identifies your client. \[dq]Role\[dq] can be empty. - \- Tick \[dq]Furnish a new private key\[dq] \- select \[dq]Key type JSON\[dq]. - \- Tick \[dq]Enable G Suite Domain\-wide Delegation\[dq]. This option makes -\[dq]impersonation\[dq] possible, as documented here: -[Delegating domain\-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) - \- These credentials are what rclone will use for authentication. -If you ever need to remove access, press the \[dq]Delete service -account key\[dq] button. - -##### 2. Allowing API access to example.com Google Drive ##### - \- Go to example.com\[aq]s admin console - \- Go into \[dq]Security\[dq] (or use the search bar) - \- Select \[dq]Show more\[dq] and then \[dq]Advanced settings\[dq] - \- Select \[dq]Manage API client access\[dq] in the \[dq]Authentication\[dq] section - \- In the \[dq]Client Name\[dq] field enter the service account\[aq]s -\[dq]Client ID\[dq] \- this can be found in the Developer Console under -\[dq]IAM & Admin\[dq] \-> \[dq]Service Accounts\[dq], then \[dq]View Client ID\[dq] for -the newly created service account. -It is a \[ti]21 character numerical string. - \- In the next field, \[dq]One or More API Scopes\[dq], enter -\[ga]https://www.googleapis.com/auth/drive\[ga] -to grant access to Google Drive specifically. - -##### 3. Configure rclone, assuming a new install ##### -\f[R] -.fi -.PP -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 ##### - \- \[ga]rclone \-v \-\-drive\-impersonate foo\[at]example.com lsf gdrive:backup\[ga] - \- The arguments do: - \- \[ga]\-v\[ga] \- verbose logging - \- \[ga]\-\-drive\-impersonate foo\[at]example.com\[ga] \- this is what does -the magic, pretending to be user foo. - \- \[ga]lsf\[ga] \- list files in a parsing friendly way - \- \[ga]gdrive:backup\[ga] \- use the remote called gdrive, work in -the folder named backup. - -Note: in case you configured a specific root folder on gdrive and rclone is unable to access the contents of that folder when using \[ga]\-\-drive\-impersonate\[ga], do this instead: - \- in the gdrive web interface, share your root folder with the user/email of the new Service Account you created/selected at step #1 - \- use rclone without specifying the \[ga]\-\-drive\-impersonate\[ga] option, like this: - \[ga]rclone \-v foo\[at]example.com lsf gdrive:backup\[ga] - - -### Team drives ### - -If you want to configure the remote to point to a Google Team Drive -then answer \[ga]y\[ga] to the question \[ga]Configure this as a team drive?\[ga]. - -This will fetch the list of Team Drives from google and allow you to -configure which one you want to use. You can also type in a team -drive ID if you prefer. - -For example: -\f[R] -.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 -\ \[dq]xxxxxxxxxxxxxxxxxxxx\[dq] 2 / Rclone Test 2 -\ \[dq]yyyyyyyyyyyyyyyyyyyy\[dq] 3 / Rclone Test 3 -\ \[dq]zzzzzzzzzzzzzzzzzzzz\[dq] Enter a Team Drive ID> 1 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] client_id = -client_secret = token = -{\[dq]AccessToken\[dq]:\[dq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq],\[dq]Extra\[dq]:null} -team_drive = xxxxxxxxxxxxxxxxxxxx -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 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 \[ga]\-\-fast\-list\[ga] which allows you to use fewer -transactions in exchange for more memory. See the [rclone -docs](https://rclone.org/docs/#fast\-list) for more details. - -It does this by combining multiple \[ga]list\[ga] calls into a single API request. - -This works by combining many \[ga]\[aq]%s\[aq] in parents\[ga] filters into one expression. -To list the contents of directories a, b and c, the following requests will be send by the regular \[ga]List\[ga] function: -\f[R] -.fi -.PP -trashed=false and \[aq]a\[aq] in parents trashed=false and \[aq]b\[aq] -in parents trashed=false and \[aq]c\[aq] in parents -.IP -.nf -\f[C] -These can now be combined into a single request: -\f[R] -.fi -.PP -trashed=false and (\[aq]a\[aq] in parents or \[aq]b\[aq] in parents or -\[aq]c\[aq] in parents) -.IP -.nf -\f[C] - -The implementation of \[ga]ListR\[ga] will put up to 50 \[ga]parents\[ga] filters into one request. -It will use the \[ga]\-\-checkers\[ga] value to specify the number of requests to run in parallel. - -In tests, these batch requests were up to 20x faster than the regular method. -Running the following command against different sized folders gives: -\f[R] -.fi -.PP -rclone lsjson \-vv \-R \-\-checkers=6 gdrive:folder -.IP -.nf -\f[C] - -small folder (220 directories, 700 files): - -\- without \[ga]\-\-fast\-list\[ga]: 38s -\- with \[ga]\-\-fast\-list\[ga]: 10s - -large folder (10600 directories, 39000 files): - -\- without \[ga]\-\-fast\-list\[ga]: 22:05 min -\- with \[ga]\-\-fast\-list\[ga]: 58s - -### Modified time ### - -Google drive stores modification times accurate to 1 ms. - -#### Restricted filename characters - -Only Invalid UTF\-8 bytes will be [replaced](https://rclone.org/overview/#invalid\-utf8), -as they can\[aq]t be used in JSON strings. - -In contrast to other backends, \[ga]/\[ga] can also be used in names and \[ga].\[ga] -or \[ga]..\[ga] are valid names. - -### Revisions ### - -Google drive stores revisions of files. When you upload a change to -an existing file to google drive using rclone it will create a new -revision of that file. - -Revisions follow the standard google policy which at time of writing -was - - * They are deleted after 30 days or 100 revisions (whatever comes first). - * They do not count towards a user storage quota. - -### Deleting files ### - -By default rclone will send all files to the trash when deleting -files. If deleting them permanently is required then use the -\[ga]\-\-drive\-use\-trash=false\[ga] flag, or set the equivalent environment -variable. - -### Shortcuts ### - -In March 2020 Google introduced a new feature in Google Drive called -[drive shortcuts](https://support.google.com/drive/answer/9700156) -([API](https://developers.google.com/drive/api/v3/shortcuts)). These -will (by September 2020) [replace the ability for files or folders to -be in multiple folders at once](https://cloud.google.com/blog/products/g\-suite/simplifying\-google\-drives\-folder\-structure\-and\-sharing\-models). - -Shortcuts are files that link to other files on Google Drive somewhat -like a symlink in unix, except they point to the underlying file data -(eg the inode in unix terms) so they don\[aq]t break if the source is -renamed or moved about. - -Be default rclone treats these as follows. - -For shortcuts pointing to files: - -\- When listing a file shortcut appears as the destination file. -\- When downloading the contents of the destination file is downloaded. -\- When updating shortcut file with a non shortcut file, the shortcut is removed then a new file is uploaded in place of the shortcut. -\- When server side moving (renaming) the shortcut is renamed, not the destination file. -\- When server side copying the shortcut is copied, not the contents of the shortcut. -\- When deleting the shortcut is deleted not the linked file. -\- When setting the modification time, the modification time of the linked file will be set. - -For shortcuts pointing to folders: - -\- When listing the shortcut appears as a folder and that folder will contain the contents of the linked folder appear (including any sub folders) -\- When downloading the contents of the linked folder and sub contents are downloaded -\- When uploading to a shortcut folder the file will be placed in the linked folder -\- When server side moving (renaming) the shortcut is renamed, not the destination folder -\- When server side copying the contents of the linked folder is copied, not the shortcut. -\- When deleting with \[ga]rclone rmdir\[ga] or \[ga]rclone purge\[ga] the shortcut is deleted not the linked folder. -\- **NB** When deleting with \[ga]rclone remove\[ga] or \[ga]rclone mount\[ga] the contents of the linked folder will be deleted. - -The [rclone backend](https://rclone.org/commands/rclone_backend/) command can be used to create shortcuts. - -Shortcuts can be completely ignored with the \[ga]\-\-drive\-skip\-shortcuts\[ga] flag -or the corresponding \[ga]skip_shortcuts\[ga] configuration setting. - -### Emptying trash ### - -If you wish to empty your trash you can use the \[ga]rclone cleanup remote:\[ga] -command which will permanently delete all your trashed files. This command -does not take any path arguments. - -Note that Google Drive takes some time (minutes to days) to empty the -trash even though the command returns within a few seconds. No output -is echoed, so there will be no confirmation even using \-v or \-vv. - -### Quota information ### - -To view your current quota you can use the \[ga]rclone about remote:\[ga] -command which will display your usage limit (quota), the usage in Google -Drive, the size of all files in the Trash and the space used by other -Google services such as Gmail. This command does not take any path -arguments. - -#### Import/Export of google documents #### - -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 \[ga]\-\-drive\-export\-formats\[ga] setting. -By default the export formats are \[ga]docx,xlsx,pptx,svg\[ga] which are a -sensible default for an editable document. - -When choosing a format, rclone runs down the list provided in order -and chooses the first file format the doc can be exported as from the -list. If the file can\[aq]t be exported to a format on the formats list, -then rclone will choose a format from the default list. - -If you prefer an archive copy then you might use \[ga]\-\-drive\-export\-formats -pdf\[ga], or if you prefer openoffice/libreoffice formats you might use -\[ga]\-\-drive\-export\-formats ods,odt,odp\[ga]. - -Note that rclone adds the extension to the google doc, so if it is -called \[ga]My Spreadsheet\[ga] on google docs, it will be exported as \[ga]My -Spreadsheet.xlsx\[ga] or \[ga]My Spreadsheet.pdf\[ga] etc. - -When importing files into Google Drive, rclone will convert all -files with an extension in \[ga]\-\-drive\-import\-formats\[ga] to their -associated document type. -rclone will not convert any files by default, since the conversion -is lossy process. - -The conversion must result in a file with the same extension when -the \[ga]\-\-drive\-export\-formats\[ga] rules are applied to the uploaded document. - -Here are some examples for allowed and prohibited conversions. - -| export\-formats | import\-formats | Upload Ext | Document Ext | Allowed | -| \-\-\-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\- | -| odt | odt | odt | odt | Yes | -| odt | docx,odt | odt | odt | Yes | -| | docx | docx | docx | Yes | -| | odt | odt | docx | No | -| odt,docx | docx,odt | docx | odt | No | -| docx,odt | docx,odt | docx | docx | Yes | -| docx,odt | docx,odt | odt | docx | No | - -This limitation can be disabled by specifying \[ga]\-\-drive\-allow\-import\-name\-change\[ga]. -When using this flag, rclone can convert multiple files types resulting -in the same document type at once, eg with \[ga]\-\-drive\-import\-formats docx,odt,txt\[ga], -all files having these extension would result in a document represented as a docx file. -This brings the additional risk of overwriting a document, if multiple files -have the same stem. Many rclone operations will not handle this name change -in any way. They assume an equal name when copying files and might copy the -file again or delete them when the name changes. - -Here are the possible export extensions with their corresponding mime types. -Most of these can also be used for importing, but there more that are not -listed here. Some of these additional ones might only be available when -the operating system provides the correct MIME type entries. - -This list can be changed by Google Drive at any time and might not -represent the currently available conversions. - -| Extension | Mime Type | Description | -| \-\-\-\-\-\-\-\-\- |\-\-\-\-\-\-\-\-\-\-\-| \-\-\-\-\-\-\-\-\-\-\-\-| -| csv | text/csv | Standard CSV format for Spreadsheets | -| docx | application/vnd.openxmlformats\-officedocument.wordprocessingml.document | Microsoft Office Document | -| epub | application/epub+zip | E\-book format | -| html | text/html | An HTML Document | -| jpg | image/jpeg | A JPEG Image File | -| json | application/vnd.google\-apps.script+json | JSON Text Format | -| odp | application/vnd.oasis.opendocument.presentation | Openoffice Presentation | -| ods | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | -| ods | application/x\-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | -| odt | application/vnd.oasis.opendocument.text | Openoffice Document | -| pdf | application/pdf | Adobe PDF Format | -| png | image/png | PNG Image Format| -| pptx | application/vnd.openxmlformats\-officedocument.presentationml.presentation | Microsoft Office Powerpoint | -| rtf | application/rtf | Rich Text Format | -| svg | image/svg+xml | Scalable Vector Graphics Format | -| tsv | text/tab\-separated\-values | Standard TSV format for spreadsheets | -| txt | text/plain | Plain Text | -| xlsx | application/vnd.openxmlformats\-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | -| zip | application/zip | A ZIP file of HTML, Images CSS | - -Google documents can also be exported as link files. These files will -open a browser window for the Google Docs website of that document -when opened. The link file extension has to be specified as a -\[ga]\-\-drive\-export\-formats\[ga] parameter. They will match all available -Google Documents. - -| Extension | Description | OS Support | -| \-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\-\- | \-\-\-\-\-\-\-\-\-\- | -| desktop | freedesktop.org specified desktop entry | Linux | -| link.html | An HTML Document with a redirect | All | -| url | INI style link file | macOS, Windows | -| webloc | macOS specific XML format | macOS | - - -### Standard Options - -Here are the standard options specific to drive (Google Drive). - -#### \-\-drive\-client\-id - -OAuth Client Id -Leave blank normally. - -\- Config: client_id -\- Env Var: RCLONE_DRIVE_CLIENT_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-client\-secret - -OAuth Client Secret -Leave blank normally. - -\- Config: client_secret -\- Env Var: RCLONE_DRIVE_CLIENT_SECRET -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-scope - -Scope that rclone should use when requesting access from drive. - -\- Config: scope -\- Env Var: RCLONE_DRIVE_SCOPE -\- Type: string -\- Default: \[dq]\[dq] -\- Examples: - \- \[dq]drive\[dq] - \- Full access all files, excluding Application Data Folder. - \- \[dq]drive.readonly\[dq] - \- Read\-only access to file metadata and file contents. - \- \[dq]drive.file\[dq] - \- Access to files created by rclone only. - \- These are visible in the drive website. - \- File authorization is revoked when the user deauthorizes the app. - \- \[dq]drive.appfolder\[dq] - \- Allows read and write access to the Application Data folder. - \- This is not visible in the drive website. - \- \[dq]drive.metadata.readonly\[dq] - \- Allows read\-only access to file metadata but - \- does not allow any access to read or download file content. - -#### \-\-drive\-root\-folder\-id - -ID of the root folder -Leave blank normally. - -Fill in to access \[dq]Computers\[dq] folders (see docs), or for rclone to use -a non root folder as its starting point. - - -\- Config: root_folder_id -\- Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-service\-account\-file - -Service Account Credentials JSON file path -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -Leading \[ga]\[ti]\[ga] will be expanded in the file name as will environment variables such as \[ga]${RCLONE_CONFIG_DIR}\[ga]. - - -\- Config: service_account_file -\- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-alternate\-export - -Deprecated: no longer needed - -\- Config: alternate_export -\- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT -\- Type: bool -\- Default: false - -### Advanced Options - -Here are the advanced options specific to drive (Google Drive). - -#### \-\-drive\-token - -OAuth Access Token as a JSON blob. - -\- Config: token -\- Env Var: RCLONE_DRIVE_TOKEN -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-auth\-url - -Auth server URL. -Leave blank to use the provider defaults. - -\- Config: auth_url -\- Env Var: RCLONE_DRIVE_AUTH_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-token\-url - -Token server url. -Leave blank to use the provider defaults. - -\- Config: token_url -\- Env Var: RCLONE_DRIVE_TOKEN_URL -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-service\-account\-credentials - -Service Account Credentials JSON blob -Leave blank normally. -Needed only if you want use SA instead of interactive login. - -\- Config: service_account_credentials -\- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-team\-drive - -ID of the Team Drive - -\- Config: team_drive -\- Env Var: RCLONE_DRIVE_TEAM_DRIVE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-auth\-owner\-only - -Only consider files owned by the authenticated user. - -\- Config: auth_owner_only -\- Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY -\- Type: bool -\- Default: false - -#### \-\-drive\-use\-trash - -Send files to the trash instead of deleting permanently. -Defaults to true, namely sending files to the trash. -Use \[ga]\-\-drive\-use\-trash=false\[ga] to delete files permanently instead. - -\- Config: use_trash -\- Env Var: RCLONE_DRIVE_USE_TRASH -\- Type: bool -\- Default: true - -#### \-\-drive\-skip\-gdocs - -Skip google documents in all listings. -If given, gdocs practically become invisible to rclone. - -\- Config: skip_gdocs -\- Env Var: RCLONE_DRIVE_SKIP_GDOCS -\- Type: bool -\- Default: false - -#### \-\-drive\-skip\-checksum\-gphotos - -Skip MD5 checksum on Google photos and videos only. - -Use this if you get checksum errors when transferring Google photos or -videos. - -Setting this flag will cause Google photos and videos to return a -blank MD5 checksum. - -Google photos are identified by being in the \[dq]photos\[dq] space. - -Corrupted checksums are caused by Google modifying the image/video but -not updating the checksum. - -\- Config: skip_checksum_gphotos -\- Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS -\- Type: bool -\- Default: false - -#### \-\-drive\-shared\-with\-me - -Only show files that are shared with me. - -Instructs rclone to operate on your \[dq]Shared with me\[dq] folder (where -Google Drive lets you access the files and folders others have shared -with you). - -This works both with the \[dq]list\[dq] (lsd, lsl, etc) and the \[dq]copy\[dq] -commands (copy, sync, etc), and with all other commands too. - -\- Config: shared_with_me -\- Env Var: RCLONE_DRIVE_SHARED_WITH_ME -\- Type: bool -\- Default: false - -#### \-\-drive\-trashed\-only - -Only show files that are in the trash. -This will show trashed files in their original directory structure. - -\- Config: trashed_only -\- Env Var: RCLONE_DRIVE_TRASHED_ONLY -\- Type: bool -\- Default: false - -#### \-\-drive\-starred\-only - -Only show files that are starred. - -\- Config: starred_only -\- Env Var: RCLONE_DRIVE_STARRED_ONLY -\- Type: bool -\- Default: false - -#### \-\-drive\-formats - -Deprecated: see export_formats - -\- Config: formats -\- Env Var: RCLONE_DRIVE_FORMATS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-export\-formats - -Comma separated list of preferred formats for downloading Google docs. - -\- Config: export_formats -\- Env Var: RCLONE_DRIVE_EXPORT_FORMATS -\- Type: string -\- Default: \[dq]docx,xlsx,pptx,svg\[dq] - -#### \-\-drive\-import\-formats - -Comma separated list of preferred formats for uploading Google docs. - -\- Config: import_formats -\- Env Var: RCLONE_DRIVE_IMPORT_FORMATS -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-allow\-import\-name\-change - -Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. - -\- Config: allow_import_name_change -\- Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE -\- Type: bool -\- Default: false - -#### \-\-drive\-use\-created\-date - -Use file created date instead of modified date., - -Useful when downloading data and you want the creation date used in -place of the last modified date. - -**WARNING**: This flag may have some unexpected consequences. - -When uploading to your drive all files will be overwritten unless they -haven\[aq]t been modified since their creation. And the inverse will occur -while downloading. This side effect can be avoided by using the -\[dq]\-\-checksum\[dq] flag. - -This feature was implemented to retain photos capture date as recorded -by google photos. You will first need to check the \[dq]Create a Google -Photos folder\[dq] option in your google drive settings. You can then copy -or move the photos locally and use the date the image was taken -(created) set as the modification date. - -\- Config: use_created_date -\- Env Var: RCLONE_DRIVE_USE_CREATED_DATE -\- Type: bool -\- Default: false - -#### \-\-drive\-use\-shared\-date - -Use date file was shared instead of modified date. - -Note that, as with \[dq]\-\-drive\-use\-created\-date\[dq], this flag may have -unexpected consequences when uploading/downloading files. - -If both this flag and \[dq]\-\-drive\-use\-created\-date\[dq] are set, the created -date is used. - -\- Config: use_shared_date -\- Env Var: RCLONE_DRIVE_USE_SHARED_DATE -\- Type: bool -\- Default: false - -#### \-\-drive\-list\-chunk - -Size of listing chunk 100\-1000. 0 to disable. - -\- Config: list_chunk -\- Env Var: RCLONE_DRIVE_LIST_CHUNK -\- Type: int -\- Default: 1000 - -#### \-\-drive\-impersonate - -Impersonate this user when using a service account. - -\- Config: impersonate -\- Env Var: RCLONE_DRIVE_IMPERSONATE -\- Type: string -\- Default: \[dq]\[dq] - -#### \-\-drive\-upload\-cutoff - -Cutoff for switching to chunked upload - -\- Config: upload_cutoff -\- Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF -\- Type: SizeSuffix -\- Default: 8M - -#### \-\-drive\-chunk\-size - -Upload chunk size. Must a power of 2 >= 256k. - -Making this larger will improve performance, but note that each chunk -is buffered in memory one per transfer. - -Reducing this will reduce memory usage but decrease performance. - -\- Config: chunk_size -\- Env Var: RCLONE_DRIVE_CHUNK_SIZE -\- Type: SizeSuffix -\- Default: 8M - -#### \-\-drive\-acknowledge\-abuse - -Set to allow files which return cannotDownloadAbusiveFile to be downloaded. - -If downloading a file returns the error \[dq]This file has been identified -as malware or spam and cannot be downloaded\[dq] with the error code -\[dq]cannotDownloadAbusiveFile\[dq] then supply this flag to rclone to -indicate you acknowledge the risks of downloading the file and rclone -will download it anyway. - -\- Config: acknowledge_abuse -\- Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE -\- Type: bool -\- Default: false - -#### \-\-drive\-keep\-revision\-forever - -Keep new head revision of each file forever. - -\- Config: keep_revision_forever -\- Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER -\- Type: bool -\- Default: false - -#### \-\-drive\-size\-as\-quota - -Show sizes as storage quota usage, not actual size. - -Show the size of a file as the storage quota used. This is the -current version plus any older versions that have been set to keep -forever. - -**WARNING**: This flag may have some unexpected consequences. - -It is not recommended to set this flag in your config \- the -recommended usage is using the flag form \-\-drive\-size\-as\-quota when -doing rclone ls/lsl/lsf/lsjson/etc only. - -If you do use this flag for syncing (not recommended) then you will -need to use \-\-ignore size also. - -\- Config: size_as_quota -\- Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA -\- Type: bool -\- Default: false - -#### \-\-drive\-v2\-download\-min\-size - -If Object\[aq]s are greater, use drive v2 API to download. - -\- Config: v2_download_min_size -\- Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE -\- Type: SizeSuffix -\- Default: off - -#### \-\-drive\-pacer\-min\-sleep - -Minimum time to sleep between API calls. - -\- Config: pacer_min_sleep -\- Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP -\- Type: Duration -\- Default: 100ms - -#### \-\-drive\-pacer\-burst - -Number of API calls to allow without sleeping. - -\- Config: pacer_burst -\- Env Var: RCLONE_DRIVE_PACER_BURST -\- Type: int -\- Default: 100 - -#### \-\-drive\-server\-side\-across\-configs - -Allow server side operations (eg copy) to work across different drive configs. - -This can be useful if you wish to do a server side copy between two -different Google drives. Note that this isn\[aq]t enabled by default -because it isn\[aq]t easy to tell if it will work between any two -configurations. - -\- Config: server_side_across_configs -\- Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS -\- Type: bool -\- Default: false - -#### \-\-drive\-disable\-http2 - -Disable drive using http2 - -There is currently an unsolved issue with the google drive backend and -HTTP/2. HTTP/2 is therefore disabled by default for the drive backend -but can be re\-enabled here. When the issue is solved this flag will -be removed. - -See: https://github.com/rclone/rclone/issues/3631 - - - -\- Config: disable_http2 -\- Env Var: RCLONE_DRIVE_DISABLE_HTTP2 -\- Type: bool -\- Default: true - -#### \-\-drive\-stop\-on\-upload\-limit - -Make upload limit errors be fatal - -At the time of writing it is only possible to upload 750GB of data to -Google Drive a day (this is an undocumented limit). When this limit is -reached Google Drive produces a slightly different error message. When -this flag is set it causes these errors to be fatal. These will stop -the in\-progress sync. - -Note that this detection is relying on error message strings which -Google don\[aq]t document so it may break in the future. - -See: https://github.com/rclone/rclone/issues/3857 - - -\- Config: stop_on_upload_limit -\- Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT -\- Type: bool -\- Default: false - -#### \-\-drive\-skip\-shortcuts - -If set skip shortcut files - -Normally rclone dereferences shortcut files making them appear as if -they are the original file (see [the shortcuts section](#shortcuts)). -If this flag is set then rclone will ignore shortcut files completely. - - -\- Config: skip_shortcuts -\- Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS -\- Type: bool -\- Default: false - -#### \-\-drive\-encoding - -This sets the encoding for the backend. - -See: the [encoding section in the overview](https://rclone.org/overview/#encoding) for more info. - -\- Config: encoding -\- Env Var: RCLONE_DRIVE_ENCODING -\- Type: MultiEncoder -\- Default: InvalidUtf8 - -### Backend commands - -Here are the commands specific to the drive backend. - -Run them with - - rclone backend COMMAND remote: - -The help below will explain what arguments each command takes. - -See [the \[dq]rclone backend\[dq] command](https://rclone.org/commands/rclone_backend/) for more -info on how to pass options and arguments. - -These can be run on a running backend using the rc command -[backend/command](https://rclone.org/rc/#backend/command). - -#### get - -Get command for fetching the drive config parameters - - rclone backend get remote: [options] [+] - -This is a get command which will be used to fetch the various drive config parameters - -Usage Examples: - - rclone backend get drive: [\-o service_account_file] [\-o chunk_size] - rclone rc backend/command command=get fs=drive: [\-o service_account_file] [\-o chunk_size] - - -Options: - -\- \[dq]chunk_size\[dq]: show the current upload chunk size -\- \[dq]service_account_file\[dq]: show the current service account file - -#### set - -Set command for updating the drive config parameters - - rclone backend set remote: [options] [+] - -This is a set command which will be used to update the various drive config parameters - -Usage Examples: - - rclone backend set drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] - rclone rc backend/command command=set fs=drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] - - -Options: - -\- \[dq]chunk_size\[dq]: update the current upload chunk size -\- \[dq]service_account_file\[dq]: update the current service account file - -#### shortcut - -Create shortcuts from files or directories - - rclone backend shortcut remote: [options] [+] - -This command creates shortcuts from files or directories. - -Usage: - - rclone backend shortcut drive: source_item destination_shortcut - rclone backend shortcut drive: source_item \-o target=drive2: destination_shortcut - -In the first example this creates a shortcut from the \[dq]source_item\[dq] -which can be a file or a directory to the \[dq]destination_shortcut\[dq]. The -\[dq]source_item\[dq] and the \[dq]destination_shortcut\[dq] should be relative paths -from \[dq]drive:\[dq] - -In the second example this creates a shortcut from the \[dq]source_item\[dq] -relative to \[dq]drive:\[dq] to the \[dq]destination_shortcut\[dq] relative to -\[dq]drive2:\[dq]. This may fail with a permission error if the user -authenticated with \[dq]drive2:\[dq] can\[aq]t read files from \[dq]drive:\[dq]. - - -Options: - -\- \[dq]target\[dq]: optional target remote for the shortcut destination - -#### drives - -List the shared drives available to this account - - rclone backend drives remote: [options] [+] - -This command lists the shared drives (teamdrives) available to this -account. - -Usage: - - rclone backend drives drive: - -This will return a JSON list of objects like this - - [ - { - \[dq]id\[dq]: \[dq]0ABCDEF\-01234567890\[dq], - \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], - \[dq]name\[dq]: \[dq]My Drive\[dq] - }, - { - \[dq]id\[dq]: \[dq]0ABCDEFabcdefghijkl\[dq], - \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], - \[dq]name\[dq]: \[dq]Test Drive\[dq] - } - ] - - - -#### untrash - -Untrash files and directories - - rclone backend untrash remote: [options] [+] - -This command untrashes all the files and directories in the directory -passed in recursively. - -Usage: - -This takes an optional directory to trash which make this easier to -use via the API. - - rclone backend untrash drive:directory - rclone backend \-i untrash drive:directory subdir - -Use the \-i flag to see what would be restored before restoring it. - -Result: - - { - \[dq]Untrashed\[dq]: 17, - \[dq]Errors\[dq]: 0 - } - - - - -### Limitations ### - -Drive has quite a lot of rate limiting. This causes rclone to be -limited to transferring about 2 files per second only. Individual -files may be transferred much faster at 100s of MBytes/s but lots of -small files can take a long time. - -Server side copies are also subject to a separate rate limit. If you -see User rate limit exceeded errors, wait at least 24 hours and retry. -You can disable server side copies with \[ga]\-\-disable copy\[ga] to download -and upload the files if you prefer. - -#### Limitations of Google Docs #### - -Google docs will appear as size \-1 in \[ga]rclone ls\[ga] and as size 0 in -anything which uses the VFS layer, eg \[ga]rclone mount\[ga], \[ga]rclone serve\[ga]. - -This is because rclone can\[aq]t find out the size of the Google docs -without downloading them. - -Google docs will transfer correctly with \[ga]rclone sync\[ga], \[ga]rclone copy\[ga] -etc as rclone knows to ignore the size when doing the transfer. - -However an unfortunate consequence of this is that you may not be able -to download Google docs using \[ga]rclone mount\[ga]. If it doesn\[aq]t work you -will get a 0 sized file. If you try again the doc may gain its -correct size and be downloadable. Whether it will work on not depends -on the application accessing the mount and the OS you are running \- -experiment to find out if it does work for you! - -### Duplicated files ### - -Sometimes, for no reason I\[aq]ve been able to track down, drive will -duplicate a file that rclone uploads. Drive unlike all the other -remotes can have duplicated files. - -Duplicated files cause problems with the syncing and you will see -messages in the log about duplicates. - -Use \[ga]rclone dedupe\[ga] to fix duplicated files. - -Note that this isn\[aq]t just a problem with rclone, even Google Photos on -Android duplicates files on drive sometimes. - -### Rclone appears to be re\-copying files it shouldn\[aq]t ### - -The most likely cause of this is the duplicated file issue above \- run -\[ga]rclone dedupe\[ga] and check your logs for duplicate object or directory -messages. - -This can also be caused by a delay/caching on google drive\[aq]s end when -comparing directory listings. Specifically with team drives used in -combination with \-\-fast\-list. Files that were uploaded recently may -not appear on the directory list sent to rclone when using \-\-fast\-list. - -Waiting a moderate period of time between attempts (estimated to be -approximately 1 hour) and/or not using \-\-fast\-list both seem to be -effective in preventing the problem. - -### Making your own client_id ### - -When you use rclone with Google drive in its default configuration you -are using rclone\[aq]s client_id. This is shared between all the rclone -users. There is a global rate limit on the number of queries per -second that each client_id can do set by Google. rclone already has a -high quota and I will continue to make sure it is high enough by -contacting Google. - -It is strongly recommended to use your own client ID as the default rclone ID is heavily used. If you have multiple services running, it is recommended to use an API key for each service. The default Google quota is 10 transactions per second so it is recommended to stay under that number as if you use more than that, it will cause rclone to rate limit and make things slower. - -Here is how to create your own Google Drive client ID for rclone: - -1. Log into the [Google API -Console](https://console.developers.google.com/) with your Google -account. It doesn\[aq]t matter what Google account you use. (It need not -be the same account as the Google Drive you want to access) - -2. Select a project or create a new project. - -3. Under \[dq]ENABLE APIS AND SERVICES\[dq] search for \[dq]Drive\[dq], and enable the -\[dq]Google Drive API\[dq]. - -4. Click \[dq]Credentials\[dq] in the left\-side panel (not \[dq]Create -credentials\[dq], which opens the wizard), then \[dq]Create credentials\[dq] - -5. If you already configured an \[dq]Oauth Consent Screen\[dq], then skip -to the next step; if not, click on \[dq]CONFIGURE CONSENT SCREEN\[dq] button -(near the top right corner of the right panel), then select \[dq]External\[dq] -and click on \[dq]CREATE\[dq]; on the next screen, enter an \[dq]Application name\[dq] -(\[dq]rclone\[dq] is OK) then click on \[dq]Save\[dq] (all other data is optional). -Click again on \[dq]Credentials\[dq] on the left panel to go back to the -\[dq]Credentials\[dq] screen. - -(PS: if you are a GSuite user, you could also select \[dq]Internal\[dq] instead -of \[dq]External\[dq] above, but this has not been tested/documented so far). - -6. Click on the \[dq]+ CREATE CREDENTIALS\[dq] button at the top of the screen, -then select \[dq]OAuth client ID\[dq]. - -7. Choose an application type of \[dq]Desktop app\[dq] if you using a Google account or \[dq]Other\[dq] if -you using a GSuite account and click \[dq]Create\[dq]. (the default name is fine) - -8. It will show you a client ID and client secret. Use these values -in rclone config to add a new remote or edit an existing remote. - -Be aware that, due to the \[dq]enhanced security\[dq] recently introduced by -Google, you are theoretically expected to \[dq]submit your app for verification\[dq] -and then wait a few weeks(!) for their response; in practice, you can go right -ahead and use the client ID and client secret with rclone, the only issue will -be a very scary confirmation screen shown when you connect via your browser -for rclone to be able to get its token\-id (but as this only happens during -the remote configuration, it\[aq]s not such a big deal). - -(Thanks to \[at]balazer on github for these instructions.) - -Sometimes, creation of an OAuth consent in Google API Console fails due to an error message -\[lq]The request failed because changes to one of the field of the resource is not supported\[rq]. -As a convenient workaround, the necessary Google Drive API key can be created on the -[Python Quickstart](https://developers.google.com/drive/api/v3/quickstart/python) page. -Just push the Enable the Drive API button to receive the Client ID and Secret. -Note that it will automatically create a new project in the API Console. - - Google Photos -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The rclone backend for [Google Photos](https://www.google.com/photos/about/) is -a specialized backend for transferring photos and videos to and from -Google Photos. - -**NB** The Google Photos API which rclone uses has quite a few -limitations, so please read the [limitations section](#limitations) -carefully to make sure it is suitable for your use. - -## Configuring Google Photos - -The initial setup for google cloud storage involves getting a token from Google Photos -which you need to do in your browser. \[ga]rclone config\[ga] walks you -through it. - -Here is an example of how to make a remote called \[ga]remote\[ga]. First run: - - rclone config - -This will guide you through an interactive setup process: -\f[R] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -Choose a number from below, or type in your own value [snip] XX / Google -Photos \ \[dq]google photos\[dq] [snip] Storage> google photos ** See -help for google photos backend at: https://rclone.org/googlephotos/ ** -.PP -Google Application Client Id Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -client_id> Google Application Client Secret Leave blank normally. -Enter a string value. -Press Enter for the default (\[dq]\[dq]). -client_secret> Set to make the Google Photos backend read only. -.PP -If you choose read only then rclone will only request read only access -to your photos, otherwise rclone will request full access. -Enter a boolean value (true or false). -Press Enter for the default (\[dq]false\[dq]). -read_only> Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn\[aq]t open -automatically go to the following link: http://127.0.0.1:53682/auth Log -in and authorize rclone for access Waiting for code... -Got code -.PP -*** IMPORTANT: All media items uploaded to Google Photos with rclone *** -are stored in full resolution at original quality. -These uploads *** will count towards storage in your Google Account. +.SS Restricted filename characters .PP .TS tab(@); -lw(20.4n). +l c c. T{ -[remote] type = google photos token = -{\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-06\-28T17:38:04.644930156+01:00\[dq]} +Character +T}@T{ +Value +T}@T{ +Replacement T} _ T{ -y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y -\[ga]\[ga]\[ga] +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] T} T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +T{ +DEL +T}@T{ +0x7F +T}@T{ +\[u2421] +T} +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP +File names can also not end with the following characters. +These only get replaced if they are the last character in the name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to dropbox (Dropbox). +.SS \-\-dropbox\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to dropbox (Dropbox). +.SS \-\-dropbox\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-chunk\-size +.PP +Upload chunk size. +(< 150M). +.PP +Any files larger than this will be uploaded in chunks of this size. +.PP +Note that chunks are buffered in memory (one at a time) so rclone can +deal with retries. +Setting this larger will increase the speed slightly (at most 10% for +128MB in tests) at the cost of using more memory. +It can be set smaller if you are tight on memory. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 48M +.SS \-\-dropbox\-impersonate +.PP +Impersonate this user when using a business account. +.IP \[bu] 2 +Config: impersonate +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_IMPERSONATE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-dropbox\-shared\-files +.PP +Instructs rclone to work on individual shared files. +.PP +In this mode rclone\[aq]s features are extremely limited \- only list +(ls, lsl, etc.) operations and read operations (e.g. +downloading) are supported in this mode. +All other operations will be disabled. +.IP \[bu] 2 +Config: shared_files +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_SHARED_FILES +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-dropbox\-shared\-folders +.PP +Instructs rclone to work on shared folders. +.PP +When this flag is used with no path only the List operation is supported +and all available shared folders will be listed. +If you specify a path the first part will be interpreted as the name of +shared folder. +Rclone will then try to mount this shared to the root namespace. +On success shared folder rclone proceeds normally. +The shared folder is now pretty much a normal folder and all normal +operations are supported. +.PP +Note that we don\[aq]t unmount the shared folder afterwards so the +\-\-dropbox\-shared\-folders can be omitted after the first use of a +particular shared folder. +.IP \[bu] 2 +Config: shared_folders +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_SHARED_FOLDERS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-dropbox\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot +.SS Limitations +.PP +Note that Dropbox is case insensitive so you can\[aq]t have a file +called \[dq]Hello.doc\[dq] and one called \[dq]hello.doc\[dq]. +.PP +There are some file names such as \f[C]thumbs.db\f[R] which Dropbox +can\[aq]t store. +There is a full list of them in the \[dq]Ignored Files\[dq] section of +this document (https://www.dropbox.com/en/help/145). +Rclone will issue an error message +\f[C]File name disallowed \- not uploading\f[R] if it attempts to upload +one of those file names, but the sync won\[aq]t fail. +.PP +Some errors may occur if you try to sync copyright\-protected files +because Dropbox has its own copyright +detector (https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/) +that prevents this sort of file being downloaded. +This will return the error +\f[C]ERROR : /path/to/your/file: Failed to copy: failed to open source object: path/restricted_content/.\f[R] +.PP +If you have more than 10,000 files in a directory then +\f[C]rclone purge dropbox:dir\f[R] will return the error +\f[C]Failed to purge: There are too many files involved in this operation\f[R]. +As a work\-around do an \f[C]rclone delete dropbox:dir\f[R] followed by +an \f[C]rclone rmdir dropbox:dir\f[R]. +.SS Get your own Dropbox App ID +.PP +When you use rclone with Dropbox in its default configuration you are +using rclone\[aq]s App ID. +This is shared between all the rclone users. +.PP +Here is how to create your own Dropbox App ID for rclone: +.IP "1." 3 +Log into the Dropbox App +console (https://www.dropbox.com/developers/apps/create) with your +Dropbox Account (It need not to be the same account as the Dropbox you +want to access) +.IP "2." 3 +Choose an API => Usually this should be \f[C]Dropbox API\f[R] +.IP "3." 3 +Choose the type of access you want to use => \f[C]Full Dropbox\f[R] or +\f[C]App Folder\f[R] +.IP "4." 3 +Name your App. +The app name is global, so you can\[aq]t use \f[C]rclone\f[R] for +example +.IP "5." 3 +Click the button \f[C]Create App\f[R] +.IP "6." 3 +Fill \f[C]Redirect URIs\f[R] as \f[C]http://localhost:53682/\f[R] +.IP "7." 3 +Find the \f[C]App key\f[R] and \f[C]App secret\f[R] Use these values in +rclone config to add a new remote or edit an existing remote. +.SS Enterprise File Fabric +.PP +This backend supports Storage Made Easy\[aq]s Enterprise File +Fabric\[tm] (https://storagemadeeasy.com/about/) which provides a +software solution to integrate and unify File and Object Storage +accessible through a global file system. +.PP +The initial setup for the Enterprise File Fabric backend involves +getting a token from the the Enterprise File Fabric which you need to do +in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / Enterprise File Fabric + \[rs] \[dq]filefabric\[dq] +[snip] +Storage> filefabric +** See help for filefabric backend at: https://rclone.org/filefabric/ ** + +URL of the Enterprise File Fabric to connect to +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Storage Made Easy US + \[rs] \[dq]https://storagemadeeasy.com\[dq] + 2 / Storage Made Easy EU + \[rs] \[dq]https://eu.storagemadeeasy.com\[dq] + 3 / Connect to your Enterprise File Fabric + \[rs] \[dq]https://yourfabric.smestorage.com\[dq] +url> https://yourfabric.smestorage.com/ +ID of the root folder +Leave blank normally. + +Fill in to make rclone start with directory of a given ID. + +Enter a string value. Press Enter for the default (\[dq]\[dq]). +root_folder_id> +Permanent Authentication Token + +A Permanent Authentication Token can be created in the Enterprise File +Fabric, on the users Dashboard under Security, there is an entry +you\[aq]ll see called \[dq]My Authentication Tokens\[dq]. Click the Manage button +to create one. + +These tokens are normally valid for several years. + +For more info see: https://docs.storagemadeeasy.com/organisationcloud/api\-tokens + +Enter a string value. Press Enter for the default (\[dq]\[dq]). +permanent_token> xxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxx +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = filefabric +url = https://yourfabric.smestorage.com/ +permanent_token = xxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxx +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level of your Enterprise File Fabric +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your Enterprise File Fabric +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an Enterprise File Fabric directory called +backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Modified time and hashes +.PP +The Enterprise File Fabric allows modification times to be set on files +accurate to 1 second. +These will be used to detect whether objects need syncing or not. +.PP +The Enterprise File Fabric does not support any data hashes at this +time. +.SS Restricted filename characters +.PP +The default restricted characters +set (https://rclone.org/overview/#restricted-characters) will be +replaced. +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Empty files +.PP +Empty files aren\[aq]t supported by the Enterprise File Fabric. +Rclone will therefore upload an empty file as a single space with a mime +type of \f[C]application/vnd.rclone.empty.file\f[R] and files with that +mime type are treated as empty. +.SS Root folder ID +.PP +You can set the \f[C]root_folder_id\f[R] for rclone. +This is the directory (identified by its \f[C]Folder ID\f[R]) that +rclone considers to be the root of your Enterprise File Fabric. +.PP +Normally you will leave this blank and rclone will determine the correct +root to use itself. +.PP +However you can set this to restrict rclone to a specific folder +hierarchy. +.PP +In order to do this you will have to find the \f[C]Folder ID\f[R] of the +directory you wish rclone to display. +These aren\[aq]t displayed in the web interface, but you can use +\f[C]rclone lsf\f[R] to find them, for example +.IP +.nf +\f[C] +$ rclone lsf \-\-dirs\-only \-Fip \-\-csv filefabric: +120673758,Burnt PDFs/ +120673759,My Quick Uploads/ +120673755,My Syncs/ +120673756,My backups/ +120673757,My contacts/ +120673761,S3 Storage/ +\f[R] +.fi +.PP +The ID for \[dq]S3 Storage\[dq] would be \f[C]120673761\f[R]. +.SS Standard Options +.PP +Here are the standard options specific to filefabric (Enterprise File +Fabric). +.SS \-\-filefabric\-url +.PP +URL of the Enterprise File Fabric to connect to +.IP \[bu] 2 +Config: url +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]https://storagemadeeasy.com\[dq] +.RS 2 +.IP \[bu] 2 +Storage Made Easy US +.RE +.IP \[bu] 2 +\[dq]https://eu.storagemadeeasy.com\[dq] +.RS 2 +.IP \[bu] 2 +Storage Made Easy EU +.RE +.IP \[bu] 2 +\[dq]https://yourfabric.smestorage.com\[dq] +.RS 2 +.IP \[bu] 2 +Connect to your Enterprise File Fabric +.RE +.RE +.SS \-\-filefabric\-root\-folder\-id +.PP +ID of the root folder Leave blank normally. +.PP +Fill in to make rclone start with directory of a given ID. +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-filefabric\-permanent\-token +.PP +Permanent Authentication Token +.PP +A Permanent Authentication Token can be created in the Enterprise File +Fabric, on the users Dashboard under Security, there is an entry +you\[aq]ll see called \[dq]My Authentication Tokens\[dq]. +Click the Manage button to create one. +.PP +These tokens are normally valid for several years. +.PP +For more info see: +https://docs.storagemadeeasy.com/organisationcloud/api\-tokens +.IP \[bu] 2 +Config: permanent_token +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to filefabric (Enterprise File +Fabric). +.SS \-\-filefabric\-token +.PP +Session Token +.PP +This is a session token which rclone caches in the config file. +It is usually valid for 1 hour. +.PP +Don\[aq]t set this value \- rclone will set it automatically. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-filefabric\-token\-expiry +.PP +Token expiry time +.PP +Don\[aq]t set this value \- rclone will set it automatically. +.IP \[bu] 2 +Config: token_expiry +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-filefabric\-version +.PP +Version read from the file fabric +.PP +Don\[aq]t set this value \- rclone will set it automatically. +.IP \[bu] 2 +Config: version +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_VERSION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-filefabric\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FILEFABRIC_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Del,Ctl,InvalidUtf8,Dot +.SS FTP +.PP +FTP is the File Transfer Protocol. +Rclone FTP support is provided using the +github.com/jlaffaye/ftp (https://godoc.org/github.com/jlaffaye/ftp) +package. +.PP +Limitations of Rclone\[aq]s FTP backend +.PP +Paths are specified as \f[C]remote:path\f[R]. +If the path does not begin with a \f[C]/\f[R] it is relative to the home +directory of the user. +An empty path \f[C]remote:\f[R] refers to the user\[aq]s home directory. +.PP +To create an FTP configuration named \f[C]remote\f[R], run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +Rclone config guides you through an interactive setup process. +A minimal rclone FTP remote definition only requires host, username and +password. +For an anonymous FTP server, use \f[C]anonymous\f[R] as username and +your email address as password. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / FTP Connection + \[rs] \[dq]ftp\[dq] +[snip] +Storage> ftp +** See help for ftp backend at: https://rclone.org/ftp/ ** + +FTP host to connect to +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Connect to ftp.example.com + \[rs] \[dq]ftp.example.com\[dq] +host> ftp.example.com +FTP username, leave blank for current username, $USER +Enter a string value. Press Enter for the default (\[dq]\[dq]). +user> +FTP port, leave blank to use default (21) +Enter a string value. Press Enter for the default (\[dq]\[dq]). +port> +FTP password +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: +password: +Confirm the password: +password: +Use FTP over TLS (Implicit) +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +tls> +Use FTP over TLS (Explicit) +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +explicit_tls> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = ftp +host = ftp.example.com +pass = *** ENCRYPTED *** +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +To see all directories in the home directory of \f[C]remote\f[R] +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +Make a new directory +.IP +.nf +\f[C] +rclone mkdir remote:path/to/directory +\f[R] +.fi +.PP +List the contents of a directory +.IP +.nf +\f[C] +rclone ls remote:path/to/directory +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote directory, deleting +any excess files in the directory. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:directory +\f[R] +.fi +.SS Example without a config file +.IP +.nf +\f[C] +rclone lsf :ftp: \-\-ftp\-host=speedtest.tele2.net \-\-ftp\-user=anonymous \-\-ftp\-pass=\[ga]rclone obscure dummy\[ga] +\f[R] +.fi +.SS Implicit TLS +.PP +Rlone FTP supports implicit FTP over TLS servers (FTPS). +This has to be enabled in the FTP backend config for the remote, or with +\f[C][\-\-ftp\-tls]{#ftp\-tls}\f[R]. +The default FTPS port is \f[C]990\f[R], not \f[C]21\f[R] and can be set +with \f[C][\-\-ftp\-port]{#ftp\-port}\f[R]. +.SS Standard Options +.PP +Here are the standard options specific to ftp (FTP Connection). +.SS \-\-ftp\-host +.PP +FTP host to connect to +.IP \[bu] 2 +Config: host +.IP \[bu] 2 +Env Var: RCLONE_FTP_HOST +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]ftp.example.com\[dq] +.RS 2 +.IP \[bu] 2 +Connect to ftp.example.com +.RE +.RE +.SS \-\-ftp\-user +.PP +FTP username, leave blank for current username, $USER +.IP \[bu] 2 +Config: user +.IP \[bu] 2 +Env Var: RCLONE_FTP_USER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-ftp\-port +.PP +FTP port, leave blank to use default (21) +.IP \[bu] 2 +Config: port +.IP \[bu] 2 +Env Var: RCLONE_FTP_PORT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-ftp\-pass +.PP +FTP password +.PP +\f[B]NB\f[R] Input to this must be obscured \- see rclone +obscure (https://rclone.org/commands/rclone_obscure/). +.IP \[bu] 2 +Config: pass +.IP \[bu] 2 +Env Var: RCLONE_FTP_PASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-ftp\-tls +.PP +Use Implicit FTPS (FTP over TLS) When using implicit FTP over TLS the +client connects using TLS right from the start which breaks +compatibility with non\-TLS\-aware servers. +This is usually served over port 990 rather than port 21. +Cannot be used in combination with explicit FTP. +.IP \[bu] 2 +Config: tls +.IP \[bu] 2 +Env Var: RCLONE_FTP_TLS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-explicit\-tls +.PP +Use Explicit FTPS (FTP over TLS) When using explicit FTP over TLS the +client explicitly requests security from the server in order to upgrade +a plain text connection to an encrypted one. +Cannot be used in combination with implicit FTP. +.IP \[bu] 2 +Config: explicit_tls +.IP \[bu] 2 +Env Var: RCLONE_FTP_EXPLICIT_TLS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to ftp (FTP Connection). +.SS \-\-ftp\-concurrency +.PP +Maximum number of FTP simultaneous connections, 0 for unlimited +.IP \[bu] 2 +Config: concurrency +.IP \[bu] 2 +Env Var: RCLONE_FTP_CONCURRENCY +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 0 +.SS \-\-ftp\-no\-check\-certificate +.PP +Do not verify the TLS certificate of the server +.IP \[bu] 2 +Config: no_check_certificate +.IP \[bu] 2 +Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-disable\-epsv +.PP +Disable using EPSV even if server advertises support +.IP \[bu] 2 +Config: disable_epsv +.IP \[bu] 2 +Env Var: RCLONE_FTP_DISABLE_EPSV +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-disable\-mlsd +.PP +Disable using MLSD even if server advertises support +.IP \[bu] 2 +Config: disable_mlsd +.IP \[bu] 2 +Env Var: RCLONE_FTP_DISABLE_MLSD +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-ftp\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FTP_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Del,Ctl,RightSpace,Dot +.SS Limitations +.PP +Modified times are not supported. +Times you see on the FTP server through rclone are those of upload. +.PP +Rclone\[aq]s FTP backend does not support any checksums but can compare +file sizes. +.PP +\f[C]rclone about\f[R] is not supported by the FTP backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.PP +The implementation of : \f[C]\-\-dump headers\f[R], +\f[C]\-\-dump bodies\f[R], \f[C]\-\-dump auth\f[R] for debugging +isn\[aq]t the same as for rclone HTTP based backends \- it has less fine +grained control. +.PP +\f[C]\-\-timeout\f[R] isn\[aq]t supported (but \f[C]\-\-contimeout\f[R] +is). +.PP +\f[C]\-\-bind\f[R] isn\[aq]t supported. +.PP +Rclone\[aq]s FTP backend could support server\-side move but does not at +present. +.PP +The \f[C]ftp_proxy\f[R] environment variable is not currently supported. +.PP +FTP servers acting as rclone remotes must support \[aq]passive\[aq] +mode. +Rclone\[aq]s FTP implementation is not compatible with \[aq]active\[aq] +mode. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +File names cannot end with the following characters. +Repacement is limited to the last character in a file name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Not all FTP servers can have all characters in file names, for example: +.PP +.TS +tab(@); +l c. +T{ +FTP Server +T}@T{ +Forbidden characters +T} +_ +T{ +proftpd +T}@T{ +\f[C]*\f[R] +T} +T{ +pureftpd +T}@T{ +\f[C]\[rs] [ ]\f[R] +T} +.TE +.SS Google Cloud Storage +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +The initial setup for google cloud storage involves getting a token from +Google Cloud Storage which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +n) New remote +d) Delete remote +q) Quit config +e/n/d/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Google Cloud Storage (this is not Google Drive) + \[rs] \[dq]google cloud storage\[dq] +[snip] +Storage> google cloud storage +Google Application Client Id \- leave blank normally. +client_id> +Google Application Client Secret \- leave blank normally. +client_secret> +Project number optional \- needed only for list/create/delete buckets \- see your developer console. +project_number> 12345678 +Service Account Credentials JSON file path \- needed only if you want use SA instead of interactive login. +service_account_file> +Access Control List for new objects. +Choose a number from below, or type in your own value + 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. + \[rs] \[dq]authenticatedRead\[dq] + 2 / Object owner gets OWNER access, and project team owners get OWNER access. + \[rs] \[dq]bucketOwnerFullControl\[dq] + 3 / Object owner gets OWNER access, and project team owners get READER access. + \[rs] \[dq]bucketOwnerRead\[dq] + 4 / Object owner gets OWNER access [default if left blank]. + \[rs] \[dq]private\[dq] + 5 / Object owner gets OWNER access, and project team members get access according to their roles. + \[rs] \[dq]projectPrivate\[dq] + 6 / Object owner gets OWNER access, and all Users get READER access. + \[rs] \[dq]publicRead\[dq] +object_acl> 4 +Access Control List for new buckets. +Choose a number from below, or type in your own value + 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. + \[rs] \[dq]authenticatedRead\[dq] + 2 / Project team owners get OWNER access [default if left blank]. + \[rs] \[dq]private\[dq] + 3 / Project team members get access according to their roles. + \[rs] \[dq]projectPrivate\[dq] + 4 / Project team owners get OWNER access, and all Users get READER access. + \[rs] \[dq]publicRead\[dq] + 5 / Project team owners get OWNER access, and all Users get WRITER access. + \[rs] \[dq]publicReadWrite\[dq] +bucket_acl> 2 +Location for the newly created buckets. +Choose a number from below, or type in your own value + 1 / Empty for default location (US). + \[rs] \[dq]\[dq] + 2 / Multi\-regional location for Asia. + \[rs] \[dq]asia\[dq] + 3 / Multi\-regional location for Europe. + \[rs] \[dq]eu\[dq] + 4 / Multi\-regional location for United States. + \[rs] \[dq]us\[dq] + 5 / Taiwan. + \[rs] \[dq]asia\-east1\[dq] + 6 / Tokyo. + \[rs] \[dq]asia\-northeast1\[dq] + 7 / Singapore. + \[rs] \[dq]asia\-southeast1\[dq] + 8 / Sydney. + \[rs] \[dq]australia\-southeast1\[dq] + 9 / Belgium. + \[rs] \[dq]europe\-west1\[dq] +10 / London. + \[rs] \[dq]europe\-west2\[dq] +11 / Iowa. + \[rs] \[dq]us\-central1\[dq] +12 / South Carolina. + \[rs] \[dq]us\-east1\[dq] +13 / Northern Virginia. + \[rs] \[dq]us\-east4\[dq] +14 / Oregon. + \[rs] \[dq]us\-west1\[dq] +location> 12 +The storage class to use when storing objects in Google Cloud Storage. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Multi\-regional storage class + \[rs] \[dq]MULTI_REGIONAL\[dq] + 3 / Regional storage class + \[rs] \[dq]REGIONAL\[dq] + 4 / Nearline storage class + \[rs] \[dq]NEARLINE\[dq] + 5 / Coldline storage class + \[rs] \[dq]COLDLINE\[dq] + 6 / Durable reduced availability storage class + \[rs] \[dq]DURABLE_REDUCED_AVAILABILITY\[dq] +storage_class> 5 +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn\[aq]t work +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = google cloud storage +client_id = +client_secret = +token = {\[dq]AccessToken\[dq]:\[dq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-07\-17T20:49:14.929208288+01:00\[dq],\[dq]Extra\[dq]:null} +project_number = 12345678 +object_acl = private +bucket_acl = private +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall, or use +manual mode. +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP +See all the buckets in your project +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +Make a new bucket +.IP +.nf +\f[C] +rclone mkdir remote:bucket +\f[R] +.fi +.PP +List the contents of a bucket +.IP +.nf +\f[C] +rclone ls remote:bucket +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote bucket, deleting any +excess files in the bucket. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:bucket +\f[R] +.fi +.SS Service Account support +.PP +You can set up rclone with Google Cloud Storage in an unattended mode, +i.e. +not tied to a specific end\-user Google account. +This is useful when you want to synchronise files onto machines that +don\[aq]t have actively logged\-in users, for example build machines. +.PP +To get credentials for Google Cloud Platform IAM Service +Accounts (https://cloud.google.com/iam/docs/service-accounts), please +head to the Service +Account (https://console.cloud.google.com/permissions/serviceaccounts) +section of the Google Developer Console. +Service Accounts behave just like normal \f[C]User\f[R] permissions in +Google Cloud Storage +ACLs (https://cloud.google.com/storage/docs/access-control), so you can +limit their access (e.g. +make them read only). +After creating an account, a JSON file containing the Service +Account\[aq]s credentials will be downloaded onto your machines. +These credentials are what rclone will use for authentication. +.PP +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the \f[C]service_account_file\f[R] +prompt and rclone won\[aq]t use the browser based authentication flow. +If you\[aq]d rather stuff the contents of the credentials file into the +rclone config file, you can set \f[C]service_account_credentials\f[R] +with the actual contents of the file instead, or set the equivalent +environment variable. +.SS Anonymous Access +.PP +For downloads of objects that permit public access you can configure +rclone to use anonymous access by setting \f[C]anonymous\f[R] to +\f[C]true\f[R]. +With unauthorized access you can\[aq]t write or create files but only +read or list those buckets and objects that have public read access. +.SS Application Default Credentials +.PP +If no other source of credentials is provided, rclone will fall back to +Application Default +Credentials (https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) +this is useful both when you already have configured authentication for +your developer account, or in production when running on a google +compute host. +Note that if running in docker, you may need to run additional commands +on your google compute machine \- see this +page (https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). +.PP +Note that in the case application default credentials are used, there is +no need to explicitly configure a project number. +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.SS Custom upload headers +.PP +You can set custom upload headers with the \f[C]\-\-header\-upload\f[R] +flag. +Google Cloud Storage supports the headers as described in the working +with metadata +documentation (https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata) +.IP \[bu] 2 +Cache\-Control +.IP \[bu] 2 +Content\-Disposition +.IP \[bu] 2 +Content\-Encoding +.IP \[bu] 2 +Content\-Language +.IP \[bu] 2 +Content\-Type +.IP \[bu] 2 +X\-Goog\-Storage\-Class +.IP \[bu] 2 +X\-Goog\-Meta\- +.PP +Eg \f[C]\-\-header\-upload \[dq]Content\-Type text/potato\[dq]\f[R] +.PP +Note that the last of these is for setting custom metadata in the form +\f[C]\-\-header\-upload \[dq]x\-goog\-meta\-key: value\[dq]\f[R] +.SS Modified time +.PP +Google google cloud storage stores md5sums natively and rclone stores +modification times as metadata on the object, under the \[dq]mtime\[dq] +key in RFC3339 format accurate to 1ns. +.SS Restricted filename characters +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +LF +T}@T{ +0x0A +T}@T{ +\[u240A] +T} +T{ +CR +T}@T{ +0x0D +T}@T{ +\[u240D] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +.TE +.PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). +.SS \-\-gcs\-client\-id +.PP +OAuth Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_GCS_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_GCS_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-project\-number +.PP +Project number. +Optional \- needed only for list/create/delete buckets \- see your +developer console. +.IP \[bu] 2 +Config: project_number +.IP \[bu] 2 +Env Var: RCLONE_GCS_PROJECT_NUMBER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-service\-account\-file +.PP +Service Account Credentials JSON file path Leave blank normally. +Needed only if you want use SA instead of interactive login. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: service_account_file +.IP \[bu] 2 +Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-service\-account\-credentials +.PP +Service Account Credentials JSON blob Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_credentials +.IP \[bu] 2 +Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-anonymous +.PP +Access public buckets and objects without credentials Set to +\[aq]true\[aq] if you just want to download files and don\[aq]t +configure credentials. +.IP \[bu] 2 +Config: anonymous +.IP \[bu] 2 +Env Var: RCLONE_GCS_ANONYMOUS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-gcs\-object\-acl +.PP +Access Control List for new objects. +.IP \[bu] 2 +Config: object_acl +.IP \[bu] 2 +Env Var: RCLONE_GCS_OBJECT_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]authenticatedRead\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and all Authenticated Users get READER +access. +.RE +.IP \[bu] 2 +\[dq]bucketOwnerFullControl\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team owners get OWNER +access. +.RE +.IP \[bu] 2 +\[dq]bucketOwnerRead\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team owners get READER +access. +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access [default if left blank]. +.RE +.IP \[bu] 2 +\[dq]projectPrivate\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team members get access +according to their roles. +.RE +.IP \[bu] 2 +\[dq]publicRead\[dq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and all Users get READER access. +.RE +.RE +.SS \-\-gcs\-bucket\-acl +.PP +Access Control List for new buckets. +.IP \[bu] 2 +Config: bucket_acl +.IP \[bu] 2 +Env Var: RCLONE_GCS_BUCKET_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]authenticatedRead\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Authenticated Users get +READER access. +.RE +.IP \[bu] 2 +\[dq]private\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access [default if left blank]. +.RE +.IP \[bu] 2 +\[dq]projectPrivate\[dq] +.RS 2 +.IP \[bu] 2 +Project team members get access according to their roles. +.RE +.IP \[bu] 2 +\[dq]publicRead\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Users get READER access. +.RE +.IP \[bu] 2 +\[dq]publicReadWrite\[dq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Users get WRITER access. +.RE +.RE +.SS \-\-gcs\-bucket\-policy\-only +.PP +Access checks should use bucket\-level IAM policies. +.PP +If you want to upload objects to a bucket with Bucket Policy Only set +then you will need to set this. +.PP +When it is set, rclone: +.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 \-\-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: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Empty for default location (US). +.RE +.IP \[bu] 2 +\[dq]asia\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for Asia. +.RE +.IP \[bu] 2 +\[dq]eu\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for Europe. +.RE +.IP \[bu] 2 +\[dq]us\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for United States. +.RE +.IP \[bu] 2 +\[dq]asia\-east1\[dq] +.RS 2 +.IP \[bu] 2 +Taiwan. +.RE +.IP \[bu] 2 +\[dq]asia\-east2\[dq] +.RS 2 +.IP \[bu] 2 +Hong Kong. +.RE +.IP \[bu] 2 +\[dq]asia\-northeast1\[dq] +.RS 2 +.IP \[bu] 2 +Tokyo. +.RE +.IP \[bu] 2 +\[dq]asia\-south1\[dq] +.RS 2 +.IP \[bu] 2 +Mumbai. +.RE +.IP \[bu] 2 +\[dq]asia\-southeast1\[dq] +.RS 2 +.IP \[bu] 2 +Singapore. +.RE +.IP \[bu] 2 +\[dq]australia\-southeast1\[dq] +.RS 2 +.IP \[bu] 2 +Sydney. +.RE +.IP \[bu] 2 +\[dq]europe\-north1\[dq] +.RS 2 +.IP \[bu] 2 +Finland. +.RE +.IP \[bu] 2 +\[dq]europe\-west1\[dq] +.RS 2 +.IP \[bu] 2 +Belgium. +.RE +.IP \[bu] 2 +\[dq]europe\-west2\[dq] +.RS 2 +.IP \[bu] 2 +London. +.RE +.IP \[bu] 2 +\[dq]europe\-west3\[dq] +.RS 2 +.IP \[bu] 2 +Frankfurt. +.RE +.IP \[bu] 2 +\[dq]europe\-west4\[dq] +.RS 2 +.IP \[bu] 2 +Netherlands. +.RE +.IP \[bu] 2 +\[dq]us\-central1\[dq] +.RS 2 +.IP \[bu] 2 +Iowa. +.RE +.IP \[bu] 2 +\[dq]us\-east1\[dq] +.RS 2 +.IP \[bu] 2 +South Carolina. +.RE +.IP \[bu] 2 +\[dq]us\-east4\[dq] +.RS 2 +.IP \[bu] 2 +Northern Virginia. +.RE +.IP \[bu] 2 +\[dq]us\-west1\[dq] +.RS 2 +.IP \[bu] 2 +Oregon. +.RE +.IP \[bu] 2 +\[dq]us\-west2\[dq] +.RS 2 +.IP \[bu] 2 +California. +.RE +.RE +.SS \-\-gcs\-storage\-class +.PP +The storage class to use when storing objects in Google Cloud Storage. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_GCS_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[dq]MULTI_REGIONAL\[dq] +.RS 2 +.IP \[bu] 2 +Multi\-regional storage class +.RE +.IP \[bu] 2 +\[dq]REGIONAL\[dq] +.RS 2 +.IP \[bu] 2 +Regional storage class +.RE +.IP \[bu] 2 +\[dq]NEARLINE\[dq] +.RS 2 +.IP \[bu] 2 +Nearline storage class +.RE +.IP \[bu] 2 +\[dq]COLDLINE\[dq] +.RS 2 +.IP \[bu] 2 +Coldline storage class +.RE +.IP \[bu] 2 +\[dq]ARCHIVE\[dq] +.RS 2 +.IP \[bu] 2 +Archive storage class +.RE +.IP \[bu] 2 +\[dq]DURABLE_REDUCED_AVAILABILITY\[dq] +.RS 2 +.IP \[bu] 2 +Durable reduced availability storage class +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). +.SS \-\-gcs\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_GCS_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_GCS_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_GCS_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gcs\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_GCS_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,CrLf,InvalidUtf8,Dot +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the Google Cloud Storage +backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Google Drive +.PP +Paths are specified as \f[C]drive:path\f[R] +.PP +Drive paths may be as deep as required, e.g. +\f[C]drive:directory/subdirectory\f[R]. +.PP +The initial setup for drive involves getting a token from Google drive +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Google Drive + \[rs] \[dq]drive\[dq] +[snip] +Storage> drive +Google Application Client Id \- leave blank normally. +client_id> +Google Application Client Secret \- leave blank normally. +client_secret> +Scope that rclone should use when requesting access from drive. +Choose a number from below, or type in your own value + 1 / Full access all files, excluding Application Data Folder. + \[rs] \[dq]drive\[dq] + 2 / Read\-only access to file metadata and file contents. + \[rs] \[dq]drive.readonly\[dq] + / Access to files created by rclone only. + 3 | These are visible in the drive website. + | File authorization is revoked when the user deauthorizes the app. + \[rs] \[dq]drive.file\[dq] + / Allows read and write access to the Application Data folder. + 4 | This is not visible in the drive website. + \[rs] \[dq]drive.appfolder\[dq] + / Allows read\-only access to file metadata but + 5 | does not allow any access to read or download file content. + \[rs] \[dq]drive.metadata.readonly\[dq] +scope> 1 +ID of the root folder \- leave blank normally. Fill in to access \[dq]Computers\[dq] folders. (see docs). +root_folder_id> +Service Account Credentials JSON file path \- needed only if you want use SA instead of interactive login. +service_account_file> +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn\[aq]t work +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +Configure this as a team drive? +y) Yes +n) No +y/n> n +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +scope = drive +root_folder_id = +service_account_file = +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall, or use +manual mode. +.PP +You can then use it like this, +.PP +List directories in top level of your drive +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your drive +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to a drive directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS 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\[aq]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\[aq]t be able to see rclone\[aq]s files from the web interface +either. +.SS drive.metadata.readonly +.PP +This allows read only access to file names only. +It does not allow rclone to download or upload data, or rename or delete +files or directories. +.SS Root folder ID +.PP +You can set the \f[C]root_folder_id\f[R] for rclone. +This is the directory (identified by its \f[C]Folder ID\f[R]) that +rclone considers to be the root of your drive. +.PP +Normally you will leave this blank and rclone will determine the correct +root to use itself. +.PP +However you can set this to restrict rclone to a specific folder +hierarchy or to access data within the \[dq]Computers\[dq] tab on the +drive web interface (where files from Google\[aq]s Backup and Sync +desktop program go). +.PP +In order to do this you will have to find the \f[C]Folder ID\f[R] of the +directory you wish rclone to display. +This will be the last segment of the URL when you open the relevant +folder in the drive web interface. +.PP +So if the folder you want rclone to use has a URL which looks like +\f[C]https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[R] +in the browser, then you use \f[C]1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh\f[R] +as the \f[C]root_folder_id\f[R] in the config. +.PP +\f[B]NB\f[R] folders under the \[dq]Computers\[dq] tab seem to be read +only (drive gives a 500 error) when using rclone. +.PP +There doesn\[aq]t appear to be an API to discover the folder IDs of the +\[dq]Computers\[dq] tab \- please contact us if you know otherwise! +.PP +Note also that rclone can\[aq]t access any data under the +\[dq]Backups\[dq] tab on the google drive web interface yet. +.SS Service Account support +.PP +You can set up rclone with Google Drive in an unattended mode, i.e. +not tied to a specific end\-user Google account. +This is useful when you want to synchronise files onto machines that +don\[aq]t have actively logged\-in users, for example build machines. +.PP +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the \f[C]service_account_file\f[R] +prompt during \f[C]rclone config\f[R] and rclone won\[aq]t use the +browser based authentication flow. +If you\[aq]d rather stuff the contents of the credentials file into the +rclone config file, you can set \f[C]service_account_credentials\f[R] +with the actual contents of the file instead, or set the equivalent +environment variable. +.SS Use case \- Google Apps/G\-suite account and individual Drive +.PP +Let\[aq]s say that you are the administrator of a Google Apps (old) or +G\-suite account. +The goal is to store data on an individual\[aq]s Drive account, who IS a +member of the domain. +We\[aq]ll call the domain \f[B]example.com\f[R], and the user +\f[B]foo\[at]example.com\f[R]. +.PP +There\[aq]s a few steps we need to go through to accomplish this: +.SS 1. Create a service account for example.com +.IP \[bu] 2 +To create a service account and obtain its credentials, go to the Google +Developer Console (https://console.developers.google.com). +.IP \[bu] 2 +You must have a project \- create one if you don\[aq]t. +.IP \[bu] 2 +Then go to \[dq]IAM & admin\[dq] \-> \[dq]Service Accounts\[dq]. +.IP \[bu] 2 +Use the \[dq]Create Credentials\[dq] button. +Fill in \[dq]Service account name\[dq] with something that identifies +your client. +\[dq]Role\[dq] can be empty. +.IP \[bu] 2 +Tick \[dq]Furnish a new private key\[dq] \- select \[dq]Key type +JSON\[dq]. +.IP \[bu] 2 +Tick \[dq]Enable G Suite Domain\-wide Delegation\[dq]. +This option makes \[dq]impersonation\[dq] possible, as documented here: +Delegating domain\-wide authority to the service +account (https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) +.IP \[bu] 2 +These credentials are what rclone will use for authentication. +If you ever need to remove access, press the \[dq]Delete service account +key\[dq] button. +.SS 2. Allowing API access to example.com Google Drive +.IP \[bu] 2 +Go to example.com\[aq]s admin console +.IP \[bu] 2 +Go into \[dq]Security\[dq] (or use the search bar) +.IP \[bu] 2 +Select \[dq]Show more\[dq] and then \[dq]Advanced settings\[dq] +.IP \[bu] 2 +Select \[dq]Manage API client access\[dq] in the +\[dq]Authentication\[dq] section +.IP \[bu] 2 +In the \[dq]Client Name\[dq] field enter the service account\[aq]s +\[dq]Client ID\[dq] \- this can be found in the Developer Console under +\[dq]IAM & Admin\[dq] \-> \[dq]Service Accounts\[dq], then \[dq]View +Client ID\[dq] for the newly created service account. +It is a \[ti]21 character numerical string. +.IP \[bu] 2 +In the next field, \[dq]One or More API Scopes\[dq], enter +\f[C]https://www.googleapis.com/auth/drive\f[R] to grant access to +Google Drive specifically. +.SS 3. Configure rclone, assuming a new install +.IP +.nf +\f[C] +rclone config + +n/s/q> n # New +name>gdrive # Gdrive is an example name +Storage> # Select the number shown for Google Drive +client_id> # Can be left blank +client_secret> # Can be left blank +scope> # Select your scope, 1 for example +root_folder_id> # Can be left blank +service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! +y/n> # Auto config, y +\f[R] +.fi +.SS 4. Verify that it\[aq]s working +.IP \[bu] 2 +\f[C]rclone \-v \-\-drive\-impersonate foo\[at]example.com lsf gdrive:backup\f[R] +.IP \[bu] 2 +The arguments do: +.RS 2 +.IP \[bu] 2 +\f[C]\-v\f[R] \- verbose logging +.IP \[bu] 2 +\f[C]\-\-drive\-impersonate foo\[at]example.com\f[R] \- this is what +does the magic, pretending to be user foo. +.IP \[bu] 2 +\f[C]lsf\f[R] \- list files in a parsing friendly way +.IP \[bu] 2 +\f[C]gdrive:backup\f[R] \- use the remote called gdrive, work in the +folder named backup. +.RE +.PP +Note: in case you configured a specific root folder on gdrive and rclone +is unable to access the contents of that folder when using +\f[C]\-\-drive\-impersonate\f[R], do this instead: \- in the gdrive web +interface, share your root folder with the user/email of the new Service +Account you created/selected at step #1 \- use rclone without specifying +the \f[C]\-\-drive\-impersonate\f[R] option, like this: +\f[C]rclone \-v foo\[at]example.com lsf gdrive:backup\f[R] +.SS Team drives +.PP +If you want to configure the remote to point to a Google Team Drive then +answer \f[C]y\f[R] to the question +\f[C]Configure this as a team drive?\f[R]. +.PP +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 + \[rs] \[dq]xxxxxxxxxxxxxxxxxxxx\[dq] + 2 / Rclone Test 2 + \[rs] \[dq]yyyyyyyyyyyyyyyyyyyy\[dq] + 3 / Rclone Test 3 + \[rs] \[dq]zzzzzzzzzzzzzzzzzzzz\[dq] +Enter a Team Drive ID> 1 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +token = {\[dq]AccessToken\[dq]:\[dq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]RefreshToken\[dq]:\[dq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]Expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq],\[dq]Extra\[dq]:null} +team_drive = xxxxxxxxxxxxxxxxxxxx +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS \-\-fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (https://rclone.org/docs/#fast-list) for more +details. +.PP +It does this by combining multiple \f[C]list\f[R] calls into a single +API request. +.PP +This works by combining many \f[C]\[aq]%s\[aq] in parents\f[R] filters +into one expression. +To list the contents of directories a, b and c, the following requests +will be send by the regular \f[C]List\f[R] function: +.IP +.nf +\f[C] +trashed=false and \[aq]a\[aq] in parents +trashed=false and \[aq]b\[aq] in parents +trashed=false and \[aq]c\[aq] in parents +\f[R] +.fi +.PP +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[R] +.fi +.PP +The implementation of \f[C]ListR\f[R] will put up to 50 +\f[C]parents\f[R] filters into one request. +It will use the \f[C]\-\-checkers\f[R] value to specify the number of +requests to run in parallel. +.PP +In tests, these batch requests were up to 20x faster than the regular +method. +Running the following command against different sized folders gives: +.IP +.nf +\f[C] +rclone lsjson \-vv \-R \-\-checkers=6 gdrive:folder +\f[R] +.fi +.PP +small folder (220 directories, 700 files): +.IP \[bu] 2 +without \f[C]\-\-fast\-list\f[R]: 38s +.IP \[bu] 2 +with \f[C]\-\-fast\-list\f[R]: 10s +.PP +large folder (10600 directories, 39000 files): +.IP \[bu] 2 +without \f[C]\-\-fast\-list\f[R]: 22:05 min +.IP \[bu] 2 +with \f[C]\-\-fast\-list\f[R]: 58s +.SS Modified time +.PP +Google drive stores modification times accurate to 1 ms. +.SS Restricted filename characters +.PP +Only Invalid UTF\-8 bytes will be +replaced (https://rclone.org/overview/#invalid-utf8), as they can\[aq]t +be used in JSON strings. +.PP +In contrast to other backends, \f[C]/\f[R] can also be used in names and +\f[C].\f[R] or \f[C]..\f[R] are valid names. +.SS Revisions +.PP +Google drive stores revisions of files. +When you upload a change to an existing file to google drive using +rclone it will create a new revision of that file. +.PP +Revisions follow the standard google policy which at time of writing was +.IP \[bu] 2 +They are deleted after 30 days or 100 revisions (whatever comes first). +.IP \[bu] 2 +They do not count towards a user storage quota. +.SS Deleting files +.PP +By default rclone will send all files to the trash when deleting files. +If deleting them permanently is required then use the +\f[C]\-\-drive\-use\-trash=false\f[R] flag, or set the equivalent +environment variable. +.SS Shortcuts +.PP +In March 2020 Google introduced a new feature in Google Drive called +drive shortcuts (https://support.google.com/drive/answer/9700156) +(API (https://developers.google.com/drive/api/v3/shortcuts)). +These will (by September 2020) replace the ability for files or folders +to be in multiple folders at +once (https://cloud.google.com/blog/products/g-suite/simplifying-google-drives-folder-structure-and-sharing-models). +.PP +Shortcuts are files that link to other files on Google Drive somewhat +like a symlink in unix, except they point to the underlying file data +(e.g. +the inode in unix terms) so they don\[aq]t break if the source is +renamed or moved about. +.PP +Be default rclone treats these as follows. +.PP +For shortcuts pointing to files: +.IP \[bu] 2 +When listing a file shortcut appears as the destination file. +.IP \[bu] 2 +When downloading the contents of the destination file is downloaded. +.IP \[bu] 2 +When updating shortcut file with a non shortcut file, the shortcut is +removed then a new file is uploaded in place of the shortcut. +.IP \[bu] 2 +When server\-side moving (renaming) the shortcut is renamed, not the +destination file. +.IP \[bu] 2 +When server\-side copying the shortcut is copied, not the contents of +the shortcut. +.IP \[bu] 2 +When deleting the shortcut is deleted not the linked file. +.IP \[bu] 2 +When setting the modification time, the modification time of the linked +file will be set. +.PP +For shortcuts pointing to folders: +.IP \[bu] 2 +When listing the shortcut appears as a folder and that folder will +contain the contents of the linked folder appear (including any sub +folders) +.IP \[bu] 2 +When downloading the contents of the linked folder and sub contents are +downloaded +.IP \[bu] 2 +When uploading to a shortcut folder the file will be placed in the +linked folder +.IP \[bu] 2 +When server\-side moving (renaming) the shortcut is renamed, not the +destination folder +.IP \[bu] 2 +When server\-side copying the contents of the linked folder is copied, +not the shortcut. +.IP \[bu] 2 +When deleting with \f[C]rclone rmdir\f[R] or \f[C]rclone purge\f[R] the +shortcut is deleted not the linked folder. +.IP \[bu] 2 +\f[B]NB\f[R] When deleting with \f[C]rclone remove\f[R] or +\f[C]rclone mount\f[R] the contents of the linked folder will be +deleted. +.PP +The rclone backend (https://rclone.org/commands/rclone_backend/) command +can be used to create shortcuts. +.PP +Shortcuts can be completely ignored with the +\f[C]\-\-drive\-skip\-shortcuts\f[R] flag or the corresponding +\f[C]skip_shortcuts\f[R] configuration setting. +.SS Emptying trash +.PP +If you wish to empty your trash you can use the +\f[C]rclone cleanup remote:\f[R] command which will permanently delete +all your trashed files. +This command does not take any path arguments. +.PP +Note that Google Drive takes some time (minutes to days) to empty the +trash even though the command returns within a few seconds. +No output is echoed, so there will be no confirmation even using \-v or +\-vv. +.SS Quota information +.PP +To view your current quota you can use the +\f[C]rclone about remote:\f[R] command which will display your usage +limit (quota), the usage in Google Drive, the size of all files in the +Trash and the space used by other Google services such as Gmail. +This command does not take any path arguments. +.SS Import/Export of google documents +.PP +Google documents can be exported from and uploaded to Google Drive. +.PP +When rclone downloads a Google doc it chooses a format to download +depending upon the \f[C]\-\-drive\-export\-formats\f[R] setting. +By default the export formats are \f[C]docx,xlsx,pptx,svg\f[R] which are +a sensible default for an editable document. +.PP +When choosing a format, rclone runs down the list provided in order and +chooses the first file format the doc can be exported as from the list. +If the file can\[aq]t be exported to a format on the formats list, then +rclone will choose a format from the default list. +.PP +If you prefer an archive copy then you might use +\f[C]\-\-drive\-export\-formats pdf\f[R], or if you prefer +openoffice/libreoffice formats you might use +\f[C]\-\-drive\-export\-formats ods,odt,odp\f[R]. +.PP +Note that rclone adds the extension to the google doc, so if it is +called \f[C]My Spreadsheet\f[R] on google docs, it will be exported as +\f[C]My Spreadsheet.xlsx\f[R] or \f[C]My Spreadsheet.pdf\f[R] etc. +.PP +When importing files into Google Drive, rclone will convert all files +with an extension in \f[C]\-\-drive\-import\-formats\f[R] to their +associated document type. +rclone will not convert any files by default, since the conversion is +lossy process. +.PP +The conversion must result in a file with the same extension when the +\f[C]\-\-drive\-export\-formats\f[R] rules are applied to the uploaded +document. +.PP +Here are some examples for allowed and prohibited conversions. +.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{ +Yes +T} +T{ +odt +T}@T{ +docx,odt +T}@T{ +odt +T}@T{ +odt +T}@T{ +Yes +T} +T{ +T}@T{ +docx +T}@T{ +docx +T}@T{ +docx +T}@T{ +Yes +T} +T{ +T}@T{ +odt +T}@T{ +odt +T}@T{ +docx +T}@T{ +No +T} +T{ +odt,docx +T}@T{ +docx,odt +T}@T{ +docx +T}@T{ +odt +T}@T{ +No +T} +T{ +docx,odt +T}@T{ +docx,odt +T}@T{ +docx +T}@T{ +docx +T}@T{ +Yes +T} +T{ +docx,odt +T}@T{ +docx,odt +T}@T{ +odt +T}@T{ +docx +T}@T{ +No +T} +.TE +.PP +This limitation can be disabled by specifying +\f[C]\-\-drive\-allow\-import\-name\-change\f[R]. +When using this flag, rclone can convert multiple files types resulting +in the same document type at once, e.g. +with \f[C]\-\-drive\-import\-formats docx,odt,txt\f[R], all files having +these extension would result in a document represented as a docx file. +This brings the additional risk of overwriting a document, if multiple +files have the same stem. +Many rclone operations will not handle this name change in any way. +They assume an equal name when copying files and might copy the file +again or delete them when the name changes. +.PP +Here are the possible export extensions with their corresponding mime +types. +Most of these can also be used for importing, but there more that are +not listed here. +Some of these additional ones might only be available when the operating +system provides the correct MIME type entries. +.PP +This list can be changed by Google Drive at any time and might not +represent the currently available conversions. +.PP +.TS +tab(@); +lw(19.7n) lw(24.1n) lw(26.2n). +T{ +Extension +T}@T{ +Mime Type +T}@T{ +Description +T} +_ +T{ +csv +T}@T{ +text/csv +T}@T{ +Standard CSV format for Spreadsheets +T} +T{ +docx +T}@T{ +application/vnd.openxmlformats\-officedocument.wordprocessingml.document +T}@T{ +Microsoft Office Document +T} +T{ +epub +T}@T{ +application/epub+zip +T}@T{ +E\-book format +T} +T{ +html +T}@T{ +text/html +T}@T{ +An HTML Document +T} +T{ +jpg +T}@T{ +image/jpeg +T}@T{ +A JPEG Image File +T} +T{ +json +T}@T{ +application/vnd.google\-apps.script+json +T}@T{ +JSON Text Format +T} +T{ +odp +T}@T{ +application/vnd.oasis.opendocument.presentation +T}@T{ +Openoffice Presentation +T} +T{ +ods +T}@T{ +application/vnd.oasis.opendocument.spreadsheet +T}@T{ +Openoffice Spreadsheet +T} +T{ +ods +T}@T{ +application/x\-vnd.oasis.opendocument.spreadsheet +T}@T{ +Openoffice Spreadsheet +T} +T{ +odt +T}@T{ +application/vnd.oasis.opendocument.text +T}@T{ +Openoffice Document +T} +T{ +pdf +T}@T{ +application/pdf +T}@T{ +Adobe PDF Format +T} +T{ +png +T}@T{ +image/png +T}@T{ +PNG Image Format +T} +T{ +pptx +T}@T{ +application/vnd.openxmlformats\-officedocument.presentationml.presentation +T}@T{ +Microsoft Office Powerpoint +T} +T{ +rtf +T}@T{ +application/rtf +T}@T{ +Rich Text Format +T} +T{ +svg +T}@T{ +image/svg+xml +T}@T{ +Scalable Vector Graphics Format +T} +T{ +tsv +T}@T{ +text/tab\-separated\-values +T}@T{ +Standard TSV format for spreadsheets +T} +T{ +txt +T}@T{ +text/plain +T}@T{ +Plain Text +T} +T{ +xlsx +T}@T{ +application/vnd.openxmlformats\-officedocument.spreadsheetml.sheet +T}@T{ +Microsoft Office Spreadsheet +T} +T{ +zip +T}@T{ +application/zip +T}@T{ +A ZIP file of HTML, Images CSS +T} +.TE +.PP +Google documents can also be exported as link files. +These files will open a browser window for the Google Docs website of +that document when opened. +The link file extension has to be specified as a +\f[C]\-\-drive\-export\-formats\f[R] parameter. +They will match all available Google Documents. +.PP +.TS +tab(@); +l l l. +T{ +Extension +T}@T{ +Description +T}@T{ +OS Support +T} +_ +T{ +desktop +T}@T{ +freedesktop.org specified desktop entry +T}@T{ +Linux +T} +T{ +link.html +T}@T{ +An HTML Document with a redirect +T}@T{ +All +T} +T{ +url +T}@T{ +INI style link file +T}@T{ +macOS, Windows +T} +T{ +webloc +T}@T{ +macOS specific XML format +T}@T{ +macOS +T} +.TE +.SS Standard Options +.PP +Here are the standard options specific to drive (Google Drive). +.SS \-\-drive\-client\-id +.PP +Google Application Client Id Setting your own is recommended. +See https://rclone.org/drive/#making\-your\-own\-client\-id for how to +create your own. +If you leave this blank, it will use an internal key which is low +performance. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-client\-secret +.PP +OAuth Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-scope +.PP +Scope that rclone should use when requesting access from drive. +.IP \[bu] 2 +Config: scope +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SCOPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]drive\[dq] +.RS 2 +.IP \[bu] 2 +Full access all files, excluding Application Data Folder. +.RE +.IP \[bu] 2 +\[dq]drive.readonly\[dq] +.RS 2 +.IP \[bu] 2 +Read\-only access to file metadata and file contents. +.RE +.IP \[bu] 2 +\[dq]drive.file\[dq] +.RS 2 +.IP \[bu] 2 +Access to files created by rclone only. +.IP \[bu] 2 +These are visible in the drive website. +.IP \[bu] 2 +File authorization is revoked when the user deauthorizes the app. +.RE +.IP \[bu] 2 +\[dq]drive.appfolder\[dq] +.RS 2 +.IP \[bu] 2 +Allows read and write access to the Application Data folder. +.IP \[bu] 2 +This is not visible in the drive website. +.RE +.IP \[bu] 2 +\[dq]drive.metadata.readonly\[dq] +.RS 2 +.IP \[bu] 2 +Allows read\-only access to file metadata but +.IP \[bu] 2 +does not allow any access to read or download file content. +.RE +.RE +.SS \-\-drive\-root\-folder\-id +.PP +ID of the root folder Leave blank normally. +.PP +Fill in to access \[dq]Computers\[dq] folders (see docs), or for rclone +to use a non root folder as its starting point. +.IP \[bu] 2 +Config: root_folder_id +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-service\-account\-file +.PP +Service Account Credentials JSON file path Leave blank normally. +Needed only if you want use SA instead of interactive login. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: service_account_file +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-alternate\-export +.PP +Deprecated: no longer needed +.IP \[bu] 2 +Config: alternate_export +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to drive (Google Drive). +.SS \-\-drive\-token +.PP +OAuth Access Token as a JSON blob. +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-auth\-url +.PP +Auth server URL. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-token\-url +.PP +Token server url. +Leave blank to use the provider defaults. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-service\-account\-credentials +.PP +Service Account Credentials JSON blob Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_credentials +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-team\-drive +.PP +ID of the Team Drive +.IP \[bu] 2 +Config: team_drive +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TEAM_DRIVE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-auth\-owner\-only +.PP +Only consider files owned by the authenticated user. +.IP \[bu] 2 +Config: auth_owner_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-use\-trash +.PP +Send files to the trash instead of deleting permanently. +Defaults to true, namely sending files to the trash. +Use \f[C]\-\-drive\-use\-trash=false\f[R] to delete files permanently +instead. +.IP \[bu] 2 +Config: use_trash +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_TRASH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.SS \-\-drive\-skip\-gdocs +.PP +Skip google documents in all listings. +If given, gdocs practically become invisible to rclone. +.IP \[bu] 2 +Config: skip_gdocs +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_GDOCS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-skip\-checksum\-gphotos +.PP +Skip MD5 checksum on Google photos and videos only. +.PP +Use this if you get checksum errors when transferring Google photos or +videos. +.PP +Setting this flag will cause Google photos and videos to return a blank +MD5 checksum. +.PP +Google photos are identified by being in the \[dq]photos\[dq] space. +.PP +Corrupted checksums are caused by Google modifying the image/video but +not updating the checksum. +.IP \[bu] 2 +Config: skip_checksum_gphotos +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-shared\-with\-me +.PP +Only show files that are shared with me. +.PP +Instructs rclone to operate on your \[dq]Shared with me\[dq] folder +(where Google Drive lets you access the files and folders others have +shared with you). +.PP +This works both with the \[dq]list\[dq] (lsd, lsl, etc.) and the +\[dq]copy\[dq] commands (copy, sync, etc.), and with all other commands +too. +.IP \[bu] 2 +Config: shared_with_me +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SHARED_WITH_ME +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-trashed\-only +.PP +Only show files that are in the trash. +This will show trashed files in their original directory structure. +.IP \[bu] 2 +Config: trashed_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TRASHED_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-starred\-only +.PP +Only show files that are starred. +.IP \[bu] 2 +Config: starred_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_STARRED_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-formats +.PP +Deprecated: see export_formats +.IP \[bu] 2 +Config: formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-export\-formats +.PP +Comma separated list of preferred formats for downloading Google docs. +.IP \[bu] 2 +Config: export_formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_EXPORT_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]docx,xlsx,pptx,svg\[dq] +.SS \-\-drive\-import\-formats +.PP +Comma separated list of preferred formats for uploading Google docs. +.IP \[bu] 2 +Config: import_formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_IMPORT_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-allow\-import\-name\-change +.PP +Allow the filetype to change when uploading Google docs (e.g. +file.doc to file.docx). +This will confuse sync and reupload every time. +.IP \[bu] 2 +Config: allow_import_name_change +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-use\-created\-date +.PP +Use file created date instead of modified date., +.PP +Useful when downloading data and you want the creation date used in +place of the last modified date. +.PP +\f[B]WARNING\f[R]: This flag may have some unexpected consequences. +.PP +When uploading to your drive all files will be overwritten unless they +haven\[aq]t been modified since their creation. +And the inverse will occur while downloading. +This side effect can be avoided by using the \[dq]\-\-checksum\[dq] +flag. +.PP +This feature was implemented to retain photos capture date as recorded +by google photos. +You will first need to check the \[dq]Create a Google Photos folder\[dq] +option in your google drive settings. +You can then copy or move the photos locally and use the date the image +was taken (created) set as the modification date. +.IP \[bu] 2 +Config: use_created_date +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_CREATED_DATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-use\-shared\-date +.PP +Use date file was shared instead of modified date. +.PP +Note that, as with \[dq]\-\-drive\-use\-created\-date\[dq], this flag +may have unexpected consequences when uploading/downloading files. +.PP +If both this flag and \[dq]\-\-drive\-use\-created\-date\[dq] are set, +the created date is used. +.IP \[bu] 2 +Config: use_shared_date +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_SHARED_DATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-list\-chunk +.PP +Size of listing chunk 100\-1000. +0 to disable. +.IP \[bu] 2 +Config: list_chunk +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_LIST_CHUNK +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1000 +.SS \-\-drive\-impersonate +.PP +Impersonate this user when using a service account. +.IP \[bu] 2 +Config: impersonate +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_IMPERSONATE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-drive\-upload\-cutoff +.PP +Cutoff for switching to chunked upload +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 8M +.SS \-\-drive\-chunk\-size +.PP +Upload chunk size. +Must a power of 2 >= 256k. +.PP +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. +.PP +Reducing this will reduce memory usage but decrease performance. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 8M +.SS \-\-drive\-acknowledge\-abuse +.PP +Set to allow files which return cannotDownloadAbusiveFile to be +downloaded. +.PP +If downloading a file returns the error \[dq]This file has been +identified as malware or spam and cannot be downloaded\[dq] with the +error code \[dq]cannotDownloadAbusiveFile\[dq] then supply this flag to +rclone to indicate you acknowledge the risks of downloading the file and +rclone will download it anyway. +.IP \[bu] 2 +Config: acknowledge_abuse +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-keep\-revision\-forever +.PP +Keep new head revision of each file forever. +.IP \[bu] 2 +Config: keep_revision_forever +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-size\-as\-quota +.PP +Show sizes as storage quota usage, not actual size. +.PP +Show the size of a file as the storage quota used. +This is the current version plus any older versions that have been set +to keep forever. +.PP +\f[B]WARNING\f[R]: This flag may have some unexpected consequences. +.PP +It is not recommended to set this flag in your config \- the recommended +usage is using the flag form \-\-drive\-size\-as\-quota when doing +rclone ls/lsl/lsf/lsjson/etc only. +.PP +If you do use this flag for syncing (not recommended) then you will need +to use \-\-ignore size also. +.IP \[bu] 2 +Config: size_as_quota +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-v2\-download\-min\-size +.PP +If Object\[aq]s are greater, use drive v2 API to download. +.IP \[bu] 2 +Config: v2_download_min_size +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: off +.SS \-\-drive\-pacer\-min\-sleep +.PP +Minimum time to sleep between API calls. +.IP \[bu] 2 +Config: pacer_min_sleep +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 100ms +.SS \-\-drive\-pacer\-burst +.PP +Number of API calls to allow without sleeping. +.IP \[bu] 2 +Config: pacer_burst +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_PACER_BURST +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 100 +.SS \-\-drive\-server\-side\-across\-configs +.PP +Allow server\-side operations (e.g. +copy) to work across different drive configs. +.PP +This can be useful if you wish to do a server\-side copy between two +different Google drives. +Note that this isn\[aq]t enabled by default because it isn\[aq]t easy to +tell if it will work between any two configurations. +.IP \[bu] 2 +Config: server_side_across_configs +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-disable\-http2 +.PP +Disable drive using http2 +.PP +There is currently an unsolved issue with the google drive backend and +HTTP/2. +HTTP/2 is therefore disabled by default for the drive backend but can be +re\-enabled here. +When the issue is solved this flag will be removed. +.PP +See: https://github.com/rclone/rclone/issues/3631 +.IP \[bu] 2 +Config: disable_http2 +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_DISABLE_HTTP2 +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.SS \-\-drive\-stop\-on\-upload\-limit +.PP +Make upload limit errors be fatal +.PP +At the time of writing it is only possible to upload 750GB of data to +Google Drive a day (this is an undocumented limit). +When this limit is reached Google Drive produces a slightly different +error message. +When this flag is set it causes these errors to be fatal. +These will stop the in\-progress sync. +.PP +Note that this detection is relying on error message strings which +Google don\[aq]t document so it may break in the future. +.PP +See: https://github.com/rclone/rclone/issues/3857 +.IP \[bu] 2 +Config: stop_on_upload_limit +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_STOP_ON_UPLOAD_LIMIT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-stop\-on\-download\-limit +.PP +Make download limit errors be fatal +.PP +At the time of writing it is only possible to download 10TB of data from +Google Drive a day (this is an undocumented limit). +When this limit is reached Google Drive produces a slightly different +error message. +When this flag is set it causes these errors to be fatal. +These will stop the in\-progress sync. +.PP +Note that this detection is relying on error message strings which +Google don\[aq]t document so it may break in the future. +.IP \[bu] 2 +Config: stop_on_download_limit +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_STOP_ON_DOWNLOAD_LIMIT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-skip\-shortcuts +.PP +If set skip shortcut files +.PP +Normally rclone dereferences shortcut files making them appear as if +they are the original file (see the shortcuts section). +If this flag is set then rclone will ignore shortcut files completely. +.IP \[bu] 2 +Config: skip_shortcuts +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_SHORTCUTS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-drive\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: InvalidUtf8 +.SS Backend commands +.PP +Here are the commands specific to the drive backend. +.PP +Run them with +.IP +.nf +\f[C] +rclone backend COMMAND remote: +\f[R] +.fi +.PP +The help below will explain what arguments each command takes. +.PP +See the \[dq]rclone backend\[dq] +command (https://rclone.org/commands/rclone_backend/) for more info on +how to pass options and arguments. +.PP +These can be run on a running backend using the rc command +backend/command (https://rclone.org/rc/#backend/command). +.SS get +.PP +Get command for fetching the drive config parameters +.IP +.nf +\f[C] +rclone backend get remote: [options] [+] +\f[R] +.fi +.PP +This is a get command which will be used to fetch the various drive +config parameters +.PP +Usage Examples: +.IP +.nf +\f[C] +rclone backend get drive: [\-o service_account_file] [\-o chunk_size] +rclone rc backend/command command=get fs=drive: [\-o service_account_file] [\-o chunk_size] +\f[R] +.fi +.PP +Options: +.IP \[bu] 2 +\[dq]chunk_size\[dq]: show the current upload chunk size +.IP \[bu] 2 +\[dq]service_account_file\[dq]: show the current service account file +.SS set +.PP +Set command for updating the drive config parameters +.IP +.nf +\f[C] +rclone backend set remote: [options] [+] +\f[R] +.fi +.PP +This is a set command which will be used to update the various drive +config parameters +.PP +Usage Examples: +.IP +.nf +\f[C] +rclone backend set drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] +rclone rc backend/command command=set fs=drive: [\-o service_account_file=sa.json] [\-o chunk_size=67108864] +\f[R] +.fi +.PP +Options: +.IP \[bu] 2 +\[dq]chunk_size\[dq]: update the current upload chunk size +.IP \[bu] 2 +\[dq]service_account_file\[dq]: update the current service account file +.SS shortcut +.PP +Create shortcuts from files or directories +.IP +.nf +\f[C] +rclone backend shortcut remote: [options] [+] +\f[R] +.fi +.PP +This command creates shortcuts from files or directories. +.PP +Usage: +.IP +.nf +\f[C] +rclone backend shortcut drive: source_item destination_shortcut +rclone backend shortcut drive: source_item \-o target=drive2: destination_shortcut +\f[R] +.fi +.PP +In the first example this creates a shortcut from the +\[dq]source_item\[dq] which can be a file or a directory to the +\[dq]destination_shortcut\[dq]. +The \[dq]source_item\[dq] and the \[dq]destination_shortcut\[dq] should +be relative paths from \[dq]drive:\[dq] +.PP +In the second example this creates a shortcut from the +\[dq]source_item\[dq] relative to \[dq]drive:\[dq] to the +\[dq]destination_shortcut\[dq] relative to \[dq]drive2:\[dq]. +This may fail with a permission error if the user authenticated with +\[dq]drive2:\[dq] can\[aq]t read files from \[dq]drive:\[dq]. +.PP +Options: +.IP \[bu] 2 +\[dq]target\[dq]: optional target remote for the shortcut destination +.SS drives +.PP +List the shared drives available to this account +.IP +.nf +\f[C] +rclone backend drives remote: [options] [+] +\f[R] +.fi +.PP +This command lists the shared drives (teamdrives) available to this +account. +.PP +Usage: +.IP +.nf +\f[C] +rclone backend drives drive: +\f[R] +.fi +.PP +This will return a JSON list of objects like this +.IP +.nf +\f[C] +[ + { + \[dq]id\[dq]: \[dq]0ABCDEF\-01234567890\[dq], + \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], + \[dq]name\[dq]: \[dq]My Drive\[dq] + }, + { + \[dq]id\[dq]: \[dq]0ABCDEFabcdefghijkl\[dq], + \[dq]kind\[dq]: \[dq]drive#teamDrive\[dq], + \[dq]name\[dq]: \[dq]Test Drive\[dq] + } +] +\f[R] +.fi +.SS untrash +.PP +Untrash files and directories +.IP +.nf +\f[C] +rclone backend untrash remote: [options] [+] +\f[R] +.fi +.PP +This command untrashes all the files and directories in the directory +passed in recursively. +.PP +Usage: +.PP +This takes an optional directory to trash which make this easier to use +via the API. +.IP +.nf +\f[C] +rclone backend untrash drive:directory +rclone backend \-i untrash drive:directory subdir +\f[R] +.fi +.PP +Use the \-i flag to see what would be restored before restoring it. +.PP +Result: +.IP +.nf +\f[C] +{ + \[dq]Untrashed\[dq]: 17, + \[dq]Errors\[dq]: 0 +} +\f[R] +.fi +.SS copyid +.PP +Copy files by ID +.IP +.nf +\f[C] +rclone backend copyid remote: [options] [+] +\f[R] +.fi +.PP +This command copies files by ID +.PP +Usage: +.IP +.nf +\f[C] +rclone backend copyid drive: ID path +rclone backend copyid drive: ID1 path1 ID2 path2 +\f[R] +.fi +.PP +It copies the drive file with ID given to the path (an rclone path which +will be passed internally to rclone copyto). +The ID and path pairs can be repeated. +.PP +The path should end with a / to indicate copy the file as named to this +directory. +If it doesn\[aq]t end with a / then the last path component will be used +as the file name. +.PP +If the destination is a drive backend then server\-side copying will be +attempted if possible. +.PP +Use the \-i flag to see what would be copied before copying. +.SS Limitations +.PP +Drive has quite a lot of rate limiting. +This causes rclone to be limited to transferring about 2 files per +second only. +Individual files may be transferred much faster at 100s of MBytes/s but +lots of small files can take a long time. +.PP +Server side copies are also subject to a separate rate limit. +If you see User rate limit exceeded errors, wait at least 24 hours and +retry. +You can disable server\-side copies with \f[C]\-\-disable copy\f[R] to +download and upload the files if you prefer. +.SS Limitations of Google Docs +.PP +Google docs will appear as size \-1 in \f[C]rclone ls\f[R] and as size 0 +in anything which uses the VFS layer, e.g. +\f[C]rclone mount\f[R], \f[C]rclone serve\f[R]. +.PP +This is because rclone can\[aq]t find out the size of the Google docs +without downloading them. +.PP +Google docs will transfer correctly with \f[C]rclone sync\f[R], +\f[C]rclone copy\f[R] etc as rclone knows to ignore the size when doing +the transfer. +.PP +However an unfortunate consequence of this is that you may not be able +to download Google docs using \f[C]rclone mount\f[R]. +If it doesn\[aq]t work you will get a 0 sized file. +If you try again the doc may gain its correct size and be downloadable. +Whether it will work on not depends on the application accessing the +mount and the OS you are running \- experiment to find out if it does +work for you! +.SS Duplicated files +.PP +Sometimes, for no reason I\[aq]ve been able to track down, drive will +duplicate a file that rclone uploads. +Drive unlike all the other remotes can have duplicated files. +.PP +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. +.PP +Use \f[C]rclone dedupe\f[R] to fix duplicated files. +.PP +Note that this isn\[aq]t just a problem with rclone, even Google Photos +on Android duplicates files on drive sometimes. +.SS Rclone appears to be re\-copying files it shouldn\[aq]t +.PP +The most likely cause of this is the duplicated file issue above \- run +\f[C]rclone dedupe\f[R] and check your logs for duplicate object or +directory messages. +.PP +This can also be caused by a delay/caching on google drive\[aq]s end +when comparing directory listings. +Specifically with team drives used in combination with \-\-fast\-list. +Files that were uploaded recently may not appear on the directory list +sent to rclone when using \-\-fast\-list. +.PP +Waiting a moderate period of time between attempts (estimated to be +approximately 1 hour) and/or not using \-\-fast\-list both seem to be +effective in preventing the problem. +.SS Making your own client_id +.PP +When you use rclone with Google drive in its default configuration you +are using rclone\[aq]s client_id. +This is shared between all the rclone users. +There is a global rate limit on the number of queries per second that +each client_id can do set by Google. +rclone already has a high quota and I will continue to make sure it is +high enough by contacting Google. +.PP +It is strongly recommended to use your own client ID as the default +rclone ID is heavily used. +If you have multiple services running, it is recommended to use an API +key for each service. +The default Google quota is 10 transactions per second so it is +recommended to stay under that number as if you use more than that, it +will cause rclone to rate limit and make things slower. +.PP +Here is how to create your own Google Drive client ID for rclone: +.IP "1." 3 +Log into the Google API Console (https://console.developers.google.com/) +with your Google account. +It doesn\[aq]t matter what Google account you use. +(It need not be the same account as the Google Drive you want to access) +.IP "2." 3 +Select a project or create a new project. +.IP "3." 3 +Under \[dq]ENABLE APIS AND SERVICES\[dq] search for \[dq]Drive\[dq], and +enable the \[dq]Google Drive API\[dq]. +.IP "4." 3 +Click \[dq]Credentials\[dq] in the left\-side panel (not \[dq]Create +credentials\[dq], which opens the wizard), then \[dq]Create +credentials\[dq] +.IP "5." 3 +If you already configured an \[dq]Oauth Consent Screen\[dq], then skip +to the next step; if not, click on \[dq]CONFIGURE CONSENT SCREEN\[dq] +button (near the top right corner of the right panel), then select +\[dq]External\[dq] and click on \[dq]CREATE\[dq]; on the next screen, +enter an \[dq]Application name\[dq] (\[dq]rclone\[dq] is OK) then click +on \[dq]Save\[dq] (all other data is optional). +Click again on \[dq]Credentials\[dq] on the left panel to go back to the +\[dq]Credentials\[dq] screen. +.PP +(PS: if you are a GSuite user, you could also select \[dq]Internal\[dq] +instead of \[dq]External\[dq] above, but this has not been +tested/documented so far). +.IP "6." 3 +Click on the \[dq]+ CREATE CREDENTIALS\[dq] button at the top of the +screen, then select \[dq]OAuth client ID\[dq]. +.IP "7." 3 +Choose an application type of \[dq]Desktop app\[dq] if you using a +Google account or \[dq]Other\[dq] if you using a GSuite account and +click \[dq]Create\[dq]. +(the default name is fine) +.IP "8." 3 +It will show you a client ID and client secret. +Use these values in rclone config to add a new remote or edit an +existing remote. +.PP +Be aware that, due to the \[dq]enhanced security\[dq] recently +introduced by Google, you are theoretically expected to \[dq]submit your +app for verification\[dq] and then wait a few weeks(!) for their +response; in practice, you can go right ahead and use the client ID and +client secret with rclone, the only issue will be a very scary +confirmation screen shown when you connect via your browser for rclone +to be able to get its token\-id (but as this only happens during the +remote configuration, it\[aq]s not such a big deal). +.PP +(Thanks to \[at]balazer on github for these instructions.) +.PP +Sometimes, creation of an OAuth consent in Google API Console fails due +to an error message \[lq]The request failed because changes to one of +the field of the resource is not supported\[rq]. +As a convenient workaround, the necessary Google Drive API key can be +created on the Python +Quickstart (https://developers.google.com/drive/api/v3/quickstart/python) +page. +Just push the Enable the Drive API button to receive the Client ID and +Secret. +Note that it will automatically create a new project in the API Console. +.SS Google Photos +.PP +The rclone backend for Google +Photos (https://www.google.com/photos/about/) is a specialized backend +for transferring photos and videos to and from Google Photos. +.PP +\f[B]NB\f[R] The Google Photos API which rclone uses has quite a few +limitations, so please read the limitations section carefully to make +sure it is suitable for your use. +.SS Configuring Google Photos +.PP +The initial setup for google cloud storage involves getting a token from +Google Photos which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / Google Photos + \[rs] \[dq]google photos\[dq] +[snip] +Storage> google photos +** See help for google photos backend at: https://rclone.org/googlephotos/ ** + +Google Application Client Id +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +client_id> +Google Application Client Secret +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +client_secret> +Set to make the Google Photos backend read only. + +If you choose read only then rclone will only request read only access +to your photos, otherwise rclone will request full access. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +read_only> +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code + +*** IMPORTANT: All media items uploaded to Google Photos with rclone +*** are stored in full resolution at original quality. These uploads +*** will count towards storage in your Google Account. + +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = google photos +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-06\-28T17:38:04.644930156+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you @@ -20549,43 +27833,46 @@ get back the verification code. This is on \f[C]http://127.0.0.1:53682/\f[R] and this may require you to unblock it temporarily if you are running a host firewall, or use manual mode. -T} -T{ +.PP This remote is called \f[C]remote\f[R] and can now be used like this -T} -T{ +.PP See all the albums in your photos -T} -T{ +.IP +.nf +\f[C] rclone lsd remote:album -T} -T{ +\f[R] +.fi +.PP Make a new album -T} -T{ +.IP +.nf +\f[C] rclone mkdir remote:album/newAlbum -T} -T{ +\f[R] +.fi +.PP List the contents of an album -T} -T{ +.IP +.nf +\f[C] rclone ls remote:album/newAlbum -T} -T{ +\f[R] +.fi +.PP Sync \f[C]/home/local/images\f[R] to the Google Photos, removing any excess files in the album. -T} -T{ +.IP +.nf +\f[C] rclone sync \-i /home/local/image remote:album/newAlbum -T} -T{ -## Layout -T} -T{ +\f[R] +.fi +.SS Layout +.PP As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it. -T} -T{ +.PP The directories under \f[C]media\f[R] show different ways of categorizing the media. Each file will appear multiple times. @@ -20593,20 +27880,65 @@ So if you want to make a backup of your google photos you might choose to backup \f[C]remote:media/by\-month\f[R]. (\f[B]NB\f[R] \f[C]remote:media/by\-day\f[R] is rather slow at the moment so avoid for syncing.) -T} -T{ +.PP Note that all your photos and videos will appear somewhere under \f[C]media\f[R], but they may not appear under \f[C]album\f[R] unless you\[aq]ve put them into albums. -T} -T{ -\f[C]/ \- upload \- file1.jpg \- file2.jpg \- ... \- media \- all \- file1.jpg \- file2.jpg \- ... \- by\-year \- 2000 \- file1.jpg \- ... \- 2001 \- file2.jpg \- ... \- ... \- by\-month \- 2000 \- 2000\-01 \- file1.jpg \- ... \- 2000\-02 \- file2.jpg \- ... \- ... \- by\-day \- 2000 \- 2000\-01\-01 \- file1.jpg \- ... \- 2000\-01\-02 \- file2.jpg \- ... \- ... \- album \- album name \- album name/sub \- shared\-album \- album name \- album name/sub \- feature \- favorites \- file1.jpg \- file2.jpg\f[R] -T} -T{ +.IP +.nf +\f[C] +/ +\- upload + \- file1.jpg + \- file2.jpg + \- ... +\- media + \- all + \- file1.jpg + \- file2.jpg + \- ... + \- by\-year + \- 2000 + \- file1.jpg + \- ... + \- 2001 + \- file2.jpg + \- ... + \- ... + \- by\-month + \- 2000 + \- 2000\-01 + \- file1.jpg + \- ... + \- 2000\-02 + \- file2.jpg + \- ... + \- ... + \- by\-day + \- 2000 + \- 2000\-01\-01 + \- file1.jpg + \- ... + \- 2000\-01\-02 + \- file2.jpg + \- ... + \- ... +\- album + \- album name + \- album name/sub +\- shared\-album + \- album name + \- album name/sub +\- feature + \- favorites + \- file1.jpg + \- file2.jpg +\f[R] +.fi +.PP There are two writable parts of the tree, the \f[C]upload\f[R] directory and sub directories of the \f[C]album\f[R] directory. -T} -T{ +.PP The \f[C]upload\f[R] directory is for uploading files you don\[aq]t want to put into albums. This will be empty to start with and will contain the files you\[aq]ve @@ -20615,93 +27947,108 @@ restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to \f[C]album\f[R] will work better. -T} -T{ +.PP Directories within the \f[C]album\f[R] directory are also writeable and you may create new directories (albums) under \f[C]album\f[R]. If you copy files with a directory hierarchy in there then rclone will create albums with the \f[C]/\f[R] character in them. For example if you do -T} -T{ +.IP +.nf +\f[C] rclone copy /path/to/images remote:album/images -T} -T{ +\f[R] +.fi +.PP and the images directory contains -T} -T{ -\f[C]images \- file1.jpg dir file2.jpg dir2 dir3 file3.jpg\f[R] -T} -T{ +.IP +.nf +\f[C] +images + \- file1.jpg + dir + file2.jpg + dir2 + dir3 + file3.jpg +\f[R] +.fi +.PP Then rclone will create the following albums with the following files in -T} -T{ -\- images \- file1.jpg \- images/dir \- file2.jpg \- images/dir2/dir3 \- +.IP \[bu] 2 +images +.RS 2 +.IP \[bu] 2 +file1.jpg +.RE +.IP \[bu] 2 +images/dir +.RS 2 +.IP \[bu] 2 +file2.jpg +.RE +.IP \[bu] 2 +images/dir2/dir3 +.RS 2 +.IP \[bu] 2 file3.jpg -T} -T{ +.RE +.PP This means that you can use the \f[C]album\f[R] path pretty much like a normal filesystem and it is a good target for repeated syncing. -T} -T{ +.PP The \f[C]shared\-album\f[R] directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface. -T} -T{ -## Limitations -T} -T{ +.SS Limitations +.PP Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn\[aq]t understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item. -T} -T{ +.PP Note that all media items uploaded to Google Photos through the API are stored in full resolution at \[dq]original quality\[dq] and \f[B]will\f[R] count towards your storage quota in your Google Account. The API does \f[B]not\f[R] offer a way to upload in \[dq]high quality\[dq] mode.. -T} -T{ -### Downloading Images -T} -T{ +.PP +\f[C]rclone about\f[R] is not supported by the Google Photos backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) +.SS Downloading Images +.PP When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115 (https://issuetracker.google.com/issues/112096115). -T} -T{ +.PP \f[B]The current google API does not allow photos to be downloaded at original resolution. This is very important if you are, for example, relying on \[dq]Google Photos\[dq] as a backup of your photos. You will not be able to use rclone to redownload original images. You could use \[aq]google takeout\[aq] to recover the original photos as a last resort\f[R] -T} -T{ -### Downloading Videos -T} -T{ +.SS Downloading Videos +.PP When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044 (https://issuetracker.google.com/issues/113672044). -T} -T{ -### Duplicates -T} -T{ +.SS Duplicates +.PP If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called \f[C]file.jpg\f[R] would then appear as \f[C]file {123456}.jpg\f[R] and \f[C]file {ABCDEF}.jpg\f[R] (the actual IDs are a lot longer alas!). -T} -T{ +.PP If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may @@ -20711,185 +28058,493 @@ the same image to \f[C]album/my_album\f[R] the filename of the image in \f[C]album/my_album\f[R] will be what it was uploaded with initially, not what you uploaded it with to \f[C]album\f[R]. In practise this shouldn\[aq]t cause too many problems. -T} -T{ -### Modified time -T} -T{ +.SS Modified time +.PP The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known. -T} -T{ +.PP This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes. -T} -T{ -### Size -T} -T{ +.SS Size +.PP The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check. -T} -T{ +.PP It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is \f[B]very slow\f[R] and uses up a lot of transactions. This can be enabled with the \f[C]\-\-gphotos\-read\-size\f[R] option or the \f[C]read_size = true\f[R] config parameter. -T} -T{ +.PP If you want to use the backend with \f[C]rclone mount\f[R] you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You\[aq]ll need to experiment to see if it works for you without the flag. -T} -T{ -### Albums -T} -T{ +.SS Albums +.PP Rclone can only upload files to albums it created. This is a limitation of the Google Photos API (https://developers.google.com/photos/library/guides/manage-albums). -T} -T{ +.PP Rclone can remove files it uploaded from albums it created only. -T} -T{ -### Deleting files -T} -T{ +.SS Deleting files +.PP Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781 (https://issuetracker.google.com/issues/109759781). -T} -T{ +.PP Rclone cannot delete files anywhere except under \f[C]album\f[R]. -T} -T{ -### Deleting albums -T} -T{ +.SS Deleting albums +.PP The Google Photos API does not support deleting albums \- see bug #135714733 (https://issuetracker.google.com/issues/135714733). -T} -T{ -### Standard Options -T} -T{ +.SS Standard Options +.PP Here are the standard options specific to google photos (Google Photos). -T} -T{ -#### \-\-gphotos\-client\-id -T} -T{ +.SS \-\-gphotos\-client\-id +.PP OAuth Client Id Leave blank normally. -T} -T{ -\- Config: client_id \- Env Var: RCLONE_GPHOTOS_CLIENT_ID \- Type: -string \- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-client\-secret -T} -T{ +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-client\-secret +.PP OAuth Client Secret Leave blank normally. -T} -T{ -\- Config: client_secret \- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET \- -Type: string \- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-read\-only -T} -T{ +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-read\-only +.PP Set to make the Google Photos backend read only. -T} -T{ +.PP If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. -T} -T{ -\- Config: read_only \- Env Var: RCLONE_GPHOTOS_READ_ONLY \- Type: bool -\- Default: false -T} -T{ -### Advanced Options -T} -T{ +.IP \[bu] 2 +Config: read_only +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_READ_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP Here are the advanced options specific to google photos (Google Photos). -T} -T{ -#### \-\-gphotos\-token -T} -T{ +.SS \-\-gphotos\-token +.PP OAuth Access Token as a JSON blob. -T} -T{ -\- Config: token \- Env Var: RCLONE_GPHOTOS_TOKEN \- Type: string \- +.IP \[bu] 2 +Config: token +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-auth\-url -T} -T{ +.SS \-\-gphotos\-auth\-url +.PP Auth server URL. Leave blank to use the provider defaults. -T} -T{ -\- Config: auth_url \- Env Var: RCLONE_GPHOTOS_AUTH_URL \- Type: string -\- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-token\-url -T} -T{ +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-token\-url +.PP Token server url. Leave blank to use the provider defaults. -T} -T{ -\- Config: token_url \- Env Var: RCLONE_GPHOTOS_TOKEN_URL \- Type: -string \- Default: \[dq]\[dq] -T} -T{ -#### \-\-gphotos\-read\-size -T} -T{ +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-gphotos\-read\-size +.PP Set to read the size of media items. -T} -T{ +.PP Normally rclone does not read the size of media items since this takes another transaction. This isn\[aq]t necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media. -T} -T{ -\- Config: read_size \- Env Var: RCLONE_GPHOTOS_READ_SIZE \- Type: bool -\- Default: false -T} -T{ -#### \-\-gphotos\-start\-year -T} -T{ +.IP \[bu] 2 +Config: read_size +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_READ_SIZE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \-\-gphotos\-start\-year +.PP Year limits the photos to be downloaded to those which are uploaded after the given year -T} +.IP \[bu] 2 +Config: start_year +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_START_YEAR +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 2000 +.SS \-\-gphotos\-include\-archived +.PP +Also view and download archived media. +.PP +By default rclone does not request archived media. +Thus, when syncing, archived media is not visible in directory listings +or transferred. +.PP +Note that media in albums is always visible and synced, no matter their +archive status. +.PP +With this flag, archived media are always visible in directory listings +and transferred. +.PP +Without this flag, archived media will not be visible in directory +listings and won\[aq]t be transferred. +.IP \[bu] 2 +Config: include_archived +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_INCLUDE_ARCHIVED +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS HDFS +.PP +HDFS (https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html) +is a distributed file\-system, part of the Apache +Hadoop (https://hadoop.apache.org/) framework. +.PP +Paths are specified as \f[C]remote:\f[R] or +\f[C]remote:path/to/dir\f[R]. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[skip] +XX / Hadoop distributed file system + \[rs] \[dq]hdfs\[dq] +[skip] +Storage> hdfs +** See help for hdfs backend at: https://rclone.org/hdfs/ ** + +hadoop name node and port +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Connect to host namenode at port 8020 + \[rs] \[dq]namenode:8020\[dq] +namenode> namenode.hadoop:8020 +hadoop user name +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Connect to hdfs as root + \[rs] \[dq]root\[dq] +username> root +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = hdfs +namenode = namenode.hadoop:8020 +username = root +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: + +Name Type +==== ==== +hadoop hdfs + +e) Edit existing remote +n) New remote +d) Delete remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +e/n/d/r/c/s/q> q +\f[R] +.fi +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP +See all the top level directories +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List the contents of a directory +.IP +.nf +\f[C] +rclone ls remote:directory +\f[R] +.fi +.PP +Sync the remote \f[C]directory\f[R] to \f[C]/home/local/directory\f[R], +deleting any excess files. +.IP +.nf +\f[C] +rclone sync \-i remote:directory /home/local/directory +\f[R] +.fi +.SS Setting up your own HDFS instance for testing +.PP +You may start with a manual +setup (https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/SingleCluster.html) +or use the docker image from the tests: +.PP +If you want to build the docker image +.IP +.nf +\f[C] +git clone https://github.com/rclone/rclone.git +cd rclone/fstest/testserver/images/test\-hdfs +docker build \-\-rm \-t rclone/test\-hdfs . +\f[R] +.fi +.PP +Or you can just use the latest one pushed +.IP +.nf +\f[C] +docker run \-\-rm \-\-name \[dq]rclone\-hdfs\[dq] \-p 127.0.0.1:9866:9866 \-p 127.0.0.1:8020:8020 \-\-hostname \[dq]rclone\-hdfs\[dq] rclone/test\-hdfs +\f[R] +.fi +.PP +\f[B]NB\f[R] it need few seconds to startup. +.PP +For this docker image the remote needs to be configured like this: +.IP +.nf +\f[C] +[remote] +type = hdfs +namenode = 127.0.0.1:8020 +username = root +\f[R] +.fi +.PP +You can stop this image with \f[C]docker kill rclone\-hdfs\f[R] +(\f[B]NB\f[R] it does not use volumes, so all data uploaded will be +lost.) +.SS Modified time +.PP +Time accurate to 1 second is stored. +.SS Checksum +.PP +No checksums are implemented. +.SS Usage information +.PP +You can use the \f[C]rclone about remote:\f[R] command which will +display filesystem size and current usage. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (https://rclone.org/overview/#restricted-characters) the following +characters are also replaced: +.PP +.TS +tab(@); +l c c. T{ -\- Config: start_year \- Env Var: RCLONE_GPHOTOS_START_YEAR \- Type: int -\- Default: 2000 +Character +T}@T{ +Value +T}@T{ +Replacement T} +_ T{ -HTTP +: +T}@T{ +0x3A +T}@T{ +\[uFF1A] T} .TE .PP +Invalid UTF\-8 bytes will also be +replaced (https://rclone.org/overview/#invalid-utf8). +.SS Limitations +.IP \[bu] 2 +No server\-side \f[C]Move\f[R] or \f[C]DirMove\f[R]. +.IP \[bu] 2 +Checksums not implemented. +.SS Standard Options +.PP +Here are the standard options specific to hdfs (Hadoop distributed file +system). +.SS \-\-hdfs\-namenode +.PP +hadoop name node and port +.IP \[bu] 2 +Config: namenode +.IP \[bu] 2 +Env Var: RCLONE_HDFS_NAMENODE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]namenode:8020\[dq] +.RS 2 +.IP \[bu] 2 +Connect to host namenode at port 8020 +.RE +.RE +.SS \-\-hdfs\-username +.PP +hadoop user name +.IP \[bu] 2 +Config: username +.IP \[bu] 2 +Env Var: RCLONE_HDFS_USERNAME +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]root\[dq] +.RS 2 +.IP \[bu] 2 +Connect to hdfs as root +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to hdfs (Hadoop distributed file +system). +.SS \-\-hdfs\-service\-principal\-name +.PP +Kerberos service principal name for the namenode +.PP +Enables KERBEROS authentication. +Specifies the Service Principal Name (/) for the namenode. +.IP \[bu] 2 +Config: service_principal_name +.IP \[bu] 2 +Env Var: RCLONE_HDFS_SERVICE_PRINCIPAL_NAME +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]hdfs/namenode.hadoop.docker\[dq] +.RS 2 +.IP \[bu] 2 +Namenode running as service \[aq]hdfs\[aq] with FQDN +\[aq]namenode.hadoop.docker\[aq]. +.RE +.RE +.SS \-\-hdfs\-data\-transfer\-protection +.PP +Kerberos data transfer protection: authentication|integrity|privacy +.PP +Specifies whether or not authentication, data signature integrity +checks, and wire encryption is required when communicating the the +datanodes. +Possible values are \[aq]authentication\[aq], \[aq]integrity\[aq] and +\[aq]privacy\[aq]. +Used only with KERBEROS enabled. +.IP \[bu] 2 +Config: data_transfer_protection +.IP \[bu] 2 +Env Var: RCLONE_HDFS_DATA_TRANSFER_PROTECTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]privacy\[dq] +.RS 2 +.IP \[bu] 2 +Ensure authentication, integrity and encryption enabled. +.RE +.RE +.SS \-\-hdfs\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_HDFS_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Colon,Del,Ctl,InvalidUtf8,Dot +.SS HTTP +.PP The HTTP remote is a read only remote for reading files of a webserver. The webserver should provide file listings which rclone will read and turn into a remote. @@ -21048,7 +28703,7 @@ Standard CSV encoding (https://godoc.org/encoding/csv) may be used. For example to set a Cookie use \[aq]Cookie,name=value\[aq], or \[aq]\[dq]Cookie\[dq],\[dq]name=value\[dq]\[aq]. .PP -You can set multiple headers, eg +You can set multiple headers, e.g. \[aq]\[dq]Cookie\[dq],\[dq]name=value\[dq],\[dq]Authorization\[dq],\[dq]xxx\[dq]\[aq]. .IP \[bu] 2 Config: headers @@ -21111,12 +28766,22 @@ Env Var: RCLONE_HTTP_NO_HEAD Type: bool .IP \[bu] 2 Default: false +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the HTTP backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) .SS Hubic .PP Paths are specified as \f[C]remote:path\f[R] .PP Paths are specified as \f[C]remote:container\f[R] (or \f[C]remote:\f[R] -for the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:container/path/to/dir\f[R]. .PP The initial setup for Hubic involves getting a token from Hubic which @@ -21318,8 +28983,9 @@ Default: 5G .PP Don\[aq]t chunk files during streaming upload. .PP -When doing streaming uploads (eg using rcat or mount) setting this flag -will cause the swift backend to not upload chunked files. +When doing streaming uploads (e.g. +using rcat or mount) setting this flag will cause the swift backend to +not upload chunked files. .PP This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM. @@ -21367,7 +29033,7 @@ whitelabel versions which should work with this backend. .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Setup .SS Default Setup @@ -21382,10 +29048,19 @@ Note that the web interface may refer to this token as a JottaCli token. .PP If you are using one of the whitelabel versions (Elgiganten, Com Hem Cloud) you may not have the option to generate a CLI token. -In this case you\[aq]ll have to use the legacy authentification. -To to this select yes when the setup asks for legacy authentification -and enter your username and password. +In this case you\[aq]ll have to use the legacy authentication. +To to this select yes when the setup asks for legacy authentication and +enter your username and password. The rest of the setup is identical to the default setup. +.SS Telia Cloud Setup +.PP +Similar to other whitelabel versions Telia Cloud doesn\[aq]t offer the +option of creating a CLI token, and additionally uses a separate +authentication flow where the username is generated internally. +To setup rclone to use Telia Cloud, choose Telia Cloud authentication in +the setup. +The rest of the setup is identical to the default setup. +.SS Example .PP Here is an example of how to make a remote called \f[C]remote\f[R] with the default setup. @@ -21422,7 +29097,7 @@ y) Yes n) No y/n> n Remote config -Use legacy authentification?. +Use legacy authentication?. This is only required for certain whitelabel versions of Jottacloud and not recommended for normal users. y) Yes n) No (default) @@ -21531,6 +29206,12 @@ temporarily on disk (wherever the \f[C]TMPDIR\f[R] environment variable points to) before it is uploaded. Small files will be cached in memory \- see the \-\-jottacloud\-md5\-memory\-limit flag. +When uploading from local disk the source checksum is always available, +so this does not apply. +Starting with rclone version 1.52 the same is true for crypted remotes +(in older versions the crypt backend would not calculate hashes for +uploads from local disk, so the Jottacloud backend had to do it as +described above). .SS Restricted filename characters .PP In addition to the default restricted characters @@ -21710,7 +29391,7 @@ Emptying the trash should help in such cases. .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for Koofr involves creating an application password @@ -21935,7 +29616,7 @@ Currently it is recommended to disable 2FA on Mail.ru accounts intended for rclone until it gets eventually implemented. .SS Features highlights .IP \[bu] 2 -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R] .IP \[bu] 2 Files have a \f[C]last modified time\f[R] property, directories @@ -22212,6 +29893,7 @@ This feature is called \[dq]speedup\[dq] or \[dq]put by hash\[dq]. 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. +It is meaningless and ineffective if source file is unique or encrypted. Please note that rclone may need local memory and disk space to calculate content hash in advance and decide whether full upload is required. @@ -22404,7 +30086,7 @@ 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 +Supported quirks: atomicmkdir binlist unknowndirs .IP \[bu] 2 Config: quirks .IP \[bu] 2 @@ -22441,7 +30123,7 @@ features of Mega using the same client side encryption. .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. @@ -22707,7 +30389,8 @@ Mega allows duplicate files which may confuse rclone. The memory backend is an in RAM backend. It does not persist its data \- use the local backend for that. .PP -The memory backend behaves like a bucket based remote (eg like s3). +The memory backend behaves like a bucket based remote (e.g. +like s3). Because it has no parameters you can just use it with the \f[C]:memory:\f[R] remote name. .PP @@ -22746,7 +30429,7 @@ y/e/d> y .fi .PP Because the memory backend isn\[aq]t persistent it is most useful for -testing or with an rclone server or rclone mount, eg +testing or with an rclone server or rclone mount, e.g. .IP .nf \f[C] @@ -22766,7 +30449,7 @@ set (https://rclone.org/overview/#restricted-characters). .SS Microsoft Azure Blob Storage .PP Paths are specified as \f[C]remote:container\f[R] (or \f[C]remote:\f[R] -for the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:container/path/to/dir\f[R]. .PP Here is an example of making a Microsoft Azure Blob Storage @@ -22925,7 +30608,8 @@ be used in JSON strings. .PP 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. +source remote was capable of MD5 hashes, e.g. +the local disk. .SS Authenticating with Azure Blob Storage .PP Rclone has 3 ways of authenticating with Azure Blob Storage: @@ -22947,7 +30631,7 @@ To get a container level SAS URL right click on a container in the Azure Blob explorer in the Azure portal. .PP If you use a container level SAS URL, rclone operations are permitted -only on a particular container, eg +only on a particular container, e.g. .IP .nf \f[C] @@ -22977,28 +30661,6 @@ rclone ls azureblob:othercontainer Container level SAS URLs are useful for temporarily allowing third parties access to a single container or putting credentials into an untrusted environment such as a CI build server. -.SS Multipart uploads -.PP -Rclone supports multipart uploads with Azure Blob storage. -Files bigger than 256MB will be uploaded using chunked upload by -default. -.PP -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 -\f[C]\-\-transfers\f[R] of them being uploaded at once. -.PP -Files can\[aq]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 -\f[C]\-\-azureblob\-chunk\-size 100M\f[R]. -.PP -Note that rclone doesn\[aq]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\[aq]t allow more than that amount of -uncommitted blocks. .SS Standard Options .PP Here are the standard options specific to azureblob (Microsoft Azure @@ -23014,6 +30676,34 @@ Env Var: RCLONE_AZUREBLOB_ACCOUNT Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS \-\-azureblob\-service\-principal\-file +.PP +Path to file containing credentials for use with a service principal. +.PP +Leave blank normally. +Needed only if you want to use a service principal instead of +interactive login. +.IP +.nf +\f[C] +$ az sp create\-for\-rbac \-\-name \[dq]\[dq] \[rs] + \-\-role \[dq]Storage Blob Data Owner\[dq] \[rs] + \-\-scopes \[dq]/subscriptions//resourceGroups//providers/Microsoft.Storage/storageAccounts//blobServices/default/containers/\[dq] \[rs] + > azure\-principal.json +\f[R] +.fi +.PP +See Use Azure CLI to assign an Azure role for access to blob and queue +data (https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) +for more details. +.IP \[bu] 2 +Config: service_principal_file +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_SERVICE_PRINCIPAL_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] .SS \-\-azureblob\-key .PP Storage Account Key (leave blank to use SAS URL or Emulator) @@ -23037,6 +30727,29 @@ Env Var: RCLONE_AZUREBLOB_SAS_URL Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS \-\-azureblob\-use\-msi +.PP +Use a managed service identity to authenticate (only works in Azure) +.PP +When true, use a managed service +identity (https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) +to authenticate to Azure Storage instead of a SAS token or account key. +.PP +If the VM(SS) on which this program is running has a system\-assigned +identity, it will be used by default. +If the resource has no system\-assigned but exactly one user\-assigned +identity, the user\-assigned identity will be used by default. +If the resource has multiple user\-assigned identities, the identity to +use must be explicitly specified using exactly one of the msi_object_id, +msi_client_id, or msi_mi_res_id parameters. +.IP \[bu] 2 +Config: use_msi +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_USE_MSI +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS \-\-azureblob\-use\-emulator .PP Uses local storage emulator if provided as \[aq]true\[aq] (leave blank @@ -23053,6 +30766,42 @@ Default: false .PP Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage). +.SS \-\-azureblob\-msi\-object\-id +.PP +Object ID of the user\-assigned MSI to use, if any. +Leave blank if msi_client_id or msi_mi_res_id specified. +.IP \[bu] 2 +Config: msi_object_id +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_MSI_OBJECT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-azureblob\-msi\-client\-id +.PP +Object ID of the user\-assigned MSI to use, if any. +Leave blank if msi_object_id or msi_mi_res_id specified. +.IP \[bu] 2 +Config: msi_client_id +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_MSI_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \-\-azureblob\-msi\-mi\-res\-id +.PP +Azure resource ID of the user\-assigned MSI to use, if any. +Leave blank if msi_client_id or msi_object_id specified. +.IP \[bu] 2 +Config: msi_mi_res_id +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_MSI_MI_RES_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] .SS \-\-azureblob\-endpoint .PP Endpoint for the service Leave blank normally. @@ -23067,14 +30816,15 @@ Default: \[dq]\[dq] .SS \-\-azureblob\-upload\-cutoff .PP Cutoff for switching to chunked upload (<= 256MB). +(Deprecated) .IP \[bu] 2 Config: upload_cutoff .IP \[bu] 2 Env Var: RCLONE_AZUREBLOB_UPLOAD_CUTOFF .IP \[bu] 2 -Type: SizeSuffix +Type: string .IP \[bu] 2 -Default: 256M +Default: \[dq]\[dq] .SS \-\-azureblob\-chunk\-size .PP Upload chunk size (<= 100MB). @@ -23136,6 +30886,34 @@ Env Var: RCLONE_AZUREBLOB_ACCESS_TIER Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS \-\-azureblob\-archive\-tier\-delete +.PP +Delete archive tier blobs before overwriting. +.PP +Archive tier blobs cannot be updated. +So without this flag, if you attempt to update an archive tier blob, +then rclone will produce the error: +.IP +.nf +\f[C] +can\[aq]t update archive tier blob without \-\-azureblob\-archive\-tier\-delete +\f[R] +.fi +.PP +With this flag set then before rclone attempts to overwrite an archive +tier blob, it will delete the existing blob before uploading its +replacement. +This has the potential for data loss if the upload fails (unlike +updating a normal blob) and also may cost more since deleting archive +tier blobs early may be chargable. +.IP \[bu] 2 +Config: archive_tier_delete +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_ARCHIVE_TIER_DELETE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS \-\-azureblob\-disable\-checksum .PP Don\[aq]t store MD5 checksum with object metadata. @@ -23197,6 +30975,16 @@ Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 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. +.PP +\f[C]rclone about\f[R] is not supported by the Microsoft Azure Blob +storage backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) .SS Azure Storage Emulator Support .PP You can test rclone with storage emulator locally, to do this make sure @@ -23208,7 +30996,7 @@ provide default account name or key if using emulator. .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for OneDrive involves getting a token from Microsoft @@ -23353,8 +31141,8 @@ and then click \f[C]New registration\f[R]. .IP "2." 3 Enter a name for your app, choose account type \f[C]Accounts in any organizational directory (Any Azure AD directory \- Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)\f[R], -select \f[C]Web\f[R] in \f[C]Redirect URI\f[R] Enter -\f[C]http://localhost:53682/\f[R] and click Register. +select \f[C]Web\f[R] in \f[C]Redirect URI\f[R], then type (do not copy +and paste) \f[C]http://localhost:53682/\f[R] and click Register. Copy and keep the \f[C]Application (client) ID\f[R] under the app name for later use. .IP "3." 3 @@ -23460,20 +31248,6 @@ T}@T{ T}@T{ \[uFF5C] T} -T{ -# -T}@T{ -0x23 -T}@T{ -\[uFF03] -T} -T{ -% -T}@T{ -0x25 -T}@T{ -\[uFF05] -T} .TE .PP File names can also not end with the following characters. @@ -23570,6 +31344,45 @@ Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS \-\-onedrive\-region +.PP +Choose national cloud region for OneDrive. +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_ONEDRIVE_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]global\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]global\[dq] +.RS 2 +.IP \[bu] 2 +Microsoft Cloud Global +.RE +.IP \[bu] 2 +\[dq]us\[dq] +.RS 2 +.IP \[bu] 2 +Microsoft Cloud for US Government +.RE +.IP \[bu] 2 +\[dq]de\[dq] +.RS 2 +.IP \[bu] 2 +Microsoft Cloud Germany +.RE +.IP \[bu] 2 +\[dq]cn\[dq] +.RS 2 +.IP \[bu] 2 +Azure and Office 365 operated by 21Vianet in China +.RE +.RE .SS Advanced Options .PP Here are the advanced options specific to onedrive (Microsoft OneDrive). @@ -23669,13 +31482,14 @@ Type: bool Default: false .SS \-\-onedrive\-server\-side\-across\-configs .PP -Allow server side operations (eg copy) to work across different onedrive -configs. +Allow server\-side operations (e.g. +copy) to work across different onedrive configs. .PP -This can be useful if you wish to do a server side copy between two -different Onedrives. -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. +This will only work if you are copying between two OneDrive +\f[I]Personal\f[R] drives AND the files to copy are already shared +between them. +In other cases, rclone will fall back to normal copy (which will be +slightly slower). .IP \[bu] 2 Config: server_side_across_configs .IP \[bu] 2 @@ -23706,6 +31520,84 @@ Env Var: RCLONE_ONEDRIVE_NO_VERSIONS Type: bool .IP \[bu] 2 Default: false +.SS \-\-onedrive\-link\-scope +.PP +Set the scope of the links created by the link command. +.IP \[bu] 2 +Config: link_scope +.IP \[bu] 2 +Env Var: RCLONE_ONEDRIVE_LINK_SCOPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]anonymous\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]anonymous\[dq] +.RS 2 +.IP \[bu] 2 +Anyone with the link has access, without needing to sign in. +This may include people outside of your organization. +Anonymous link support may be disabled by an administrator. +.RE +.IP \[bu] 2 +\[dq]organization\[dq] +.RS 2 +.IP \[bu] 2 +Anyone signed into your organization (tenant) can use the link to get +access. +Only available in OneDrive for Business and SharePoint. +.RE +.RE +.SS \-\-onedrive\-link\-type +.PP +Set the type of the links created by the link command. +.IP \[bu] 2 +Config: link_type +.IP \[bu] 2 +Env Var: RCLONE_ONEDRIVE_LINK_TYPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]view\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]view\[dq] +.RS 2 +.IP \[bu] 2 +Creates a read\-only link to the item. +.RE +.IP \[bu] 2 +\[dq]edit\[dq] +.RS 2 +.IP \[bu] 2 +Creates a read\-write link to the item. +.RE +.IP \[bu] 2 +\[dq]embed\[dq] +.RS 2 +.IP \[bu] 2 +Creates an embeddable link to the item. +.RE +.RE +.SS \-\-onedrive\-link\-password +.PP +Set the password for links created by the link command. +.PP +At the time of writing this only works with OneDrive personal paid +accounts. +.IP \[bu] 2 +Config: link_password +.IP \[bu] 2 +Env Var: RCLONE_ONEDRIVE_LINK_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] .SS \-\-onedrive\-encoding .PP This sets the encoding for the backend. @@ -23720,7 +31612,7 @@ Env Var: RCLONE_ONEDRIVE_ENCODING Type: MultiEncoder .IP \[bu] 2 Default: -Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot .SS Limitations .PP If you don\[aq]t use rclone for 90 days the refresh token will expire. @@ -23743,9 +31635,9 @@ For example if a file has a \f[C]?\f[R] in it will be mapped to \f[C]\[uFF1F]\f[R] instead. .SS File sizes .PP -The largest allowed file size is 100GB for both OneDrive Personal and -OneDrive for Business (Updated 17 June -2020) (https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize). +The largest allowed file size is 250GB for both OneDrive Personal and +OneDrive for Business (Updated 13 Jan +2021) (https://support.microsoft.com/en-us/office/invalid-file-names-and-file-types-in-onedrive-and-sharepoint-64883a5d-228e-48f5-b3d2-eb39e07630fa?ui=en-us&rs=en-us&ad=us#individualfilesize). .SS Path length .PP The entire path, including the file name, must contain fewer than 400 @@ -23952,7 +31844,7 @@ After this, rclone should work again for this backend. .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP Here is an example of how to make a remote called \f[C]remote\f[R]. @@ -24243,10 +32135,19 @@ Rclone will map these names to and from an identical looking unicode equivalent. For example if a file has a \f[C]?\f[R] in it will be mapped to \f[C]\[uFF1F]\f[R] instead. +.PP +\f[C]rclone about\f[R] is not supported by the OpenDrive backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) .SS QingStor .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for -the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .PP Here is an example of making an QingStor configuration. @@ -24565,7 +32466,7 @@ multipart uploads using this chunk size. Note that \[dq]\-\-qingstor\-upload\-concurrency\[dq] chunks of this size are buffered in memory per transfer. .PP -If you are transferring large files over high speed links and you have +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 @@ -24582,10 +32483,10 @@ Concurrency for multipart uploads. This is the number of chunks of the same file that are uploaded concurrently. .PP -NB if you set this to > 1 then the checksums of multpart uploads become +NB if you set this to > 1 then the checksums of multipart uploads become corrupted (the uploads themselves are not corrupted though). .PP -If you are uploading small numbers of large file over high speed link +If you are uploading small numbers of large files over high\-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers. .IP \[bu] 2 @@ -24610,6 +32511,16 @@ Env Var: RCLONE_QINGSTOR_ENCODING Type: MultiEncoder .IP \[bu] 2 Default: Slash,Ctl,InvalidUtf8 +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the qingstor backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) .SS Swift .PP Swift refers to OpenStack Object @@ -24629,7 +32540,7 @@ IBM Bluemix Cloud ObjectStorage Swift (https://console.bluemix.net/docs/infrastructure/objectstorage-swift/index.html) .PP Paths are specified as \f[C]remote:container\f[R] (or \f[C]remote:\f[R] -for the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +for the \f[C]lsd\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:container/path/to/dir\f[R]. .PP Here is an example of making a swift configuration. @@ -25182,6 +33093,18 @@ OVH Public Cloud Archive .PP Here are the advanced options specific to swift (OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)). +.SS \-\-swift\-leave\-parts\-on\-error +.PP +If true avoid calling abort upload on a failure. +It should be set to true for resuming uploads across different sessions. +.IP \[bu] 2 +Config: leave_parts_on_error +.IP \[bu] 2 +Env Var: RCLONE_SWIFT_LEAVE_PARTS_ON_ERROR +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS \-\-swift\-chunk\-size .PP Above this size files will be chunked into a _segments container. @@ -25200,8 +33123,9 @@ Default: 5G .PP Don\[aq]t chunk files during streaming upload. .PP -When doing streaming uploads (eg using rcat or mount) setting this flag -will cause the swift backend to not upload chunked files. +When doing streaming uploads (e.g. +using rcat or mount) setting this flag will cause the swift backend to +not upload chunked files. .PP This will limit the maximum upload size to 5GB. However non chunked files are easier to deal with and have an MD5SUM. @@ -25286,7 +33210,8 @@ So this most likely means your username / password is wrong. You can investigate further with the \f[C]\-\-dump\-bodies\f[R] flag. .PP This may also be caused by specifying the region when you shouldn\[aq]t -have (eg OVH). +have (e.g. +OVH). .SS Rclone gives Failed to create file system: Response didn\[aq]t have storage url and auth token .PP This is most likely caused by forgetting to specify your tenant when @@ -25295,7 +33220,7 @@ setting up a swift remote. .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for pCloud involves getting a token from pCloud which @@ -25399,8 +33324,11 @@ 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. .PP -pCloud supports MD5 and SHA1 type hashes, so you can use the -\f[C]\-\-checksum\f[R] flag. +pCloud supports MD5 and SHA1 type hashes in the US region but and SHA1 +only in the EU region, so you can use the \f[C]\-\-checksum\f[R] flag. +.PP +(Note that pCloud also support SHA256 in the EU region, but rclone does +not have support for that yet.) .SS Restricted filename characters .PP In addition to the default restricted characters @@ -25579,7 +33507,7 @@ EU region .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for premiumize.me (https://premiumize.me/) involves @@ -25762,7 +33690,7 @@ premiumize.me only supports filenames up to 255 characters in length. .PP Paths are specified as \f[C]remote:path\f[R] .PP -put.io paths may be as deep as required, eg +put.io paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for put.io involves getting a token from put.io which @@ -25928,7 +33856,7 @@ There are two distinct modes you can setup your remote: \- you point your remote to the \f[B]root of the server\f[R], meaning you don\[aq]t specify a library during the configuration: Paths are specified as \f[C]remote:library\f[R]. -You may put subdirectories in too, eg +You may put subdirectories in too, e.g. \f[C]remote:library/path/to/dir\f[R]. \- you point your remote to a specific library during the configuration: Paths are specified as \f[C]remote:path/to/dir\f[R]. @@ -26438,7 +34366,7 @@ Choose a number from below, or type in your own value 1 / Connect to example.com \[rs] \[dq]example.com\[dq] host> example.com -SSH username, leave blank for current username, ncw +SSH username, leave blank for current username, $USER user> sftpuser SSH port, leave blank to use default (22) port> @@ -26505,7 +34433,7 @@ The SFTP remote supports three authentication methods: .IP \[bu] 2 Password .IP \[bu] 2 -Key file +Key file, including certificate signed keys .IP \[bu] 2 ssh\-agent .PP @@ -26543,12 +34471,111 @@ the moment. .PP If you set the \f[C]\-\-sftp\-ask\-password\f[R] option, rclone will prompt for a password when needed and no password has been configured. +.PP +If you have a certificate then you can provide the path to the public +key that contains the certificate. +For example: +.IP +.nf +\f[C] +[remote] +type = sftp +host = example.com +user = sftpuser +key_file = \[ti]/id_rsa +pubkey_file = \[ti]/id_rsa\-cert.pub +\f[R] +.fi +.PP +If you concatenate a cert with a private key then you can specify the +merged file in both places. +.PP +Note: the cert must come first in the file. +e.g. +.IP +.nf +\f[C] +cat id_rsa\-cert.pub id_rsa > merged_key +\f[R] +.fi +.SS Host key validation +.PP +By default rclone will not check the server\[aq]s host key for +validation. +This can allow an attacker to replace a server with their own and if you +use password authentication then this can lead to that password being +exposed. +.PP +Host key matching, using standard \f[C]known_hosts\f[R] files can be +turned on by enabling the \f[C]known_hosts_file\f[R] option. +This can point to the file maintained by \f[C]OpenSSH\f[R] or can point +to a unique file. +.PP +e.g. +.IP +.nf +\f[C] +[remote] +type = sftp +host = example.com +user = sftpuser +pass = +known_hosts_file = \[ti]/.ssh/known_hosts +\f[R] +.fi +.PP +There are some limitations: +.IP \[bu] 2 +\f[C]rclone\f[R] will not \f[I]manage\f[R] this file for you. +If the key is missing or wrong then the connection will be refused. +.IP \[bu] 2 +If the server is set up for a certificate host key then the entry in the +\f[C]known_hosts\f[R] file \f[I]must\f[R] be the +\f[C]\[at]cert\-authority\f[R] entry for the CA +.IP \[bu] 2 +Unlike \f[C]OpenSSH\f[R], the libraries used by \f[C]rclone\f[R] do not +permit (at time of writing) multiple host keys to be listed for a +server. +Only the first entry is used. +.PP +If the host key provided by the server does not match the one in the +file (or is missing) then the connection will be aborted and an error +returned such as +.IP +.nf +\f[C] +NewFs: couldn\[aq]t connect SSH: ssh: handshake failed: knownhosts: key mismatch +\f[R] +.fi +.PP +or +.IP +.nf +\f[C] +NewFs: couldn\[aq]t connect SSH: ssh: handshake failed: knownhosts: key is unknown +\f[R] +.fi +.PP +If you see an error such as +.IP +.nf +\f[C] +NewFs: couldn\[aq]t connect SSH: ssh: handshake failed: ssh: no authorities for hostname: example.com:22 +\f[R] +.fi +.PP +then it is likely the server has presented a CA signed host certificate +and you will need to add the appropriate \f[C]\[at]cert\-authority\f[R] +entry. +.PP +The \f[C]known_hosts_file\f[R] setting can be set during +\f[C]rclone config\f[R] as an advanced option. .SS ssh\-agent on macOS .PP Note that there seem to be various problems with using an ssh\-agent on macOS due to recent changes in the OS. The most effective work\-around seems to be to start an ssh\-agent in -each session, eg +each session, e.g. .IP .nf \f[C] @@ -26603,7 +34630,7 @@ Connect to example.com .RE .SS \-\-sftp\-user .PP -SSH username, leave blank for current username, ncw +SSH username, leave blank for current username, $USER .IP \[bu] 2 Config: user .IP \[bu] 2 @@ -26681,6 +34708,23 @@ Env Var: RCLONE_SFTP_KEY_FILE_PASS Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS \-\-sftp\-pubkey\-file +.PP +Optional path to public key file. +.PP +Set this if you have a signed certificate you want to use for +authentication. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: pubkey_file +.IP \[bu] 2 +Env Var: RCLONE_SFTP_PUBKEY_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] .SS \-\-sftp\-key\-use\-agent .PP When set forces the usage of the ssh\-agent. @@ -26763,6 +34807,32 @@ Default: false .SS Advanced Options .PP Here are the advanced options specific to sftp (SSH/SFTP Connection). +.SS \-\-sftp\-known\-hosts\-file +.PP +Optional path to known_hosts file. +.PP +Set this value to enable server host key validation. +.PP +Leading \f[C]\[ti]\f[R] will be expanded in the file name as will +environment variables such as \f[C]${RCLONE_CONFIG_DIR}\f[R]. +.IP \[bu] 2 +Config: known_hosts_file +.IP \[bu] 2 +Env Var: RCLONE_SFTP_KNOWN_HOSTS_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[ti]/.ssh/known_hosts\[dq] +.RS 2 +.IP \[bu] 2 +Use OpenSSH\[aq]s known_hosts file +.RE +.RE .SS \-\-sftp\-ask\-password .PP Allow asking for SFTP password when needed. @@ -26877,6 +34947,26 @@ Env Var: RCLONE_SFTP_SERVER_COMMAND Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS \-\-sftp\-use\-fstat +.PP +If set use fstat instead of stat +.PP +Some servers limit the amount of open files and calling Stat after +opening the file will throw an error from the server. +Setting this flag will call Fstat instead of Stat which is called on an +already open file handle. +.PP +It has been found that this helps with IBM Sterling SFTP servers which +have \[dq]extractability\[dq] level set to 1 which means only 1 file can +be opened at any given time. +.IP \[bu] 2 +Config: use_fstat +.IP \[bu] 2 +Env Var: RCLONE_SFTP_USE_FSTAT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Limitations .PP SFTP supports checksums if the same login has shell access and @@ -26898,8 +34988,9 @@ not set, the disk of the root on the remote. \f[C]about\f[R] will fail if it does not have shell access or if \f[C]df\f[R] is not in the remote\[aq]s PATH. .PP -Note that some SFTP servers (eg Synology) the paths are different for -SSH and SFTP so the hashes can\[aq]t be calculated properly. +Note that some SFTP servers (e.g. +Synology) the paths are different for SSH and SFTP so the hashes +can\[aq]t be calculated properly. For them using \f[C]disable_hashcheck\f[R] is a good idea. .PP The only ssh agent supported under Windows is Putty\[aq]s pageant. @@ -27039,7 +35130,7 @@ rclone copy /home/source remote:backup .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP \f[B]NB\f[R] you can\[aq]t create files in the top level folder you have @@ -27216,6 +35307,16 @@ Env Var: RCLONE_SUGARSYNC_ENCODING Type: MultiEncoder .IP \[bu] 2 Default: Slash,Ctl,InvalidUtf8,Dot +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the SugarSync backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) .SS Tardigrade .PP Tardigrade (https://tardigrade.io) is an encrypted, secure, and @@ -27282,7 +35383,7 @@ d) Delete this remote y/e/d> y \f[R] .fi -.SS Setup with API key and passhprase +.SS Setup with API key and passphrase .IP .nf \f[C] @@ -27344,7 +35445,7 @@ y/e/d> y .SS Usage .PP Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for -the \f[C]lsf\f[R] command.) You may put subdirectories in too, eg +the \f[C]lsf\f[R] command.) You may put subdirectories in too, e.g. \f[C]remote:bucket/path/to/dir\f[R]. .PP Once configured you can then use \f[C]rclone\f[R] like this. @@ -27626,12 +35727,23 @@ Env Var: RCLONE_TARDIGRADE_PASSPHRASE Type: string .IP \[bu] 2 Default: \[dq]\[dq] +.SS Limitations +.PP +\f[C]rclone about\f[R] is not supported by the rclone Tardigrade +backend. +Backends without this capability cannot determine free space for an +rclone mount or use policy \f[C]mfs\f[R] (most free space) as a member +of an rclone union remote. +.PP +See List of backends that do not support rclone +about (https://rclone.org/overview/#optional-features) See rclone +about (https://rclone.org/commands/rclone_about/) .SS Union .PP The \f[C]union\f[R] remote provides a unification similar to UnionFS using other remotes. .PP -Paths may be as deep as required or a local path, eg +Paths may be as deep as required or a local path, e.g. \f[C]remote:directory/subdirectory\f[R] or \f[C]/directory/subdirectory\f[R]. .PP @@ -27640,7 +35752,8 @@ the upstream remotes as a space separated list. The upstream remotes can either be a local paths or other remotes. .PP Attribute \f[C]:ro\f[R] and \f[C]:nc\f[R] can be attach to the end of -path to tag the remote as \f[B]read only\f[R] or \f[B]no create\f[R], eg +path to tag the remote as \f[B]read only\f[R] or \f[B]no create\f[R], +e.g. \f[C]remote:directory/subdirectory:ro\f[R] or \f[C]remote:directory/subdirectory:nc\f[R]. .PP @@ -27648,12 +35761,12 @@ Subfolders can be used in upstream remotes. Assume a union remote named \f[C]backup\f[R] with the remotes \f[C]mydrive:private/backup\f[R]. Invoking \f[C]rclone mkdir backup:desktop\f[R] is exactly the same as -invoking \f[C]rclone mkdir mydrive2:/backup/desktop\f[R]. +invoking \f[C]rclone mkdir mydrive:private/backup/desktop\f[R]. .PP There will be no special handling of paths containing \f[C]..\f[R] segments. Invoking \f[C]rclone mkdir backup:../desktop\f[R] is exactly the same as -invoking \f[C]rclone mkdir mydrive2:/backup/../desktop\f[R]. +invoking \f[C]rclone mkdir mydrive:private/backup/../desktop\f[R]. .SS Behavior / Policies .PP The behavior of union backend is inspired by @@ -27928,7 +36041,7 @@ Storage> union List of space separated upstreams. Can be \[aq]upstreama:test/dir upstreamb:\[aq], \[aq]\[rs]\[dq]upstreama:test/space:ro dir\[rs]\[dq] upstreamb:\[aq], etc. Enter a string value. Press Enter for the default (\[dq]\[dq]). -upstreams> +upstreams> remote1:dir1 remote2:dir2 remote3:dir3 Policy to choose upstream on ACTION class. Enter a string value. Press Enter for the default (\[dq]epall\[dq]). action_policy> @@ -27945,7 +36058,7 @@ Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] type = union -upstreams = C:\[rs]dir1 C:\[rs]dir2 C:\[rs]dir3 +upstreams = remote1:dir1 remote2:dir2 remote3:dir3 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- y) Yes this is OK e) Edit this remote @@ -27970,8 +36083,8 @@ e/n/d/r/c/s/q> q .PP Once configured you can then use \f[C]rclone\f[R] like this, .PP -List directories in top level in \f[C]C:\[rs]dir1\f[R], -\f[C]C:\[rs]dir2\f[R] and \f[C]C:\[rs]dir3\f[R] +List directories in top level in \f[C]remote1:dir1\f[R], +\f[C]remote2:dir2\f[R] and \f[C]remote3:dir3\f[R] .IP .nf \f[C] @@ -27979,8 +36092,8 @@ rclone lsd remote: \f[R] .fi .PP -List all the files in \f[C]C:\[rs]dir1\f[R], \f[C]C:\[rs]dir2\f[R] and -\f[C]C:\[rs]dir3\f[R] +List all the files in \f[C]remote1:dir1\f[R], \f[C]remote2:dir2\f[R] and +\f[C]remote3:dir3\f[R] .IP .nf \f[C] @@ -27989,7 +36102,7 @@ rclone ls remote: .fi .PP Copy another local directory to the union directory called source, which -will be placed into \f[C]C:\[rs]dir3\f[R] +will be placed into \f[C]remote3:dir3\f[R] .IP .nf \f[C] @@ -28062,7 +36175,7 @@ Default: 120 .PP Paths are specified as \f[C]remote:path\f[R] .PP -Paths may be as deep as required, eg +Paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .PP To configure the WebDAV remote you will need to have a URL for it, and a @@ -28123,7 +36236,7 @@ Enter the password: password: Confirm the password: password: -Bearer token instead of user/pass (eg a Macaroon) +Bearer token instead of user/pass (e.g. a Macaroon) bearer_token> Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- @@ -28268,7 +36381,8 @@ Type: string Default: \[dq]\[dq] .SS \-\-webdav\-bearer\-token .PP -Bearer token instead of user/pass (eg a Macaroon) +Bearer token instead of user/pass (e.g. +a Macaroon) .IP \[bu] 2 Config: bearer_token .IP \[bu] 2 @@ -28306,11 +36420,11 @@ header. .SS Nextcloud .PP This is configured in an identical way to Owncloud. -Note that Nextcloud does not support streaming of files (\f[C]rcat\f[R]) -whereas Owncloud does. -This may be -fixed (https://github.com/nextcloud/nextcloud-snap/issues/365) in the -future. +Note that Nextcloud initially did not support streaming of files +(\f[C]rcat\f[R]) whereas Owncloud did, but +this (https://github.com/nextcloud/nextcloud-snap/issues/365) seems to +be fixed as of 2020\-11\-27 (tested with rclone v1.53.1 and Nextcloud +Server v19). .SS Sharepoint .PP Rclone can be used with Sharepoint provided by OneDrive for Business or @@ -28564,7 +36678,7 @@ rclone sync \-i /home/local/directory remote:directory \f[R] .fi .PP -Yandex paths may be as deep as required, eg +Yandex paths may be as deep as required, e.g. \f[C]remote:directory/subdirectory\f[R]. .SS Modified time .PP @@ -28684,9 +36798,209 @@ Env Var: RCLONE_YANDEX_ENCODING Type: MultiEncoder .IP \[bu] 2 Default: Slash,Del,Ctl,InvalidUtf8,Dot +.SS Zoho Workdrive +.PP +Zoho WorkDrive (https://www.zoho.com/workdrive/) is a cloud storage +solution created by Zoho (https://zoho.com). +.PP +Here is an example of making a zoho configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +n/s> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / Zoho + \[rs] \[dq]zoho\[dq] +[snip] +Storage> zoho +** See help for zoho backend at: https://rclone.org/zoho/ ** + +OAuth Client Id +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +client_id> +OAuth Client Secret +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +client_secret> +Edit advanced config? (y/n) +y) Yes +n) No (default) +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 (default) +n) No +y/n> +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=LVn0IHzxej1ZkmQw31d0wQ +Log in and authorize rclone for access +Waiting for code... +Got code +Choose a number from below, or type in your own value + 1 / MyTeam + \[rs] \[dq]4u28602177065ff22426787a6745dba8954eb\[dq] +Enter a Team ID> 1 +Choose a number from below, or type in your own value + 1 / General + \[rs] \[dq]4u2869d2aa6fca04f4f2f896b6539243b85b1\[dq] +Enter a Workspace ID> 1 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = zoho +token = {\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]Zoho\-oauthtoken\[dq],\[dq]refresh_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]expiry\[dq]:\[dq]2020\-10\-12T00:54:52.370275223+02:00\[dq]} +root_folder_id = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> +\f[R] +.fi +.PP +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Zoho Workdrive. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +See top level directories +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +Make a new directory +.IP +.nf +\f[C] +rclone mkdir remote:directory +\f[R] +.fi +.PP +List the contents of a directory +.IP +.nf +\f[C] +rclone ls remote:directory +\f[R] +.fi +.PP +Sync \f[C]/home/local/directory\f[R] to the remote path, deleting any +excess files in the path. +.IP +.nf +\f[C] +rclone sync \-i /home/local/directory remote:directory +\f[R] +.fi +.PP +Zoho paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.SS Modified time +.PP +Modified times are currently not supported for Zoho Workdrive +.SS Checksums +.PP +No checksums are supported. +.SS Usage information +.PP +To view your current quota you can use the +\f[C]rclone about remote:\f[R] command which will display your current +usage. +.SS Restricted filename characters +.PP +Only control characters and invalid UTF\-8 are replaced. +In addition most Unicode full\-width characters are not supported at all +and will be removed from filenames during upload. +.SS Standard Options +.PP +Here are the standard options specific to zoho (Zoho). +.SS \-\-zoho\-region +.PP +Zoho region to connect to. +You\[aq]ll have to use the region you organization is registered in. +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_ZOHO_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]com\[dq] +.RS 2 +.IP \[bu] 2 +United states / Global +.RE +.IP \[bu] 2 +\[dq]eu\[dq] +.RS 2 +.IP \[bu] 2 +Europe +.RE +.IP \[bu] 2 +\[dq]in\[dq] +.RS 2 +.IP \[bu] 2 +India +.RE +.IP \[bu] 2 +\[dq]com.au\[dq] +.RS 2 +.IP \[bu] 2 +Australia +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to zoho (Zoho). +.SS \-\-zoho\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the +overview (https://rclone.org/overview/#encoding) for more info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_ZOHO_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Del,Ctl,InvalidUtf8 .SS Local Filesystem .PP -Local paths are specified as normal filesystem paths, eg +Local paths are specified as normal filesystem paths, e.g. \f[C]/path/to/wherever\f[R], so .IP .nf @@ -28711,7 +37025,8 @@ This is the normal case for Windows and OS X. .PP 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 +If you are using an old Linux filesystem with non UTF\-8 file names +(e.g. latin1) then you can use the \f[C]convmv\f[R] tool to convert the filesystem to UTF\-8. This tool is available in most distributions\[aq] package managers. @@ -28721,7 +37036,7 @@ be replaced with a quoted representation of the invalid bytes. The name \f[C]gro\[rs]xdf\f[R] will be transferred as \f[C]gro\[u201B]DF\f[R]. \f[C]rclone\f[R] will emit a debug message in this case (use -\f[C]\-v\f[R] to see), eg +\f[C]\-v\f[R] to see), e.g. .IP .nf \f[C] @@ -29321,7 +37636,8 @@ $ rclone \-q ls root device as being on the same filesystem. .PP \f[B]NB\f[R] This flag is only available on Unix based systems. -On systems where it isn\[aq]t supported (eg Windows) it will be ignored. +On systems where it isn\[aq]t supported (e.g. +Windows) it will be ignored. .SS Standard Options .PP Here are the standard options specific to local (Local Disk). @@ -29385,6 +37701,31 @@ Env Var: RCLONE_LOCAL_SKIP_LINKS Type: bool .IP \[bu] 2 Default: false +.SS \-\-local\-zero\-size\-links +.PP +Assume the Stat size of links is zero (and read them instead) +.PP +On some virtual filesystems (such ash LucidLink), reading a link size +via a Stat call always returns 0. +However, on unix it reads as the length of the text in the link. +This may cause errors like this when syncing: +.IP +.nf +\f[C] +Failed to copy: corrupted on transfer: sizes differ 0 vs 13 +\f[R] +.fi +.PP +Setting this flag causes rclone to read the link and use that as the +size of the link instead of 0 which in most cases fixes the problem. +.IP \[bu] 2 +Config: zero_size_links +.IP \[bu] 2 +Env Var: RCLONE_LOCAL_ZERO_SIZE_LINKS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS \-\-local\-no\-unicode\-normalization .PP Don\[aq]t apply unicode normalization to paths and filenames @@ -29410,15 +37751,15 @@ are being uploaded and aborts with a message which starts \[dq]can\[aq]t copy \- source file is being updated\[dq] if the file changes during upload. .PP -However on some file systems this modification time check may fail (eg +However on some file systems this modification time check may fail (e.g. Glusterfs #2206 (https://github.com/rclone/rclone/issues/2206)) so this check can be disabled with this flag. .PP If this flag is set, rclone will use its best efforts to transfer a file which is being updated. -If the file is only having things appended to it (eg a log) then rclone -will transfer the log file with the size it had the first time rclone -saw it. +If the file is only having things appended to it (e.g. +a log) then rclone will transfer the log file with the size it had the +first time rclone saw it. .PP If the file is being modified throughout (not just appended to) then the transfer may fail with a hash check failure. @@ -29569,6 +37910,952 @@ Options: .IP \[bu] 2 \[dq]error\[dq]: return an error based on option value .SH Changelog +.SS v1.54.0 \- 2021\-02\-02 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.53.0...v1.54.0) +.IP \[bu] 2 +New backends +.RS 2 +.IP \[bu] 2 +Compression remote (experimental)(buengese) +.IP \[bu] 2 +Enterprise File Fabric (Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +This work was sponsored by Storage Made +Easy (https://storagemadeeasy.com/) +.RE +.IP \[bu] 2 +HDFS (Hadoop Distributed File System) (Yury Stankevich) +.IP \[bu] 2 +Zoho workdrive (buengese) +.RE +.IP \[bu] 2 +New Features +.RS 2 +.IP \[bu] 2 +Deglobalise the config (Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +Global config now read from the context +.IP \[bu] 2 +Global config can be passed into the rc +.IP \[bu] 2 +This work was sponsored by Digitalis (digitalis.io) +.RE +.IP \[bu] 2 +Add \f[C]\-\-bwlimit\f[R] for upload and download (Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +Obey bwlimit in http Transport for better limiting +.RE +.IP \[bu] 2 +Enhance systemd integration (Hekmon) +.RS 2 +.IP \[bu] 2 +log level identification +.IP \[bu] 2 +manual activation with flag +.IP \[bu] 2 +automatic systemd launch detection +.IP \[bu] 2 +Don\[aq]t compile systemd log integration for non unix systems (Benjamin +Gustin) +.RE +.IP \[bu] 2 +Add a download flag to hashsum and related commands to force rclone to +download and hash files locally (lostheli) +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Raise minimum go version to go1.12 (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +check +.RS 2 +.IP \[bu] 2 +Make the error count match up in the log message (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +cmd +.RS 2 +.IP \[bu] 2 +Add \-\-progress\-terminal\-title to print ETA to terminal title +(LaSombra) +.IP \[bu] 2 +Make backend env vars show in help as the defaults for backend flags +(Nick Craig\-Wood) +.RE +.IP \[bu] 2 +dedupe +.RS 2 +.IP \[bu] 2 +Add \-\-by\-hash to dedupe on hash not file name (Nick Craig\-Wood) +.IP \[bu] 2 +Add \-\-dedupe\-mode list to just list dupes, changing nothing (Nick +Craig\-Wood) +.IP \[bu] 2 +Add warning if used on a remote which can\[aq]t have duplicate names +(Nick Craig\-Wood) +.RE +.IP \[bu] 2 +flags: Improve error message when reading environment vars (Nick +Craig\-Wood) +.IP \[bu] 2 +fs +.RS 2 +.IP \[bu] 2 +Add Shutdown optional method for backends (Nick Craig\-Wood) +.IP \[bu] 2 +When using \-\-files\-from check files concurrently (zhucan) +.IP \[bu] 2 +Accumulate stats when using \-\-dry\-run (Ingo Weiss) +.IP \[bu] 2 +Always show stats when using \-\-dry\-run or \-\-interactive (Nick +Craig\-Wood) +.IP \[bu] 2 +Add support for flag \-\-no\-console on windows to hide the console +window (albertony) +.RE +.IP \[bu] 2 +genautocomplete: Add support to output to stdout (Ingo) +.IP \[bu] 2 +ncdu +.RS 2 +.IP \[bu] 2 +Highlight read errors instead of aborting (Claudio Bantaloukas) +.IP \[bu] 2 +Add sort by average size in directory (Adam Pl\['a]nsk\['y]) +.IP \[bu] 2 +Add toggle option for average size in directory \- key \[aq]a\[aq] (Adam +Pl\['a]nsk\['y]) +.IP \[bu] 2 +Add empty folder flag into ncdu browser (Adam Pl\['a]nsk\['y]) +.IP \[bu] 2 +Add ! (errror) and . +(unreadable) file flags to go with e (empty) (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +obscure: Make \f[C]rclone osbcure \-\f[R] ignore newline at end of line +(Nick Craig\-Wood) +.IP \[bu] 2 +operations +.RS 2 +.IP \[bu] 2 +Add logs when need to upload files to set mod times (Nick Craig\-Wood) +.IP \[bu] 2 +Move and copy log name of the destination object in verbose (Adam +Pl\['a]nsk\['y]) +.IP \[bu] 2 +Add size if known to skipped items and JSON log (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +rc +.RS 2 +.IP \[bu] 2 +Prefer actual listener address if using \[dq]:port\[dq] or +\[dq]addr:0\[dq] only (Nick Craig\-Wood) +.IP \[bu] 2 +Add listener for finished jobs (Aleksandar Jankovic) +.RE +.IP \[bu] 2 +serve ftp: Add options to enable TLS (Deepak Sah) +.IP \[bu] 2 +serve http/webdav: Redirect requests to the base url without the / (Nick +Craig\-Wood) +.IP \[bu] 2 +serve restic: Implement object cache (Nick Craig\-Wood) +.IP \[bu] 2 +stats: Add counter for deleted directories (Nick Craig\-Wood) +.IP \[bu] 2 +sync: Only print \[dq]There was nothing to transfer\[dq] if no errors +(Nick Craig\-Wood) +.IP \[bu] 2 +webui +.RS 2 +.IP \[bu] 2 +Prompt user for updating webui if an update is available (Chaitanya +Bankanhal) +.IP \[bu] 2 +Fix plugins initialization (negative0) +.RE +.RE +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Explicitly set ARM version to fix build (Nick Craig\-Wood) +.IP \[bu] 2 +Don\[aq]t explicitly set ARM version to fix ARMv5 build (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix nfpm install (Nick Craig\-Wood) +.IP \[bu] 2 +Fix docker build by upgrading ilteoood/docker_buildx (Nick Craig\-Wood) +.IP \[bu] 2 +Temporary fix for Windows build errors (Ivan Andreev) +.RE +.IP \[bu] 2 +fs +.RS 2 +.IP \[bu] 2 +Fix nil pointer on copy & move operations directly to remote (Anagh +Kumar Baranwal) +.IP \[bu] 2 +Fix parsing of .. +when joining remotes (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +log: Fix enabling systemd logging when using \-\-log\-file (Nick +Craig\-Wood) +.IP \[bu] 2 +move: Fix data loss when moving the same object (Nick Craig\-Wood) +.IP \[bu] 2 +operations +.RS 2 +.IP \[bu] 2 +Fix \-\-cutof\-mode hard not cutting off immediately (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \-\-immutable error message (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +sync +.RS 2 +.IP \[bu] 2 +Fix \-\-cutoff\-mode soft & cautious so it doesn\[aq]t end the transfer +early (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \-\-immutable errors retrying many times (Nick Craig\-Wood) +.RE +.RE +.IP \[bu] 2 +Docs +.RS 2 +.IP \[bu] 2 +Many fixes and a rewrite of the filtering docs (edwardxml) +.IP \[bu] 2 +Many spelling and grammar problems (Josh Soref) +.IP \[bu] 2 +Doc fixes for commands delete, purge, rmdir, rmdirs and mount +(albertony) +.IP \[bu] 2 +And thanks to these people for many doc fixes too numerous to list +.RS 2 +.IP \[bu] 2 +Ameer Dawood, Antoine GIRARD, Bob Bagwill, Christopher Stewart +.IP \[bu] 2 +CokeMine, David, Dov Murik, Durval Menezes, Evan Harris, gtorelly +.IP \[bu] 2 +Ilyess Bachiri, Janne Johansson, Kerry Su, Marcin Zelent, +.IP \[bu] 2 +Martin Michlmayr, Milly, S\[u01A1]n Tr\[u1EA7]n\-Nguy\[u1EC5]n +.RE +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +Update systemd status with cache stats (Hekmon) +.IP \[bu] 2 +Disable bazil/fuse based mount on macOS (Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +Make mount be cmount under macOS (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Implement mknod to make NFS file creation work (Nick Craig\-Wood) +.IP \[bu] 2 +Make sure we don\[aq]t call umount more than once (Nick Craig\-Wood) +.IP \[bu] 2 +Don\[aq]t call host.Umount if a signal has been received (Nick +Craig\-Wood) +.IP \[bu] 2 +More user friendly mounting as network drive on windows (albertony) +.IP \[bu] 2 +Cleanup OS specific option handling and documentation (albertony) +.IP \[bu] 2 +Detect if uid or gid are set in same option string: \-o uid=123,gid=456 +(albertony) +.IP \[bu] 2 +Don\[aq]t attempt to unmount if fs has been destroyed already (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Fix virtual entries causing deleted files to still appear (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix \[dq]file already exists\[dq] error for stale cache files (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix file leaks with \-\-vfs\-cache\-mode full and \-\-buffer\-size 0 +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix invalid cache path on windows when using :backend: as remote +(albertony) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Continue listing files/folders when a circular symlink is detected +(Manish Gupta) +.IP \[bu] 2 +New flag \-\-local\-zero\-size\-links to fix sync on some virtual +filesystems (Riccardo Iaconelli) +.RE +.IP \[bu] 2 +Azure Blob +.RS 2 +.IP \[bu] 2 +Add support for service principals (James Lim) +.IP \[bu] 2 +Utilize streaming capabilities (Denis Neuling) +.IP \[bu] 2 +Update SDK to v0.13.0 and fix API breakage (Nick Craig\-Wood, Mitsuo +Heijo) +.IP \[bu] 2 +Fix setting of mime types (Nick Craig\-Wood) +.IP \[bu] 2 +Fix crash when listing outside a SAS URL\[aq]s root (Nick Craig\-Wood) +.IP \[bu] 2 +Delete archive tier blobs before update if +\-\-azureblob\-archive\-tier\-delete (Nick Craig\-Wood) +.IP \[bu] 2 +Add support for managed identities (Brad Ackerman) +.IP \[bu] 2 +Fix crash on startup (Nick Craig\-Wood) +.IP \[bu] 2 +Add examples for access tier (Bob Pusateri) +.IP \[bu] 2 +Fix memory usage by upgrading the SDK and implementing a TransferManager +(Nick Craig\-Wood) +.IP \[bu] 2 +Require go1.14+ to compile due to SDK changes (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +B2 +.RS 2 +.IP \[bu] 2 +Make NewObject use less expensive API calls (Nick Craig\-Wood) +.IP \[bu] 2 +Fixed possible crash when accessing Backblaze b2 remote (lluuaapp) +.RE +.IP \[bu] 2 +Box +.RS 2 +.IP \[bu] 2 +Fix NewObject for files that differ in case (Nick Craig\-Wood) +.IP \[bu] 2 +Fix finding directories in a case insentive way (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Chunker +.RS 2 +.IP \[bu] 2 +Skip long local hashing, hash in\-transit (fixes) (Ivan Andreev) +.IP \[bu] 2 +Set Features.ReadMimeType=false as Object.MimeType not supported (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix case\-insensitive NewObject, test metadata detection (Ivan Andreev) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Implement \[dq]rclone backend copyid\[dq] command for copying files by +ID (Nick Craig\-Wood) +.IP \[bu] 2 +Added flag \f[C]\-\-drive\-stop\-on\-download\-limit\f[R] to stop +transfers when the download limit is exceeded (Anagh Kumar Baranwal) +.IP \[bu] 2 +Implement CleanUp workaround for team drives (buengese) +.IP \[bu] 2 +Allow shortcut resolution and creation to be retried (Nick Craig\-Wood) +.IP \[bu] 2 +Log that emptying the trash can take some time (Nick Craig\-Wood) +.IP \[bu] 2 +Add xdg office icons to xdg desktop files (Pau Rodriguez\-Estivill) +.RE +.IP \[bu] 2 +Dropbox +.RS 2 +.IP \[bu] 2 +Add support for viewing shared files and folders (buengese) +.IP \[bu] 2 +Implement IDer (buengese) +.IP \[bu] 2 +Set Features.ReadMimeType=false as Object.MimeType not supported (Nick +Craig\-Wood) +.IP \[bu] 2 +Tidy repeated error message (Nick Craig\-Wood) +.IP \[bu] 2 +Make malformed_path errors from too long files not retriable (Nick +Craig\-Wood) +.IP \[bu] 2 +Test file name length before upload to fix upload loop (Nick +Craig\-Wood) +.IP \[bu] 2 +Enable short lived access tokens (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Fichier +.RS 2 +.IP \[bu] 2 +Set Features.ReadMimeType=true as Object.MimeType is supported (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +FTP +.RS 2 +.IP \[bu] 2 +Add \-\-ftp\-disable\-msld option to ignore MLSD for really old servers +(Nick Craig\-Wood) +.IP \[bu] 2 +Make \-\-tpslimit apply (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Google Cloud Storage +.RS 2 +.IP \[bu] 2 +Storage class object header support (Laurens Janssen) +.IP \[bu] 2 +Fix anonymous client to use rclone\[aq]s HTTP client (Nick Craig\-Wood) +.IP \[bu] 2 +Fix Entry doesn\[aq]t belong in directory \[dq]\[dq] (same as directory) +\- ignoring (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Googlephotos +.RS 2 +.IP \[bu] 2 +New flag \-\-gphotos\-include\-archived (Nicolas Rueff) +.RE +.IP \[bu] 2 +Jottacloud +.RS 2 +.IP \[bu] 2 +Don\[aq]t erroniously report support for writing mime types (buengese) +.IP \[bu] 2 +Add support for Telia Cloud (#4930) (Patrik Nordl\['e]n) +.RE +.IP \[bu] 2 +Mailru +.RS 2 +.IP \[bu] 2 +Fix uploads after recent changes on server (Ivan Andreev) +.IP \[bu] 2 +Fix range requests after June 2020 changes on server (Ivan Andreev) +.IP \[bu] 2 +Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) +.IP \[bu] 2 +Remove deprecated protocol quirks (Ivan Andreev) +.IP \[bu] 2 +Accept special folders eg camera\-upload (Ivan Andreev) +.IP \[bu] 2 +Avoid prehashing of large local files (Ivan Andreev) +.RE +.IP \[bu] 2 +Memory +.RS 2 +.IP \[bu] 2 +Fix setting of mime types (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +Add support for china region operated by 21vianet and other regional +suppliers (#4963) (NyaMisty) +.IP \[bu] 2 +Warn on gateway timeout errors (Nick Craig\-Wood) +.IP \[bu] 2 +Fall back to normal copy if server\-side copy unavailable (#4903) (Alex +Chen) +.IP \[bu] 2 +Fix server\-side copy completely disabled on OneDrive for Business +(Cnly) +.IP \[bu] 2 +(business only) workaround to replace existing file on server\-side copy +(#4904) (Alex Chen) +.IP \[bu] 2 +Enhance link creation with expiry, scope, type and password (Nick +Craig\-Wood) +.IP \[bu] 2 +Remove % and # from the set of encoded characters (#4909) (Alex Chen) +.IP \[bu] 2 +Support addressing site by server\-relative URL (#4761) (kice) +.RE +.IP \[bu] 2 +Opendrive +.RS 2 +.IP \[bu] 2 +Fix finding directories in a case insensitive way (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Pcloud +.RS 2 +.IP \[bu] 2 +Fix setting of mime types (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Premiumizeme +.RS 2 +.IP \[bu] 2 +Fix finding directories in a case insensitive way (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Qingstor +.RS 2 +.IP \[bu] 2 +Fix error propagation in CleanUp (Nick Craig\-Wood) +.IP \[bu] 2 +Fix rclone cleanup (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Added \f[C]\-\-s3\-disable\-http2\f[R] to disable http/2 (Anagh Kumar +Baranwal) +.IP \[bu] 2 +Complete SSE\-C implementation (Nick Craig\-Wood) +.IP \[bu] 2 +Fix hashes on small files with AWS:KMS and SSE\-C (Nick Craig\-Wood) +.IP \[bu] 2 +Add MD5 metadata to objects uploaded with SSE\-AWS/SSE\-C (Nick +Craig\-Wood) +.IP \[bu] 2 +Update docs with a Reducing Costs section (Nick Craig\-Wood) +.IP \[bu] 2 +Added error handling for error code 429 indicating too many requests +(Anagh Kumar Baranwal) +.IP \[bu] 2 +Add requester pays option (kelv) +.IP \[bu] 2 +Fix copy multipart with v2 auth failing with +\[aq]SignatureDoesNotMatch\[aq] (Louis Koo) +.IP \[bu] 2 +Add \-\-s3\-no\-head parameter to minimise transactions on upload (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +SFTP +.RS 2 +.IP \[bu] 2 +Allow cert based auth via optional pubkey (Stephen Harris) +.IP \[bu] 2 +Allow user to optionally check server hosts key to add security (Stephen +Harris) +.IP \[bu] 2 +Defer asking for user passwords until the SSH connection succeeds +(Stephen Harris) +.IP \[bu] 2 +Remember entered password in AskPass mode (Stephen Harris) +.IP \[bu] 2 +Implement Shutdown method (Nick Craig\-Wood) +.IP \[bu] 2 +Implement keyboard interactive authentication (Nick Craig\-Wood) +.IP \[bu] 2 +Make \-\-tpslimit apply (Nick Craig\-Wood) +.IP \[bu] 2 +Implement \-\-sftp\-use\-fstat (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Sugarsync +.RS 2 +.IP \[bu] 2 +Fix NewObject for files that differ in case (Nick Craig\-Wood) +.IP \[bu] 2 +Fix finding directories in a case insentive way (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Swift +.RS 2 +.IP \[bu] 2 +Fix deletion of parts of Static Large Object (SLO) (Nguy\[u1EC5]n +H\[u1EEF]u Lu\[^a]n) +.IP \[bu] 2 +Ensure partially uploaded large files are uploaded unless +\-\-swift\-leave\-parts\-on\-error (Nguy\[u1EC5]n H\[u1EEF]u Lu\[^a]n) +.RE +.IP \[bu] 2 +Tardigrade +.RS 2 +.IP \[bu] 2 +Upgrade to uplink v1.4.1 (Caleb Case) +.RE +.IP \[bu] 2 +WebDAV +.RS 2 +.IP \[bu] 2 +Updated docs to show streaming to nextcloud is working (Durval Menezes) +.RE +.IP \[bu] 2 +Yandex +.RS 2 +.IP \[bu] 2 +Set Features.WriteMimeType=false as Yandex ignores mime types (Nick +Craig\-Wood) +.RE +.SS v1.53.4 \- 2021\-01\-20 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.53.3...v1.53.4) +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting: Fix data race in Transferred() (Maciej Zimnoch) +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Stop tagged releases making a current beta (Nick Craig\-Wood) +.IP \[bu] 2 +Upgrade docker buildx action (Matteo Pietro Dazzi) +.IP \[bu] 2 +Add \-buildmode to cross\-compile.go (Nick Craig\-Wood) +.IP \[bu] 2 +Fix docker build by upgrading ilteoood/docker_buildx (Nick Craig\-Wood) +.IP \[bu] 2 +Revert GitHub actions brew fix since this is now fixed (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix brew install \-\-cask syntax for macOS build (Nick Craig\-Wood) +.IP \[bu] 2 +Update nfpm syntax to fix build of .deb/.rpm packages (Nick Craig\-Wood) +.IP \[bu] 2 +Fix for Windows build errors (Ivan Andreev) +.RE +.IP \[bu] 2 +fs: Parseduration: fixed tests to use UTC time (Ankur Gupta) +.IP \[bu] 2 +fshttp: Prevent overlap of HTTP headers in logs (Nathan Collins) +.IP \[bu] 2 +rc +.RS 2 +.IP \[bu] 2 +Fix core/command giving 500 internal error (Nick Craig\-Wood) +.IP \[bu] 2 +Add Copy method to rc.Params (Nick Craig\-Wood) +.IP \[bu] 2 +Fix 500 error when marshalling errors from core/command (Nick +Craig\-Wood) +.IP \[bu] 2 +plugins: Create plugins files only if webui is enabled. +(negative0) +.RE +.IP \[bu] 2 +serve http: Fix serving files of unknown length (Nick Craig\-Wood) +.IP \[bu] 2 +serve sftp: Fix authentication on one connection blocking others (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +Add optional \f[C]brew\f[R] tag to throw an error when using mount in +the binaries installed via Homebrew (Anagh Kumar Baranwal) +.IP \[bu] 2 +Add \[dq].\[dq] and \[dq]..\[dq] to directories to match cmount and +expectations (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Make cache dir absolute before using it to fix path too long errors +(Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Chunker +.RS 2 +.IP \[bu] 2 +Improve detection of incompatible metadata (Ivan Andreev) +.RE +.IP \[bu] 2 +Google Cloud Storage +.RS 2 +.IP \[bu] 2 +Fix server side copy of large objects (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Jottacloud +.RS 2 +.IP \[bu] 2 +Fix token renewer to fix long uploads (Nick Craig\-Wood) +.IP \[bu] 2 +Fix token refresh failed: is not a regular file error (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Pcloud +.RS 2 +.IP \[bu] 2 +Only use SHA1 hashes in EU region (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Sharefile +.RS 2 +.IP \[bu] 2 +Undo Fix backend due to API swapping integers for strings (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +WebDAV +.RS 2 +.IP \[bu] 2 +Fix Open Range requests to fix 4shared mount (Nick Craig\-Wood) +.IP \[bu] 2 +Add \[dq]Depth: 0\[dq] to GET requests to fix bitrix (Nick Craig\-Wood) +.RE +.SS v1.53.3 \- 2020\-11\-19 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.53.2...v1.53.3) +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +random: Fix incorrect use of math/rand instead of crypto/rand +CVE\-2020\-28924 (Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +Passwords you have generated with \f[C]rclone config\f[R] may be +insecure +.IP \[bu] 2 +See issue #4783 (https://github.com/rclone/rclone/issues/4783) for more +details and a checking tool +.RE +.IP \[bu] 2 +random: Seed math/rand in one place with crypto strong seed (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Fix vfs/refresh calls with fs= parameter (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Sharefile +.RS 2 +.IP \[bu] 2 +Fix backend due to API swapping integers for strings (Nick Craig\-Wood) +.RE +.SS v1.53.2 \- 2020\-10\-26 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.53.1...v1.53.2) +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +acounting +.RS 2 +.IP \[bu] 2 +Fix incorrect speed and transferTime in core/stats (Nick Craig\-Wood) +.IP \[bu] 2 +Stabilize display order of transfers on Windows (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +operations +.RS 2 +.IP \[bu] 2 +Fix use of \-\-suffix without \-\-backup\-dir (Nick Craig\-Wood) +.IP \[bu] 2 +Fix spurious \[dq]\-\-checksum is in use but the source and destination +have no hashes in common\[dq] (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Work around GitHub actions brew problem (Nick Craig\-Wood) +.IP \[bu] 2 +Stop using set\-env and set\-path in the GitHub actions (Nick +Craig\-Wood) +.RE +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +mount2: Fix the swapped UID / GID values (Russell Cattelan) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Detect and recover from a file being removed externally from the cache +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix a deadlock vulnerability in downloaders.Close (Leo Luan) +.IP \[bu] 2 +Fix a race condition in retryFailedResets (Leo Luan) +.IP \[bu] 2 +Fix missed concurrency control between some item operations and reset +(Leo Luan) +.IP \[bu] 2 +Add exponential backoff during ENOSPC retries (Leo Luan) +.IP \[bu] 2 +Add a missed update of used cache space (Leo Luan) +.IP \[bu] 2 +Fix \-\-no\-modtime to not attempt to set modtimes (as documented) (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Fix sizes and syncing with \-\-links option on Windows (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Chunker +.RS 2 +.IP \[bu] 2 +Disable ListR to fix missing files on GDrive (workaround) (Ivan Andreev) +.IP \[bu] 2 +Fix upload over crypt (Ivan Andreev) +.RE +.IP \[bu] 2 +Fichier +.RS 2 +.IP \[bu] 2 +Increase maximum file size from 100GB to 300GB (gyutw) +.RE +.IP \[bu] 2 +Jottacloud +.RS 2 +.IP \[bu] 2 +Remove clientSecret from config when upgrading to token based +authentication (buengese) +.IP \[bu] 2 +Avoid double url escaping of device/mountpoint (albertony) +.IP \[bu] 2 +Remove DirMove workaround as it\[aq]s not required anymore \- also +(buengese) +.RE +.IP \[bu] 2 +Mailru +.RS 2 +.IP \[bu] 2 +Fix uploads after recent changes on server (Ivan Andreev) +.IP \[bu] 2 +Fix range requests after june changes on server (Ivan Andreev) +.IP \[bu] 2 +Fix invalid timestamp on corrupted files (fixes) (Ivan Andreev) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +Fix disk usage for sharepoint (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Add missing regions for AWS (Anagh Kumar Baranwal) +.RE +.IP \[bu] 2 +Seafile +.RS 2 +.IP \[bu] 2 +Fix accessing libraries > 2GB on 32 bit systems (Muffin King) +.RE +.IP \[bu] 2 +SFTP +.RS 2 +.IP \[bu] 2 +Always convert the checksum to lower case (buengese) +.RE +.IP \[bu] 2 +Union +.RS 2 +.IP \[bu] 2 +Create root directories if none exist (Nick Craig\-Wood) +.RE +.SS v1.53.1 \- 2020\-09\-13 +.PP +See commits (https://github.com/rclone/rclone/compare/v1.53.0...v1.53.1) +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting: Remove new line from end of \-\-stats\-one\-line display +(Nick Craig\-Wood) +.IP \[bu] 2 +check +.RS 2 +.IP \[bu] 2 +Add back missing \-\-download flag (Nick Craig\-Wood) +.IP \[bu] 2 +Fix docs (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +docs +.RS 2 +.IP \[bu] 2 +Note \-\-log\-file does append (Nick Craig\-Wood) +.IP \[bu] 2 +Add full stops for consistency in rclone \-\-help (edwardxml) +.IP \[bu] 2 +Add Tencent COS to s3 provider list (wjielai) +.IP \[bu] 2 +Updated mount command to reflect that it requires Go 1.13 or newer (Evan +Harris) +.IP \[bu] 2 +jottacloud: Mention that uploads from local disk will not need to cache +files to disk for md5 calculation (albertony) +.IP \[bu] 2 +Fix formatting of rc docs page (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Include vendor tar ball in release and fix startdev (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \[dq]Illegal instruction\[dq] error for ARMv6 builds (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix architecture name in ARMv7 build (Nick Craig\-Wood) +.RE +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Fix spurious error \[dq]vfs cache: failed to _ensure cache EOF\[dq] +(Nick Craig\-Wood) +.IP \[bu] 2 +Log an ERROR if we fail to set the file to be sparse (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Log an ERROR if we fail to set the file to be sparse (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Re\-adds special oauth help text (Tim Gallant) +.RE +.IP \[bu] 2 +Opendrive +.RS 2 +.IP \[bu] 2 +Do not retry 400 errors (Evan Harris) +.RE .SS v1.53.0 \- 2020\-09\-02 .PP See commits (https://github.com/rclone/rclone/compare/v1.52.0...v1.53.0) @@ -29640,7 +38927,7 @@ Add \f[C]mount/listmounts\f[R] option for listing current mounts Add \f[C]operations/uploadfile\f[R] to upload a file through rc using encoding multipart/form\-data (Chaitanya Bankanhal) .IP \[bu] 2 -Add \f[C]core/copmmand\f[R] to execute rclone terminal commands. +Add \f[C]core/command\f[R] to execute rclone terminal commands. (Chaitanya Bankanhal) .RE .IP \[bu] 2 @@ -29879,7 +39166,7 @@ Don\[aq]t compile on < go1.13 after dependency update (Nick Craig\-Wood) B2 .RS 2 .IP \[bu] 2 -Implement server side copy for files > 5GB (Nick Craig\-Wood) +Implement server\-side copy for files > 5GB (Nick Craig\-Wood) .IP \[bu] 2 Cancel in progress multipart uploads and copies on rclone exit (Nick Craig\-Wood) @@ -29925,7 +39212,7 @@ McEntire) Deprecate \f[C]\-\-drive\-alternate\-export\f[R] as it is no longer needed (themylogin) .IP \[bu] 2 -Fix duplication of Google docs on server side copy (Nick Craig\-Wood) +Fix duplication of Google docs on server\-side copy (Nick Craig\-Wood) .IP \[bu] 2 Fix \[dq]panic: send on closed channel\[dq] when recycling dir entries (Nick Craig\-Wood) @@ -29968,7 +39255,7 @@ Add support for anonymous access (Kai L\[:u]ke) Jottacloud .RS 2 .IP \[bu] 2 -Bring back legacy authentification for use with whitelabel versions +Bring back legacy authentication for use with whitelabel versions (buengese) .IP \[bu] 2 Switch to new api root \- also implement a very ugly workaround for the @@ -30088,8 +39375,8 @@ Bug Fixes docs .RS 2 .IP \[bu] 2 -Disable smart typography (eg en\-dash) in MANUAL.* and man page (Nick -Craig\-Wood) +Disable smart typography (e.g. +en\-dash) in MANUAL.* and man page (Nick Craig\-Wood) .IP \[bu] 2 Update install.md to reflect minimum Go version (Evan Harris) .IP \[bu] 2 @@ -30352,11 +39639,11 @@ transfers (Nick Craig\-Wood) Add \f[C]\-\-track\-renames\-strategy\f[R] for configurable matching criteria for \f[C]\-\-track\-renames\f[R] (Bernd Schoolmann) .IP \[bu] 2 -Add \f[C]\-\-cutoff\-mode\f[R] hard,soft,catious (Shing Kit Chan & +Add \f[C]\-\-cutoff\-mode\f[R] hard,soft,cautious (Shing Kit Chan & Franklyn Tackitt) .IP \[bu] 2 -Filter flags (eg \f[C]\-\-files\-from \-\f[R]) can read from stdin -(fishbullet) +Filter flags (e.g. +\f[C]\-\-files\-from \-\f[R]) can read from stdin (fishbullet) .IP \[bu] 2 Add \f[C]\-\-error\-on\-no\-transfer\f[R] option (Jon Fautley) .IP \[bu] 2 @@ -31133,7 +40420,7 @@ dedupe: Add missing modes to help string (Nick Craig\-Wood) operations .RS 2 .IP \[bu] 2 -Fix dedupe continuing on errors like insufficientFilePermisson +Fix dedupe continuing on errors like insufficientFilePersimmon (SezalAgrawal) .IP \[bu] 2 Clear accounting before low level retry (Maciej Zimnoch) @@ -31311,7 +40598,7 @@ Re\-implement multipart upload to fix memory issues (Nick Craig\-Wood) Add \f[C]\-\-s3\-copy\-cutoff\f[R] for size to switch to multipart copy (Nick Craig\-Wood) .IP \[bu] 2 -Add new region Asia Patific (Hong Kong) (Outvi V) +Add new region Asia Pacific (Hong Kong) (Outvi V) .IP \[bu] 2 Reduce memory usage streaming files by reducing max stream upload size (Nick Craig\-Wood) @@ -31523,7 +40810,7 @@ scan (Nick Craig\-Wood) operations .RS 2 .IP \[bu] 2 -Fix accounting for server side copies (Nick Craig\-Wood) +Fix accounting for server\-side copies (Nick Craig\-Wood) .IP \[bu] 2 Display \[aq]All duplicates removed\[aq] only if dedupe successful (Sezal Agrawal) @@ -31580,8 +40867,8 @@ Remove error: can\[aq]t use \f[C]\-\-size\-only\f[R] and filter: Prevent mixing options when \f[C]\-\-files\-from\f[R] is in use (Michele Caci) .IP \[bu] 2 -serve sftp: Fix crash on unsupported operations (eg Readlink) (Nick -Craig\-Wood) +serve sftp: Fix crash on unsupported operations (e.g. +Readlink) (Nick Craig\-Wood) .RE .IP \[bu] 2 Mount @@ -31627,8 +40914,8 @@ Disable logging to the Windows event log (Nick Craig\-Wood) B2 .RS 2 .IP \[bu] 2 -Remove \f[C]unverified:\f[R] prefix on sha1 to improve interop (eg with -CyberDuck) (Nick Craig\-Wood) +Remove \f[C]unverified:\f[R] prefix on sha1 to improve interop (e.g. +with CyberDuck) (Nick Craig\-Wood) .RE .IP \[bu] 2 Box @@ -31997,7 +41284,7 @@ rcd: Fix permissions problems on cache directory with web gui download Mount .RS 2 .IP \[bu] 2 -Default \f[C]\-\-deamon\-timout\f[R] to 15 minutes on macOS and FreeBSD +Default \f[C]\-\-daemon\-timout\f[R] to 15 minutes on macOS and FreeBSD (Nick Craig\-Wood) .IP \[bu] 2 Update docs to show mounting from root OK for bucket based (Nick @@ -32045,7 +41332,7 @@ B2 .IP \[bu] 2 Implement link sharing (yparitcher) .IP \[bu] 2 -Enable server side copy to copy between buckets (Nick Craig\-Wood) +Enable server\-side copy to copy between buckets (Nick Craig\-Wood) .IP \[bu] 2 Make all operations work from the root (Nick Craig\-Wood) .RE @@ -32053,7 +41340,7 @@ Make all operations work from the root (Nick Craig\-Wood) Drive .RS 2 .IP \[bu] 2 -Fix server side copy of big files (Nick Craig\-Wood) +Fix server\-side copy of big files (Nick Craig\-Wood) .IP \[bu] 2 Update API for teamdrive use (Nick Craig\-Wood) .IP \[bu] 2 @@ -32183,7 +41470,8 @@ Use rclone.conf from rclone executable directory to enable portable use Allow sync of a file and a directory with the same name (forgems) .RS 2 .IP \[bu] 2 -this is common on bucket based remotes, eg s3, gcs +this is common on bucket based remotes, e.g. +s3, gcs .RE .IP \[bu] 2 Add \f[C]\-\-ignore\-case\-sync\f[R] for forced case insensitivity @@ -32311,7 +41599,7 @@ Implement Optional methods SetTier, GetTier (Nick Craig\-Wood) B2 .RS 2 .IP \[bu] 2 -Implement server side copy (Nick Craig\-Wood) +Implement server\-side copy (Nick Craig\-Wood) .IP \[bu] 2 Implement SetModTime (Nick Craig\-Wood) .RE @@ -32325,7 +41613,7 @@ Add notes that cleanup works in the background on drive (Nick Craig\-Wood) .IP \[bu] 2 Add \f[C]\-\-drive\-server\-side\-across\-configs\f[R] to default back -to old server side copy semantics by default (Nick Craig\-Wood) +to old server\-side copy semantics by default (Nick Craig\-Wood) .IP \[bu] 2 Add \f[C]\-\-drive\-size\-as\-quota\f[R] to show storage quota usage for file size (Garry McNulty) @@ -32436,8 +41724,8 @@ this fixes \f[C]\-\-files\-from\f[R] with Google drive and excessive API use in general. .RE .IP \[bu] 2 -Make server side copy account bytes and obey \f[C]\-\-max\-transfer\f[R] -(Nick Craig\-Wood) +Make server\-side copy account bytes and obey +\f[C]\-\-max\-transfer\f[R] (Nick Craig\-Wood) .IP \[bu] 2 Add \f[C]\-\-create\-empty\-src\-dirs\f[R] flag and default to not creating empty dirs (ishuah) @@ -32452,7 +41740,7 @@ Implement \f[C]\-\-suffix\-keep\-extension\f[R] for use with build: .RS 2 .IP \[bu] 2 -Switch to semvar compliant version tags to be go modules compliant (Nick +Switch to semver compliant version tags to be go modules compliant (Nick Craig\-Wood) .IP \[bu] 2 Update to use go1.12.x for the build (Nick Craig\-Wood) @@ -32536,7 +41824,7 @@ Drive Add \f[C]\-\-skip\-checksum\-gphotos\f[R] to ignore incorrect checksums on Google Photos (Nick Craig\-Wood) .IP \[bu] 2 -Allow server side move/copy between different remotes. +Allow server\-side move/copy between different remotes. (Fionera) .IP \[bu] 2 Add docs on team drives and \f[C]\-\-fast\-list\f[R] eventual @@ -32546,7 +41834,7 @@ Fix imports of text files (Nick Craig\-Wood) .IP \[bu] 2 Fix range requests on 0 length files (Nick Craig\-Wood) .IP \[bu] 2 -Fix creation of duplicates with server side copy (Nick Craig\-Wood) +Fix creation of duplicates with server\-side copy (Nick Craig\-Wood) .RE .IP \[bu] 2 Dropbox @@ -32787,7 +42075,8 @@ Azure Blob Allow building azureblob backend on *BSD (themylogin) .IP \[bu] 2 Use the rclone HTTP client to support \f[C]\-\-dump headers\f[R], -\f[C]\-\-tpslimit\f[R] etc (Nick Craig\-Wood) +\f[C]\-\-tpslimit\f[R], etc. +(Nick Craig\-Wood) .IP \[bu] 2 Use the s3 pacer for 0 delay in non error conditions (Nick Craig\-Wood) .IP \[bu] 2 @@ -32957,7 +42246,8 @@ Add option to force the usage of an ssh\-agent (Fabian M\[:o]ller) .IP \[bu] 2 Perform environment variable expansion on key\-file (Fabian M\[:o]ller) .IP \[bu] 2 -Fix rmdir on Windows based servers (eg CrushFTP) (Nick Craig\-Wood) +Fix rmdir on Windows based servers (e.g. +CrushFTP) (Nick Craig\-Wood) .IP \[bu] 2 Fix rmdir deleting directory contents on some SFTP servers (Nick Craig\-Wood) @@ -33036,7 +42326,8 @@ config/* operations to configure rclone .IP \[bu] 2 options/* for reading/setting command line flags .IP \[bu] 2 -operations/* for all low level operations, eg copy file, list directory +operations/* for all low level operations, e.g. +copy file, list directory .IP \[bu] 2 sync/* for sync, copy and move .IP \[bu] 2 @@ -33154,7 +42445,7 @@ Fix retries of upload chunks (Nick Craig\-Wood) S3 .RS 2 .IP \[bu] 2 -Set ACL for server side copies to that provided by the user (Nick +Set ACL for server\-side copies to that provided by the user (Nick Craig\-Wood) .IP \[bu] 2 Fix role_arn, credential_source, ... @@ -33265,7 +42556,7 @@ Fix race condition detected by serve ftp tests (Nick Craig\-Wood) .IP \[bu] 2 Add vfs/poll\-interval rc command (Fabian M\[:o]ller) .IP \[bu] 2 -Enable rename for nearly all remotes using server side Move or Copy +Enable rename for nearly all remotes using server\-side Move or Copy (Nick Craig\-Wood) .IP \[bu] 2 Reduce directory cache cleared by poll\-interval (Fabian M\[:o]ller) @@ -33436,7 +42727,7 @@ Union Implement union backend which reads from multiple backends (Felix Brucker) .IP \[bu] 2 -Implement optional interfaces (Move, DirMove, Copy etc) (Nick +Implement optional interfaces (Move, DirMove, Copy, etc.) (Nick Craig\-Wood) .IP \[bu] 2 Fix ChangeNotify to support multiple remotes (Fabian M\[:o]ller) @@ -33763,7 +43054,7 @@ Add \f[C]storage_policy\f[R] (Ruben Vandamme) Make it so just \f[C]storage_url\f[R] or \f[C]auth_token\f[R] can be overridden (Nick Craig\-Wood) .IP \[bu] 2 -Fix server side copy bug for unusual file names (Nick Craig\-Wood) +Fix server\-side copy bug for unusual file names (Nick Craig\-Wood) .IP \[bu] 2 Remove leading / from paths (Nick Craig\-Wood) .RE @@ -34085,8 +43376,8 @@ rc: take note of the \-\-rc\-addr flag too as per the docs Mount .RS 2 .IP \[bu] 2 -Use About to return the correct disk total/used/free (eg in -\f[C]df\f[R]) +Use About to return the correct disk total/used/free (e.g. +in \f[C]df\f[R]) .IP \[bu] 2 Set \f[C]\-\-attr\-timeout default\f[R] to \f[C]1s\f[R] \- fixes: .RS 2 @@ -34604,7 +43895,7 @@ Don\[aq]t check for bucket/container presence if listing was OK this makes rclone do one less request per invocation .RE .IP \[bu] 2 -Fix server side copy and set modtime on files with + in +Fix server\-side copy and set modtime on files with + in .RE .IP \[bu] 2 SFTP @@ -34733,7 +44024,8 @@ config Warn the user if \-\-include and \-\-exclude are used together (Ernest Borowski) .IP \[bu] 2 -Fix duplicate files (eg on Google drive) causing spurious copies +Fix duplicate files (e.g. +on Google drive) causing spurious copies .IP \[bu] 2 Allow trailing and leading whitespace for passwords (Jason Rose) .IP \[bu] 2 @@ -34961,7 +44253,7 @@ Stop using deprecated API methods Swift .RS 2 .IP \[bu] 2 -Fix server side copy to empty container with \f[C]\-\-fast\-list\f[R] +Fix server\-side copy to empty container with \f[C]\-\-fast\-list\f[R] .RE .IP \[bu] 2 Google Drive @@ -35217,7 +44509,7 @@ Google Cloud Storage Add ability to specify location and storage class via config and command line \- thanks gdm85 .IP \[bu] 2 -Create container if necessary on server side copy +Create container if necessary on server\-side copy .IP \[bu] 2 Increase directory listing chunk to 1000 to increase performance .IP \[bu] 2 @@ -35259,7 +44551,7 @@ S3 .IP \[bu] 2 Work around eventual consistency in bucket creation .IP \[bu] 2 -Create container if necessary on server side copy +Create container if necessary on server\-side copy .IP \[bu] 2 Add us\-east\-2 (Ohio) and eu\-west\-2 (London) S3 regions \- Zahiar Ahmed @@ -35280,7 +44572,7 @@ Fix paged directory listings this caused duplicate directory errors .RE .IP \[bu] 2 -Create container if necessary on server side copy +Create container if necessary on server\-side copy .IP \[bu] 2 Increase directory listing chunk to 1000 to increase performance .IP \[bu] 2 @@ -35523,7 +44815,7 @@ Only show transfer stats on commands which transfer stuff show stats on any command using the \f[C]\-\-stats\f[R] flag .RE .IP \[bu] 2 -Allow overlapping directories in move when server side dir move is +Allow overlapping directories in move when server\-side dir move is supported .IP \[bu] 2 Add \-\-stats\-unit option \- thanks Scott McGillivray @@ -35579,7 +44871,7 @@ these will now return the underlying unexpected EOF instead Amazon Drive .RS 2 .IP \[bu] 2 -Add support for server side move and directory move \- thanks Stefan +Add support for server\-side move and directory move \- thanks Stefan Breunig .IP \[bu] 2 Fix nil pointer deref on size attribute @@ -35824,8 +45116,8 @@ Set maximum backoff to 5 Minutes onedrive .RS 2 .IP \[bu] 2 -Fix URL escaping in file names \- eg uploading files with \f[C]+\f[R] in -them. +Fix URL escaping in file names \- e.g. +uploading files with \f[C]+\f[R] in them. .RE .IP \[bu] 2 amazon cloud drive @@ -35929,7 +45221,8 @@ Backblaze B2 .IP \[bu] 2 Add \-\-b2\-versions flag so old versions can be listed and retrieved. .IP \[bu] 2 -Treat 403 errors (eg cap exceeded) as fatal. +Treat 403 errors (e.g. +cap exceeded) as fatal. .IP \[bu] 2 Implement cleanup command for deleting old file versions. .IP \[bu] 2 @@ -35979,7 +45272,7 @@ Display the transfer stats in more human readable form Make 0 size files specifiable with \f[C]\-\-max\-size 0b\f[R] .IP \[bu] 2 Add \f[C]b\f[R] suffix so we can specify bytes in \-\-bwlimit, -\-\-min\-size etc +\-\-min\-size, etc. .IP \[bu] 2 Use \[dq]password:\[dq] instead of \[dq]password>\[dq] prompt \- thanks Klaus Post and Leigh Klotz @@ -36330,7 +45623,7 @@ Fix sync for chunked files OneDrive .RS 2 .IP \[bu] 2 -Re\-enable server side copy +Re\-enable server\-side copy .IP \[bu] 2 Don\[aq]t mask HTTP error codes with JSON decode error .RE @@ -36363,7 +45656,8 @@ Always check first with \f[C]\-\-dry\-run\f[R]! Swift .RS 2 .IP \[bu] 2 -Stop SetModTime losing metadata (eg X\-Object\-Manifest) +Stop SetModTime losing metadata (e.g. +X\-Object\-Manifest) .RS 2 .IP \[bu] 2 This could have caused data loss for files > 5GB in size @@ -36375,7 +45669,7 @@ Use ContentType from Object to avoid lookups in listings OneDrive .RS 2 .IP \[bu] 2 -disable server side copy as it seems to be broken at Microsoft +disable server\-side copy as it seems to be broken at Microsoft .RE .SS v1.24 \- 2015\-11\-07 .IP \[bu] 2 @@ -36509,7 +45803,7 @@ Implement \-\-dump\-headers and \-\-dump\-bodies debug flags .IP \[bu] 2 Show multiple matched commands if abbreviation too short .IP \[bu] 2 -Implement server side move where possible +Implement server\-side move where possible .RE .IP \[bu] 2 local @@ -36532,7 +45826,7 @@ New features .IP \[bu] 2 Server side copies for s3/swift/drive/dropbox/gcs .IP \[bu] 2 -Move command \- uses server side copies if it can +Move command \- uses server\-side copies if it can .IP \[bu] 2 Implement \-\-retries flag \- tries 3 times by default .IP \[bu] 2 @@ -36680,7 +45974,8 @@ s3: list an unlimited number of items Fix getting stuck in the configurator .SS v1.09 \- 2015\-02\-07 .IP \[bu] 2 -windows: Stop drive letters (eg C:) getting mixed up with remotes (eg +windows: Stop drive letters (e.g. +C:) getting mixed up with remotes (e.g. drive:) .IP \[bu] 2 local: Fix directory separators on Windows @@ -36845,8 +46140,9 @@ issues (https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+milestone .SS Do all cloud storage systems support all rclone commands .PP Yes they do. -All the rclone commands (eg \f[C]sync\f[R], \f[C]copy\f[R] etc) will -work on all the remote storage systems. +All the rclone commands (e.g. +\f[C]sync\f[R], \f[C]copy\f[R], etc.) will work on all the remote +storage systems. .SS Can I copy the config from one machine to another .PP Sure! Rclone stores all of its config in a single file. @@ -36878,7 +46174,7 @@ rclone sync \-i drive:Folder s3:bucket .SS Using rclone from multiple locations at the same time .PP You can use rclone from multiple places at the same time if you choose -different subdirectory for the output, eg +different subdirectory for the output, e.g. .IP .nf \f[C] @@ -36889,7 +46185,7 @@ Server B> rclone sync \-i /tmp/whatever remote:ServerB .PP If you sync to the same directory then you should use rclone copy otherwise the two instances of rclone may delete each other\[aq]s files, -eg +e.g. .IP .nf \f[C] @@ -36899,14 +46195,15 @@ Server B> rclone copy /tmp/whatever remote:Backup .fi .PP The file names you upload from Server A and Server B should be different -in this case, otherwise some file systems (eg Drive) may make -duplicates. +in this case, otherwise some file systems (e.g. +Drive) may make duplicates. .SS Why doesn\[aq]t rclone support partial transfers / binary diffs like rsync? .PP Rclone stores each file you transfer as a native object on the remote cloud storage system. This means that you can see the files you upload as expected using -alternative access methods (eg using the Google Drive web interface). +alternative access methods (e.g. +using the Google Drive web interface). There is a 1:1 mapping between files on your hard disk and objects created in the cloud storage system. .PP @@ -36980,7 +46277,7 @@ export NO_PROXY=$no_proxy Note that the ftp backend does not support \f[C]ftp_proxy\f[R] yet. .SS Rclone gives x509: failed to load system roots and no roots provided error .PP -This means that \f[C]rclone\f[R] can\[aq]t file the SSL root +This means that \f[C]rclone\f[R] can\[aq]t find the SSL root certificates. Likely you are running \f[C]rclone\f[R] on a NAS with a cut\-down Linux OS, or possibly on Solaris. @@ -37468,7 +46765,7 @@ reddi1 .IP \[bu] 2 Matt Tucker .IP \[bu] 2 -Sebastian B\[:u]nger +Sebastian B\[:u]nger .IP \[bu] 2 Martin Polden .IP \[bu] 2 @@ -37921,6 +47218,101 @@ Lucas Kanashiro WarpedPixel .IP \[bu] 2 Sam Edwards +.IP \[bu] 2 +wjielai +.IP \[bu] 2 +Muffin King +.IP \[bu] 2 +Christopher Stewart <6573710+1f47a@users.noreply.github.com> +.IP \[bu] 2 +Russell Cattelan +.IP \[bu] 2 +gyutw <30371241+gyutw@users.noreply.github.com> +.IP \[bu] 2 +Hekmon +.IP \[bu] 2 +LaSombra +.IP \[bu] 2 +Dov Murik +.IP \[bu] 2 +Ameer Dawood +.IP \[bu] 2 +Dan Hipschman +.IP \[bu] 2 +Josh Soref +.IP \[bu] 2 +David +.IP \[bu] 2 +Ingo +.IP \[bu] 2 +Adam Pl\['a]nsk\['y] + +.IP \[bu] 2 +Manish Gupta +.IP \[bu] 2 +Deepak Sah +.IP \[bu] 2 +Marcin Zelent +.IP \[bu] 2 +zhucan +.IP \[bu] 2 +James Lim +.IP \[bu] 2 +Laurens Janssen +.IP \[bu] 2 +Bob Bagwill +.IP \[bu] 2 +Nathan Collins +.IP \[bu] 2 +lostheli +.IP \[bu] 2 +kelv +.IP \[bu] 2 +Milly +.IP \[bu] 2 +gtorelly +.IP \[bu] 2 +Brad Ackerman +.IP \[bu] 2 +Mitsuo Heijo +.IP \[bu] 2 +Claudio Bantaloukas +.IP \[bu] 2 +Benjamin Gustin +.IP \[bu] 2 +Ingo Weiss +.IP \[bu] 2 +Kerry Su +.IP \[bu] 2 +Ilyess Bachiri +.IP \[bu] 2 +Yury Stankevich +.IP \[bu] 2 +kice +.IP \[bu] 2 +Denis Neuling +.IP \[bu] 2 +Janne Johansson +.IP \[bu] 2 +Patrik Nordl\['e]n +.IP \[bu] 2 +CokeMine +.IP \[bu] 2 +S\[u01A1]n Tr\[u1EA7]n\-Nguy\[u1EC5]n +.IP \[bu] 2 +lluuaapp <266615+lluuaapp@users.noreply.github.com> +.IP \[bu] 2 +Zach Kipp +.IP \[bu] 2 +Riccardo Iaconelli +.IP \[bu] 2 +Sakuragawa Misty +.IP \[bu] 2 +Nicolas Rueff +.IP \[bu] 2 +Pau Rodriguez\-Estivill +.IP \[bu] 2 +Bob Pusateri .SH Contact the rclone project .SS Forum .PP